xref: /rk3399_rockchip-uboot/README (revision daab59ac05d8fd1092e34a4c695ac265ae700141)
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  /m68k			Files generic to m68k architecture
1408d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1418d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
142afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
1438d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
14433c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
145a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1467207b366SRobert P. J. Day  /sandbox		Files generic to HW-independent "sandbox"
1478d321b81SPeter Tyser  /sh			Files generic to SH architecture
14833c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
1498d321b81SPeter Tyser/api			Machine/arch independent API for external apps
1508d321b81SPeter Tyser/board			Board dependent files
151740f7e5cSXu Ziyuan/cmd			U-Boot commands functions
1528d321b81SPeter Tyser/common			Misc architecture independent functions
1537207b366SRobert P. J. Day/configs		Board default configuration files
1548d321b81SPeter Tyser/disk			Code for disk drive partition handling
1558d321b81SPeter Tyser/doc			Documentation (don't expect too much)
1568d321b81SPeter Tyser/drivers		Commonly used device drivers
15733c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
1588d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
1598d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
1608d321b81SPeter Tyser/include		Header Files
1617207b366SRobert P. J. Day/lib			Library routines generic to all architectures
1627207b366SRobert P. J. Day/Licenses		Various license files
1638d321b81SPeter Tyser/net			Networking code
1648d321b81SPeter Tyser/post			Power On Self Test
1657207b366SRobert P. J. Day/scripts		Various build scripts and Makefiles
1667207b366SRobert P. J. Day/test			Various unit test files
1678d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
168c609719bSwdenk
169c609719bSwdenkSoftware Configuration:
170c609719bSwdenk=======================
171c609719bSwdenk
172c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
173c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
174c609719bSwdenk
175c609719bSwdenkThere are two classes of configuration variables:
176c609719bSwdenk
177c609719bSwdenk* Configuration _OPTIONS_:
178c609719bSwdenk  These are selectable by the user and have names beginning with
179c609719bSwdenk  "CONFIG_".
180c609719bSwdenk
181c609719bSwdenk* Configuration _SETTINGS_:
182c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
183c609719bSwdenk  you don't know what you're doing; they have names beginning with
1846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
185c609719bSwdenk
1867207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating
1877207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently,
1887207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel,
1897207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your
1907207b366SRobert P. J. Daybuild.
191c609719bSwdenk
192c609719bSwdenk
193c609719bSwdenkSelection of Processor Architecture and Board Type:
194c609719bSwdenk---------------------------------------------------
195c609719bSwdenk
196c609719bSwdenkFor all supported boards there are ready-to-use default
197ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
198c609719bSwdenk
199c609719bSwdenkExample: For a TQM823L module type:
200c609719bSwdenk
201c609719bSwdenk	cd u-boot
202ab584d67SHolger Freyther	make TQM823L_defconfig
203c609719bSwdenk
2047207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board
2057207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file
2067207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards.
207c609719bSwdenk
20875b3c3aaSSimon GlassSandbox Environment:
20975b3c3aaSSimon Glass--------------------
21075b3c3aaSSimon Glass
21175b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
21275b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
21375b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
21475b3c3aaSSimon Glassrun some of U-Boot's tests.
21575b3c3aaSSimon Glass
2166b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
21775b3c3aaSSimon Glass
21875b3c3aaSSimon Glass
219db910353SSimon GlassBoard Initialisation Flow:
220db910353SSimon Glass--------------------------
221db910353SSimon Glass
222db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
2237207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules).
224db910353SSimon Glass
2257207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in
2267207b366SRobert P. J. Daymore detail later in this file.
2277207b366SRobert P. J. Day
2287207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names
2297207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures
2307207b366SRobert P. J. Daymay not conform to this.  At least most ARM boards which use
2317207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this.
2327207b366SRobert P. J. Day
2337207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly
2347207b366SRobert P. J. DayCPU-specific) start.S file, such as:
2357207b366SRobert P. J. Day
2367207b366SRobert P. J. Day	- arch/arm/cpu/armv7/start.S
2377207b366SRobert P. J. Day	- arch/powerpc/cpu/mpc83xx/start.S
2387207b366SRobert P. J. Day	- arch/mips/cpu/start.S
2397207b366SRobert P. J. Day
2407207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and
2417207b366SRobert P. J. Daylimitations of each of these functions are described below.
242db910353SSimon Glass
243db910353SSimon Glasslowlevel_init():
244db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
245db910353SSimon Glass	- no global_data or BSS
246db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
247db910353SSimon Glass	- must not set up SDRAM or use console
248db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
249db910353SSimon Glass		board_init_f()
250db910353SSimon Glass	- this is almost never needed
251db910353SSimon Glass	- return normally from this function
252db910353SSimon Glass
253db910353SSimon Glassboard_init_f():
254db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
255db910353SSimon Glass		i.e. SDRAM and serial UART
256db910353SSimon Glass	- global_data is available
257db910353SSimon Glass	- stack is in SRAM
258db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
259db910353SSimon Glass		only stack variables and global_data
260db910353SSimon Glass
261db910353SSimon Glass	Non-SPL-specific notes:
262db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
263db910353SSimon Glass		can do nothing
264db910353SSimon Glass
265db910353SSimon Glass	SPL-specific notes:
266db910353SSimon Glass	- you can override the entire board_init_f() function with your own
267db910353SSimon Glass		version as needed.
268db910353SSimon Glass	- preloader_console_init() can be called here in extremis
269db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
270db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
271db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
272db910353SSimon Glass		directly)
273db910353SSimon Glass
274db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
275db910353SSimon Glassthis point the stack and global_data are relocated to below
276db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
277db910353SSimon Glassmemory.
278db910353SSimon Glass
279db910353SSimon Glassboard_init_r():
280db910353SSimon Glass	- purpose: main execution, common code
281db910353SSimon Glass	- global_data is available
282db910353SSimon Glass	- SDRAM is available
283db910353SSimon Glass	- BSS is available, all static/global variables can be used
284db910353SSimon Glass	- execution eventually continues to main_loop()
285db910353SSimon Glass
286db910353SSimon Glass	Non-SPL-specific notes:
287db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
288db910353SSimon Glass		there.
289db910353SSimon Glass
290db910353SSimon Glass	SPL-specific notes:
291db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
292db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
293db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
2940680f1b1SLey Foon Tan		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
295db910353SSimon Glass		spl_board_init() function containing this call
296db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
297db910353SSimon Glass
298db910353SSimon Glass
299db910353SSimon Glass
300c609719bSwdenkConfiguration Options:
301c609719bSwdenk----------------------
302c609719bSwdenk
303c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
304c609719bSwdenksuch information is kept in a configuration file
305c609719bSwdenk"include/configs/<board_name>.h".
306c609719bSwdenk
307c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
308c609719bSwdenk"include/configs/TQM823L.h".
309c609719bSwdenk
310c609719bSwdenk
3117f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3127f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3137f6c2cbcSwdenkbuild a config tool - later.
3147f6c2cbcSwdenk
3157f6c2cbcSwdenk
316c609719bSwdenkThe following options need to be configured:
317c609719bSwdenk
3182628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
319c609719bSwdenk
3202628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3216ccec449SWolfgang Denk
322cf946c6dSLei Wen- Marvell Family Member
323cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
324cf946c6dSLei Wen					  multiple fs option at one time
325cf946c6dSLei Wen					  for marvell soc family
326cf946c6dSLei Wen
32766412c63SKumar Gala- 85xx CPU Options:
328ffd06e02SYork Sun		CONFIG_SYS_PPC64
329ffd06e02SYork Sun
330ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
331ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
332ffd06e02SYork Sun		compliance, among other possible reasons.
333ffd06e02SYork Sun
33466412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
33566412c63SKumar Gala
33666412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
33766412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
33866412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
33966412c63SKumar Gala
3408f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3418f29084aSKumar Gala
3428f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3438f29084aSKumar Gala		tree nodes for the given platform.
3448f29084aSKumar Gala
34533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
34633eee330SScott Wood
34733eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
34833eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
34933eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
35033eee330SScott Wood
35133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
35233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
35333eee330SScott Wood
35433eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
35533eee330SScott Wood		for which the A004510 workaround should be applied.
35633eee330SScott Wood
35733eee330SScott Wood		The rest of SVR is either not relevant to the decision
35833eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
35933eee330SScott Wood		p2041) or is implied by the build target, which controls
36033eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
36133eee330SScott Wood
36233eee330SScott Wood		See Freescale App Note 4493 for more information about
36333eee330SScott Wood		this erratum.
36433eee330SScott Wood
36574fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
36674fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
367b445bbb4SJeremiah Mahler		required during NOR boot.
36874fa22edSPrabhakar Kushwaha
3699f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
3709f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
371b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
3729f074e67SPrabhakar Kushwaha
37333eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
37433eee330SScott Wood
37533eee330SScott Wood		This is the value to write into CCSR offset 0x18600
37633eee330SScott Wood		according to the A004510 workaround.
37733eee330SScott Wood
37864501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
37964501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
38064501c66SPriyanka Jain		connected exclusively to the DSP cores.
38164501c66SPriyanka Jain
382765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
383765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
384765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
385765b0bdbSPriyanka Jain
38664501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
38764501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
38864501c66SPriyanka Jain		connected to the DSP core.
38964501c66SPriyanka Jain
390765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
391765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
392765b0bdbSPriyanka Jain
393b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
394b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
395b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
396b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
397b135991aSPriyanka Jain
398fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
399fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
400a187559eSBin Meng		time of U-Boot entry and is required to be re-initialized.
401fb4a2409SAneesh Bansal
402aade2004STang Yuantian		CONFIG_DEEP_SLEEP
403b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
404aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
405aade2004STang Yuantian
4066cb461b4SDaniel Schwierzeck- Generic CPU options:
4072a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4082a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4092a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4102a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4112a1680e3SYork Sun		should initialize global data before calling board_init_f().
4122a1680e3SYork Sun
4136cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4146cb461b4SDaniel Schwierzeck
4156cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4166cb461b4SDaniel Schwierzeck		values is arch specific.
4176cb461b4SDaniel Schwierzeck
4185614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4195614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4205614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4215614e71bSYork Sun		SoCs.
4225614e71bSYork Sun
4235614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4245614e71bSYork Sun		Freescale DDR memory-mapped register base.
4255614e71bSYork Sun
4265614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4275614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4285614e71bSYork Sun		deskew training are not available.
4295614e71bSYork Sun
4305614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4315614e71bSYork Sun		Freescale DDR1 controller.
4325614e71bSYork Sun
4335614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4345614e71bSYork Sun		Freescale DDR2 controller.
4355614e71bSYork Sun
4365614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4375614e71bSYork Sun		Freescale DDR3 controller.
4385614e71bSYork Sun
43934e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
44034e026f9SYork Sun		Freescale DDR4 controller.
44134e026f9SYork Sun
4429ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4439ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4449ac4ffbdSYork Sun
4455614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4465614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4475614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4485614e71bSYork Sun		implemetation.
4495614e71bSYork Sun
4505614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
45162a3b7ddSRobert P. J. Day		Board config to use DDR2. It can be enabled for SoCs with
4525614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4535614e71bSYork Sun		implementation.
4545614e71bSYork Sun
4555614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4565614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
45734e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
45834e026f9SYork Sun
45934e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
46034e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
46134e026f9SYork Sun		DDR3L controllers.
46234e026f9SYork Sun
46334e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
46434e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
46534e026f9SYork Sun		DDR4 controllers.
4665614e71bSYork Sun
4671b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4681b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4691b4175d6SPrabhakar Kushwaha
4701b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4711b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4721b4175d6SPrabhakar Kushwaha
4731c40707eSPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_CLK_DIV
4741c40707eSPrabhakar Kushwaha		Defines divider of platform clock(clock input to IFC controller).
4751c40707eSPrabhakar Kushwaha
476add63f94SPrabhakar Kushwaha		CONFIG_SYS_FSL_LBC_CLK_DIV
477add63f94SPrabhakar Kushwaha		Defines divider of platform clock(clock input to eLBC controller).
478add63f94SPrabhakar Kushwaha
479690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
480690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
481690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
482690e4258SPrabhakar Kushwaha
483690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
484690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
485690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
486690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
487690e4258SPrabhakar Kushwaha
48889ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
48989ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
49089ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
49189ad7be8SPrabhakar Kushwaha
4924e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
4934e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
4944e5b1bd0SYork Sun
4954e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
4964e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
4974e5b1bd0SYork Sun
4986b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
4996b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5006b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5016b9e309aSYork Sun		it could be different for ARM SoCs.
5026b9e309aSYork Sun
5036b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5046b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5056b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5066b1e1254SYork Sun		SoCs with ARM core.
5076b1e1254SYork Sun
5081d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5091d71efbbSYork Sun		Number of controllers used as main memory.
5101d71efbbSYork Sun
5111d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5121d71efbbSYork Sun		Number of controllers used for other than main memory.
5131d71efbbSYork Sun
51444937214SPrabhakar Kushwaha		CONFIG_SYS_FSL_HAS_DP_DDR
51544937214SPrabhakar Kushwaha		Defines the SoC has DP-DDR used for DPAA.
51644937214SPrabhakar Kushwaha
517028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
518028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
519028dbb8dSRuchika Gupta
520028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
521028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
522028dbb8dSRuchika Gupta
52392bbd64eSDaniel Schwierzeck- MIPS CPU options:
52492bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
52592bbd64eSDaniel Schwierzeck
52692bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
52792bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
52892bbd64eSDaniel Schwierzeck		relocation.
52992bbd64eSDaniel Schwierzeck
53092bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
53192bbd64eSDaniel Schwierzeck
53292bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
53392bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
53492bbd64eSDaniel Schwierzeck		Possible values are:
53592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
53692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
53792bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
53892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
53992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
54092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
54192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
54292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
54392bbd64eSDaniel Schwierzeck
54492bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
54592bbd64eSDaniel Schwierzeck
54692bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
54792bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
54892bbd64eSDaniel Schwierzeck
54992bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
55092bbd64eSDaniel Schwierzeck
55192bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
55292bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
55392bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
55492bbd64eSDaniel Schwierzeck
555b67d8816SChristian Riesch- ARM options:
556b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
557b67d8816SChristian Riesch
558b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
559b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
560b67d8816SChristian Riesch
561207774b2SYork Sun		COUNTER_FREQUENCY
562207774b2SYork Sun		Generic timer clock source frequency.
563207774b2SYork Sun
564207774b2SYork Sun		COUNTER_FREQUENCY_REAL
565207774b2SYork Sun		Generic timer clock source frequency if the real clock is
566207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
567207774b2SYork Sun		at run time.
568207774b2SYork Sun
56973c38934SStephen Warren- Tegra SoC options:
57073c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
57173c38934SStephen Warren
57273c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
57373c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
57473c38934SStephen Warren		such as ARM architectural timer initialization.
57573c38934SStephen Warren
5765da627a4Swdenk- Linux Kernel Interface:
577c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
578c609719bSwdenk
579c609719bSwdenk		U-Boot stores all clock information in Hz
580c609719bSwdenk		internally. For binary compatibility with older Linux
581c609719bSwdenk		kernels (which expect the clocks passed in the
582c609719bSwdenk		bd_info data to be in MHz) the environment variable
583c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
584c609719bSwdenk		converts clock data to MHZ before passing it to the
585c609719bSwdenk		Linux kernel.
586c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
587c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
588c609719bSwdenk		default environment.
589c609719bSwdenk
5905da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5915da627a4Swdenk
592b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
5935da627a4Swdenk		expect it to be in bytes, others in MB.
5945da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5955da627a4Swdenk
596fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
597f57f70aaSWolfgang Denk
598f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
599213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
600213bf8c8SGerald Van Baren		concepts).
601213bf8c8SGerald Van Baren
602213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
603213bf8c8SGerald Van Baren		 * New libfdt-based support
604213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6053bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
606213bf8c8SGerald Van Baren
607f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
608c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
609f57f70aaSWolfgang Denk
61011ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
61111ccc33fSMarcel Ziswiler		addresses
6123bb342fcSKim Phillips
6134e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6144e253137SKumar Gala
6154e253137SKumar Gala		Board code has addition modification that it wants to make
6164e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6176705d81eSwdenk
618c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
619c654b517SSimon Glass
620c654b517SSimon Glass		Other code has addition modification that it wants to make
621c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
622c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
623c654b517SSimon Glass		the kernel.
624c654b517SSimon Glass
6253887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6263887c3fbSHeiko Schocher
6273887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6283887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6293887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6303887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6313887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6323887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6333887c3fbSHeiko Schocher
6347eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6357eb29398SIgor Grinberg
6367eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6377eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6387eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6397eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6407eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6417eb29398SIgor Grinberg		in a single configuration file and the machine type is
6427eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6437eb29398SIgor Grinberg
6440b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6450b2f4ecaSNiklaus Giger
6460b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6479e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
6489e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
6490b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6500b2f4ecaSNiklaus Giger
6510b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6520b2f4ecaSNiklaus Giger		the defaults discussed just above.
6530b2f4ecaSNiklaus Giger
6542c451f78SAneesh V- Cache Configuration:
6552c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6562c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6572c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6582c451f78SAneesh V
65993bc2193SAneesh V- Cache Configuration for ARM:
66093bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
66193bc2193SAneesh V				      controller
66293bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
66393bc2193SAneesh V					controller register space
66493bc2193SAneesh V
6656705d81eSwdenk- Serial Ports:
66648d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6676705d81eSwdenk
6686705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6696705d81eSwdenk
67048d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6716705d81eSwdenk
6726705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6736705d81eSwdenk
6746705d81eSwdenk		CONFIG_PL011_CLOCK
6756705d81eSwdenk
6766705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6776705d81eSwdenk		the clock speed of the UARTs.
6786705d81eSwdenk
6796705d81eSwdenk		CONFIG_PL01x_PORTS
6806705d81eSwdenk
6816705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6826705d81eSwdenk		define this to a list of base addresses for each (supported)
6836705d81eSwdenk		port. See e.g. include/configs/versatile.h
6846705d81eSwdenk
685d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
686d57dee57SKaricheri, Muralidharan
687d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
688d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
6896705d81eSwdenk
690c609719bSwdenk- Console Baudrate:
691c609719bSwdenk		CONFIG_BAUDRATE - in bps
692c609719bSwdenk		Select one of the baudrates listed in
6936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
694c609719bSwdenk
695c609719bSwdenk- Autoboot Command:
696c609719bSwdenk		CONFIG_BOOTCOMMAND
697c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
698c609719bSwdenk		define a command string that is automatically executed
699c609719bSwdenk		when no character is read on the console interface
700c609719bSwdenk		within "Boot Delay" after reset.
701c609719bSwdenk
702c609719bSwdenk		CONFIG_BOOTARGS
703c609719bSwdenk		This can be used to pass arguments to the bootm
704c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
705c609719bSwdenk		environment value "bootargs".
706c609719bSwdenk
707c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
708c609719bSwdenk		The value of these goes into the environment as
709c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
710c609719bSwdenk		as a convenience, when switching between booting from
71111ccc33fSMarcel Ziswiler		RAM and NFS.
712c609719bSwdenk
713eda0ba38SHeiko Schocher- Bootcount:
714eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
715eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
716eda0ba38SHeiko Schocher		cycle, see:
717eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
718eda0ba38SHeiko Schocher
719eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
720eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
721eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
722eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
723eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
724eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
725eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
726eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
727eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
728eda0ba38SHeiko Schocher
729c609719bSwdenk- Pre-Boot Commands:
730c609719bSwdenk		CONFIG_PREBOOT
731c609719bSwdenk
732c609719bSwdenk		When this option is #defined, the existence of the
733c609719bSwdenk		environment variable "preboot" will be checked
734c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
735c609719bSwdenk		countdown and/or running the auto-boot command resp.
736c609719bSwdenk		entering interactive mode.
737c609719bSwdenk
738c609719bSwdenk		This feature is especially useful when "preboot" is
739c609719bSwdenk		automatically generated or modified. For an example
740c609719bSwdenk		see the LWMON board specific code: here "preboot" is
741c609719bSwdenk		modified when the user holds down a certain
742c609719bSwdenk		combination of keys on the (special) keyboard when
743c609719bSwdenk		booting the systems
744c609719bSwdenk
745c609719bSwdenk- Serial Download Echo Mode:
746c609719bSwdenk		CONFIG_LOADS_ECHO
747c609719bSwdenk		If defined to 1, all characters received during a
748c609719bSwdenk		serial download (using the "loads" command) are
749c609719bSwdenk		echoed back. This might be needed by some terminal
750c609719bSwdenk		emulations (like "cu"), but may as well just take
751c609719bSwdenk		time on others. This setting #define's the initial
752c609719bSwdenk		value of the "loads_echo" environment variable.
753c609719bSwdenk
754602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
755c609719bSwdenk		CONFIG_KGDB_BAUDRATE
756c609719bSwdenk		Select one of the baudrates listed in
7576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
758c609719bSwdenk
759c609719bSwdenk- Monitor Functions:
760602ad3b3SJon Loeliger		Monitor commands can be included or excluded
761602ad3b3SJon Loeliger		from the build by using the #include files
762c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
763ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
764c609719bSwdenk
765602ad3b3SJon Loeliger		The default command configuration includes all commands
766602ad3b3SJon Loeliger		except those marked below with a "*".
767602ad3b3SJon Loeliger
768b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
769602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
770602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
771602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
772d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
773602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
774602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
775602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
776602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
777602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
778246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
779602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
78088733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
7810c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
78203e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
78303e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
78416f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
78516f4d933SStephen Warren					  that work for multiple fs types
78659e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
787bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
788602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
789602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
790a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
791a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
792602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
793602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
7948fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
7954d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
7960c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
797c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
798602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
7994d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
800d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
801d22c338eSJoe Hershberger					  (169.254.*.*)
802602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
803602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8044d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
80502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
80615a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
807602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
808a2681707SWolfgang Denk					  loop, loopw
8094d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
810602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
811602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
812602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
81368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
814602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
815602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8164d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
817e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
818e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
819602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
820602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
821602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
822602ad3b3SJon Loeliger					  host
823602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
824ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
825602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
826602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
827d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
828602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
829c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
830602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
831602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
832f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
8337d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
83474de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
835602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8367a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8371fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
838da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
839da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
840602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
841602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
842c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
8434d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
84489c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
845c609719bSwdenk
846c609719bSwdenk		EXAMPLE: If you want all functions except of network
847c609719bSwdenk		support you can write:
848c609719bSwdenk
849602ad3b3SJon Loeliger		#include "config_cmd_all.h"
850602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
851c609719bSwdenk
852213bf8c8SGerald Van Baren	Other Commands:
853213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
854c609719bSwdenk
855c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
856602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
857c609719bSwdenk		what you (and your U-Boot users) are doing. Data
8585b8e76c3SHeiko Schocher		cache cannot be enabled on systems like the
859c609719bSwdenk		8260 (where accesses to the IMMR region must be
860c609719bSwdenk		uncached), and it cannot be disabled on all other
861c609719bSwdenk		systems where we (mis-) use the data cache to hold an
862c609719bSwdenk		initial stack and some data.
863c609719bSwdenk
864c609719bSwdenk
865c609719bSwdenk		XXX - this list needs to get updated!
866c609719bSwdenk
867302a6487SSimon Glass- Removal of commands
868302a6487SSimon Glass		If no commands are needed to boot, you can disable
869302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
870302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
871302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
872302a6487SSimon Glass		instead. This can reduce image size significantly for very
873302a6487SSimon Glass		simple boot procedures.
874302a6487SSimon Glass
875a5ecbe62SWolfgang Denk- Regular expression support:
876a5ecbe62SWolfgang Denk		CONFIG_REGEX
877a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
878a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
879a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
880a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
881a5ecbe62SWolfgang Denk
88245ba8077SSimon Glass- Device tree:
88345ba8077SSimon Glass		CONFIG_OF_CONTROL
88445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
88545ba8077SSimon Glass		to configure its devices, instead of relying on statically
88645ba8077SSimon Glass		compiled #defines in the board file. This option is
88745ba8077SSimon Glass		experimental and only available on a few boards. The device
88845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
88945ba8077SSimon Glass
8902c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
89182f766d1SAlex Deymo		be done using one of the three options below:
892bbb0b128SSimon Glass
893bbb0b128SSimon Glass		CONFIG_OF_EMBED
894bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
895bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
896bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
897bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
898bbb0b128SSimon Glass		the global data structure as gd->blob.
89945ba8077SSimon Glass
9002c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9012c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9022c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9032c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9042c0f79e4SSimon Glass
9052c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9062c0f79e4SSimon Glass
9072c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9082c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9092c0f79e4SSimon Glass		still use the individual files if you need something more
9102c0f79e4SSimon Glass		exotic.
9112c0f79e4SSimon Glass
91282f766d1SAlex Deymo		CONFIG_OF_BOARD
91382f766d1SAlex Deymo		If this variable is defined, U-Boot will use the device tree
91482f766d1SAlex Deymo		provided by the board at runtime instead of embedding one with
91582f766d1SAlex Deymo		the image. Only boards defining board_fdt_blob_setup() support
91682f766d1SAlex Deymo		this option (see include/fdtdec.h file).
91782f766d1SAlex Deymo
918c609719bSwdenk- Watchdog:
919c609719bSwdenk		CONFIG_WATCHDOG
920c609719bSwdenk		If this variable is defined, it enables watchdog
9216abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9222eb48ff7SHeiko Schocher		specific code for a watchdog. When supported for a
9232eb48ff7SHeiko Schocher		specific SoC is available, then no further board specific
9242eb48ff7SHeiko Schocher		code should be needed to use it.
9256abe6fb6SDetlev Zundel
9266abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9276abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9286abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9296abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
930c609719bSwdenk
9317bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
9327bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
9337bae0d6fSHeiko Schocher
934c1551ea8Sstroese- U-Boot Version:
935c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
936c1551ea8Sstroese		If this variable is defined, an environment variable
937c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
938c1551ea8Sstroese		version as printed by the "version" command.
939a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
940a1ea8e51SBenoît Thébaudeau		next reset.
941c1551ea8Sstroese
942c609719bSwdenk- Real-Time Clock:
943c609719bSwdenk
944602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
945c609719bSwdenk		has to be selected, too. Define exactly one of the
946c609719bSwdenk		following options:
947c609719bSwdenk
948c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9494e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
950c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9511cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
952c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9537f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
954412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
9553bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9569536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9574c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9582bd3cab3SChris Packham		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
95971d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
96071d19f30SHeiko Schocher					  RV3029 RTC.
961c609719bSwdenk
962b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
963b37c7e5eSwdenk		must also be configured. See I2C Support, below.
964b37c7e5eSwdenk
965e92739d3SPeter Tyser- GPIO Support:
966e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
967e92739d3SPeter Tyser
9685dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9695dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9705dec49caSChris Packham		pins supported by a particular chip.
9715dec49caSChris Packham
972e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
973e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
974e92739d3SPeter Tyser
975aa53233aSSimon Glass- I/O tracing:
976aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
977aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
978aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
979aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
980aa53233aSSimon Glass		the driver behaves the same way before and after a code
981aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
982aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
983aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
984aa53233aSSimon Glass
985aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
986aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
987aa53233aSSimon Glass		still continue to operate.
988aa53233aSSimon Glass
989aa53233aSSimon Glass			iotrace is enabled
990aa53233aSSimon Glass			Start:  10000000	(buffer start address)
991aa53233aSSimon Glass			Size:   00010000	(buffer size)
992aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
993aa53233aSSimon Glass			Output: 10000120	(start + offset)
994aa53233aSSimon Glass			Count:  00000018	(number of trace records)
995aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
996aa53233aSSimon Glass
997c609719bSwdenk- Timestamp Support:
998c609719bSwdenk
999c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1000c609719bSwdenk		(date and time) of an image is printed by image
1001c609719bSwdenk		commands like bootm or iminfo. This option is
1002602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1003c609719bSwdenk
1004923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1005923c46f9SKarl O. Pinc		Zero or more of the following:
1006923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1007923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1008923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1009923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1010923c46f9SKarl O. Pinc				       disk/part_efi.c
1011923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1012c609719bSwdenk
1013fc843a02SSimon Glass		If IDE or SCSI support is enabled (CONFIG_IDE or
1014c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1015923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1016c609719bSwdenk
1017c609719bSwdenk- IDE Reset method:
10184d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10194d13cbadSwdenk		board configurations files but used nowhere!
1020c609719bSwdenk
10214d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10224d13cbadSwdenk		be performed by calling the function
10234d13cbadSwdenk			ide_set_reset(int reset)
10244d13cbadSwdenk		which has to be defined in a board specific file
1025c609719bSwdenk
1026c609719bSwdenk- ATAPI Support:
1027c609719bSwdenk		CONFIG_ATAPI
1028c609719bSwdenk
1029c609719bSwdenk		Set this to enable ATAPI support.
1030c609719bSwdenk
1031c40b2956Swdenk- LBA48 Support
1032c40b2956Swdenk		CONFIG_LBA48
1033c40b2956Swdenk
1034c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10354b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1036c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1037c40b2956Swdenk		support disks up to 2.1TB.
1038c40b2956Swdenk
10396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1040c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1041c40b2956Swdenk			Default is 32bit.
1042c40b2956Swdenk
1043c609719bSwdenk- SCSI Support:
1044c609719bSwdenk		At the moment only there is only support for the
1045c609719bSwdenk		SYM53C8XX SCSI controller; define
1046c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1047c609719bSwdenk
10486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1051c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1052c609719bSwdenk		devices.
10536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1054c609719bSwdenk
1055447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1056447c031bSStefan Reinauer		SCSI devices found during the last scan.
1057447c031bSStefan Reinauer
1058c609719bSwdenk- NETWORK Support (PCI):
1059682011ffSwdenk		CONFIG_E1000
1060ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1061ce5207e1SKyle Moffett
1062ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1063ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1064ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1065ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1066ce5207e1SKyle Moffett
1067ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1068ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1069ce5207e1SKyle Moffett		example with the "sspi" command.
1070ce5207e1SKyle Moffett
1071ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1072ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1073ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1074682011ffSwdenk
1075c609719bSwdenk		CONFIG_EEPRO100
1076c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
107711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1078c609719bSwdenk		write routine for first time initialisation.
1079c609719bSwdenk
1080c609719bSwdenk		CONFIG_TULIP
1081c609719bSwdenk		Support for Digital 2114x chips.
1082c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1083c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1084c609719bSwdenk
1085c609719bSwdenk		CONFIG_NATSEMI
1086c609719bSwdenk		Support for National dp83815 chips.
1087c609719bSwdenk
1088c609719bSwdenk		CONFIG_NS8382X
1089c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1090c609719bSwdenk
109145219c46Swdenk- NETWORK Support (other):
109245219c46Swdenk
1093c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1094c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1095c041e9d2SJens Scharsig
1096c041e9d2SJens Scharsig			CONFIG_RMII
1097c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1098c041e9d2SJens Scharsig
1099c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1100c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1101c041e9d2SJens Scharsig			The driver doen't show link status messages.
1102c041e9d2SJens Scharsig
1103efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1104efdd7319SRob Herring		Support for the Calxeda XGMAC device
1105efdd7319SRob Herring
11063bb46d23SAshok		CONFIG_LAN91C96
110745219c46Swdenk		Support for SMSC's LAN91C96 chips.
110845219c46Swdenk
110945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
111045219c46Swdenk			Define this to enable 32 bit addressing
111145219c46Swdenk
11123bb46d23SAshok		CONFIG_SMC91111
1113f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1114f39748aeSwdenk
1115f39748aeSwdenk			CONFIG_SMC91111_BASE
1116f39748aeSwdenk			Define this to hold the physical address
1117f39748aeSwdenk			of the device (I/O space)
1118f39748aeSwdenk
1119f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1120f39748aeSwdenk			Define this if data bus is 32 bits
1121f39748aeSwdenk
1122f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1123f39748aeSwdenk			Define this to use i/o functions instead of macros
1124f39748aeSwdenk			(some hardware wont work with macros)
1125f39748aeSwdenk
1126dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1127dc02badaSHeiko Schocher		Support for davinci emac
1128dc02badaSHeiko Schocher
1129dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1130dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1131dc02badaSHeiko Schocher
1132b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1133b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1134b3dbf4a5SMacpaul Lin
1135b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1136b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1137b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1138b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1139b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1140b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1141b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1142b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1143b3dbf4a5SMacpaul Lin
1144c2fff331SMike Rapoport		CONFIG_SMC911X
1145557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1146557b377dSJens Gehrlein
1147c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1148557b377dSJens Gehrlein			Define this to hold the physical address
1149557b377dSJens Gehrlein			of the device (I/O space)
1150557b377dSJens Gehrlein
1151c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1152557b377dSJens Gehrlein			Define this if data bus is 32 bits
1153557b377dSJens Gehrlein
1154c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1155557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1156557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1157c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1158557b377dSJens Gehrlein
11593d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11603d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11613d0075faSYoshihiro Shimoda
11623d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11633d0075faSYoshihiro Shimoda			Define the number of ports to be used
11643d0075faSYoshihiro Shimoda
11653d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11663d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11673d0075faSYoshihiro Shimoda
116868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
116968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
117068260aabSYoshihiro Shimoda
1171b2f97cf2SHeiko Schocher- PWM Support:
1172b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
11735052e819SRobert P. J. Day		Support for PWM module on the imx6.
1174b2f97cf2SHeiko Schocher
11755e124724SVadim Bendebury- TPM Support:
117690899cc0SChe-liang Chiou		CONFIG_TPM
117790899cc0SChe-liang Chiou		Support TPM devices.
117890899cc0SChe-liang Chiou
11790766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
11800766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
11811b393db5STom Wai-Hong Tam		per system is supported at this time.
11821b393db5STom Wai-Hong Tam
11831b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
11841b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
11851b393db5STom Wai-Hong Tam
11863aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
11873aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
11883aa74088SChristophe Ricard
11893aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
11903aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
11913aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
11923aa74088SChristophe Ricard
1193b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1194b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1195b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1196b75fdc11SChristophe Ricard
1197c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1198c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1199c01939c7SDirk Eibach
120090899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12015e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12025e124724SVadim Bendebury		per system is supported at this time.
12035e124724SVadim Bendebury
12045e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12055e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12065e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12075e124724SVadim Bendebury			0xfed40000.
12085e124724SVadim Bendebury
1209be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1210be6c1529SReinhard Pfau		Add tpm monitor functions.
1211be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1212be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1213be6c1529SReinhard Pfau
1214be6c1529SReinhard Pfau		CONFIG_TPM
1215be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1216be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1217be6c1529SReinhard Pfau		Requires support for a TPM device.
1218be6c1529SReinhard Pfau
1219be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1220be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1221be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1222be6c1529SReinhard Pfau
1223c609719bSwdenk- USB Support:
1224c609719bSwdenk		At the moment only the UHCI host controller is
1225064b55cfSHeiko Schocher		supported (PIP405, MIP405); define
1226c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1227c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
122830d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1229c609719bSwdenk		storage devices.
1230c609719bSwdenk		Note:
1231c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1232c609719bSwdenk		(TEAC FD-05PUB).
12334d13cbadSwdenk
12349ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12359ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12369ab4ce22SSimon Glass
12376e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
12386e9e0626SOleksandr Tymoshenko		HW module registers.
12396e9e0626SOleksandr Tymoshenko
124016c8d5e7SWolfgang Denk- USB Device:
124116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
124216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
124316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
124411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
124516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
124616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
124716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
124816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
124916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
125016c8d5e7SWolfgang Denk		a Linux host by
125116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
125216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
125316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
125416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
125516c8d5e7SWolfgang Denk
125616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
125716c8d5e7SWolfgang Denk			Define this to build a UDC device
125816c8d5e7SWolfgang Denk
125916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
126016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
126116c8d5e7SWolfgang Denk			talk to the UDC device
126216c8d5e7SWolfgang Denk
1263f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1264f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1265f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1266f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1267f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1268f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1269f9da0f89SVipin KUMAR			speed.
1270f9da0f89SVipin KUMAR
12716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
127216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
127316c8d5e7SWolfgang Denk			be set to usbtty.
127416c8d5e7SWolfgang Denk
127516c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
127616c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
127716c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
127816c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
127916c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
128016c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
128116c8d5e7SWolfgang Denk
128216c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
128316c8d5e7SWolfgang Denk			Define this string as the name of your company for
128416c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
128516c8d5e7SWolfgang Denk
128616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
128716c8d5e7SWolfgang Denk			Define this string as the name of your product
128816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
128916c8d5e7SWolfgang Denk
129016c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
129116c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
129216c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
129316c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
129416c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
129516c8d5e7SWolfgang Denk
129616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
129716c8d5e7SWolfgang Denk			Define this as the unique Product ID
129816c8d5e7SWolfgang Denk			for your device
129916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1300c609719bSwdenk
1301d70a560fSIgor Grinberg- ULPI Layer Support:
1302d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1303d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1304d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1305d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1306d70a560fSIgor Grinberg		viewport is supported.
1307d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1308d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13096d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13106d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13116d365ea0SLucas Stach		the appropriate value in Hz.
1312c609719bSwdenk
1313c609719bSwdenk- MMC Support:
1314c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1315c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1316c609719bSwdenk		accessed from the boot prompt by mapping the device
1317c609719bSwdenk		to physical memory similar to flash. Command line is
1318602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1319602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1320c609719bSwdenk
1321afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1322afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1323afb35666SYoshihiro Shimoda
1324afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1325afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1326afb35666SYoshihiro Shimoda
1327afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1328afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1329afb35666SYoshihiro Shimoda
13301fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
13311fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
13321fd93c6eSPierre Aubert
13331fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
13341fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
13351fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
13361fd93c6eSPierre Aubert
1337b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
133801acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1339b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1340b3ba6e94STom Rini
1341b3ba6e94STom Rini		CONFIG_CMD_DFU
1342b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1343b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1344b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1345b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1346b3ba6e94STom Rini
1347b3ba6e94STom Rini		CONFIG_DFU_MMC
1348b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1349b3ba6e94STom Rini
1350c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1351c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1352c6631764SPantelis Antoniou
1353a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1354a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1355a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1356a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1357a9479f04SAfzal Mohammed		one that would help mostly the developer.
1358a9479f04SAfzal Mohammed
1359e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1360e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1361e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1362e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1363e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1364e7e75c70SHeiko Schocher
1365ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1366ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1367ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1368ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1369ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1370ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1371ea2453d5SPantelis Antoniou
1372001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1373001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1374001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1375001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1376001a8319SHeiko Schocher
1377001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1378001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1379001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1380001a8319SHeiko Schocher		sending again an USB request to the device.
1381001a8319SHeiko Schocher
13823aab70afSSebastian Siewior- USB Device Android Fastboot support:
138317da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
138417da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
138517da3c0cSPaul Kocialkowski
13863aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
13873aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
13883aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
13893aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
13903aab70afSSebastian Siewior		used on Android devices.
13913aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
13923aab70afSSebastian Siewior
13933aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
13943aab70afSSebastian Siewior		This enables support for booting images which use the Android
13953aab70afSSebastian Siewior		image format header.
13963aab70afSSebastian Siewior
1397a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
13983aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
13993aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
14003aab70afSSebastian Siewior		downloaded images.
14013aab70afSSebastian Siewior
1402a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
14033aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
14043aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
14053aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
14063aab70afSSebastian Siewior
1407d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1408d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1409d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1410d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1411d1b5ed07SSteve Rae
1412d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1413d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1414d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1415d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1416d1b5ed07SSteve Rae
14170ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
14180ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
14190ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
14200ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
14210ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
14220ff7e585SSteve Rae		This occurs when the specified "partition name" on the
14230ff7e585SSteve Rae		"fastboot flash" command line matches this value.
14246f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
14250ff7e585SSteve Rae
1426b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1427b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1428b6dd69a4SPetr Kulhavy		image to DOS MBR.
1429b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1430b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1431b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1432b6dd69a4SPetr Kulhavy
14336705d81eSwdenk- Journaling Flash filesystem support:
1434b2482dffSSimon Glass		CONFIG_JFFS2_NAND
14356705d81eSwdenk		Define these for a default partition on a NAND device
14366705d81eSwdenk
14376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14396705d81eSwdenk		Define these for a default partition on a NOR device
14406705d81eSwdenk
1441c609719bSwdenk- Keyboard Support:
144239f615edSSimon Glass		See Kconfig help for available keyboard drivers.
144339f615edSSimon Glass
144439f615edSSimon Glass		CONFIG_KEYBOARD
144539f615edSSimon Glass
144639f615edSSimon Glass		Define this to enable a custom keyboard support.
144739f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
144839f615edSSimon Glass		defined in your board-specific files. This option is deprecated
144939f615edSSimon Glass		and is only used by novena. For new boards, use driver model
145039f615edSSimon Glass		instead.
1451c609719bSwdenk
1452c609719bSwdenk- Video support:
14537d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14547d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14557d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14567d3053fbSTimur Tabi		support, and should also define these other macros:
14577d3053fbSTimur Tabi
14587d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14597d3053fbSTimur Tabi			CONFIG_VIDEO
14607d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14617d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14627d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14637d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14647d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14657d3053fbSTimur Tabi
1466ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1467ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
14688eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1469ba8e76bdSTimur Tabi		description of this variable.
14707d3053fbSTimur Tabi
1471c609719bSwdenk- LCD Support:	CONFIG_LCD
1472c609719bSwdenk
1473c609719bSwdenk		Define this to enable LCD support (for output to LCD
1474c609719bSwdenk		display); also select one of the supported displays
1475c609719bSwdenk		by defining one of these:
1476c609719bSwdenk
147739cf4804SStelian Pop		CONFIG_ATMEL_LCD:
147839cf4804SStelian Pop
147939cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
148039cf4804SStelian Pop
1481fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1482c609719bSwdenk
1483fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1484c609719bSwdenk
1485fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1486c609719bSwdenk
1487fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1488fd3103bbSwdenk			Active, color, single scan.
1489fd3103bbSwdenk
1490fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1491fd3103bbSwdenk
1492fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1493c609719bSwdenk			Active, color, single scan.
1494c609719bSwdenk
1495c609719bSwdenk		CONFIG_SHARP_16x9
1496c609719bSwdenk
1497c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1498c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1499c609719bSwdenk
1500c609719bSwdenk		CONFIG_SHARP_LQ64D341
1501c609719bSwdenk
1502c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1503c609719bSwdenk			Active, color, single scan.
1504c609719bSwdenk
1505c609719bSwdenk		CONFIG_HLD1045
1506c609719bSwdenk
1507c609719bSwdenk			HLD1045 display, 640x480.
1508c609719bSwdenk			Active, color, single scan.
1509c609719bSwdenk
1510c609719bSwdenk		CONFIG_OPTREX_BW
1511c609719bSwdenk
1512c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1513c609719bSwdenk			or
1514c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1515c609719bSwdenk			or
1516c609719bSwdenk			Hitachi	 SP14Q002
1517c609719bSwdenk
1518c609719bSwdenk			320x240. Black & white.
1519c609719bSwdenk
1520676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1521676d319eSSimon Glass
1522b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1523676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1524676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1525676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1526676d319eSSimon Glass		a per-section basis.
1527676d319eSSimon Glass
1528676d319eSSimon Glass
1529604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1530604c7d4aSHannes Petermaier
1531604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1532604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1533604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1534604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1535604c7d4aSHannes Petermaier		printed out.
1536604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1537604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1538604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1539604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1540604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1541604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1542604c7d4aSHannes Petermaier		1 = 90 degree rotation
1543604c7d4aSHannes Petermaier		2 = 180 degree rotation
1544604c7d4aSHannes Petermaier		3 = 270 degree rotation
1545604c7d4aSHannes Petermaier
1546604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1547604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1548604c7d4aSHannes Petermaier
154945d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
155045d7f525STom Wai-Hong Tam
155145d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
155245d7f525STom Wai-Hong Tam
1553735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1554735987c5STom Wai-Hong Tam
1555735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1556735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1557735987c5STom Wai-Hong Tam
15587152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1559d791b1dcSwdenk
1560d791b1dcSwdenk		If this option is set, the environment is checked for
1561d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1562d791b1dcSwdenk		of logo, copyright and system information on the LCD
1563e94d2cd9Swdenk		is suppressed and the BMP image at the address
1564d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1565d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1566d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1567d791b1dcSwdenk		loaded very quickly after power-on.
1568d791b1dcSwdenk
1569c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1570c0880485SNikita Kiryanov
1571c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1572c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1573ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1574c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1575c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1576c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1577c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1578c0880485SNikita Kiryanov		there is no need to set this option.
1579c0880485SNikita Kiryanov
15801ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
15811ca298ceSMatthias Weisser
15821ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
15831ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
15841ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
15851ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
15861ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
15871ca298ceSMatthias Weisser		specify 'm' for centering the image.
15881ca298ceSMatthias Weisser
15891ca298ceSMatthias Weisser		Example:
15901ca298ceSMatthias Weisser		setenv splashpos m,m
15911ca298ceSMatthias Weisser			=> image at center of screen
15921ca298ceSMatthias Weisser
15931ca298ceSMatthias Weisser		setenv splashpos 30,20
15941ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
15951ca298ceSMatthias Weisser
15961ca298ceSMatthias Weisser		setenv splashpos -10,m
15971ca298ceSMatthias Weisser			=> vertically centered image
15981ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
15991ca298ceSMatthias Weisser
160098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
160198f4a3dfSStefan Roese
160298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
160398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
160498f4a3dfSStefan Roese		splashscreen support or the bmp command.
160598f4a3dfSStefan Roese
1606d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1607d5011762SAnatolij Gustschin
1608d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1609d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1610d5011762SAnatolij Gustschin		bmp command.
1611d5011762SAnatolij Gustschin
1612c29fdfc1Swdenk- Compression support:
16138ef70478SKees Cook		CONFIG_GZIP
16148ef70478SKees Cook
16158ef70478SKees Cook		Enabled by default to support gzip compressed images.
16168ef70478SKees Cook
1617c29fdfc1Swdenk		CONFIG_BZIP2
1618c29fdfc1Swdenk
1619c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1620c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1621c29fdfc1Swdenk		compressed images are supported.
1622c29fdfc1Swdenk
1623c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1625c29fdfc1Swdenk		be at least 4MB.
1626d791b1dcSwdenk
16278ef70478SKees Cook		CONFIG_LZO
16288ef70478SKees Cook
16298ef70478SKees Cook		If this option is set, support for LZO compressed images
16308ef70478SKees Cook		is included.
16318ef70478SKees Cook
163217ea1177Swdenk- MII/PHY support:
163317ea1177Swdenk		CONFIG_PHY_ADDR
163417ea1177Swdenk
163517ea1177Swdenk		The address of PHY on MII bus.
163617ea1177Swdenk
163717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
163817ea1177Swdenk
163917ea1177Swdenk		The clock frequency of the MII bus
164017ea1177Swdenk
164117ea1177Swdenk		CONFIG_PHY_GIGE
164217ea1177Swdenk
164317ea1177Swdenk		If this option is set, support for speed/duplex
164411ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
164517ea1177Swdenk
164617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
164717ea1177Swdenk
164817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
164917ea1177Swdenk		reset before any MII register access is possible.
165017ea1177Swdenk		For such PHY, set this option to the usec delay
165117ea1177Swdenk		required. (minimum 300usec for LXT971A)
165217ea1177Swdenk
165317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
165417ea1177Swdenk
165517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
165617ea1177Swdenk		command issued before MII status register can be read
165717ea1177Swdenk
1658c609719bSwdenk- IP address:
1659c609719bSwdenk		CONFIG_IPADDR
1660c609719bSwdenk
1661c609719bSwdenk		Define a default value for the IP address to use for
166211ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1663c609719bSwdenk		determined through e.g. bootp.
16641ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1665c609719bSwdenk
1666c609719bSwdenk- Server IP address:
1667c609719bSwdenk		CONFIG_SERVERIP
1668c609719bSwdenk
1669c609719bSwdenk		Defines a default value for the IP address of a TFTP
1670c609719bSwdenk		server to contact when using the "tftboot" command.
16711ebcd654SWolfgang Denk		(Environment variable "serverip")
1672c609719bSwdenk
167397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
167497cfe861SRobin Getz
167597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
167697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
167797cfe861SRobin Getz
16781ebcd654SWolfgang Denk- Gateway IP address:
16791ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16801ebcd654SWolfgang Denk
16811ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16821ebcd654SWolfgang Denk		default router where packets to other networks are
16831ebcd654SWolfgang Denk		sent to.
16841ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16851ebcd654SWolfgang Denk
16861ebcd654SWolfgang Denk- Subnet mask:
16871ebcd654SWolfgang Denk		CONFIG_NETMASK
16881ebcd654SWolfgang Denk
16891ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16901ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16911ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16921ebcd654SWolfgang Denk		forwarded through a router.
16931ebcd654SWolfgang Denk		(Environment variable "netmask")
16941ebcd654SWolfgang Denk
169553a5c424SDavid Updegraff- Multicast TFTP Mode:
169653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
169753a5c424SDavid Updegraff
169853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
169953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
170011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
170153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
170253a5c424SDavid Updegraff		multicast group.
170353a5c424SDavid Updegraff
1704c609719bSwdenk- BOOTP Recovery Mode:
1705c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1706c609719bSwdenk
1707c609719bSwdenk		If you have many targets in a network that try to
1708c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1709c609719bSwdenk		systems send out BOOTP requests at precisely the same
1710c609719bSwdenk		moment (which would happen for instance at recovery
1711c609719bSwdenk		from a power failure, when all systems will try to
1712c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1713c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1714c609719bSwdenk		inserted before sending out BOOTP requests. The
17156c33c785SWolfgang Denk		following delays are inserted then:
1716c609719bSwdenk
1717c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1718c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1719c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1720c609719bSwdenk		4th and following
1721c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1722c609719bSwdenk
172392ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
172492ac8accSThierry Reding
172592ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
172692ac8accSThierry Reding		server will copy the ID from client requests to responses and
172792ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
172892ac8accSThierry Reding		an incoming response. Some servers will check that addresses
172992ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
173092ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
173192ac8accSThierry Reding		respond. Network congestion may also influence the time it
173292ac8accSThierry Reding		takes for a response to make it back to the client. If that
173392ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
173492ac8accSThierry Reding		to allow earlier responses to still be accepted after these
173592ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
173692ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
173792ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
173892ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
173992ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
174092ac8accSThierry Reding
1741fe389a82Sstroese- DHCP Advanced Options:
17421fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
17431fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1744fe389a82Sstroese
17451fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
17461fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
17471fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
17481fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
17491fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
17501fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
17511fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
17521fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
17531fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
17541fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
17551fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17561fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17572c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1758fe389a82Sstroese
17595d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17605d110f0aSWilson Callan		environment variable, not the BOOTP server.
1761fe389a82Sstroese
17622c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17632c00e099SJoe Hershberger		after the configured retry count, the call will fail
17642c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17652c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17662c00e099SJoe Hershberger		is not available.
17672c00e099SJoe Hershberger
1768fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1769fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1770fe389a82Sstroese		than one DNS serverip is offered to the client.
1771fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1772fe389a82Sstroese		serverip will be stored in the additional environment
1773fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1774fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
17751fe80d79SJon Loeliger		is defined.
1776fe389a82Sstroese
1777fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1778fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1779fe389a82Sstroese		need the hostname of the DHCP requester.
17805d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
17811fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
17821fe80d79SJon Loeliger		option 12 to the DHCP server.
1783fe389a82Sstroese
1784d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1785d9a2f416SAras Vaichas
1786d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1787d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1788d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1789d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1790d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1791d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1792d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1793d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1794d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1795d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1796d9a2f416SAras Vaichas		this delay.
1797d9a2f416SAras Vaichas
1798d22c338eSJoe Hershberger - Link-local IP address negotiation:
1799d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1800d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1801d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1802d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1803d22c338eSJoe Hershberger
1804d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1805d22c338eSJoe Hershberger
1806a3d991bdSwdenk - CDP Options:
1807a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1808a3d991bdSwdenk
1809a3d991bdSwdenk		The device id used in CDP trigger frames.
1810a3d991bdSwdenk
1811a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1812a3d991bdSwdenk
1813a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1814a3d991bdSwdenk		of the device.
1815a3d991bdSwdenk
1816a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1817a3d991bdSwdenk
1818a3d991bdSwdenk		A printf format string which contains the ascii name of
1819a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
182011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1821a3d991bdSwdenk
1822a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1823a3d991bdSwdenk
1824a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1825a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1826a3d991bdSwdenk
1827a3d991bdSwdenk		CONFIG_CDP_VERSION
1828a3d991bdSwdenk
1829a3d991bdSwdenk		An ascii string containing the version of the software.
1830a3d991bdSwdenk
1831a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1832a3d991bdSwdenk
1833a3d991bdSwdenk		An ascii string containing the name of the platform.
1834a3d991bdSwdenk
1835a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1836a3d991bdSwdenk
1837a3d991bdSwdenk		A 32bit integer sent on the trigger.
1838a3d991bdSwdenk
1839a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1840a3d991bdSwdenk
1841a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1842a3d991bdSwdenk		device in .1 of milliwatts.
1843a3d991bdSwdenk
1844a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1845a3d991bdSwdenk
1846a3d991bdSwdenk		A byte containing the id of the VLAN.
1847a3d991bdSwdenk
184879267eddSUri Mashiach- Status LED:	CONFIG_LED_STATUS
1849c609719bSwdenk
1850c609719bSwdenk		Several configurations allow to display the current
1851c609719bSwdenk		status using a LED. For instance, the LED will blink
1852c609719bSwdenk		fast while running U-Boot code, stop blinking as
1853c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1854c609719bSwdenk		start blinking slow once the Linux kernel is running
1855c609719bSwdenk		(supported by a status LED driver in the Linux
185679267eddSUri Mashiach		kernel). Defining CONFIG_LED_STATUS enables this
1857c609719bSwdenk		feature in U-Boot.
1858c609719bSwdenk
18591df7bbbaSIgor Grinberg		Additional options:
18601df7bbbaSIgor Grinberg
186179267eddSUri Mashiach		CONFIG_LED_STATUS_GPIO
18621df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
18631df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
186479267eddSUri Mashiach		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
18651df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
18661df7bbbaSIgor Grinberg
18679dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
18689dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
18699dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
18709dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
18719dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
18729dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
18739dfdcdfeSIgor Grinberg
18743f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1875c609719bSwdenk
18763f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
18773f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
18783f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
18793f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
18803f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
18813f4978c7SHeiko Schocher		interface.
18823f4978c7SHeiko Schocher
18833f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1884ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1885ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1886ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1887ea818dbbSHeiko Schocher		    for defining speed and slave address
1888ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1889ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1890ea818dbbSHeiko Schocher		    for defining speed and slave address
1891ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1892ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1893ea818dbbSHeiko Schocher		    for defining speed and slave address
1894ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1895ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1896ea818dbbSHeiko Schocher		    for defining speed and slave address
18973f4978c7SHeiko Schocher
189800f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
189900f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
190000f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
190100f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
190200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
190300f792e0SHeiko Schocher		    bus.
190400f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
190500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
190600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
190700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
190800f792e0SHeiko Schocher		    second bus.
190900f792e0SHeiko Schocher
19101f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
19111f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
19121f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
19131f2ba722SSimon Glass		    100000 and the slave addr 0!
19141f2ba722SSimon Glass
1915880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
1916880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1917880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1918880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1919880540deSDirk Eibach
1920fac96408Strem		- drivers/i2c/i2c_mxc.c
1921fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
192203544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
192303544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
192403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
192503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1926fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1927fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1928fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1929fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1930fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1931fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
193203544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
193303544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1934b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
1935fac96408Strem		for speed, and 0 for slave.
1936fac96408Strem
19371086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
19381086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
19391086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
19401086bfa9SNobuhiro Iwamatsu
19411086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
19421086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
19431086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
19441086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
19451086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
19461086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
19471086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
19481086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
19491086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
19501086bfa9SNobuhiro Iwamatsu
19512035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
19522035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
19532035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
19542035d77dSNobuhiro Iwamatsu
19552035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
19562035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
19572035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
19582035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
19592035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
19602035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
19612035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
19622035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
19632035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
19642035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1965b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
19662035d77dSNobuhiro Iwamatsu
19676789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
19686789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
19696789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
19706789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
19716789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
19726789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
19736789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
19746789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
19756789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
19766789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
19776789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
19786789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
19796789e84eSHeiko Schocher
19800bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
19810bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
19820bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
19830bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
19840bdffe71SHeiko Schocher
1985e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
1986e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
1987e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1988e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1989e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
1990e717fc6dSNaveen Krishna Ch
1991b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
1992b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
1993b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1994b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1995b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1996b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1997b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1998b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1999b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2000b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2001b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2002b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2003b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2004b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2005071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2006071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2007071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2008071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2009071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2010071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2011071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2012071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2013071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2014b46226bdSDirk Eibach
20153f4978c7SHeiko Schocher		additional defines:
20163f4978c7SHeiko Schocher
20173f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2018945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
20193f4978c7SHeiko Schocher
20203f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20213f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20223f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20233f4978c7SHeiko Schocher		omit this define.
20243f4978c7SHeiko Schocher
20253f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20263f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20273f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20283f4978c7SHeiko Schocher		define.
20293f4978c7SHeiko Schocher
20303f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2031b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
20323f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20333f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20343f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20353f4978c7SHeiko Schocher
20363f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20373f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20383f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20393f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20403f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20413f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20423f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20433f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20443f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20453f4978c7SHeiko Schocher					}
20463f4978c7SHeiko Schocher
20473f4978c7SHeiko Schocher		which defines
20483f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2049ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2050ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2051ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2052ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2053ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20543f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2055ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2056ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20573f4978c7SHeiko Schocher
20583f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20593f4978c7SHeiko Schocher
2060ce3b5d69SSimon Glass- Legacy I2C Support:
2061ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2062b37c7e5eSwdenk		then the following macros need to be defined (examples are
2063b37c7e5eSwdenk		from include/configs/lwmon.h):
2064c609719bSwdenk
2065c609719bSwdenk		I2C_INIT
2066c609719bSwdenk
2067b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2068c609719bSwdenk		controller or configure ports.
2069c609719bSwdenk
2070b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2071b37c7e5eSwdenk
2072c609719bSwdenk		I2C_ACTIVE
2073c609719bSwdenk
2074c609719bSwdenk		The code necessary to make the I2C data line active
2075c609719bSwdenk		(driven).  If the data line is open collector, this
2076c609719bSwdenk		define can be null.
2077c609719bSwdenk
2078b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2079b37c7e5eSwdenk
2080c609719bSwdenk		I2C_TRISTATE
2081c609719bSwdenk
2082c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2083c609719bSwdenk		(inactive).  If the data line is open collector, this
2084c609719bSwdenk		define can be null.
2085c609719bSwdenk
2086b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2087b37c7e5eSwdenk
2088c609719bSwdenk		I2C_READ
2089c609719bSwdenk
2090472d5460SYork Sun		Code that returns true if the I2C data line is high,
2091472d5460SYork Sun		false if it is low.
2092c609719bSwdenk
2093b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2094b37c7e5eSwdenk
2095c609719bSwdenk		I2C_SDA(bit)
2096c609719bSwdenk
2097472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2098472d5460SYork Sun		is false, it clears it (low).
2099c609719bSwdenk
2100b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2101b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2102b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2103b37c7e5eSwdenk
2104c609719bSwdenk		I2C_SCL(bit)
2105c609719bSwdenk
2106472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2107472d5460SYork Sun		is false, it clears it (low).
2108c609719bSwdenk
2109b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2110b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2111b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2112b37c7e5eSwdenk
2113c609719bSwdenk		I2C_DELAY
2114c609719bSwdenk
2115c609719bSwdenk		This delay is invoked four times per clock cycle so this
2116c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2117b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2118b37c7e5eSwdenk		like:
2119b37c7e5eSwdenk
2120b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2121c609719bSwdenk
2122793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2123793b5726SMike Frysinger
2124793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2125793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2126793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2127793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2128793b5726SMike Frysinger
2129793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2130793b5726SMike Frysinger		the generic GPIO functions.
2131793b5726SMike Frysinger
21326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
213347cd00faSwdenk
213447cd00faSwdenk		When a board is reset during an i2c bus transfer
213547cd00faSwdenk		chips might think that the current transfer is still
213647cd00faSwdenk		in progress. On some boards it is possible to access
213747cd00faSwdenk		the i2c SCLK line directly, either by using the
213847cd00faSwdenk		processor pin as a GPIO or by having a second pin
213947cd00faSwdenk		connected to the bus. If this option is defined a
214047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
214147cd00faSwdenk		is run early in the boot sequence.
214247cd00faSwdenk
2143bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2144bb99ad6dSBen Warren
2145bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2146bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2147bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2148bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2149bb99ad6dSBen Warren
21506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2151bb99ad6dSBen Warren
2152bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
21530f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
21540f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
21550f89c54bSPeter Tyser		a 1D array of device addresses
2156bb99ad6dSBen Warren
2157bb99ad6dSBen Warren		e.g.
2158bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
21596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2160bb99ad6dSBen Warren
2161bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2162bb99ad6dSBen Warren
2163bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2164945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2165bb99ad6dSBen Warren
2166bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2167bb99ad6dSBen Warren
21686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2169be5e6181STimur Tabi
2170be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2171be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2172be5e6181STimur Tabi
21736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
21740dc018ecSStefan Roese
21750dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
21760dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
21770dc018ecSStefan Roese
21782ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
21792ac6985aSAndrew Dyer
21802ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
21812ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
21822ac6985aSAndrew Dyer		between writing the address pointer and reading the
21832ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
21842ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
21852ac6985aSAndrew Dyer		devices can use either method, but some require one or
21862ac6985aSAndrew Dyer		the other.
2187be5e6181STimur Tabi
2188c609719bSwdenk- SPI Support:	CONFIG_SPI
2189c609719bSwdenk
2190c609719bSwdenk		Enables SPI driver (so far only tested with
2191c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2192c609719bSwdenk		D/As on the SACSng board)
2193c609719bSwdenk
21946639562eSYoshihiro Shimoda		CONFIG_SH_SPI
21956639562eSYoshihiro Shimoda
21966639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
21976639562eSYoshihiro Shimoda		only SH7757 is supported.
21986639562eSYoshihiro Shimoda
2199c609719bSwdenk		CONFIG_SOFT_SPI
2200c609719bSwdenk
2201c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2202c609719bSwdenk		using hardware support. This is a general purpose
2203c609719bSwdenk		driver that only requires three general I/O port pins
2204c609719bSwdenk		(two outputs, one input) to function. If this is
2205c609719bSwdenk		defined, the board configuration must define several
2206c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2207c609719bSwdenk		an example, see include/configs/sacsng.h.
2208c609719bSwdenk
220904a9e118SBen Warren		CONFIG_HARD_SPI
221004a9e118SBen Warren
221104a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
221204a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
221304a9e118SBen Warren		must define a list of chip-select function pointers.
221404a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
221504a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
221604a9e118SBen Warren
221738254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
221838254f45SGuennadi Liakhovetski
221938254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
22202e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
222138254f45SGuennadi Liakhovetski
2222f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2223f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2224f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2225f659b573SHeiko Schocher
22260133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
22270133502eSMatthias Fuchs
22280133502eSMatthias Fuchs		Enables FPGA subsystem.
22290133502eSMatthias Fuchs
22300133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
22310133502eSMatthias Fuchs
22320133502eSMatthias Fuchs		Enables support for specific chip vendors.
22330133502eSMatthias Fuchs		(ALTERA, XILINX)
22340133502eSMatthias Fuchs
22350133502eSMatthias Fuchs		CONFIG_FPGA_<family>
22360133502eSMatthias Fuchs
22370133502eSMatthias Fuchs		Enables support for FPGA family.
22380133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
22390133502eSMatthias Fuchs
22400133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2241c609719bSwdenk
2242c609719bSwdenk		Specify the number of FPGA devices to support.
2243c609719bSwdenk
22446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2245c609719bSwdenk
2246c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2247c609719bSwdenk
22486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2249c609719bSwdenk
2250c609719bSwdenk		Enable checks on FPGA configuration interface busy
2251c609719bSwdenk		status by the configuration function. This option
2252c609719bSwdenk		will require a board or device specific function to
2253c609719bSwdenk		be written.
2254c609719bSwdenk
2255c609719bSwdenk		CONFIG_FPGA_DELAY
2256c609719bSwdenk
2257c609719bSwdenk		If defined, a function that provides delays in the FPGA
2258c609719bSwdenk		configuration driver.
2259c609719bSwdenk
22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2261c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2262c609719bSwdenk
22636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2264c609719bSwdenk
2265c609719bSwdenk		Check for configuration errors during FPGA bitfile
2266c609719bSwdenk		loading. For example, abort during Virtex II
2267c609719bSwdenk		configuration if the INIT_B line goes low (which
2268c609719bSwdenk		indicated a CRC error).
2269c609719bSwdenk
22706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2271c609719bSwdenk
2272b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2273b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2274c609719bSwdenk		FPGA configuration sequence. The default time is 500
227511ccc33fSMarcel Ziswiler		ms.
2276c609719bSwdenk
22776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2278c609719bSwdenk
2279b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
228011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2281c609719bSwdenk
22826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2283c609719bSwdenk
2284c609719bSwdenk		Time to wait after FPGA configuration. The default is
228511ccc33fSMarcel Ziswiler		200 ms.
2286c609719bSwdenk
2287c609719bSwdenk- Configuration Management:
2288b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2289b2b8a696SStefan Roese
2290b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2291b2b8a696SStefan Roese		with a special header) as build targets. By defining
2292b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2293b2b8a696SStefan Roese		special image will be automatically built upon calling
22946de80f21SSimon Glass		make / buildman.
2295b2b8a696SStefan Roese
2296c609719bSwdenk		CONFIG_IDENT_STRING
2297c609719bSwdenk
2298c609719bSwdenk		If defined, this string will be added to the U-Boot
2299c609719bSwdenk		version information (U_BOOT_VERSION)
2300c609719bSwdenk
2301c609719bSwdenk- Vendor Parameter Protection:
2302c609719bSwdenk
2303c609719bSwdenk		U-Boot considers the values of the environment
2304c609719bSwdenk		variables "serial#" (Board Serial Number) and
23057152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2306c609719bSwdenk		are set once by the board vendor / manufacturer, and
2307c609719bSwdenk		protects these variables from casual modification by
2308c609719bSwdenk		the user. Once set, these variables are read-only,
2309c609719bSwdenk		and write or delete attempts are rejected. You can
231011ccc33fSMarcel Ziswiler		change this behaviour:
2311c609719bSwdenk
2312c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2313c609719bSwdenk		file, the write protection for vendor parameters is
231447cd00faSwdenk		completely disabled. Anybody can change or delete
2315c609719bSwdenk		these parameters.
2316c609719bSwdenk
231792ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
231892ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
231911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2320c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2321c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2322c609719bSwdenk		read-only.]
2323c609719bSwdenk
23242598090bSJoe Hershberger		The same can be accomplished in a more flexible way
23252598090bSJoe Hershberger		for any variable by configuring the type of access
23262598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
23272598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
23282598090bSJoe Hershberger
2329c609719bSwdenk- Protected RAM:
2330c609719bSwdenk		CONFIG_PRAM
2331c609719bSwdenk
2332c609719bSwdenk		Define this variable to enable the reservation of
2333c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2334c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2335c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2336c609719bSwdenk		this default value by defining an environment
2337c609719bSwdenk		variable "pram" to the number of kB you want to
2338c609719bSwdenk		reserve. Note that the board info structure will
2339c609719bSwdenk		still show the full amount of RAM. If pRAM is
2340c609719bSwdenk		reserved, a new environment variable "mem" will
2341c609719bSwdenk		automatically be defined to hold the amount of
2342c609719bSwdenk		remaining RAM in a form that can be passed as boot
2343c609719bSwdenk		argument to Linux, for instance like that:
2344c609719bSwdenk
2345fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2346c609719bSwdenk			saveenv
2347c609719bSwdenk
2348c609719bSwdenk		This way you can tell Linux not to use this memory,
2349c609719bSwdenk		either, which results in a memory region that will
2350c609719bSwdenk		not be affected by reboots.
2351c609719bSwdenk
2352c609719bSwdenk		*WARNING* If your board configuration uses automatic
2353c609719bSwdenk		detection of the RAM size, you must make sure that
2354c609719bSwdenk		this memory test is non-destructive. So far, the
2355c609719bSwdenk		following board configurations are known to be
2356c609719bSwdenk		"pRAM-clean":
2357c609719bSwdenk
23585b8e76c3SHeiko Schocher			IVMS8, IVML24, SPD8xx,
23591b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
23602eb48ff7SHeiko Schocher			FLAGADM
2361c609719bSwdenk
236240fef049SGabe Black- Access to physical memory region (> 4GB)
236340fef049SGabe Black		Some basic support is provided for operations on memory not
236440fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
236540fef049SGabe Black		support access to more than 4GB of memory on 32-bit
236640fef049SGabe Black		machines using physical address extension or similar.
236740fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
236840fef049SGabe Black		currently only supports clearing the memory.
236940fef049SGabe Black
2370c609719bSwdenk- Error Recovery:
2371c609719bSwdenk		CONFIG_PANIC_HANG
2372c609719bSwdenk
2373c609719bSwdenk		Define this variable to stop the system in case of a
2374c609719bSwdenk		fatal error, so that you have to reset it manually.
2375c609719bSwdenk		This is probably NOT a good idea for an embedded
237611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2377c609719bSwdenk		automatically as fast as possible, but it may be
2378c609719bSwdenk		useful during development since you can try to debug
2379c609719bSwdenk		the conditions that lead to the situation.
2380c609719bSwdenk
2381c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2382c609719bSwdenk
2383c609719bSwdenk		This variable defines the number of retries for
2384c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2385c609719bSwdenk		before giving up the operation. If not defined, a
2386c609719bSwdenk		default value of 5 is used.
2387c609719bSwdenk
238840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
238940cb90eeSGuennadi Liakhovetski
239040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
239140cb90eeSGuennadi Liakhovetski
239248a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
239348a3e999STetsuyuki Kobayashi
239448a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
239548a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
239648a3e999STetsuyuki Kobayashi		try longer timeout such as
239748a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
239848a3e999STetsuyuki Kobayashi
2399c609719bSwdenk- Command Interpreter:
24008078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
240104a85b3bSwdenk
240204a85b3bSwdenk		Enable auto completion of commands using TAB.
240304a85b3bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2405c609719bSwdenk
2406c609719bSwdenk		This defines the secondary prompt string, which is
2407c609719bSwdenk		printed when the command interpreter needs more input
2408c609719bSwdenk		to complete a command. Usually "> ".
2409c609719bSwdenk
2410c609719bSwdenk	Note:
2411c609719bSwdenk
2412c609719bSwdenk		In the current implementation, the local variables
2413c609719bSwdenk		space and global environment variables space are
2414c609719bSwdenk		separated. Local variables are those you define by
24153b57fe0aSwdenk		simply typing `name=value'. To access a local
2416c609719bSwdenk		variable later on, you have write `$name' or
24173b57fe0aSwdenk		`${name}'; to execute the contents of a variable
24183b57fe0aSwdenk		directly type `$name' at the command prompt.
2419c609719bSwdenk
2420c609719bSwdenk		Global environment variables are those you use
2421c609719bSwdenk		setenv/printenv to work with. To run a command stored
2422c609719bSwdenk		in such a variable, you need to use the run command,
2423c609719bSwdenk		and you must not use the '$' sign to access them.
2424c609719bSwdenk
2425c609719bSwdenk		To store commands and special characters in a
2426c609719bSwdenk		variable, please use double quotation marks
2427c609719bSwdenk		surrounding the whole text of the variable, instead
2428c609719bSwdenk		of the backslashes before semicolons and special
2429c609719bSwdenk		symbols.
2430c609719bSwdenk
2431b445bbb4SJeremiah Mahler- Command Line Editing and History:
2432aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2433aa0c71acSWolfgang Denk
243411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2435aa0c71acSWolfgang Denk		command line input operations
2436aa0c71acSWolfgang Denk
2437f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2438f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2439f3b267b3SMarek Vasut
2440f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2441f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2442f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2443f3b267b3SMarek Vasut		and PS2.
2444f3b267b3SMarek Vasut
2445a8c7c708Swdenk- Default Environment:
2446c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2447c609719bSwdenk
2448c609719bSwdenk		Define this to contain any number of null terminated
2449c609719bSwdenk		strings (variable = value pairs) that will be part of
24507152b1d0Swdenk		the default environment compiled into the boot image.
24512262cfeeSwdenk
2452c609719bSwdenk		For example, place something like this in your
2453c609719bSwdenk		board's config file:
2454c609719bSwdenk
2455c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2456c609719bSwdenk			"myvar1=value1\0" \
2457c609719bSwdenk			"myvar2=value2\0"
2458c609719bSwdenk
2459c609719bSwdenk		Warning: This method is based on knowledge about the
2460c609719bSwdenk		internal format how the environment is stored by the
24612262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2462c609719bSwdenk		interface! Although it is unlikely that this format
24637152b1d0Swdenk		will change soon, there is no guarantee either.
2464c609719bSwdenk		You better know what you are doing here.
2465c609719bSwdenk
2466c609719bSwdenk		Note: overly (ab)use of the default environment is
2467c609719bSwdenk		discouraged. Make sure to check other ways to preset
246874de7aefSWolfgang Denk		the environment like the "source" command or the
2469c609719bSwdenk		boot command first.
2470c609719bSwdenk
24715e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
24725e724ca2SStephen Warren
24735e724ca2SStephen Warren		Define this in order to add variables describing the
24745e724ca2SStephen Warren		U-Boot build configuration to the default environment.
24755e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
24765e724ca2SStephen Warren
24775e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
24785e724ca2SStephen Warren
24795e724ca2SStephen Warren		- CONFIG_SYS_ARCH
24805e724ca2SStephen Warren		- CONFIG_SYS_CPU
24815e724ca2SStephen Warren		- CONFIG_SYS_BOARD
24825e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
24835e724ca2SStephen Warren		- CONFIG_SYS_SOC
24845e724ca2SStephen Warren
24857e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
24867e27f89fSTom Rini
24877e27f89fSTom Rini		Define this in order to add variables describing certain
24887e27f89fSTom Rini		run-time determined information about the hardware to the
24897e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
24907e27f89fSTom Rini
249106fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
249206fd8538SSimon Glass
249306fd8538SSimon Glass		Normally the environment is loaded when the board is
2494b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
249506fd8538SSimon Glass		that so that the environment is not available until
249606fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
249706fd8538SSimon Glass		this is instead controlled by the value of
249806fd8538SSimon Glass		/config/load-environment.
249906fd8538SSimon Glass
2500a8c7c708Swdenk- DataFlash Support:
25012abbe075Swdenk		CONFIG_HAS_DATAFLASH
25022abbe075Swdenk
25032abbe075Swdenk		Defining this option enables DataFlash features and
25042abbe075Swdenk		allows to read/write in Dataflash via the standard
25052abbe075Swdenk		commands cp, md...
25062abbe075Swdenk
2507f61ec45eSEric Nelson- Serial Flash support
2508f61ec45eSEric Nelson		CONFIG_CMD_SF
2509f61ec45eSEric Nelson
2510f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2511f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2512f61ec45eSEric Nelson
2513f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2514f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2515f61ec45eSEric Nelson		commands.
2516f61ec45eSEric Nelson
2517f61ec45eSEric Nelson		The following defaults may be provided by the platform
2518f61ec45eSEric Nelson		to handle the common case when only a single serial
2519f61ec45eSEric Nelson		flash is present on the system.
2520f61ec45eSEric Nelson
2521f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2522f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2523f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2524f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2525f61ec45eSEric Nelson
252624007273SSimon Glass		CONFIG_CMD_SF_TEST
252724007273SSimon Glass
252824007273SSimon Glass		Define this option to include a destructive SPI flash
252924007273SSimon Glass		test ('sf test').
253024007273SSimon Glass
25313f85ce27Swdenk- SystemACE Support:
25323f85ce27Swdenk		CONFIG_SYSTEMACE
25333f85ce27Swdenk
25343f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
25353f85ce27Swdenk		chips attached via some sort of local bus. The address
253611ccc33fSMarcel Ziswiler		of the chip must also be defined in the
25376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
25383f85ce27Swdenk
25393f85ce27Swdenk		#define CONFIG_SYSTEMACE
25406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
25413f85ce27Swdenk
25423f85ce27Swdenk		When SystemACE support is added, the "ace" device type
25433f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
25443f85ce27Swdenk
2545ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2546ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2547ecb0ccd9SWolfgang Denk
254828cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2549ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
255028cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2551ecb0ccd9SWolfgang Denk		number generator is used.
2552ecb0ccd9SWolfgang Denk
255328cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
255428cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
255528cb9375SWolfgang Denk		defined, the normal port 69 is used.
255628cb9375SWolfgang Denk
255728cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2558ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2559ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2560ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2561ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2562ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2563ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2564ecb0ccd9SWolfgang Denk
25659e50c406SHeiko Schocher- bootcount support:
25669e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
25679e50c406SHeiko Schocher
25689e50c406SHeiko Schocher		This enables the bootcounter support, see:
25699e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
25709e50c406SHeiko Schocher
25719e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
25729e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
25739e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
25749e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
25759e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
25769e50c406SHeiko Schocher		enable support for the bootcounter in RAM
25779e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
25789e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
25799e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
25809e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
25819e50c406SHeiko Schocher						    the bootcounter.
25829e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
258319c402afSSimon Glass
2584a8c7c708Swdenk- Show boot progress:
2585c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2586c609719bSwdenk
2587c609719bSwdenk		Defining this option allows to add some board-
2588c609719bSwdenk		specific code (calling a user-provided function
2589c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2590c609719bSwdenk		the system's boot progress on some display (for
2591c609719bSwdenk		example, some LED's) on your board. At the moment,
2592c609719bSwdenk		the following checkpoints are implemented:
2593c609719bSwdenk
259494fd1316SSimon Glass
25951372cce2SMarian BalakowiczLegacy uImage format:
25961372cce2SMarian Balakowicz
2597c609719bSwdenk  Arg	Where			When
2598c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2599c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2600c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2601c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2602c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2603c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2604c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2605c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2606c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
26071372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2608c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2609c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2610c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2611c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
26121372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2613c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
26141372cce2SMarian Balakowicz
26151372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
26161372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
26171372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
26181372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
26191372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
26201372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
26211372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
262211ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
26231372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
26241372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
26251372cce2SMarian Balakowicz
2626ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2627c609719bSwdenk
2628a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
262963e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
263063e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
263163e73c9aSwdenk
2632566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2633566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2634566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2635566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2636566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2637566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2638566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2639566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2640566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2641566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2642566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2643566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2644566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2645566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2646566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2647566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2648566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2649566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2650566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2651566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2652566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2653566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2654566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2655566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2656566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2657566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2658566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2659566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2660566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2661566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2662566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2663566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2664566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2665566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2666566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2667566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2668566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2669566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2670566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2671566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2672566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2673566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2674566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2675566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2676566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2677566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2678566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2679c609719bSwdenk
2680566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2681c609719bSwdenk
2682566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2683566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2684566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2685206c60cbSwdenk
2686566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2687bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
2688bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
2689bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
2690566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2691566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
269274de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
269374de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2694566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2695c609719bSwdenk
26961372cce2SMarian BalakowiczFIT uImage format:
26971372cce2SMarian Balakowicz
26981372cce2SMarian Balakowicz  Arg	Where			When
26991372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
27001372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
27011372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
27021372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
27031372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
27041372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2705f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
27061372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
27071372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
27081372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
27091372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
27101372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
271111ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
271211ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
27131372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
27141372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
27151372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
27161372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
27171372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
27181372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
27191372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
27201372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
27211372cce2SMarian Balakowicz
27221372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
27231372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
27241372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
272511ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
27261372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
27271372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
27281372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
27291372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
27301372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
27311372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
27321372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
27331372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
27341372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
27351372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
27361372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
27371372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
27381372cce2SMarian Balakowicz
273911ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
27401372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
27411372cce2SMarian Balakowicz
274211ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
27431372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
27441372cce2SMarian Balakowicz
274511ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
27461372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
27471372cce2SMarian Balakowicz
274821d29f7fSHeiko Schocher- legacy image format:
274921d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
275021d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
275121d29f7fSHeiko Schocher
275221d29f7fSHeiko Schocher		Default:
275321d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
275421d29f7fSHeiko Schocher
275521d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
275621d29f7fSHeiko Schocher		disable the legacy image format
275721d29f7fSHeiko Schocher
275821d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
275921d29f7fSHeiko Schocher		enabled per default for backward compatibility.
276021d29f7fSHeiko Schocher
27614cf2609bSWolfgang Denk- Standalone program support:
27624cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
27634cf2609bSWolfgang Denk
27646feff899SWolfgang Denk		This option defines a board specific value for the
27656feff899SWolfgang Denk		address where standalone program gets loaded, thus
27666feff899SWolfgang Denk		overwriting the architecture dependent default
27674cf2609bSWolfgang Denk		settings.
27684cf2609bSWolfgang Denk
27694cf2609bSWolfgang Denk- Frame Buffer Address:
27704cf2609bSWolfgang Denk		CONFIG_FB_ADDR
27714cf2609bSWolfgang Denk
27724cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
277344a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
277444a53b57SWolfgang Denk		when using a graphics controller has separate video
277544a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
277644a53b57SWolfgang Denk		the given address instead of dynamically reserving it
277744a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
277844a53b57SWolfgang Denk		the memory for the frame buffer depending on the
277944a53b57SWolfgang Denk		configured panel size.
27804cf2609bSWolfgang Denk
27814cf2609bSWolfgang Denk		Please see board_init_f function.
27824cf2609bSWolfgang Denk
2783cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2784cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2785cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2786cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2787cccfc2abSDetlev Zundel
2788cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2789cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2790cccfc2abSDetlev Zundel
2791cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2792cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2793cccfc2abSDetlev Zundel
2794cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2795cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2796cccfc2abSDetlev Zundel
2797cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2798cccfc2abSDetlev Zundel
2799cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2800cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2801cccfc2abSDetlev Zundel
280270c219cdSJoe Hershberger- UBI support
280370c219cdSJoe Hershberger		CONFIG_CMD_UBI
280470c219cdSJoe Hershberger
280570c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
280670c219cdSJoe Hershberger		with the UBI flash translation layer
280770c219cdSJoe Hershberger
280870c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
280970c219cdSJoe Hershberger
2810147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2811147162daSJoe Hershberger
2812147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2813147162daSJoe Hershberger		warnings and errors enabled.
2814147162daSJoe Hershberger
2815ff94bc40SHeiko Schocher
2816ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
2817ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
2818ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
2819ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
2820ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
2821ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
2822ff94bc40SHeiko Schocher
2823ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
2824ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
2825ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
2826ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
2827ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
2828ff94bc40SHeiko Schocher
2829ff94bc40SHeiko Schocher		default: 4096
2830ff94bc40SHeiko Schocher
2831ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
2832ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
2833ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
2834ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
2835ff94bc40SHeiko Schocher		flash), this value is ignored.
2836ff94bc40SHeiko Schocher
2837ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
2838ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
2839ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
2840ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2841ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
2842ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
2843ff94bc40SHeiko Schocher
2844ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
2845ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
2846ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
2847ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
2848ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
2849ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
2850ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
2851ff94bc40SHeiko Schocher		partition.
2852ff94bc40SHeiko Schocher
2853ff94bc40SHeiko Schocher		default: 20
2854ff94bc40SHeiko Schocher
2855ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
2856ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
2857ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
2858ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
2859ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
2860ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
2861ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
2862ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
2863ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2864ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
2865ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
2866ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2867ff94bc40SHeiko Schocher
2868ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2869ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
2870ff94bc40SHeiko Schocher		without a fastmap.
2871ff94bc40SHeiko Schocher		default: 0
2872ff94bc40SHeiko Schocher
28730195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
28740195a7bbSHeiko Schocher		Enable UBI fastmap debug
28750195a7bbSHeiko Schocher		default: 0
28760195a7bbSHeiko Schocher
287770c219cdSJoe Hershberger- UBIFS support
287870c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
287970c219cdSJoe Hershberger
288070c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
288170c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
288270c219cdSJoe Hershberger
288370c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
288470c219cdSJoe Hershberger
2885147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2886147162daSJoe Hershberger
2887147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2888147162daSJoe Hershberger		warnings and errors enabled.
2889147162daSJoe Hershberger
28906a11cf48SDaniel Schwierzeck- SPL framework
28916a11cf48SDaniel Schwierzeck		CONFIG_SPL
28926a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
28936a11cf48SDaniel Schwierzeck
289495579793STom Rini		CONFIG_SPL_LDSCRIPT
289595579793STom Rini		LDSCRIPT for linking the SPL binary.
289695579793STom Rini
28976ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
28986ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
28996ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
29006ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
29018960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29026ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
29036ebc3461SAlbert ARIBAUD
290495579793STom Rini		CONFIG_SPL_MAX_SIZE
29056ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
29066ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
29076ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
29086ebc3461SAlbert ARIBAUD		not exceed it.
290995579793STom Rini
29106a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
29116a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
29126a11cf48SDaniel Schwierzeck
291394a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
291494a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
291594a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
291694a45bb1SScott Wood
291795579793STom Rini		CONFIG_SPL_BSS_START_ADDR
291895579793STom Rini		Link address for the BSS within the SPL binary.
291995579793STom Rini
292095579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
29216ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
29226ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
29236ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
29248960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29256ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
292695579793STom Rini
292795579793STom Rini		CONFIG_SPL_STACK
292895579793STom Rini		Adress of the start of the stack SPL will use
292995579793STom Rini
29308c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
29318c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
29328c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
29338c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
29348c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
29358c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
29368c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
29378c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
29388c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
29398c80eb3bSAlbert ARIBAUD \(3ADEV\)
294094a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
294194a45bb1SScott Wood		Adress of the start of the stack SPL will use after
294294a45bb1SScott Wood		relocation.  If unspecified, this is equal to
294394a45bb1SScott Wood		CONFIG_SPL_STACK.
294494a45bb1SScott Wood
294595579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
294695579793STom Rini		Starting address of the malloc pool used in SPL.
29479ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
29489ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
29499ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
295095579793STom Rini
295195579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
295295579793STom Rini		The size of the malloc pool used in SPL.
29536a11cf48SDaniel Schwierzeck
295447f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
295547f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
295647f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
295747f7bcaeSTom Rini		NAND loading of the Linux Kernel.
295847f7bcaeSTom Rini
29599607faf2STom Rini		CONFIG_SPL_OS_BOOT
29609607faf2STom Rini		Enable booting directly to an OS from SPL.
29619607faf2STom Rini		See also: doc/README.falcon
29629607faf2STom Rini
2963861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2964861a86f4STom Rini		For ARM, enable an optional function to print more information
2965861a86f4STom Rini		about the running system.
2966861a86f4STom Rini
29674b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
29684b919725SScott Wood		Arch init code should be built for a very small image
29694b919725SScott Wood
2970b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2971b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2972b97300b6SPaul Kocialkowski		used in raw mode
2973b97300b6SPaul Kocialkowski
29742b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
29752b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
29762b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
29772b75b0adSPeter Korsgaard
29782b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
29792b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
29802b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
29812b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
29822b75b0adSPeter Korsgaard		(for falcon mode)
29832b75b0adSPeter Korsgaard
2984e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2985e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2986e2ccdf89SPaul Kocialkowski		used in fs mode
2987e2ccdf89SPaul Kocialkowski
2988fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2989fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
2990fae81c72SGuillaume GARDET
2991fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
29927ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
2993fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
29947ad2cc79SPeter Korsgaard
2995fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
29967ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
2997fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
29987ad2cc79SPeter Korsgaard
299906f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
300006f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
300106f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
300206f60ae3SScott Wood		continuing (the hardware starts execution after just
300306f60ae3SScott Wood		loading the first page rather than the full 4K).
300406f60ae3SScott Wood
3005651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3006651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3007651fcf60SPrabhakar Kushwaha
30086f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
30096f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
30106f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
30116f2f01b9SScott Wood
30126f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
30136f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
30146f2f01b9SScott Wood
30156f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
30166f2f01b9SScott Wood		Include standard software ECC in the SPL
30176f2f01b9SScott Wood
301895579793STom Rini		CONFIG_SPL_NAND_SIMPLE
30197d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
30207d4b7955SScott Wood		expose the cmd_ctrl() interface.
302195579793STom Rini
30226f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
30236f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
30246f4e7d3cSThomas Gleixner		loader
30256f4e7d3cSThomas Gleixner
30260c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
30270c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
30280c3117b1SHeiko Schocher		if you need to save space.
30290c3117b1SHeiko Schocher
30307c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
30317c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
30327c8eea59SYing Zhang		SPL binary.
30337c8eea59SYing Zhang
303495579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
303595579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
303695579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
303795579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
303895579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
303995579793STom Rini		Defines the size and behavior of the NAND that SPL uses
30407d4b7955SScott Wood		to read U-Boot
304195579793STom Rini
3042fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3043fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3044fbe76ae4SPrabhakar Kushwaha
304595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
30467d4b7955SScott Wood		Location in NAND to read U-Boot from
30477d4b7955SScott Wood
30487d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
30497d4b7955SScott Wood		Location in memory to load U-Boot to
30507d4b7955SScott Wood
30517d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
30527d4b7955SScott Wood		Size of image to load
305395579793STom Rini
305495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
30557d4b7955SScott Wood		Entry point in loaded image to jump to
305695579793STom Rini
305795579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
305895579793STom Rini		Define this if you need to first read the OOB and then the
3059b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
306095579793STom Rini
306195579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
306295579793STom Rini		Support for an OMAP3-specific set of functions to return the
306395579793STom Rini		ID and MFR of the first attached NAND chip, if present.
306495579793STom Rini
3065c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3066c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3067c57b953dSPavel Machek
306874752baaSScott Wood		CONFIG_SPL_PAD_TO
30696113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
30706113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
30716113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
30726113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
30736113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
307474752baaSScott Wood
3075ca2fca22SScott Wood		CONFIG_SPL_TARGET
3076ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3077ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3078ca2fca22SScott Wood		example if more than one image needs to be produced.
3079ca2fca22SScott Wood
308087ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
308187ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
308287ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
308387ebee39SSimon Glass		option to re-enable it. This will affect the output of the
308487ebee39SSimon Glass		bootm command when booting a FIT image.
308587ebee39SSimon Glass
30863aa29de0SYing Zhang- TPL framework
30873aa29de0SYing Zhang		CONFIG_TPL
30883aa29de0SYing Zhang		Enable building of TPL globally.
30893aa29de0SYing Zhang
30903aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
30913aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
30923aa29de0SYing Zhang		the TPL payload. By default, this is defined as
30933aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
30943aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
30953aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
30963aa29de0SYing Zhang
3097a8c7c708Swdenk- Interrupt support (PPC):
3098a8c7c708Swdenk
3099a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3100a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
310111ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3102a8c7c708Swdenk		should set decrementer_count to appropriate value. If
310311ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3104a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
310511ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3106a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3107a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3108a8c7c708Swdenk		general timer_interrupt().
3109a8c7c708Swdenk
3110c609719bSwdenk
31119660e442SHelmut RaigerBoard initialization settings:
31129660e442SHelmut Raiger------------------------------
31139660e442SHelmut Raiger
31149660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
31159660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
31169660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
31179660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
31189660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
31199660e442SHelmut Raigertypically in board_init_f() and board_init_r().
31209660e442SHelmut Raiger
31219660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
31229660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
31239660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
31249660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3125c609719bSwdenk
3126c609719bSwdenkConfiguration Settings:
3127c609719bSwdenk-----------------------
3128c609719bSwdenk
31294d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
31304d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
31314d1fd7f1SYork Sun
31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3133c609719bSwdenk		undefine this when you're short of memory.
3134c609719bSwdenk
31352fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
31362fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
31372fb2604dSPeter Tyser
31386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3139c609719bSwdenk		prompt for user input.
3140c609719bSwdenk
31416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3142c609719bSwdenk
31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3144c609719bSwdenk
31456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3146c609719bSwdenk
31476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3148c609719bSwdenk		the application (usually a Linux kernel) when it is
3149c609719bSwdenk		booted
3150c609719bSwdenk
31516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3152c609719bSwdenk		List of legal baudrate settings for this board.
3153c609719bSwdenk
31546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3155c609719bSwdenk		Begin and End addresses of the area used by the
3156c609719bSwdenk		simple memory test.
3157c609719bSwdenk
31586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3159c609719bSwdenk		Enable an alternate, more extensive memory test.
3160c609719bSwdenk
31616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
31625f535fe1Swdenk		Scratch address used by the alternate memory test
31635f535fe1Swdenk		You only need to set this if address zero isn't writeable
31645f535fe1Swdenk
3165e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3166e61a7534SYork Sun		Only implemented for ARMv8 for now.
3167e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3168e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3169e8149522SYork Sun		This memory can be used as secure memory. A variable
3170e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3171e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3172e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3173e8149522SYork Sun
3174aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
31756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
317614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
317711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
317814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
317914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
318014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
31815e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
318214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
31835e12e75dSStefan Roese		will have to get fixed in Linux additionally.
318414f73ca6SStefan Roese
318514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
318614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
318714f73ca6SStefan Roese		be touched.
318814f73ca6SStefan Roese
318914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
319014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
319114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
319214f73ca6SStefan Roese		non page size aligned address and this could cause major
319314f73ca6SStefan Roese		problems.
319414f73ca6SStefan Roese
31956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3196c609719bSwdenk		Enable temporary baudrate change while serial download
3197c609719bSwdenk
31986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3199c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3200c609719bSwdenk
32016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3202c609719bSwdenk		Physical start address of Flash memory.
3203c609719bSwdenk
32046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3205c609719bSwdenk		Physical start address of boot monitor code (set by
3206c609719bSwdenk		make config files to be same as the text base address
320714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
32086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3209c609719bSwdenk
32106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
32113b57fe0aSwdenk		Size of memory reserved for monitor code, used to
32123b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
32133b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
32143b57fe0aSwdenk		flash sector.
3215c609719bSwdenk
32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3217c609719bSwdenk		Size of DRAM reserved for malloc() use.
3218c609719bSwdenk
3219d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3220d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3221d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3222d59476b6SSimon Glass		will become available before relocation. The address is just
3223d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3224d59476b6SSimon Glass		space.
3225d59476b6SSimon Glass
3226d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3227d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3228d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3229b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3230d59476b6SSimon Glass		U-Boot relocates itself.
3231d59476b6SSimon Glass
323238687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
323338687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
323438687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
323538687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
323638687ae6SSimon Glass
32371dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
32381dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
32391dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
32401dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
32411dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
32421dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
32431dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
32441dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
32451dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
32461dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
32471dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
32481dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
32491dfdd9baSThierry Reding		written to another region in the same cache-line. This can
32501dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
32511dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
32521dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
32531dfdd9baSThierry Reding
32541dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
32551dfdd9baSThierry Reding
32566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
325715940c9aSStefan Roese		Normally compressed uImages are limited to an
325815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
326015940c9aSStefan Roese		to adjust this setting to your needs.
3261c609719bSwdenk
32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3263c609719bSwdenk		Maximum size of memory mapped by the startup code of
3264c609719bSwdenk		the Linux kernel; all data that must be processed by
32657d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
32667d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
32671bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
32687d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3269c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3270c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3271c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3272c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3273c609719bSwdenk
3274fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3275fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3276fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3277fca43cc8SJohn Rigby		is enabled.
3278fca43cc8SJohn Rigby
3279fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3280fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3281fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3282fca43cc8SJohn Rigby
3283fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3284fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3285fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3286fca43cc8SJohn Rigby
32876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3288c609719bSwdenk		Max number of Flash memory banks
3289c609719bSwdenk
32906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3291c609719bSwdenk		Max number of sectors on a Flash chip
3292c609719bSwdenk
32936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3294c609719bSwdenk		Timeout for Flash erase operations (in ms)
3295c609719bSwdenk
32966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3297c609719bSwdenk		Timeout for Flash write operations (in ms)
3298c609719bSwdenk
32996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
33008564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
33018564acf9Swdenk
33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
33038564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
33048564acf9Swdenk
33056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
33068564acf9Swdenk		If defined, hardware flash sectors protection is used
33078564acf9Swdenk		instead of U-Boot software protection.
33088564acf9Swdenk
33096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3310c609719bSwdenk
3311c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3312c609719bSwdenk		without this option such a download has to be
3313c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3314c609719bSwdenk		copy from RAM to flash.
3315c609719bSwdenk
3316c609719bSwdenk		The two-step approach is usually more reliable, since
3317c609719bSwdenk		you can check if the download worked before you erase
331811ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
331911ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3320c609719bSwdenk		downloaded image) this option may be very useful.
3321c609719bSwdenk
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3323c609719bSwdenk		Define if the flash driver uses extra elements in the
33245653fc33Swdenk		common flash structure for storing flash geometry.
33255653fc33Swdenk
332600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
33275653fc33Swdenk		This option also enables the building of the cfi_flash driver
33285653fc33Swdenk		in the drivers directory
332953cf9435Sstroese
333091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
333191809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
333291809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
333391809ed5SPiotr Ziecik		to the MTD layer.
333491809ed5SPiotr Ziecik
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
333696ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
333796ef831fSGuennadi Liakhovetski
333896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
333996ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
334096ef831fSGuennadi Liakhovetski		write commands.
334196ef831fSGuennadi Liakhovetski
33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
33435568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
33445568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
33455568e613SStefan Roese		is useful, if some of the configured banks are only
33465568e613SStefan Roese		optionally available.
33475568e613SStefan Roese
33489a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
33499a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
33509a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
33519a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
33529a042e9cSJerry Van Baren
3353352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3354352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3355352ef3f1SStefan Roese		against the source after the write operation. An error message
3356352ef3f1SStefan Roese		will be printed when the contents are not identical.
3357352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3358352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3359352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3360352ef3f1SStefan Roese		this option if you really know what you are doing.
3361352ef3f1SStefan Roese
33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
336311ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
336411ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
336553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
336653cf9435Sstroese		buffers can be full shortly after enabling the interface
336711ccc33fSMarcel Ziswiler		on high Ethernet traffic.
336853cf9435Sstroese		Defaults to 4 if not defined.
3369c609719bSwdenk
3370ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3371ea882bafSWolfgang Denk
3372ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3373ea882bafSWolfgang Denk	internally to store the environment settings. The default
3374ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3375ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3376ea882bafSWolfgang Denk	lib/hashtable.c for details.
3377ea882bafSWolfgang Denk
33782598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
33792598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
33801bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
33812598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
33822598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
33832598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
33842598090bSJoe Hershberger
33852598090bSJoe Hershberger	The format of the list is:
33862598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3387b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3388b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
33892598090bSJoe Hershberger		entry = variable_name[:attributes]
33902598090bSJoe Hershberger		list = entry[,list]
33912598090bSJoe Hershberger
33922598090bSJoe Hershberger	The type attributes are:
33932598090bSJoe Hershberger		s - String (default)
33942598090bSJoe Hershberger		d - Decimal
33952598090bSJoe Hershberger		x - Hexadecimal
33962598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
33972598090bSJoe Hershberger		i - IP address
33982598090bSJoe Hershberger		m - MAC address
33992598090bSJoe Hershberger
3400267541f7SJoe Hershberger	The access attributes are:
3401267541f7SJoe Hershberger		a - Any (default)
3402267541f7SJoe Hershberger		r - Read-only
3403267541f7SJoe Hershberger		o - Write-once
3404267541f7SJoe Hershberger		c - Change-default
3405267541f7SJoe Hershberger
34062598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
34072598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3408b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
34092598090bSJoe Hershberger
34102598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
34112598090bSJoe Hershberger		Define this to a list (string) to define validation that
34122598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
34132598090bSJoe Hershberger		environment variable.  To override a setting in the static
34142598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
34152598090bSJoe Hershberger		".flags" variable.
34162598090bSJoe Hershberger
3417bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3418bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3419bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3420bdf1fe4eSJoe Hershberger
3421267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3422267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3423267541f7SJoe Hershberger	access flags.
3424267541f7SJoe Hershberger
34250d296cc2SGabe Black- CONFIG_USE_STDINT
34260d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
34270d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
34280d296cc2SGabe Black	building U-Boot to enable this.
34290d296cc2SGabe Black
3430c609719bSwdenkThe following definitions that deal with the placement and management
3431c609719bSwdenkof environment data (variable area); in general, we support the
3432c609719bSwdenkfollowing configurations:
3433c609719bSwdenk
3434c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3435c3eb3fe4SMike Frysinger
3436c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3437c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3438c3eb3fe4SMike Frysinger
34395a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3440c609719bSwdenk
3441c609719bSwdenk	Define this if the environment is in flash memory.
3442c609719bSwdenk
3443c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3444c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3445c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3446c609719bSwdenk	   sector" type flash chips, which have several smaller
3447c609719bSwdenk	   sectors at the start or the end. For instance, such a
3448c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3449c609719bSwdenk	   such a case you would place the environment in one of the
3450c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3451c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3452c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3453c609719bSwdenk	   between U-Boot and the environment.
3454c609719bSwdenk
34550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3456c609719bSwdenk
3457c609719bSwdenk	   Offset of environment data (variable area) to the
3458c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3459c609719bSwdenk	   type flash chips the second sector can be used: the offset
3460c609719bSwdenk	   for this sector is given here.
3461c609719bSwdenk
34626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3463c609719bSwdenk
34640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3465c609719bSwdenk
3466c609719bSwdenk	   This is just another way to specify the start address of
3467c609719bSwdenk	   the flash sector containing the environment (instead of
34680e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3469c609719bSwdenk
34700e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3471c609719bSwdenk
3472c609719bSwdenk	   Size of the sector containing the environment.
3473c609719bSwdenk
3474c609719bSwdenk
3475c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3476c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3477c609719bSwdenk	   the environment.
3478c609719bSwdenk
34790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3480c609719bSwdenk
34815a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
34820e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3483c609719bSwdenk	   of this flash sector for the environment. This saves
3484c609719bSwdenk	   memory for the RAM copy of the environment.
3485c609719bSwdenk
3486c609719bSwdenk	   It may also save flash memory if you decide to use this
3487c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3488c609719bSwdenk	   since then the remainder of the flash sector could be used
3489c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3490c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3491c609719bSwdenk	   updating the environment in flash makes it always
3492c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3493c609719bSwdenk	   wrong before the contents has been restored from a copy in
3494c609719bSwdenk	   RAM, your target system will be dead.
3495c609719bSwdenk
34960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
34970e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3498c609719bSwdenk
3499c609719bSwdenk	   These settings describe a second storage area used to hold
350011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
35013e38691eSwdenk	   a valid backup copy in case there is a power failure during
3502c609719bSwdenk	   a "saveenv" operation.
3503c609719bSwdenk
3504c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3505c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3506c609719bSwdenkaccordingly!
3507c609719bSwdenk
3508c609719bSwdenk
35099314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3510c609719bSwdenk
3511c609719bSwdenk	Define this if you have some non-volatile memory device
3512c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3513c609719bSwdenk	environment.
3514c609719bSwdenk
35150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
35160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3517c609719bSwdenk
351811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3519c609719bSwdenk	  want to use for environment. It is assumed that this memory
3520c609719bSwdenk	  can just be read and written to, without any special
3521c609719bSwdenk	  provision.
3522c609719bSwdenk
3523c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3524b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
352511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3526c609719bSwdenkU-Boot will hang.
3527c609719bSwdenk
3528c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3529c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3530c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3531c609719bSwdenkto save the current settings.
3532c609719bSwdenk
3533c609719bSwdenk
3534bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3535c609719bSwdenk
3536c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3537c609719bSwdenk	device and a driver for it.
3538c609719bSwdenk
35390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3541c609719bSwdenk
3542c609719bSwdenk	  These two #defines specify the offset and size of the
3543c609719bSwdenk	  environment area within the total memory of your EEPROM.
3544c609719bSwdenk
35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3546c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3547c609719bSwdenk	  The default address is zero.
3548c609719bSwdenk
3549189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
3550189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
3551189d257bSChristian Gmeiner
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3553c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3554c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3555c609719bSwdenk	  would require six bits.
3556c609719bSwdenk
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3558c609719bSwdenk	  If defined, the number of milliseconds to delay between
3559c609719bSwdenk	  page writes.	The default is zero milliseconds.
3560c609719bSwdenk
35616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3562c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3563c609719bSwdenk	  that this is NOT the chip address length!
3564c609719bSwdenk
35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
35665cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
35675cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
35685cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
35695cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
35705cf91d6bSwdenk	  byte chips.
35715cf91d6bSwdenk
35725cf91d6bSwdenk	  Note that we consider the length of the address field to
35735cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
35745cf91d6bSwdenk	  in the chip address.
35755cf91d6bSwdenk
35766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3577c609719bSwdenk	  The size in bytes of the EEPROM device.
3578c609719bSwdenk
3579548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3580548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3581548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3582548738b4SHeiko Schocher
3583548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3584548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3585548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3586548738b4SHeiko Schocher	  EEPROM. For example:
3587548738b4SHeiko Schocher
3588ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3589548738b4SHeiko Schocher
3590548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3591548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3592c609719bSwdenk
3593057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
35945779d8d9Swdenk
35955779d8d9Swdenk	Define this if you have a DataFlash memory device which you
35965779d8d9Swdenk	want to use for the environment.
35975779d8d9Swdenk
35980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36000e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
36015779d8d9Swdenk
36025779d8d9Swdenk	  These three #defines specify the offset and size of the
36035779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
36045779d8d9Swdenk	  at the specified address.
36055779d8d9Swdenk
3606bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
3607bd83b592SWu, Josh
3608bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
3609bd83b592SWu, Josh	want to use for the environment.
3610bd83b592SWu, Josh
3611bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
3612bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
3613bd83b592SWu, Josh
3614bd83b592SWu, Josh	  These two #defines specify the offset and size of the
3615bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3616bd83b592SWu, Josh	  aligned to an erase sector boundary.
3617bd83b592SWu, Josh
3618bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
3619bd83b592SWu, Josh
3620bd83b592SWu, Josh	  Define the SPI flash's sector size.
3621bd83b592SWu, Josh
3622bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
3623bd83b592SWu, Josh
3624bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
3625bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
3626bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
36279dd05fb8SSimon Glass	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
3628bd83b592SWu, Josh	  aligned to an erase sector boundary.
3629bd83b592SWu, Josh
3630bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
3631bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
3632bd83b592SWu, Josh
3633bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
3634bd83b592SWu, Josh
3635bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
3636bd83b592SWu, Josh
3637bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
3638bd83b592SWu, Josh
3639bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
3640bd83b592SWu, Josh
3641bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
3642bd83b592SWu, Josh
36430a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
36440a85a9e7SLiu Gang
36450a85a9e7SLiu Gang	Define this if you have a remote memory space which you
36460a85a9e7SLiu Gang	want to use for the local device's environment.
36470a85a9e7SLiu Gang
36480a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
36490a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
36500a85a9e7SLiu Gang
36510a85a9e7SLiu Gang	  These two #defines specify the address and size of the
36520a85a9e7SLiu Gang	  environment area within the remote memory space. The
36530a85a9e7SLiu Gang	  local device can get the environment from remote memory
3654fc54c7faSLiu Gang	  space by SRIO or PCIE links.
36550a85a9e7SLiu Gang
36560a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
36570a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3658fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3659fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
36600a85a9e7SLiu Gang
366151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
366213a5695bSwdenk
366313a5695bSwdenk	Define this if you have a NAND device which you want to use
366413a5695bSwdenk	for the environment.
366513a5695bSwdenk
36660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
366813a5695bSwdenk
366913a5695bSwdenk	  These two #defines specify the offset and size of the environment
3670fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3671fdd813deSScott Wood	  aligned to an erase block boundary.
36725779d8d9Swdenk
3673fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3674e443c944SMarkus Klotzbuecher
36750e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3676fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3677fdd813deSScott Wood	  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
3679fdd813deSScott Wood	  aligned to an erase block boundary.
3680e443c944SMarkus Klotzbuecher
3681fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3682fdd813deSScott Wood
3683fdd813deSScott Wood	  Specifies the length of the region in which the environment
3684fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3685fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3686fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3687fdd813deSScott Wood	  the range to be avoided.
3688fdd813deSScott Wood
3689fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3690fdd813deSScott Wood
3691fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3692fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3693fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3694fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3695fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3696e443c944SMarkus Klotzbuecher
3697b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3698b74ab737SGuennadi Liakhovetski
3699b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3700b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3701b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3702b74ab737SGuennadi Liakhovetski
37032b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37042b74433fSJoe Hershberger
37052b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37062b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37072b74433fSJoe Hershberger	accesses, which is important on NAND.
37082b74433fSJoe Hershberger
37092b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37102b74433fSJoe Hershberger
37112b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37122b74433fSJoe Hershberger
37132b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
37142b74433fSJoe Hershberger
37152b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
37162b74433fSJoe Hershberger	  environment in.
37172b74433fSJoe Hershberger
3718785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3719785881f7SJoe Hershberger
3720785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3721785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3722785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3723785881f7SJoe Hershberger
37242b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
37252b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
37262b74433fSJoe Hershberger
37272b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
37282b74433fSJoe Hershberger	  when storing the env in UBI.
37292b74433fSJoe Hershberger
3730d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
3731d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
3732d1db76f1SWu, Josh
3733d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
3734d1db76f1SWu, Josh
3735d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
3736d1db76f1SWu, Josh
373741987784SNicolae Rosia       - FAT_ENV_DEVICE_AND_PART:
3738d1db76f1SWu, Josh
3739d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
3740d1db76f1SWu, Josh         be as following:
3741d1db76f1SWu, Josh
3742d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3743d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
3744d1db76f1SWu, Josh                        partition table.
3745d1db76f1SWu, Josh               - "D:0": device D.
3746d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
3747d1db76f1SWu, Josh                              table, or the whole device D if has no partition
3748d1db76f1SWu, Josh                              table.
3749d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
3750b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
3751d1db76f1SWu, Josh                           partition table then means device D.
3752d1db76f1SWu, Josh
3753d1db76f1SWu, Josh       - FAT_ENV_FILE:
3754d1db76f1SWu, Josh
3755d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
3756b445bbb4SJeremiah Mahler         environment.
3757d1db76f1SWu, Josh
3758d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
375991d27a17STom Rini         This must be enabled. Otherwise it cannot save the environment file.
3760d1db76f1SWu, Josh
376106e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
376206e4ae5fSStephen Warren
376306e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
376406e4ae5fSStephen Warren	environment.
376506e4ae5fSStephen Warren
376606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
376706e4ae5fSStephen Warren
376806e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
376906e4ae5fSStephen Warren
377006e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
377106e4ae5fSStephen Warren
377206e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
377306e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
377406e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
377506e4ae5fSStephen Warren
377606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
377706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
377806e4ae5fSStephen Warren
377906e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
378006e4ae5fSStephen Warren	  area within the specified MMC device.
378106e4ae5fSStephen Warren
37825c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
37835c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
37845c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
37855c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
37865c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
37875c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
37885c088ee8SStephen Warren	  maximum possible space before it, to store other data.
37895c088ee8SStephen Warren
379006e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
379106e4ae5fSStephen Warren	  MMC sector boundary.
379206e4ae5fSStephen Warren
379306e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
379406e4ae5fSStephen Warren
379506e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
379606e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
379706e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
379806e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
379906e4ae5fSStephen Warren
38005c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38015c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38025c088ee8SStephen Warren
380306e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
380406e4ae5fSStephen Warren	  an MMC sector boundary.
380506e4ae5fSStephen Warren
380606e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
380706e4ae5fSStephen Warren
380806e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
380906e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
381006e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
381106e4ae5fSStephen Warren
3812e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3813c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3814cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3815c609719bSwdenkuntil then to read environment variables.
3816c609719bSwdenk
381785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
381885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
381985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
382085ec0bccSwdenknecessary, because the first environment variable we need is the
382185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
382285ec0bccSwdenkhave any device yet where we could complain.]
3823c609719bSwdenk
3824c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3825c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
382685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3827c609719bSwdenk
38286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3829fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3830fc3e2165Swdenk
38316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3832fc3e2165Swdenk		      also needs to be defined.
3833fc3e2165Swdenk
38346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3835fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3836c609719bSwdenk
3837f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3838f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3839f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3840f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3841f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3842f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3843f5675aa5SRon Madrid
3844b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3845b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3846b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3847b2b92f53SSimon Glass		to do this.
3848b2b92f53SSimon Glass
3849e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3850e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3851e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3852e2e3e2b1SSimon Glass		present.
3853e2e3e2b1SSimon Glass
3854feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
3855feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
3856feb85801SSascha Silbe		build system checks that the actual size does not
3857feb85801SSascha Silbe		exceed it.
3858feb85801SSascha Silbe
3859c609719bSwdenkLow Level (hardware related) configuration options:
3860dc7c9a1aSwdenk---------------------------------------------------
3861c609719bSwdenk
38626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3863c609719bSwdenk		Cache Line Size of the CPU.
3864c609719bSwdenk
3865e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3866e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3867e46fedfeSTimur Tabi		PowerPC SOCs.
3868e46fedfeSTimur Tabi
3869e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3870e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3871e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3872e46fedfeSTimur Tabi
3873e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3874e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3875e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3876e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3877e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3878e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3879e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3880e46fedfeSTimur Tabi
3881e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3882e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3883e46fedfeSTimur Tabi
3884e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3885e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3886e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3887e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3888e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3889e46fedfeSTimur Tabi
3890e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3891e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3892e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3893e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3894e46fedfeSTimur Tabi
3895e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3896e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3897e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3898e46fedfeSTimur Tabi
38997f6c2cbcSwdenk- Floppy Disk Support:
39006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39017f6c2cbcSwdenk
39027f6c2cbcSwdenk		the default drive number (default value 0)
39037f6c2cbcSwdenk
39046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39057f6c2cbcSwdenk
390611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39077f6c2cbcSwdenk		(default value 1)
39087f6c2cbcSwdenk
39096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39107f6c2cbcSwdenk
39117f6c2cbcSwdenk		defines the offset of register from address. It
39127f6c2cbcSwdenk		depends on which part of the data bus is connected to
391311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39147f6c2cbcSwdenk
39156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39177f6c2cbcSwdenk		default value.
39187f6c2cbcSwdenk
39196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39207f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39217f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
3922b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
39237f6c2cbcSwdenk		initializations.
39247f6c2cbcSwdenk
39250abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39260abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39270abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39280abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
39290abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
39300abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
3931b445bbb4SJeremiah Mahler		is required.
39320abddf82SMacpaul Lin
39336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
393425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
39355b8e76c3SHeiko Schocher		doing! (11-4) [82xx systems only]
3936c609719bSwdenk
39376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3938c609719bSwdenk
39397152b1d0Swdenk		Start address of memory area that can be used for
3940c609719bSwdenk		initial data and stack; please note that this must be
3941c609719bSwdenk		writable memory that is working WITHOUT special
3942c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3943c609719bSwdenk		will become available only after programming the
3944c609719bSwdenk		memory controller and running certain initialization
3945c609719bSwdenk		sequences.
3946c609719bSwdenk
3947c609719bSwdenk		U-Boot uses the following memory types:
3948c609719bSwdenk
39496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3950c609719bSwdenk
3951c609719bSwdenk		Offset of the initial data structure in the memory
39526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
39536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3954c609719bSwdenk		data is located at the end of the available space
3955553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3956acd51f9dSSimon Glass		GENERATED_GBL_DATA_SIZE), and the initial stack is just
39576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
39586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3959c609719bSwdenk
3960c609719bSwdenk	Note:
3961c609719bSwdenk		On the MPC824X (or other systems that use the data
3962c609719bSwdenk		cache for initial memory) the address chosen for
39636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3964c609719bSwdenk		point to an otherwise UNUSED address space between
3965c609719bSwdenk		the top of RAM and the start of the PCI space.
3966c609719bSwdenk
39676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3968c609719bSwdenk
39696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3970c609719bSwdenk		SDRAM timing
3971c609719bSwdenk
39726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3973c609719bSwdenk		periodic timer for refresh
3974c609719bSwdenk
39756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
39766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
39776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
39786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3979c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3980c609719bSwdenk
3981c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
39826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3984c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3985c609719bSwdenk
398669fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
3987b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
398869fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
398969fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
399069fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
399169fd2d3bSAndrew Sharp		by coreboot or similar.
399269fd2d3bSAndrew Sharp
3993842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
3994842033e6SGabor Juhos		Enable support for indirect PCI bridges.
3995842033e6SGabor Juhos
3996a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3997a09b9b68SKumar Gala		Chip has SRIO or not
3998a09b9b68SKumar Gala
3999a09b9b68SKumar Gala- CONFIG_SRIO1:
4000a09b9b68SKumar Gala		Board has SRIO 1 port available
4001a09b9b68SKumar Gala
4002a09b9b68SKumar Gala- CONFIG_SRIO2:
4003a09b9b68SKumar Gala		Board has SRIO 2 port available
4004a09b9b68SKumar Gala
4005c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4006c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4007c8b28152SLiu Gang
4008a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4009a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4010a09b9b68SKumar Gala
4011a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4012a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4013a09b9b68SKumar Gala
4014a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4015a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4016a09b9b68SKumar Gala
401766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
401866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
401966bd1846SFabio Estevam		a 16 bit bus.
402066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4021a430e916SFabio Estevam		Example of drivers that use it:
402266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4023a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4024eced4626SAlex Waterman
4025eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4026eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4027eced4626SAlex Waterman		a default value will be used.
4028eced4626SAlex Waterman
4029bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4030218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4031218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4032218ca724SWolfgang Denk
4033bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4034bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4035bb99ad6dSBen Warren
40366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4037218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4038218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4039218ca724SWolfgang Denk		to something your driver can deal with.
4040bb99ad6dSBen Warren
40411b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
40421b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
40431b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
40441b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
40451b3e3c4fSYork Sun		header files or board specific files.
40461b3e3c4fSYork Sun
40476f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
40486f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
40496f5e1dc5SYork Sun
4050e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4051e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4052e32d59a2SYork Sun
40534516ff81SYork Sun- CONFIG_FSL_DDR_BIST
40544516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
40554516ff81SYork Sun
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4057218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4058218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
40592ad6b513STimur Tabi
4060c26e454dSwdenk- CONFIG_RMII
4061c26e454dSwdenk		Enable RMII mode for all FECs.
4062c26e454dSwdenk		Note that this is a global option, we can't
4063c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4064c26e454dSwdenk
40655cf91d6bSwdenk- CONFIG_CRC32_VERIFY
40665cf91d6bSwdenk		Add a verify option to the crc32 command.
40675cf91d6bSwdenk		The syntax is:
40685cf91d6bSwdenk
40695cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
40705cf91d6bSwdenk
40715cf91d6bSwdenk		Where address/count indicate a memory area
40725cf91d6bSwdenk		and crc32 is the correct crc32 which the
40735cf91d6bSwdenk		area should have.
40745cf91d6bSwdenk
407556523f12Swdenk- CONFIG_LOOPW
407656523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4077602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
407856523f12Swdenk
40797b466641Sstroese- CONFIG_MX_CYCLIC
40807b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
40817b466641Sstroese		"md/mw" commands.
40827b466641Sstroese		Examples:
40837b466641Sstroese
40847b466641Sstroese		=> mdc.b 10 4 500
40857b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
40867b466641Sstroese
40877b466641Sstroese		=> mwc.l 100 12345678 10
40887b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
40897b466641Sstroese
40907b466641Sstroese		This only takes effect if the memory commands are activated
4091602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
40927b466641Sstroese
40938aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4094afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4095e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4096e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4097e03f3169SWolfgang Denk		relocate itself into RAM.
40988aa1a2d1Swdenk
4099e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4100e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4101e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4102e03f3169SWolfgang Denk		these initializations itself.
41038aa1a2d1Swdenk
4104b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4105b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
410690211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4107b5bd0982SSimon Glass		instruction cache) is still performed.
4108b5bd0982SSimon Glass
4109401bb30bSAneesh V- CONFIG_SPL_BUILD
4110df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4111df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4112df81238bSMagnus Lilja		compiling a NAND SPL.
4113400558b5Swdenk
41143aa29de0SYing Zhang- CONFIG_TPL_BUILD
41153aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
41163aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
41173aa29de0SYing Zhang		It is loaded by the SPL.
41183aa29de0SYing Zhang
41195df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
41205df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
41215df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
41225df572f0SYing Zhang		previous 4k of the .text section.
41235df572f0SYing Zhang
41244213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
41254213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
41264213fc29SSimon Glass		effective address. It is therefore not necessary to regard
41274213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
41284213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
41294213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
41304213fc29SSimon Glass		addressable memory. This option causes some memory accesses
41314213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
41324213fc29SSimon Glass
4133588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4134588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4135588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4136b16f521aSGabe Black
413716678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
413816678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
413916678eb4SHeiko Schocher
4140999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4141999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4142999d7d32SKaricheri, Muralidharan		driver that uses this:
4143999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4144999d7d32SKaricheri, Muralidharan
4145f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4146f2717b47STimur Tabi-----------------------------------
4147f2717b47STimur Tabi
4148f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4149f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4150f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4151f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4152f2717b47STimur Tabiwithin that device.
4153f2717b47STimur Tabi
4154dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4155dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4156dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4157dcf1d774SZhao Qiang	is also specified.
4158dcf1d774SZhao Qiang
4159dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4160dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4161f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4162f2717b47STimur Tabi	is also specified.
4163f2717b47STimur Tabi
4164f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4165f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4166f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4167f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4168f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4169f2717b47STimur Tabi
4170f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4171f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4172f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4173f2717b47STimur Tabi	virtual address in NOR flash.
4174f2717b47STimur Tabi
4175f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4176f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4177f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4178f2717b47STimur Tabi
4179f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4180f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4181f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4182f2717b47STimur Tabi
4183292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4184292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4185292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4186fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4187fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4188fc54c7faSLiu Gang	master's memory space.
4189f2717b47STimur Tabi
4190b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4191b940ca64SJ. German Rivera---------------------------------------------------------
4192b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4193b940ca64SJ. German Rivera"firmware".
4194b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4195b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4196b940ca64SJ. German Riverawithin that device.
4197b940ca64SJ. German Rivera
4198b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4199b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4200b940ca64SJ. German Rivera
42015c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
42025c055089SPrabhakar Kushwaha-------------------------------------------
42035c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
42045c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
42055c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
42065c055089SPrabhakar Kushwaha
4207c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4208c0492141SYork Sun	Define alignment of reserved memory MC requires
42095c055089SPrabhakar Kushwaha
4210f3f431a7SPaul KocialkowskiReproducible builds
4211f3f431a7SPaul Kocialkowski-------------------
4212f3f431a7SPaul Kocialkowski
4213f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4214f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4215f3f431a7SPaul Kocialkowski
4216f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4217f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4218f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4219f3f431a7SPaul Kocialkowski
4220f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4221f3f431a7SPaul Kocialkowski
4222c609719bSwdenkBuilding the Software:
4223c609719bSwdenk======================
4224c609719bSwdenk
4225218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4226218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4227218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4228218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4229218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4230218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4231c609719bSwdenk
4232218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4233218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4234218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4235218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4236218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4237c609719bSwdenk
4238218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4239218ca724SWolfgang Denk	$ export CROSS_COMPILE
4240c609719bSwdenk
42412f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
42422f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
42432f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
42442f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
42452f8d396bSPeter Tyser
42462f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
42472f8d396bSPeter Tyser
42482f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
42492f8d396bSPeter Tyser      be executed on computers running Windows.
42502f8d396bSPeter Tyser
4251c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4252c609719bSwdenksources you must configure U-Boot for one specific board type. This
4253c609719bSwdenkis done by typing:
4254c609719bSwdenk
4255ab584d67SHolger Freyther	make NAME_defconfig
4256c609719bSwdenk
4257ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
42584d675ae6SMichael Jonesrations; see boards.cfg for supported names.
425954387ac9Swdenk
4260c609719bSwdenkNote: for some board special configuration names may exist; check if
4261c609719bSwdenk      additional information is available from the board vendor; for
42622729af9dSwdenk      instance, the TQM823L systems are available without (standard)
42632729af9dSwdenk      or with LCD support. You can select such additional "features"
426411ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4265c609719bSwdenk
4266ab584d67SHolger Freyther      make TQM823L_defconfig
42672729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4268c609719bSwdenk
4269ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4270c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4271c609719bSwdenk
4272c609719bSwdenk      etc.
4273c609719bSwdenk
4274c609719bSwdenk
4275c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
42767152b1d0Swdenkimages ready for download to / installation on your system:
4277c609719bSwdenk
4278c609719bSwdenk- "u-boot.bin" is a raw binary image
4279c609719bSwdenk- "u-boot" is an image in ELF binary format
4280c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4281c609719bSwdenk
4282baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4283baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4284baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4285baf31249SMarian Balakowicz
4286baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4287baf31249SMarian Balakowicz
4288baf31249SMarian Balakowicz	make O=/tmp/build distclean
4289ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4290baf31249SMarian Balakowicz	make O=/tmp/build all
4291baf31249SMarian Balakowicz
4292adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4293baf31249SMarian Balakowicz
4294adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4295baf31249SMarian Balakowicz	make distclean
4296ab584d67SHolger Freyther	make NAME_defconfig
4297baf31249SMarian Balakowicz	make all
4298baf31249SMarian Balakowicz
4299adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4300baf31249SMarian Balakowiczvariable.
4301baf31249SMarian Balakowicz
4302c609719bSwdenk
4303c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4304c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4305c609719bSwdenknative "make".
4306c609719bSwdenk
4307c609719bSwdenk
4308c609719bSwdenkIf the system board that you have is not listed, then you will need
4309c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4310c609719bSwdenksteps:
4311c609719bSwdenk
43123c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
431385ec0bccSwdenk    files you need. In your board directory, you will need at least
43143c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
43153c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
43163c1496cdSPhil Sutter    your board.
4317c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4318c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
4319ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
4320c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4321c609719bSwdenk    to be installed on your target system.
432285ec0bccSwdenk6.  Debug and solve any problems that might arise.
4323c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4324c609719bSwdenk
4325c609719bSwdenk
4326c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4327c609719bSwdenk==============================================================
4328c609719bSwdenk
4329c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4330c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4331c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4332c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4333218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4334c609719bSwdenk
4335c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4336c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4337c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
43386de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
43396de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
43406de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
43416de80f21SSimon Glassfor documentation.
4342baf31249SMarian Balakowicz
4343baf31249SMarian Balakowicz
4344c609719bSwdenkSee also "U-Boot Porting Guide" below.
4345c609719bSwdenk
4346c609719bSwdenk
4347c609719bSwdenkMonitor Commands - Overview:
4348c609719bSwdenk============================
4349c609719bSwdenk
4350c609719bSwdenkgo	- start application at address 'addr'
4351c609719bSwdenkrun	- run commands in an environment variable
4352c609719bSwdenkbootm	- boot application image from memory
4353c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
435444f074c7SMarek Vasutbootz   - boot zImage from memory
4355c609719bSwdenktftpboot- boot image via network using TFTP protocol
4356c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4357c609719bSwdenk	       (and eventually "gatewayip")
43581fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4359c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4360c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4361c609719bSwdenkloads	- load S-Record file over serial line
4362c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4363c609719bSwdenkmd	- memory display
4364c609719bSwdenkmm	- memory modify (auto-incrementing)
4365c609719bSwdenknm	- memory modify (constant address)
4366c609719bSwdenkmw	- memory write (fill)
4367c609719bSwdenkcp	- memory copy
4368c609719bSwdenkcmp	- memory compare
4369c609719bSwdenkcrc32	- checksum calculation
43700f89c54bSPeter Tyseri2c	- I2C sub-system
4371c609719bSwdenksspi	- SPI utility commands
4372c609719bSwdenkbase	- print or set address offset
4373c609719bSwdenkprintenv- print environment variables
4374c609719bSwdenksetenv	- set environment variables
4375c609719bSwdenksaveenv - save environment variables to persistent storage
4376c609719bSwdenkprotect - enable or disable FLASH write protection
4377c609719bSwdenkerase	- erase FLASH memory
4378c609719bSwdenkflinfo	- print FLASH memory information
437910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4380c609719bSwdenkbdinfo	- print Board Info structure
4381c609719bSwdenkiminfo	- print header information for application image
4382c609719bSwdenkconinfo - print console devices and informations
4383c609719bSwdenkide	- IDE sub-system
4384c609719bSwdenkloop	- infinite loop on address range
438556523f12Swdenkloopw	- infinite write loop on address range
4386c609719bSwdenkmtest	- simple RAM test
4387c609719bSwdenkicache	- enable or disable instruction cache
4388c609719bSwdenkdcache	- enable or disable data cache
4389c609719bSwdenkreset	- Perform RESET of the CPU
4390c609719bSwdenkecho	- echo args to console
4391c609719bSwdenkversion - print monitor version
4392c609719bSwdenkhelp	- print online help
4393c609719bSwdenk?	- alias for 'help'
4394c609719bSwdenk
4395c609719bSwdenk
4396c609719bSwdenkMonitor Commands - Detailed Description:
4397c609719bSwdenk========================================
4398c609719bSwdenk
4399c609719bSwdenkTODO.
4400c609719bSwdenk
4401c609719bSwdenkFor now: just type "help <command>".
4402c609719bSwdenk
4403c609719bSwdenk
4404c609719bSwdenkEnvironment Variables:
4405c609719bSwdenk======================
4406c609719bSwdenk
4407c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4408c609719bSwdenkcan be made persistent by saving to Flash memory.
4409c609719bSwdenk
4410c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4411c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4412c609719bSwdenkwithout a value can be used to delete a variable from the
4413c609719bSwdenkenvironment. As long as you don't save the environment you are
4414c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4415c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4416c609719bSwdenk
4417c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4418c96f86eeSWolfgang Denk
4419c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4420c609719bSwdenk
4421c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4422c609719bSwdenk
4423c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4424c609719bSwdenk
4425c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4426c609719bSwdenk
4427c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4428c609719bSwdenk
4429c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4430c609719bSwdenk
44317d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
44327d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44337d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
44347d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
44357d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
44367d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4437c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4438c3624e6eSGrant Likely		  bootm_mapsize.
4439c3624e6eSGrant Likely
4440c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4441c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4442c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4443c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4444c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4445c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4446c3624e6eSGrant Likely		  used otherwise.
44477d721e34SBartlomiej Sieka
44487d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
44497d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44507d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
44517d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
44527d721e34SBartlomiej Sieka		  environment variable.
44537d721e34SBartlomiej Sieka
44544bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
44554bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
44564bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
44574bae9090SBartlomiej Sieka
4458c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4459c609719bSwdenk		  "bootp" will just load perform a lookup of the
4460c609719bSwdenk		  configuration from the BOOTP server, but not try to
4461c609719bSwdenk		  load any image using TFTP
4462c609719bSwdenk
4463c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4464c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4465c609719bSwdenk		  be automatically started (by internally calling
4466c609719bSwdenk		  "bootm")
4467c609719bSwdenk
44684a6fd34bSwdenk		  If set to "no", a standalone image passed to the
44694a6fd34bSwdenk		  "bootm" command will be copied to the load address
44704a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
44714a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
44724a6fd34bSwdenk		  data.
44734a6fd34bSwdenk
4474a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4475a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4476fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4477fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4478fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4479fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4480fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4481fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4482fa34f6b2SShawn Guo		  access it during the boot procedure.
4483fa34f6b2SShawn Guo
4484a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4485a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4486a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4487a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4488a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4489a28afca5SDavid A. Long		  must be accessible by the kernel.
4490a28afca5SDavid A. Long
4491eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4492eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4493eea63e05SSimon Glass		  defined.
4494eea63e05SSimon Glass
449517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
449617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
449717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
449817ea1177Swdenk		  initialization code. So, for changes to be effective
449917ea1177Swdenk		  it must be saved and board must be reset.
450017ea1177Swdenk
4501c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4502c609719bSwdenk		  If this variable is not set, initrd images will be
4503c609719bSwdenk		  copied to the highest possible address in RAM; this
4504c609719bSwdenk		  is usually what you want since it allows for
4505c609719bSwdenk		  maximum initrd size. If for some reason you want to
4506c609719bSwdenk		  make sure that the initrd image is loaded below the
45076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4508c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4509c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4510c609719bSwdenk		  address to use (U-Boot will still check that it
4511c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4512c609719bSwdenk
4513c609719bSwdenk		  For instance, when you have a system with 16 MB
45147152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4515c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4516c609719bSwdenk		  the "bootargs" variable. However, now you must make
45177152b1d0Swdenk		  sure that the initrd image is placed in the first
4518c609719bSwdenk		  12 MB as well - this can be done with
4519c609719bSwdenk
4520c609719bSwdenk		  setenv initrd_high 00c00000
4521c609719bSwdenk
452238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
452338b99261Swdenk		  indication to U-Boot that all addresses are legal
452438b99261Swdenk		  for the Linux kernel, including addresses in flash
452538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
452638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
452738b99261Swdenk		  boot time on your system, but requires that this
452838b99261Swdenk		  feature is supported by your Linux kernel.
452938b99261Swdenk
4530c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4531c609719bSwdenk
4532c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4533dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4534c609719bSwdenk
4535c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4536c609719bSwdenk
4537c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4538c609719bSwdenk
4539c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4540c609719bSwdenk
4541c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4542c609719bSwdenk
4543c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4544c609719bSwdenk
4545e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4546a3d991bdSwdenk
4547e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4548e2a53458SMike Frysinger		  For example you can do the following
4549a3d991bdSwdenk
455048690d80SHeiko Schocher		  => setenv ethact FEC
455148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
455248690d80SHeiko Schocher		  => setenv ethact SCC
455348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4554a3d991bdSwdenk
4555e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4556e1692577SMatthias Fuchs		  available network interfaces.
4557e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4558e1692577SMatthias Fuchs
4559a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4560a3d991bdSwdenk		  either succeed or fail without retrying.
45616e592385Swdenk		  When set to "once" the network operation will
45626e592385Swdenk		  fail when all the available network interfaces
45636e592385Swdenk		  are tried once without success.
4564a3d991bdSwdenk		  Useful on scripts which control the retry operation
4565a3d991bdSwdenk		  themselves.
4566a3d991bdSwdenk
4567b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4568a1cf027aSJean-Christophe PLAGNIOL-VILLARD
4569b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
45708d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
45718d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
45728d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
45738d51aacdSSimon Glass		  is silent.
45748d51aacdSSimon Glass
4575f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
4576ecb0ccd9SWolfgang Denk		  UDP source port.
4577ecb0ccd9SWolfgang Denk
4578f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
457928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
458028cb9375SWolfgang Denk
4581c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4582c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4583c96f86eeSWolfgang Denk
4584c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4585c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4586c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4587c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4588c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4589c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4590c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4591c96f86eeSWolfgang Denk
4592f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
4593f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
4594f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
4595f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
4596f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
4597f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
4598f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
4599f5fb7346SAlbert ARIBAUD \(3ADEV\)
4600a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
460111ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4602a3d991bdSwdenk		  VLAN tagged frames.
4603c609719bSwdenk
460450768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
460550768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
460650768f5bSAlexandre Messier		  be either the default (28000), or a value based on
460750768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
460850768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
460950768f5bSAlexandre Messier
4610dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4611dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4612dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4613dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4614dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4615dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4616dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4617dc0b7b0eSJason Hobbs
4618dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4619aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
4620dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4621dc0b7b0eSJason Hobbs
4622dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4623dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4624dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4625dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4626dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4627dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4628dc0b7b0eSJason Hobbs
4629c609719bSwdenkThe following environment variables may be used and automatically
4630c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4631c609719bSwdenkdepending the information provided by your boot server:
4632c609719bSwdenk
4633c609719bSwdenk  bootfile	- see above
4634c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4635fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4636c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4637c609719bSwdenk  hostname	- Target hostname
4638c609719bSwdenk  ipaddr	- see above
4639c609719bSwdenk  netmask	- Subnet Mask
4640c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4641c609719bSwdenk  serverip	- see above
4642c609719bSwdenk
4643c609719bSwdenk
4644c609719bSwdenkThere are two special Environment Variables:
4645c609719bSwdenk
4646c609719bSwdenk  serial#	- contains hardware identification information such
4647c609719bSwdenk		  as type string and/or serial number
4648c609719bSwdenk  ethaddr	- Ethernet address
4649c609719bSwdenk
4650c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4651c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4652c609719bSwdenkonce they have been set once.
4653c609719bSwdenk
4654c609719bSwdenk
4655c1551ea8SstroeseFurther special Environment Variables:
4656c1551ea8Sstroese
4657c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4658c1551ea8Sstroese		  with the "version" command. This variable is
4659c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4660c1551ea8Sstroese
4661c1551ea8Sstroese
4662c609719bSwdenkPlease note that changes to some configuration parameters may take
4663c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4664c609719bSwdenk
4665c609719bSwdenk
4666170ab110SJoe HershbergerCallback functions for environment variables:
4667170ab110SJoe Hershberger---------------------------------------------
4668170ab110SJoe Hershberger
4669170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4670b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
4671170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4672170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4673170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4674170ab110SJoe Hershberger
4675170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4676170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4677170ab110SJoe Hershberger
4678170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4679170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4680170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4681170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4682170ab110SJoe Hershberger
4683170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4684170ab110SJoe Hershberger	list = entry[,list]
4685170ab110SJoe Hershberger
4686170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4687170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4688170ab110SJoe Hershberger
4689170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4690170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4691170ab110SJoe Hershbergeroverride any association in the static list. You can define
4692170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4693b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
4694170ab110SJoe Hershberger
4695bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
4696bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
4697bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
4698bdf1fe4eSJoe Hershberger
4699170ab110SJoe Hershberger
4700f07771ccSwdenkCommand Line Parsing:
4701f07771ccSwdenk=====================
4702f07771ccSwdenk
4703f07771ccSwdenkThere are two different command line parsers available with U-Boot:
47047152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4705f07771ccSwdenk
4706f07771ccSwdenkOld, simple command line parser:
4707f07771ccSwdenk--------------------------------
4708f07771ccSwdenk
4709f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4710f07771ccSwdenk- several commands on one line, separated by ';'
4711fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4712f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4713f07771ccSwdenk  for example:
4714fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4715f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4716f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4717f07771ccSwdenk
4718f07771ccSwdenkHush shell:
4719f07771ccSwdenk-----------
4720f07771ccSwdenk
4721f07771ccSwdenk- similar to Bourne shell, with control structures like
4722f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4723f07771ccSwdenk  until...do...done, ...
4724f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4725f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4726f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4727f07771ccSwdenk  command
4728f07771ccSwdenk
4729f07771ccSwdenkGeneral rules:
4730f07771ccSwdenk--------------
4731f07771ccSwdenk
4732f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4733f07771ccSwdenk    command) contains several commands separated by semicolon, and
4734f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4735f07771ccSwdenk    executed anyway.
4736f07771ccSwdenk
4737f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
473811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4739f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4740f07771ccSwdenk    variables are not executed.
4741f07771ccSwdenk
4742c609719bSwdenkNote for Redundant Ethernet Interfaces:
4743c609719bSwdenk=======================================
4744c609719bSwdenk
474511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4746c609719bSwdenksuch configurations and is capable of automatic selection of a
47477152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4748c609719bSwdenk
4749c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4750c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4751c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4752c609719bSwdenk
4753c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4754c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4755c609719bSwdenkding setting in the environment; if the corresponding environment
4756c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4757c609719bSwdenk
4758c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4759c609719bSwdenk  environment, the SROM's address is used.
4760c609719bSwdenk
4761c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4762c609719bSwdenk  environment exists, then the value from the environment variable is
4763c609719bSwdenk  used.
4764c609719bSwdenk
4765c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4766c609719bSwdenk  both addresses are the same, this MAC address is used.
4767c609719bSwdenk
4768c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4769c609719bSwdenk  addresses differ, the value from the environment is used and a
4770c609719bSwdenk  warning is printed.
4771c609719bSwdenk
4772c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4773bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4774bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
4775c609719bSwdenk
4776ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4777ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4778ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4779ecee9324SBen WarrenThe naming convention is as follows:
4780ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4781c609719bSwdenk
4782c609719bSwdenkImage Formats:
4783c609719bSwdenk==============
4784c609719bSwdenk
47853310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
47863310c549SMarian Balakowiczimages in two formats:
47873310c549SMarian Balakowicz
47883310c549SMarian BalakowiczNew uImage format (FIT)
47893310c549SMarian Balakowicz-----------------------
47903310c549SMarian Balakowicz
47913310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
47923310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
47933310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
47943310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
47953310c549SMarian Balakowicz
47963310c549SMarian Balakowicz
47973310c549SMarian BalakowiczOld uImage format
47983310c549SMarian Balakowicz-----------------
47993310c549SMarian Balakowicz
48003310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
48013310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
48023310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4803c609719bSwdenk
4804c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4805c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4806f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4807f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4808f5ed9e39SPeter Tyser  INTEGRITY).
4809*daab59acSAndy Shevchenko* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
4810afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4811*daab59acSAndy Shevchenko  Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4812c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4813c609719bSwdenk* Load Address
4814c609719bSwdenk* Entry Point
4815c609719bSwdenk* Image Name
4816c609719bSwdenk* Image Timestamp
4817c609719bSwdenk
4818c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4819c609719bSwdenkand the data portions of the image are secured against corruption by
4820c609719bSwdenkCRC32 checksums.
4821c609719bSwdenk
4822c609719bSwdenk
4823c609719bSwdenkLinux Support:
4824c609719bSwdenk==============
4825c609719bSwdenk
4826c609719bSwdenkAlthough U-Boot should support any OS or standalone application
48277152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4828c609719bSwdenkU-Boot.
4829c609719bSwdenk
4830c609719bSwdenkU-Boot includes many features that so far have been part of some
4831c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4832c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4833c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
48347152b1d0Swdenkserves several purposes:
4835c609719bSwdenk
4836c609719bSwdenk- the same features can be used for other OS or standalone
4837c609719bSwdenk  applications (for instance: using compressed images to reduce the
4838c609719bSwdenk  Flash memory footprint)
4839c609719bSwdenk
4840c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
48417152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4842c609719bSwdenk
4843c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4844c609719bSwdenk  images; of course this also means that different kernel images can
4845c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4846c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4847c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4848c609719bSwdenk  software is easier now.
4849c609719bSwdenk
4850c609719bSwdenk
4851c609719bSwdenkLinux HOWTO:
4852c609719bSwdenk============
4853c609719bSwdenk
4854c609719bSwdenkPorting Linux to U-Boot based systems:
4855c609719bSwdenk---------------------------------------
4856c609719bSwdenk
4857c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4858c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4859c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4860c609719bSwdenkLinux :-).
4861c609719bSwdenk
4862a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4863c609719bSwdenk
4864c609719bSwdenkJust make sure your machine specific header file (for instance
4865c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
48661dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
48671dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
48686d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4869c609719bSwdenk
48702eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
48712eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
48722eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
48732eb31b13SSimon Glassdoc/driver-model.
48742eb31b13SSimon Glass
4875c609719bSwdenk
4876c609719bSwdenkConfiguring the Linux kernel:
4877c609719bSwdenk-----------------------------
4878c609719bSwdenk
4879c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4880c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4881c609719bSwdenk
4882c609719bSwdenk
4883c609719bSwdenkBuilding a Linux Image:
4884c609719bSwdenk-----------------------
4885c609719bSwdenk
488624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
488724ee89b9Swdenknot used. If you use recent kernel source, a new build target
488824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
488924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
489024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
489124ee89b9Swdenk100% compatible format.
4892c609719bSwdenk
4893c609719bSwdenkExample:
4894c609719bSwdenk
4895ab584d67SHolger Freyther	make TQM850L_defconfig
4896c609719bSwdenk	make oldconfig
4897c609719bSwdenk	make dep
489824ee89b9Swdenk	make uImage
4899c609719bSwdenk
490024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
490124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
490224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4903c609719bSwdenk
490424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
490524ee89b9Swdenk
490624ee89b9Swdenk* convert the kernel into a raw binary image:
490724ee89b9Swdenk
490824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
490924ee89b9Swdenk				 -R .note -R .comment \
491024ee89b9Swdenk				 -S vmlinux linux.bin
491124ee89b9Swdenk
491224ee89b9Swdenk* compress the binary image:
491324ee89b9Swdenk
491424ee89b9Swdenk	gzip -9 linux.bin
491524ee89b9Swdenk
491624ee89b9Swdenk* package compressed binary image for U-Boot:
491724ee89b9Swdenk
491824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
491924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
492024ee89b9Swdenk		-d linux.bin.gz uImage
492124ee89b9Swdenk
492224ee89b9Swdenk
492324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
492424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
492524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
492624ee89b9Swdenkbyte header containing information about target architecture,
492724ee89b9Swdenkoperating system, image type, compression method, entry points, time
492824ee89b9Swdenkstamp, CRC32 checksums, etc.
492924ee89b9Swdenk
493024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
493124ee89b9Swdenkprint the header information, or to build new images.
4932c609719bSwdenk
4933c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4934c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4935c609719bSwdenkchecksum verification:
4936c609719bSwdenk
4937c609719bSwdenk	tools/mkimage -l image
4938c609719bSwdenk	  -l ==> list image header information
4939c609719bSwdenk
4940c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4941c609719bSwdenkfrom a "data file" which is used as image payload:
4942c609719bSwdenk
4943c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4944c609719bSwdenk		      -n name -d data_file image
4945c609719bSwdenk	  -A ==> set architecture to 'arch'
4946c609719bSwdenk	  -O ==> set operating system to 'os'
4947c609719bSwdenk	  -T ==> set image type to 'type'
4948c609719bSwdenk	  -C ==> set compression type 'comp'
4949c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4950c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4951c609719bSwdenk	  -n ==> set image name to 'name'
4952c609719bSwdenk	  -d ==> use image data from 'datafile'
4953c609719bSwdenk
495469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
495569459791Swdenkaddress (0x00000000), but the entry point address depends on the
495669459791Swdenkkernel version:
4957c609719bSwdenk
4958c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
495924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4960c609719bSwdenk
4961c609719bSwdenkSo a typical call to build a U-Boot image would read:
4962c609719bSwdenk
496324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
496424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4965a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
496624ee89b9Swdenk	> examples/uImage.TQM850L
496724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4968c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4969c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4970c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4971c609719bSwdenk	Load Address: 0x00000000
497224ee89b9Swdenk	Entry Point:  0x00000000
4973c609719bSwdenk
4974c609719bSwdenkTo verify the contents of the image (or check for corruption):
4975c609719bSwdenk
497624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
497724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4978c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4979c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4980c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4981c609719bSwdenk	Load Address: 0x00000000
498224ee89b9Swdenk	Entry Point:  0x00000000
4983c609719bSwdenk
4984c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4985c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4986c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4987c609719bSwdenkneed to be uncompressed:
4988c609719bSwdenk
4989a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
499024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
499124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4992a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
499324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
499424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4995c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4996c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4997c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4998c609719bSwdenk	Load Address: 0x00000000
499924ee89b9Swdenk	Entry Point:  0x00000000
5000c609719bSwdenk
5001c609719bSwdenk
5002c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5003c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5004c609719bSwdenk
5005c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5006c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5007c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5008c609719bSwdenk	Image Name:   Simple Ramdisk Image
5009c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5010c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5011c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5012c609719bSwdenk	Load Address: 0x00000000
5013c609719bSwdenk	Entry Point:  0x00000000
5014c609719bSwdenk
5015a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5016a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5017a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5018a804b5ceSGuilherme Maciel Ferreirafrom the image:
5019a804b5ceSGuilherme Maciel Ferreira
5020f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5021f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5022f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5023f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5024a804b5ceSGuilherme Maciel Ferreira
5025c609719bSwdenk
5026c609719bSwdenkInstalling a Linux Image:
5027c609719bSwdenk-------------------------
5028c609719bSwdenk
5029c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5030c609719bSwdenkyou must convert the image to S-Record format:
5031c609719bSwdenk
5032c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5033c609719bSwdenk
5034c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5035c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5036c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5037c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5038c609719bSwdenkcommand.
5039c609719bSwdenk
5040c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5041c609719bSwdenkTQM8xxL is in the first Flash bank):
5042c609719bSwdenk
5043c609719bSwdenk	=> erase 40100000 401FFFFF
5044c609719bSwdenk
5045c609719bSwdenk	.......... done
5046c609719bSwdenk	Erased 8 sectors
5047c609719bSwdenk
5048c609719bSwdenk	=> loads 40100000
5049c609719bSwdenk	## Ready for S-Record download ...
5050c609719bSwdenk	~>examples/image.srec
5051c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5052c609719bSwdenk	...
5053c609719bSwdenk	15989 15990 15991 15992
5054c609719bSwdenk	[file transfer complete]
5055c609719bSwdenk	[connected]
5056c609719bSwdenk	## Start Addr = 0x00000000
5057c609719bSwdenk
5058c609719bSwdenk
5059c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5060c609719bSwdenkthis includes a checksum verification so you can be sure no data
5061c609719bSwdenkcorruption happened:
5062c609719bSwdenk
5063c609719bSwdenk	=> imi 40100000
5064c609719bSwdenk
5065c609719bSwdenk	## Checking Image at 40100000 ...
5066c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5067c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5068c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5069c609719bSwdenk	   Load Address: 00000000
5070c609719bSwdenk	   Entry Point:	 0000000c
5071c609719bSwdenk	   Verifying Checksum ... OK
5072c609719bSwdenk
5073c609719bSwdenk
5074c609719bSwdenkBoot Linux:
5075c609719bSwdenk-----------
5076c609719bSwdenk
5077c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5078c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5079c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5080c609719bSwdenkparameters. You can check and modify this variable using the
5081c609719bSwdenk"printenv" and "setenv" commands:
5082c609719bSwdenk
5083c609719bSwdenk
5084c609719bSwdenk	=> printenv bootargs
5085c609719bSwdenk	bootargs=root=/dev/ram
5086c609719bSwdenk
5087c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5088c609719bSwdenk
5089c609719bSwdenk	=> printenv bootargs
5090c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5091c609719bSwdenk
5092c609719bSwdenk	=> bootm 40020000
5093c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5094c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5095c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5096c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5097c609719bSwdenk	   Load Address: 00000000
5098c609719bSwdenk	   Entry Point:	 0000000c
5099c609719bSwdenk	   Verifying Checksum ... OK
5100c609719bSwdenk	   Uncompressing Kernel Image ... OK
5101c609719bSwdenk	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
5102c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5103c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5104c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5105c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5106c609719bSwdenk	...
5107c609719bSwdenk
510811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
51097152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5110c609719bSwdenkformat!) to the "bootm" command:
5111c609719bSwdenk
5112c609719bSwdenk	=> imi 40100000 40200000
5113c609719bSwdenk
5114c609719bSwdenk	## Checking Image at 40100000 ...
5115c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5116c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5117c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5118c609719bSwdenk	   Load Address: 00000000
5119c609719bSwdenk	   Entry Point:	 0000000c
5120c609719bSwdenk	   Verifying Checksum ... OK
5121c609719bSwdenk
5122c609719bSwdenk	## Checking Image at 40200000 ...
5123c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5124c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5125c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5126c609719bSwdenk	   Load Address: 00000000
5127c609719bSwdenk	   Entry Point:	 00000000
5128c609719bSwdenk	   Verifying Checksum ... OK
5129c609719bSwdenk
5130c609719bSwdenk	=> bootm 40100000 40200000
5131c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5132c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5133c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5134c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5135c609719bSwdenk	   Load Address: 00000000
5136c609719bSwdenk	   Entry Point:	 0000000c
5137c609719bSwdenk	   Verifying Checksum ... OK
5138c609719bSwdenk	   Uncompressing Kernel Image ... OK
5139c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5140c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5141c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5142c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5143c609719bSwdenk	   Load Address: 00000000
5144c609719bSwdenk	   Entry Point:	 00000000
5145c609719bSwdenk	   Verifying Checksum ... OK
5146c609719bSwdenk	   Loading Ramdisk ... OK
5147c609719bSwdenk	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
5148c609719bSwdenk	Boot arguments: root=/dev/ram
5149c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5150c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5151c609719bSwdenk	...
5152c609719bSwdenk	RAMDISK: Compressed image found at block 0
5153c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5154c609719bSwdenk
5155c609719bSwdenk	bash#
5156c609719bSwdenk
51570267768eSMatthew McClintockBoot Linux and pass a flat device tree:
51580267768eSMatthew McClintock-----------
51590267768eSMatthew McClintock
51600267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
51610267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
51620267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
51630267768eSMatthew McClintockflat device tree:
51640267768eSMatthew McClintock
51650267768eSMatthew McClintock=> print oftaddr
51660267768eSMatthew McClintockoftaddr=0x300000
51670267768eSMatthew McClintock=> print oft
51680267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
51690267768eSMatthew McClintock=> tftp $oftaddr $oft
51700267768eSMatthew McClintockSpeed: 1000, full duplex
51710267768eSMatthew McClintockUsing TSEC0 device
51720267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
51730267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
51740267768eSMatthew McClintockLoad address: 0x300000
51750267768eSMatthew McClintockLoading: #
51760267768eSMatthew McClintockdone
51770267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
51780267768eSMatthew McClintock=> tftp $loadaddr $bootfile
51790267768eSMatthew McClintockSpeed: 1000, full duplex
51800267768eSMatthew McClintockUsing TSEC0 device
51810267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
51820267768eSMatthew McClintockFilename 'uImage'.
51830267768eSMatthew McClintockLoad address: 0x200000
51840267768eSMatthew McClintockLoading:############
51850267768eSMatthew McClintockdone
51860267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
51870267768eSMatthew McClintock=> print loadaddr
51880267768eSMatthew McClintockloadaddr=200000
51890267768eSMatthew McClintock=> print oftaddr
51900267768eSMatthew McClintockoftaddr=0x300000
51910267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
51920267768eSMatthew McClintock## Booting image at 00200000 ...
51930267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
51940267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
51950267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
51960267768eSMatthew McClintock   Load Address: 00000000
51970267768eSMatthew McClintock   Entry Point:	 00000000
51980267768eSMatthew McClintock   Verifying Checksum ... OK
51990267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
52000267768eSMatthew McClintockBooting using flat device tree at 0x300000
52010267768eSMatthew McClintockUsing MPC85xx ADS machine description
52020267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
52030267768eSMatthew McClintock[snip]
52040267768eSMatthew McClintock
52050267768eSMatthew McClintock
52066069ff26SwdenkMore About U-Boot Image Types:
52076069ff26Swdenk------------------------------
52086069ff26Swdenk
52096069ff26SwdenkU-Boot supports the following image types:
52106069ff26Swdenk
52116069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
52126069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
52136069ff26Swdenk	well) you can continue to work in U-Boot after return from
52146069ff26Swdenk	the Standalone Program.
52156069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
52166069ff26Swdenk	will take over control completely. Usually these programs
52176069ff26Swdenk	will install their own set of exception handlers, device
52186069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
52196069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
52206069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
52216069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
52226069ff26Swdenk	being started.
52236069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
52246069ff26Swdenk	(Linux) kernel image and one or more data images like
52256069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
52266069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
52276069ff26Swdenk	server provides just a single image file, but you want to get
52286069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
52296069ff26Swdenk
52306069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
52316069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
52326069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
52336069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
52346069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
52356069ff26Swdenk	a multiple of 4 bytes).
52366069ff26Swdenk
52376069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
52386069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
52396069ff26Swdenk	flash memory.
52406069ff26Swdenk
52416069ff26Swdenk   "Script files" are command sequences that will be executed by
52426069ff26Swdenk	U-Boot's command interpreter; this feature is especially
52436069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
52446069ff26Swdenk	as command interpreter.
52456069ff26Swdenk
524644f074c7SMarek VasutBooting the Linux zImage:
524744f074c7SMarek Vasut-------------------------
524844f074c7SMarek Vasut
524944f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
525044f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
525144f074c7SMarek Vasutas the syntax of "bootm" command.
525244f074c7SMarek Vasut
52538ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5254017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5255017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5256017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5257017e1f3fSMarek Vasut
5258c609719bSwdenk
5259c609719bSwdenkStandalone HOWTO:
5260c609719bSwdenk=================
5261c609719bSwdenk
5262c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5263c609719bSwdenkrun "standalone" applications, which can use some resources of
5264c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5265c609719bSwdenk
5266c609719bSwdenkTwo simple examples are included with the sources:
5267c609719bSwdenk
5268c609719bSwdenk"Hello World" Demo:
5269c609719bSwdenk-------------------
5270c609719bSwdenk
5271c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5272c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5273c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5274c609719bSwdenklike that:
5275c609719bSwdenk
5276c609719bSwdenk	=> loads
5277c609719bSwdenk	## Ready for S-Record download ...
5278c609719bSwdenk	~>examples/hello_world.srec
5279c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5280c609719bSwdenk	[file transfer complete]
5281c609719bSwdenk	[connected]
5282c609719bSwdenk	## Start Addr = 0x00040004
5283c609719bSwdenk
5284c609719bSwdenk	=> go 40004 Hello World! This is a test.
5285c609719bSwdenk	## Starting application at 0x00040004 ...
5286c609719bSwdenk	Hello World
5287c609719bSwdenk	argc = 7
5288c609719bSwdenk	argv[0] = "40004"
5289c609719bSwdenk	argv[1] = "Hello"
5290c609719bSwdenk	argv[2] = "World!"
5291c609719bSwdenk	argv[3] = "This"
5292c609719bSwdenk	argv[4] = "is"
5293c609719bSwdenk	argv[5] = "a"
5294c609719bSwdenk	argv[6] = "test."
5295c609719bSwdenk	argv[7] = "<NULL>"
5296c609719bSwdenk	Hit any key to exit ...
5297c609719bSwdenk
5298c609719bSwdenk	## Application terminated, rc = 0x0
5299c609719bSwdenk
5300c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5301c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5302c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5303c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5304c609719bSwdenkcharacter, but this is just a demo program. The application can be
5305c609719bSwdenkcontrolled by the following keys:
5306c609719bSwdenk
5307c609719bSwdenk	? - print current values og the CPM Timer registers
5308c609719bSwdenk	b - enable interrupts and start timer
5309c609719bSwdenk	e - stop timer and disable interrupts
5310c609719bSwdenk	q - quit application
5311c609719bSwdenk
5312c609719bSwdenk	=> loads
5313c609719bSwdenk	## Ready for S-Record download ...
5314c609719bSwdenk	~>examples/timer.srec
5315c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5316c609719bSwdenk	[file transfer complete]
5317c609719bSwdenk	[connected]
5318c609719bSwdenk	## Start Addr = 0x00040004
5319c609719bSwdenk
5320c609719bSwdenk	=> go 40004
5321c609719bSwdenk	## Starting application at 0x00040004 ...
5322c609719bSwdenk	TIMERS=0xfff00980
5323c609719bSwdenk	Using timer 1
5324c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5325c609719bSwdenk
5326c609719bSwdenkHit 'b':
5327c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5328c609719bSwdenk	Enabling timer
5329c609719bSwdenkHit '?':
5330c609719bSwdenk	[q, b, e, ?] ........
5331c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5332c609719bSwdenkHit '?':
5333c609719bSwdenk	[q, b, e, ?] .
5334c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5335c609719bSwdenkHit '?':
5336c609719bSwdenk	[q, b, e, ?] .
5337c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5338c609719bSwdenkHit '?':
5339c609719bSwdenk	[q, b, e, ?] .
5340c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5341c609719bSwdenkHit 'e':
5342c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5343c609719bSwdenkHit 'q':
5344c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5345c609719bSwdenk
5346c609719bSwdenk
534785ec0bccSwdenkMinicom warning:
534885ec0bccSwdenk================
534985ec0bccSwdenk
53507152b1d0SwdenkOver time, many people have reported problems when trying to use the
535185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
535285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5353f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
535485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5355e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5356e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5357e53515a2SKarl O. Pincfor help with kermit.
5358e53515a2SKarl O. Pinc
535985ec0bccSwdenk
536052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
536152f52c14Swdenkconfiguration to your "File transfer protocols" section:
536252f52c14Swdenk
536352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
536452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
536552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
536652f52c14Swdenk
536752f52c14Swdenk
5368c609719bSwdenkNetBSD Notes:
5369c609719bSwdenk=============
5370c609719bSwdenk
5371c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5372c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5373c609719bSwdenk
5374c609719bSwdenkBuilding requires a cross environment; it is known to work on
5375c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5376c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5377c609719bSwdenkNote that the cross-powerpc package does not install include files;
5378c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5379c609719bSwdenkmissing.  This file has to be installed and patched manually:
5380c609719bSwdenk
5381c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5382c609719bSwdenk	# mkdir powerpc
5383c609719bSwdenk	# ln -s powerpc machine
5384c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5385c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5386c609719bSwdenk
5387c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5388c609719bSwdenkand U-Boot include files.
5389c609719bSwdenk
5390c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5391c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5392c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5393c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
53942a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5395c609719bSwdenk
5396c609719bSwdenk
5397c609719bSwdenkImplementation Internals:
5398c609719bSwdenk=========================
5399c609719bSwdenk
5400c609719bSwdenkThe following is not intended to be a complete description of every
5401c609719bSwdenkimplementation detail. However, it should help to understand the
5402c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5403c609719bSwdenkhardware.
5404c609719bSwdenk
5405c609719bSwdenk
5406c609719bSwdenkInitial Stack, Global Data:
5407c609719bSwdenk---------------------------
5408c609719bSwdenk
5409c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5410c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5411c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5412c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5413c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5414c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5415c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5416c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5417c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5418c609719bSwdenklocked as (mis-) used as memory, etc.
5419c609719bSwdenk
54207152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
54210668236bSWolfgang Denk	U-Boot mailing list:
542243d9616cSwdenk
542343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
542443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
542543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
542643d9616cSwdenk	...
542743d9616cSwdenk
542843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
542943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
543043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
543143d9616cSwdenk	is that the cache is being used as a temporary supply of
543243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
543311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
543443d9616cSwdenk	can see how this works by studying the cache architecture and
543543d9616cSwdenk	operation in the architecture and processor-specific manuals.
543643d9616cSwdenk
543743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
543843d9616cSwdenk	is another option for the system designer to use as an
543911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
544043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
544143d9616cSwdenk	board designers haven't used it for something that would
544243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
544343d9616cSwdenk	used.
544443d9616cSwdenk
54456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
544643d9616cSwdenk	with your processor/board/system design. The default value
544743d9616cSwdenk	you will find in any recent u-boot distribution in
54488a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
544943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
545043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
545143d9616cSwdenk	that are supposed to respond to that address! That code in
545243d9616cSwdenk	start.S has been around a while and should work as is when
545343d9616cSwdenk	you get the config right.
545443d9616cSwdenk
545543d9616cSwdenk	-Chris Hallinan
545643d9616cSwdenk	DS4.COM, Inc.
545743d9616cSwdenk
5458c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5459c609719bSwdenkcode for the initialization procedures:
5460c609719bSwdenk
5461c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5462c609719bSwdenk  to write it.
5463c609719bSwdenk
5464b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
5465c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
54667152b1d0Swdenk  zation is performed later (when relocating to RAM).
5467c609719bSwdenk
5468c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5469c609719bSwdenk  that.
5470c609719bSwdenk
5471c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5472b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
5473c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5474c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5475c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5476c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5477c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5478c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5479c609719bSwdenkreserve for this purpose.
5480c609719bSwdenk
54817152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5482c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5483c609719bSwdenkGCC's implementation.
5484c609719bSwdenk
5485c609719bSwdenkFor PowerPC, the following registers have specific use:
5486c609719bSwdenk	R1:	stack pointer
5487e7670f6cSWolfgang Denk	R2:	reserved for system use
5488c609719bSwdenk	R3-R4:	parameter passing and return values
5489c609719bSwdenk	R5-R10: parameter passing
5490c609719bSwdenk	R13:	small data area pointer
5491c609719bSwdenk	R30:	GOT pointer
5492c609719bSwdenk	R31:	frame pointer
5493c609719bSwdenk
5494e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5495e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5496e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5497c609719bSwdenk
5498e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5499c609719bSwdenk
5500c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5501c609719bSwdenk    address of the global data structure is known at compile time),
5502c609719bSwdenk    but it turned out that reserving a register results in somewhat
5503c609719bSwdenk    smaller code - although the code savings are not that big (on
5504c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5505c609719bSwdenk    624 text + 127 data).
5506c609719bSwdenk
5507c609719bSwdenkOn ARM, the following registers are used:
5508c609719bSwdenk
5509c609719bSwdenk	R0:	function argument word/integer result
5510c609719bSwdenk	R1-R3:	function argument word
551112eba1b4SJeroen Hofstee	R9:	platform specific
551212eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5513c609719bSwdenk	R11:	argument (frame) pointer
5514c609719bSwdenk	R12:	temporary workspace
5515c609719bSwdenk	R13:	stack pointer
5516c609719bSwdenk	R14:	link register
5517c609719bSwdenk	R15:	program counter
5518c609719bSwdenk
551912eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
552012eba1b4SJeroen Hofstee
552112eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5522c609719bSwdenk
55230df01fd3SThomas ChouOn Nios II, the ABI is documented here:
55240df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
55250df01fd3SThomas Chou
55260df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
55270df01fd3SThomas Chou
55280df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
55290df01fd3SThomas Chou    to access small data sections, so gp is free.
55300df01fd3SThomas Chou
5531afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5532afc1ce82SMacpaul Lin
5533afc1ce82SMacpaul Lin	R0-R1:	argument/return
5534afc1ce82SMacpaul Lin	R2-R5:	argument
5535afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5536afc1ce82SMacpaul Lin	R16:	trampoline register
5537afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5538afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5539afc1ce82SMacpaul Lin	R30:	link register (LP)
5540afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5541afc1ce82SMacpaul Lin	PC:	program counter (PC)
5542afc1ce82SMacpaul Lin
5543afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5544afc1ce82SMacpaul Lin
5545d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5546d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5547c609719bSwdenk
5548c609719bSwdenkMemory Management:
5549c609719bSwdenk------------------
5550c609719bSwdenk
5551c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5552c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5553c609719bSwdenk
5554c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5555c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5556c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5557c609719bSwdenkphysical memory banks.
5558c609719bSwdenk
5559c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5560c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5561c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5562c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
55636d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5564c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5565c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5566c609719bSwdenk
5567c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5568c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5569c609719bSwdenk
5570c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5571c609719bSwdenkthis:
5572c609719bSwdenk
5573c609719bSwdenk	0x0000 0000	Exception Vector code
5574c609719bSwdenk	      :
5575c609719bSwdenk	0x0000 1FFF
5576c609719bSwdenk	0x0000 2000	Free for Application Use
5577c609719bSwdenk	      :
5578c609719bSwdenk	      :
5579c609719bSwdenk
5580c609719bSwdenk	      :
5581c609719bSwdenk	      :
5582c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5583c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5584c609719bSwdenk	0x00FC 0000	Malloc Arena
5585c609719bSwdenk	      :
5586c609719bSwdenk	0x00FD FFFF
5587c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5588c609719bSwdenk	...		eventually: LCD or video framebuffer
5589c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5590c609719bSwdenk	0x00FF FFFF	[End of RAM]
5591c609719bSwdenk
5592c609719bSwdenk
5593c609719bSwdenkSystem Initialization:
5594c609719bSwdenk----------------------
5595c609719bSwdenk
5596c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
559711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5598c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
55997152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5600c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5601c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
56022eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data
56032eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and
56042eb48ff7SHeiko Schocherthe SIU.
5605c609719bSwdenk
5606c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5607c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5608c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5609c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5610c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5611c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5612c609719bSwdenkbanks.
5613c609719bSwdenk
5614c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
56157152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5616c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5617c609719bSwdenk0x00000000, with any additional banks following immediately to create
5618c609719bSwdenkcontiguous memory starting from 0.
5619c609719bSwdenk
5620c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5621c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5622c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5623c609719bSwdenkpages, and the final stack is set up.
5624c609719bSwdenk
5625c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5626c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5627c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5628c609719bSwdenknew address in RAM.
5629c609719bSwdenk
5630c609719bSwdenk
5631c609719bSwdenkU-Boot Porting Guide:
5632c609719bSwdenk----------------------
5633c609719bSwdenk
5634c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
56356aff3115Swdenklist, October 2002]
5636c609719bSwdenk
5637c609719bSwdenk
5638c609719bSwdenkint main(int argc, char *argv[])
5639c609719bSwdenk{
5640c609719bSwdenk	sighandler_t no_more_time;
5641c609719bSwdenk
5642c609719bSwdenk	signal(SIGALRM, no_more_time);
5643c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5644c609719bSwdenk
5645c609719bSwdenk	if (available_money > available_manpower) {
56466c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5647c609719bSwdenk		return 0;
5648c609719bSwdenk	}
5649c609719bSwdenk
5650c609719bSwdenk	Download latest U-Boot source;
5651c609719bSwdenk
56520668236bSWolfgang Denk	Subscribe to u-boot mailing list;
56536aff3115Swdenk
56546c3fef28SJerry Van Baren	if (clueless)
5655c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5656c609719bSwdenk
5657c609719bSwdenk	while (learning) {
5658c609719bSwdenk		Read the README file in the top level directory;
56597cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
56606c3fef28SJerry Van Baren		Read applicable doc/*.README;
5661c609719bSwdenk		Read the source, Luke;
56626c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5663c609719bSwdenk	}
5664c609719bSwdenk
56656c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
56666c3fef28SJerry Van Baren		Buy a BDI3000;
56676c3fef28SJerry Van Baren	else
5668c609719bSwdenk		Add a lot of aggravation and time;
5669c609719bSwdenk
56706c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
56716c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
56726c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
56736c3fef28SJerry Van Baren	} else {
5674c609719bSwdenk		Create your own board support subdirectory;
56756c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
56766c3fef28SJerry Van Baren	}
56776c3fef28SJerry Van Baren	Edit new board/<myboard> files
56786c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5679c609719bSwdenk
56806c3fef28SJerry Van Baren	while (!accepted) {
5681c609719bSwdenk		while (!running) {
5682c609719bSwdenk			do {
5683c609719bSwdenk				Add / modify source code;
5684c609719bSwdenk			} until (compiles);
5685c609719bSwdenk			Debug;
5686c609719bSwdenk			if (clueless)
5687c609719bSwdenk				email("Hi, I am having problems...");
5688c609719bSwdenk		}
56896c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
56906c3fef28SJerry Van Baren		if (reasonable critiques)
56916c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
56926c3fef28SJerry Van Baren		else
56936c3fef28SJerry Van Baren			Defend code as written;
56946c3fef28SJerry Van Baren	}
5695c609719bSwdenk
5696c609719bSwdenk	return 0;
5697c609719bSwdenk}
5698c609719bSwdenk
5699c609719bSwdenkvoid no_more_time (int sig)
5700c609719bSwdenk{
5701c609719bSwdenk      hire_a_guru();
5702c609719bSwdenk}
5703c609719bSwdenk
5704c609719bSwdenk
5705c609719bSwdenkCoding Standards:
5706c609719bSwdenk-----------------
5707c609719bSwdenk
5708c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
57092c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
57107ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5711c609719bSwdenk
57122c051651SDetlev ZundelSource files originating from a different project (for example the
57132c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
5714b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
57152c051651SDetlev Zundelsources.
57162c051651SDetlev Zundel
57172c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
57182c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
57192c051651SDetlev Zundelin your code.
5720c609719bSwdenk
5721c178d3daSwdenkPlease also stick to the following formatting rules:
5722180d3f74Swdenk- remove any trailing white space
57237ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5724180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
57257ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5726180d3f74Swdenk- do not add trailing empty lines to source files
5727180d3f74Swdenk
5728c609719bSwdenkSubmissions which do not conform to the standards may be returned
5729c609719bSwdenkwith a request to reformat the changes.
5730c609719bSwdenk
5731c609719bSwdenk
5732c609719bSwdenkSubmitting Patches:
5733c609719bSwdenk-------------------
5734c609719bSwdenk
5735c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5736c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5737c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5738c609719bSwdenk
57390d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5740218ca724SWolfgang Denk
57410668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
57420668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
57430668236bSWolfgang Denk
5744c609719bSwdenkWhen you send a patch, please include the following information with
5745c609719bSwdenkit:
5746c609719bSwdenk
5747c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5748c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5749c609719bSwdenk  patch actually fixes something.
5750c609719bSwdenk
5751c609719bSwdenk* For new features: a description of the feature and your
5752c609719bSwdenk  implementation.
5753c609719bSwdenk
5754c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5755c609719bSwdenk
57567207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
57577207b366SRobert P. J. Day  information and associated file and directory references.
5758c609719bSwdenk
575927af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
576027af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5761c609719bSwdenk
5762c609719bSwdenk* If your patch adds new configuration options, don't forget to
5763c609719bSwdenk  document these in the README file.
5764c609719bSwdenk
5765218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5766218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
57677ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5768218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5769218ca724SWolfgang Denk  with some other mail clients.
5770c609719bSwdenk
5771218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5772218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5773218ca724SWolfgang Denk  GNU diff.
57746dff5529Swdenk
5775218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5776218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5777218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5778218ca724SWolfgang Denk  affected files).
5779218ca724SWolfgang Denk
5780218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5781218ca724SWolfgang Denk  and compressed attachments must not be used.
5782c609719bSwdenk
578352f52c14Swdenk* If one logical set of modifications affects or creates several
578452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
578552f52c14Swdenk
578652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
578752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
578852f52c14Swdenk
578952f52c14Swdenk
5790c609719bSwdenkNotes:
5791c609719bSwdenk
57926de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
5793c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5794c609719bSwdenk  for any of the boards.
5795c609719bSwdenk
5796c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5797c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5798c609719bSwdenk  returned with a request to re-formatting / split it.
5799c609719bSwdenk
5800c609719bSwdenk* If you modify existing code, make sure that your new code does not
5801c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5802c609719bSwdenk  When adding new features, these should compile conditionally only
5803c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5804c609719bSwdenk  disabled must not need more memory than the old code without your
5805c609719bSwdenk  modification.
580690dc6704Swdenk
58070668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
58080668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
58090668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
58100668236bSWolfgang Denk  bigger than the size limit should be avoided.
5811