xref: /openbmc/u-boot/README (revision 00caae6d)
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_RAMBOOT and CONFIG_NFSBOOT
703c609719bSwdenk		The value of these goes into the environment as
704c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
705c609719bSwdenk		as a convenience, when switching between booting from
70611ccc33fSMarcel Ziswiler		RAM and NFS.
707c609719bSwdenk
708eda0ba38SHeiko Schocher- Bootcount:
709eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
710eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
711eda0ba38SHeiko Schocher		cycle, see:
712eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
713eda0ba38SHeiko Schocher
714eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
715eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
716eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
717eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
718eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
719eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
720eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
721eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
722eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
723eda0ba38SHeiko Schocher
724c609719bSwdenk- Pre-Boot Commands:
725c609719bSwdenk		CONFIG_PREBOOT
726c609719bSwdenk
727c609719bSwdenk		When this option is #defined, the existence of the
728c609719bSwdenk		environment variable "preboot" will be checked
729c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
730c609719bSwdenk		countdown and/or running the auto-boot command resp.
731c609719bSwdenk		entering interactive mode.
732c609719bSwdenk
733c609719bSwdenk		This feature is especially useful when "preboot" is
734c609719bSwdenk		automatically generated or modified. For an example
735c609719bSwdenk		see the LWMON board specific code: here "preboot" is
736c609719bSwdenk		modified when the user holds down a certain
737c609719bSwdenk		combination of keys on the (special) keyboard when
738c609719bSwdenk		booting the systems
739c609719bSwdenk
740c609719bSwdenk- Serial Download Echo Mode:
741c609719bSwdenk		CONFIG_LOADS_ECHO
742c609719bSwdenk		If defined to 1, all characters received during a
743c609719bSwdenk		serial download (using the "loads" command) are
744c609719bSwdenk		echoed back. This might be needed by some terminal
745c609719bSwdenk		emulations (like "cu"), but may as well just take
746c609719bSwdenk		time on others. This setting #define's the initial
747c609719bSwdenk		value of the "loads_echo" environment variable.
748c609719bSwdenk
749602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
750c609719bSwdenk		CONFIG_KGDB_BAUDRATE
751c609719bSwdenk		Select one of the baudrates listed in
7526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
753c609719bSwdenk
754302a6487SSimon Glass- Removal of commands
755302a6487SSimon Glass		If no commands are needed to boot, you can disable
756302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
757302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
758302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
759302a6487SSimon Glass		instead. This can reduce image size significantly for very
760302a6487SSimon Glass		simple boot procedures.
761302a6487SSimon Glass
762a5ecbe62SWolfgang Denk- Regular expression support:
763a5ecbe62SWolfgang Denk		CONFIG_REGEX
764a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
765a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
766a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
767a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
768a5ecbe62SWolfgang Denk
76945ba8077SSimon Glass- Device tree:
77045ba8077SSimon Glass		CONFIG_OF_CONTROL
77145ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
77245ba8077SSimon Glass		to configure its devices, instead of relying on statically
77345ba8077SSimon Glass		compiled #defines in the board file. This option is
77445ba8077SSimon Glass		experimental and only available on a few boards. The device
77545ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
77645ba8077SSimon Glass
7772c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
77882f766d1SAlex Deymo		be done using one of the three options below:
779bbb0b128SSimon Glass
780bbb0b128SSimon Glass		CONFIG_OF_EMBED
781bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
782bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
783bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
784bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
785bbb0b128SSimon Glass		the global data structure as gd->blob.
78645ba8077SSimon Glass
7872c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
7882c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
7892c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
7902c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
7912c0f79e4SSimon Glass
7922c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
7932c0f79e4SSimon Glass
7942c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
7952c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
7962c0f79e4SSimon Glass		still use the individual files if you need something more
7972c0f79e4SSimon Glass		exotic.
7982c0f79e4SSimon Glass
79982f766d1SAlex Deymo		CONFIG_OF_BOARD
80082f766d1SAlex Deymo		If this variable is defined, U-Boot will use the device tree
80182f766d1SAlex Deymo		provided by the board at runtime instead of embedding one with
80282f766d1SAlex Deymo		the image. Only boards defining board_fdt_blob_setup() support
80382f766d1SAlex Deymo		this option (see include/fdtdec.h file).
80482f766d1SAlex Deymo
805c609719bSwdenk- Watchdog:
806c609719bSwdenk		CONFIG_WATCHDOG
807c609719bSwdenk		If this variable is defined, it enables watchdog
8086abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
809907208c4SChristophe Leroy		specific code for a watchdog. For the 8xx
810907208c4SChristophe Leroy		CPUs, the SIU Watchdog feature is enabled in the SYPCR
811907208c4SChristophe Leroy		register.  When supported for a specific SoC is
812907208c4SChristophe Leroy		available, then no further board specific code should
813907208c4SChristophe Leroy		be needed to use it.
8146abe6fb6SDetlev Zundel
8156abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8166abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8176abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8186abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
819c609719bSwdenk
8207bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
8217bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
8227bae0d6fSHeiko Schocher
823c1551ea8Sstroese- U-Boot Version:
824c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
825c1551ea8Sstroese		If this variable is defined, an environment variable
826c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
827c1551ea8Sstroese		version as printed by the "version" command.
828a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
829a1ea8e51SBenoît Thébaudeau		next reset.
830c1551ea8Sstroese
831c609719bSwdenk- Real-Time Clock:
832c609719bSwdenk
833602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
834c609719bSwdenk		has to be selected, too. Define exactly one of the
835c609719bSwdenk		following options:
836c609719bSwdenk
837c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
8384e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
839c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
8401cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
841c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
8427f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
843412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
8443bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
8459536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
8464c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
8472bd3cab3SChris Packham		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
84871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
84971d19f30SHeiko Schocher					  RV3029 RTC.
850c609719bSwdenk
851b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
852b37c7e5eSwdenk		must also be configured. See I2C Support, below.
853b37c7e5eSwdenk
854e92739d3SPeter Tyser- GPIO Support:
855e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
856e92739d3SPeter Tyser
8575dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
8585dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
8595dec49caSChris Packham		pins supported by a particular chip.
8605dec49caSChris Packham
861e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
862e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
863e92739d3SPeter Tyser
864aa53233aSSimon Glass- I/O tracing:
865aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
866aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
867aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
868aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
869aa53233aSSimon Glass		the driver behaves the same way before and after a code
870aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
871aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
872aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
873aa53233aSSimon Glass
874aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
875aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
876aa53233aSSimon Glass		still continue to operate.
877aa53233aSSimon Glass
878aa53233aSSimon Glass			iotrace is enabled
879aa53233aSSimon Glass			Start:  10000000	(buffer start address)
880aa53233aSSimon Glass			Size:   00010000	(buffer size)
881aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
882aa53233aSSimon Glass			Output: 10000120	(start + offset)
883aa53233aSSimon Glass			Count:  00000018	(number of trace records)
884aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
885aa53233aSSimon Glass
886c609719bSwdenk- Timestamp Support:
887c609719bSwdenk
888c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
889c609719bSwdenk		(date and time) of an image is printed by image
890c609719bSwdenk		commands like bootm or iminfo. This option is
891602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
892c609719bSwdenk
893923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
894923c46f9SKarl O. Pinc		Zero or more of the following:
895923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
896923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
897923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
898923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
899923c46f9SKarl O. Pinc				       disk/part_efi.c
900923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
901c609719bSwdenk
902fc843a02SSimon Glass		If IDE or SCSI support is enabled (CONFIG_IDE or
903c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
904923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
905c609719bSwdenk
906c609719bSwdenk- IDE Reset method:
9074d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9084d13cbadSwdenk		board configurations files but used nowhere!
909c609719bSwdenk
9104d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9114d13cbadSwdenk		be performed by calling the function
9124d13cbadSwdenk			ide_set_reset(int reset)
9134d13cbadSwdenk		which has to be defined in a board specific file
914c609719bSwdenk
915c609719bSwdenk- ATAPI Support:
916c609719bSwdenk		CONFIG_ATAPI
917c609719bSwdenk
918c609719bSwdenk		Set this to enable ATAPI support.
919c609719bSwdenk
920c40b2956Swdenk- LBA48 Support
921c40b2956Swdenk		CONFIG_LBA48
922c40b2956Swdenk
923c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9244b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
925c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
926c40b2956Swdenk		support disks up to 2.1TB.
927c40b2956Swdenk
9286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
929c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
930c40b2956Swdenk			Default is 32bit.
931c40b2956Swdenk
932c609719bSwdenk- SCSI Support:
9336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
936c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
937c609719bSwdenk		devices.
938c609719bSwdenk
939447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
940447c031bSStefan Reinauer		SCSI devices found during the last scan.
941447c031bSStefan Reinauer
942c609719bSwdenk- NETWORK Support (PCI):
943682011ffSwdenk		CONFIG_E1000
944ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
945ce5207e1SKyle Moffett
946ce5207e1SKyle Moffett		CONFIG_E1000_SPI
947ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
948ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
949ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
950ce5207e1SKyle Moffett
951ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
952ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
953ce5207e1SKyle Moffett		example with the "sspi" command.
954ce5207e1SKyle Moffett
955c609719bSwdenk		CONFIG_EEPRO100
956c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
95711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
958c609719bSwdenk		write routine for first time initialisation.
959c609719bSwdenk
960c609719bSwdenk		CONFIG_TULIP
961c609719bSwdenk		Support for Digital 2114x chips.
962c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
963c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
964c609719bSwdenk
965c609719bSwdenk		CONFIG_NATSEMI
966c609719bSwdenk		Support for National dp83815 chips.
967c609719bSwdenk
968c609719bSwdenk		CONFIG_NS8382X
969c609719bSwdenk		Support for National dp8382[01] gigabit chips.
970c609719bSwdenk
97145219c46Swdenk- NETWORK Support (other):
97245219c46Swdenk
973c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
974c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
975c041e9d2SJens Scharsig
976c041e9d2SJens Scharsig			CONFIG_RMII
977c041e9d2SJens Scharsig			Define this to use reduced MII inteface
978c041e9d2SJens Scharsig
979c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
980c041e9d2SJens Scharsig			If this defined, the driver is quiet.
981c041e9d2SJens Scharsig			The driver doen't show link status messages.
982c041e9d2SJens Scharsig
983efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
984efdd7319SRob Herring		Support for the Calxeda XGMAC device
985efdd7319SRob Herring
9863bb46d23SAshok		CONFIG_LAN91C96
98745219c46Swdenk		Support for SMSC's LAN91C96 chips.
98845219c46Swdenk
98945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
99045219c46Swdenk			Define this to enable 32 bit addressing
99145219c46Swdenk
9923bb46d23SAshok		CONFIG_SMC91111
993f39748aeSwdenk		Support for SMSC's LAN91C111 chip
994f39748aeSwdenk
995f39748aeSwdenk			CONFIG_SMC91111_BASE
996f39748aeSwdenk			Define this to hold the physical address
997f39748aeSwdenk			of the device (I/O space)
998f39748aeSwdenk
999f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1000f39748aeSwdenk			Define this if data bus is 32 bits
1001f39748aeSwdenk
1002f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1003f39748aeSwdenk			Define this to use i/o functions instead of macros
1004f39748aeSwdenk			(some hardware wont work with macros)
1005f39748aeSwdenk
1006dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1007dc02badaSHeiko Schocher		Support for davinci emac
1008dc02badaSHeiko Schocher
1009dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1010dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1011dc02badaSHeiko Schocher
1012b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1013b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1014b3dbf4a5SMacpaul Lin
1015b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1016b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1017b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1018b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1019b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1020b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1021b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1022b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1023b3dbf4a5SMacpaul Lin
1024c2fff331SMike Rapoport		CONFIG_SMC911X
1025557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1026557b377dSJens Gehrlein
1027c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1028557b377dSJens Gehrlein			Define this to hold the physical address
1029557b377dSJens Gehrlein			of the device (I/O space)
1030557b377dSJens Gehrlein
1031c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1032557b377dSJens Gehrlein			Define this if data bus is 32 bits
1033557b377dSJens Gehrlein
1034c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1035557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1036557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1037c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1038557b377dSJens Gehrlein
10393d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
10403d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
10413d0075faSYoshihiro Shimoda
10423d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
10433d0075faSYoshihiro Shimoda			Define the number of ports to be used
10443d0075faSYoshihiro Shimoda
10453d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
10463d0075faSYoshihiro Shimoda			Define the ETH PHY's address
10473d0075faSYoshihiro Shimoda
104868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
104968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
105068260aabSYoshihiro Shimoda
1051b2f97cf2SHeiko Schocher- PWM Support:
1052b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
10535052e819SRobert P. J. Day		Support for PWM module on the imx6.
1054b2f97cf2SHeiko Schocher
10555e124724SVadim Bendebury- TPM Support:
105690899cc0SChe-liang Chiou		CONFIG_TPM
105790899cc0SChe-liang Chiou		Support TPM devices.
105890899cc0SChe-liang Chiou
10590766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
10600766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
10611b393db5STom Wai-Hong Tam		per system is supported at this time.
10621b393db5STom Wai-Hong Tam
10631b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
10641b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
10651b393db5STom Wai-Hong Tam
10663aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
10673aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
10683aa74088SChristophe Ricard
10693aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
10703aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
10713aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
10723aa74088SChristophe Ricard
1073b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1074b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1075b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1076b75fdc11SChristophe Ricard
1077c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1078c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1079c01939c7SDirk Eibach
108090899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
10815e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
10825e124724SVadim Bendebury		per system is supported at this time.
10835e124724SVadim Bendebury
10845e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
10855e124724SVadim Bendebury			Base address where the generic TPM device is mapped
10865e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
10875e124724SVadim Bendebury			0xfed40000.
10885e124724SVadim Bendebury
1089be6c1529SReinhard Pfau		CONFIG_TPM
1090be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1091be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1092be6c1529SReinhard Pfau		Requires support for a TPM device.
1093be6c1529SReinhard Pfau
1094be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1095be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1096be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1097be6c1529SReinhard Pfau
1098c609719bSwdenk- USB Support:
1099c609719bSwdenk		At the moment only the UHCI host controller is
1100064b55cfSHeiko Schocher		supported (PIP405, MIP405); define
1101c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1102c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
110330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1104c609719bSwdenk		storage devices.
1105c609719bSwdenk		Note:
1106c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1107c609719bSwdenk		(TEAC FD-05PUB).
11084d13cbadSwdenk
11099ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11109ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
11119ab4ce22SSimon Glass
11126e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
11136e9e0626SOleksandr Tymoshenko		HW module registers.
11146e9e0626SOleksandr Tymoshenko
111516c8d5e7SWolfgang Denk- USB Device:
111616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
111716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
111816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
111911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
112016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
112116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
112216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
112316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
112416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
112516c8d5e7SWolfgang Denk		a Linux host by
112616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
112716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
112816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
112916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
113016c8d5e7SWolfgang Denk
113116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
113216c8d5e7SWolfgang Denk			Define this to build a UDC device
113316c8d5e7SWolfgang Denk
113416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
113516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
113616c8d5e7SWolfgang Denk			talk to the UDC device
113716c8d5e7SWolfgang Denk
1138f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1139f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1140f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1141f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1142f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1143f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1144f9da0f89SVipin KUMAR			speed.
1145f9da0f89SVipin KUMAR
11466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
114716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
114816c8d5e7SWolfgang Denk			be set to usbtty.
114916c8d5e7SWolfgang Denk
115016c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
115116c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
115216c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
115316c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
115416c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
115516c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
115616c8d5e7SWolfgang Denk
115716c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
115816c8d5e7SWolfgang Denk			Define this string as the name of your company for
115916c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
116016c8d5e7SWolfgang Denk
116116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
116216c8d5e7SWolfgang Denk			Define this string as the name of your product
116316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
116416c8d5e7SWolfgang Denk
116516c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
116616c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
116716c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
116816c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
116916c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
117016c8d5e7SWolfgang Denk
117116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
117216c8d5e7SWolfgang Denk			Define this as the unique Product ID
117316c8d5e7SWolfgang Denk			for your device
117416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1175c609719bSwdenk
1176d70a560fSIgor Grinberg- ULPI Layer Support:
1177d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1178d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1179d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1180d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1181d70a560fSIgor Grinberg		viewport is supported.
1182d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1183d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
11846d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
11856d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
11866d365ea0SLucas Stach		the appropriate value in Hz.
1187c609719bSwdenk
1188c609719bSwdenk- MMC Support:
1189c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1190c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1191c609719bSwdenk		accessed from the boot prompt by mapping the device
1192c609719bSwdenk		to physical memory similar to flash. Command line is
1193602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1194602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1195c609719bSwdenk
1196afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1197afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1198afb35666SYoshihiro Shimoda
1199afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1200afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1201afb35666SYoshihiro Shimoda
1202afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1203afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1204afb35666SYoshihiro Shimoda
12051fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
12061fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
12071fd93c6eSPierre Aubert
12081fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
12091fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
12101fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
12111fd93c6eSPierre Aubert
1212b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
121301acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1214b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1215b3ba6e94STom Rini
1216b3ba6e94STom Rini		CONFIG_DFU_MMC
1217b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1218b3ba6e94STom Rini
1219c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1220c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1221c6631764SPantelis Antoniou
1222a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1223a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1224a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1225a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1226a9479f04SAfzal Mohammed		one that would help mostly the developer.
1227a9479f04SAfzal Mohammed
1228e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1229e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1230e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1231e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1232e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1233e7e75c70SHeiko Schocher
1234ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1235ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1236ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1237ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1238ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1239ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1240ea2453d5SPantelis Antoniou
1241001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1242001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1243001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1244001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1245001a8319SHeiko Schocher
1246001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1247001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1248001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1249001a8319SHeiko Schocher		sending again an USB request to the device.
1250001a8319SHeiko Schocher
12513aab70afSSebastian Siewior- USB Device Android Fastboot support:
125217da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
125317da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
125417da3c0cSPaul Kocialkowski
12553aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
12563aab70afSSebastian Siewior		This enables support for booting images which use the Android
12573aab70afSSebastian Siewior		image format header.
12583aab70afSSebastian Siewior
1259a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
12603aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
12613aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
12623aab70afSSebastian Siewior		downloaded images.
12633aab70afSSebastian Siewior
1264a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
12653aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
12663aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
12673aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
12683aab70afSSebastian Siewior
1269d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1270d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1271d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1272d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1273d1b5ed07SSteve Rae
1274d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1275d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1276d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1277d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1278d1b5ed07SSteve Rae
12790ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
12800ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
12810ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
12820ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
12830ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
12840ff7e585SSteve Rae		This occurs when the specified "partition name" on the
12850ff7e585SSteve Rae		"fastboot flash" command line matches this value.
12866f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
12870ff7e585SSteve Rae
1288b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1289b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1290b6dd69a4SPetr Kulhavy		image to DOS MBR.
1291b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1292b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1293b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1294b6dd69a4SPetr Kulhavy
12956705d81eSwdenk- Journaling Flash filesystem support:
1296b2482dffSSimon Glass		CONFIG_JFFS2_NAND
12976705d81eSwdenk		Define these for a default partition on a NAND device
12986705d81eSwdenk
12996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13016705d81eSwdenk		Define these for a default partition on a NOR device
13026705d81eSwdenk
1303c609719bSwdenk- Keyboard Support:
130439f615edSSimon Glass		See Kconfig help for available keyboard drivers.
130539f615edSSimon Glass
130639f615edSSimon Glass		CONFIG_KEYBOARD
130739f615edSSimon Glass
130839f615edSSimon Glass		Define this to enable a custom keyboard support.
130939f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
131039f615edSSimon Glass		defined in your board-specific files. This option is deprecated
131139f615edSSimon Glass		and is only used by novena. For new boards, use driver model
131239f615edSSimon Glass		instead.
1313c609719bSwdenk
1314c609719bSwdenk- Video support:
13157d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13167d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13177d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13187d3053fbSTimur Tabi		support, and should also define these other macros:
13197d3053fbSTimur Tabi
13207d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13217d3053fbSTimur Tabi			CONFIG_VIDEO
13227d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13237d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13247d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13257d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13267d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13277d3053fbSTimur Tabi
1328ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1329ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
13308eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1331ba8e76bdSTimur Tabi		description of this variable.
13327d3053fbSTimur Tabi
1333c609719bSwdenk- LCD Support:	CONFIG_LCD
1334c609719bSwdenk
1335c609719bSwdenk		Define this to enable LCD support (for output to LCD
1336c609719bSwdenk		display); also select one of the supported displays
1337c609719bSwdenk		by defining one of these:
1338c609719bSwdenk
133939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
134039cf4804SStelian Pop
134139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
134239cf4804SStelian Pop
1343fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1344c609719bSwdenk
1345fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1346c609719bSwdenk
1347fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1348c609719bSwdenk
1349fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1350fd3103bbSwdenk			Active, color, single scan.
1351fd3103bbSwdenk
1352fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1353fd3103bbSwdenk
1354fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1355c609719bSwdenk			Active, color, single scan.
1356c609719bSwdenk
1357c609719bSwdenk		CONFIG_SHARP_16x9
1358c609719bSwdenk
1359c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1360c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1361c609719bSwdenk
1362c609719bSwdenk		CONFIG_SHARP_LQ64D341
1363c609719bSwdenk
1364c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1365c609719bSwdenk			Active, color, single scan.
1366c609719bSwdenk
1367c609719bSwdenk		CONFIG_HLD1045
1368c609719bSwdenk
1369c609719bSwdenk			HLD1045 display, 640x480.
1370c609719bSwdenk			Active, color, single scan.
1371c609719bSwdenk
1372c609719bSwdenk		CONFIG_OPTREX_BW
1373c609719bSwdenk
1374c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1375c609719bSwdenk			or
1376c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1377c609719bSwdenk			or
1378c609719bSwdenk			Hitachi	 SP14Q002
1379c609719bSwdenk
1380c609719bSwdenk			320x240. Black & white.
1381c609719bSwdenk
1382676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1383676d319eSSimon Glass
1384b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1385676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1386676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1387676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1388676d319eSSimon Glass		a per-section basis.
1389676d319eSSimon Glass
1390676d319eSSimon Glass
1391604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1392604c7d4aSHannes Petermaier
1393604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1394604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1395604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1396604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1397604c7d4aSHannes Petermaier		printed out.
1398604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1399604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1400604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1401604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1402604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1403604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1404604c7d4aSHannes Petermaier		1 = 90 degree rotation
1405604c7d4aSHannes Petermaier		2 = 180 degree rotation
1406604c7d4aSHannes Petermaier		3 = 270 degree rotation
1407604c7d4aSHannes Petermaier
1408604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1409604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1410604c7d4aSHannes Petermaier
141145d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
141245d7f525STom Wai-Hong Tam
141345d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
141445d7f525STom Wai-Hong Tam
1415735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1416735987c5STom Wai-Hong Tam
1417735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1418735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1419735987c5STom Wai-Hong Tam
14207152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1421d791b1dcSwdenk
1422d791b1dcSwdenk		If this option is set, the environment is checked for
1423d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1424d791b1dcSwdenk		of logo, copyright and system information on the LCD
1425e94d2cd9Swdenk		is suppressed and the BMP image at the address
1426d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1427d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1428d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1429d791b1dcSwdenk		loaded very quickly after power-on.
1430d791b1dcSwdenk
1431c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1432c0880485SNikita Kiryanov
1433c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1434c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1435ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1436c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1437c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1438c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1439c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1440c0880485SNikita Kiryanov		there is no need to set this option.
1441c0880485SNikita Kiryanov
14421ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14431ca298ceSMatthias Weisser
14441ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14451ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14461ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14471ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14481ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14491ca298ceSMatthias Weisser		specify 'm' for centering the image.
14501ca298ceSMatthias Weisser
14511ca298ceSMatthias Weisser		Example:
14521ca298ceSMatthias Weisser		setenv splashpos m,m
14531ca298ceSMatthias Weisser			=> image at center of screen
14541ca298ceSMatthias Weisser
14551ca298ceSMatthias Weisser		setenv splashpos 30,20
14561ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14571ca298ceSMatthias Weisser
14581ca298ceSMatthias Weisser		setenv splashpos -10,m
14591ca298ceSMatthias Weisser			=> vertically centered image
14601ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14611ca298ceSMatthias Weisser
146298f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
146398f4a3dfSStefan Roese
146498f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
146598f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
146698f4a3dfSStefan Roese		splashscreen support or the bmp command.
146798f4a3dfSStefan Roese
1468d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1469d5011762SAnatolij Gustschin
1470d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1471d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1472d5011762SAnatolij Gustschin		bmp command.
1473d5011762SAnatolij Gustschin
1474c29fdfc1Swdenk- Compression support:
14758ef70478SKees Cook		CONFIG_GZIP
14768ef70478SKees Cook
14778ef70478SKees Cook		Enabled by default to support gzip compressed images.
14788ef70478SKees Cook
1479c29fdfc1Swdenk		CONFIG_BZIP2
1480c29fdfc1Swdenk
1481c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1482c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1483c29fdfc1Swdenk		compressed images are supported.
1484c29fdfc1Swdenk
1485c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
14866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1487c29fdfc1Swdenk		be at least 4MB.
1488d791b1dcSwdenk
148917ea1177Swdenk- MII/PHY support:
149017ea1177Swdenk		CONFIG_PHY_ADDR
149117ea1177Swdenk
149217ea1177Swdenk		The address of PHY on MII bus.
149317ea1177Swdenk
149417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
149517ea1177Swdenk
149617ea1177Swdenk		The clock frequency of the MII bus
149717ea1177Swdenk
149817ea1177Swdenk		CONFIG_PHY_RESET_DELAY
149917ea1177Swdenk
150017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
150117ea1177Swdenk		reset before any MII register access is possible.
150217ea1177Swdenk		For such PHY, set this option to the usec delay
150317ea1177Swdenk		required. (minimum 300usec for LXT971A)
150417ea1177Swdenk
150517ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
150617ea1177Swdenk
150717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
150817ea1177Swdenk		command issued before MII status register can be read
150917ea1177Swdenk
1510c609719bSwdenk- IP address:
1511c609719bSwdenk		CONFIG_IPADDR
1512c609719bSwdenk
1513c609719bSwdenk		Define a default value for the IP address to use for
151411ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1515c609719bSwdenk		determined through e.g. bootp.
15161ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1517c609719bSwdenk
1518c609719bSwdenk- Server IP address:
1519c609719bSwdenk		CONFIG_SERVERIP
1520c609719bSwdenk
1521c609719bSwdenk		Defines a default value for the IP address of a TFTP
1522c609719bSwdenk		server to contact when using the "tftboot" command.
15231ebcd654SWolfgang Denk		(Environment variable "serverip")
1524c609719bSwdenk
152597cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
152697cfe861SRobin Getz
152797cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
152897cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
152997cfe861SRobin Getz
15301ebcd654SWolfgang Denk- Gateway IP address:
15311ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15321ebcd654SWolfgang Denk
15331ebcd654SWolfgang Denk		Defines a default value for the IP address of the
15341ebcd654SWolfgang Denk		default router where packets to other networks are
15351ebcd654SWolfgang Denk		sent to.
15361ebcd654SWolfgang Denk		(Environment variable "gatewayip")
15371ebcd654SWolfgang Denk
15381ebcd654SWolfgang Denk- Subnet mask:
15391ebcd654SWolfgang Denk		CONFIG_NETMASK
15401ebcd654SWolfgang Denk
15411ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
15421ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
15431ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
15441ebcd654SWolfgang Denk		forwarded through a router.
15451ebcd654SWolfgang Denk		(Environment variable "netmask")
15461ebcd654SWolfgang Denk
154753a5c424SDavid Updegraff- Multicast TFTP Mode:
154853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
154953a5c424SDavid Updegraff
155053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
155153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
155211ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
155353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
155453a5c424SDavid Updegraff		multicast group.
155553a5c424SDavid Updegraff
1556c609719bSwdenk- BOOTP Recovery Mode:
1557c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1558c609719bSwdenk
1559c609719bSwdenk		If you have many targets in a network that try to
1560c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1561c609719bSwdenk		systems send out BOOTP requests at precisely the same
1562c609719bSwdenk		moment (which would happen for instance at recovery
1563c609719bSwdenk		from a power failure, when all systems will try to
1564c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1565c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1566c609719bSwdenk		inserted before sending out BOOTP requests. The
15676c33c785SWolfgang Denk		following delays are inserted then:
1568c609719bSwdenk
1569c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1570c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1571c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1572c609719bSwdenk		4th and following
1573c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1574c609719bSwdenk
157592ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
157692ac8accSThierry Reding
157792ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
157892ac8accSThierry Reding		server will copy the ID from client requests to responses and
157992ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
158092ac8accSThierry Reding		an incoming response. Some servers will check that addresses
158192ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
158292ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
158392ac8accSThierry Reding		respond. Network congestion may also influence the time it
158492ac8accSThierry Reding		takes for a response to make it back to the client. If that
158592ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
158692ac8accSThierry Reding		to allow earlier responses to still be accepted after these
158792ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
158892ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
158992ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
159092ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
159192ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
159292ac8accSThierry Reding
1593fe389a82Sstroese- DHCP Advanced Options:
15941fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
15951fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1596fe389a82Sstroese
15971fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
15981fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
15991fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16001fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16011fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16021fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16031fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16041fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16051fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16061fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16071fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16081fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16092c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1610fe389a82Sstroese
16115d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16125d110f0aSWilson Callan		environment variable, not the BOOTP server.
1613fe389a82Sstroese
16142c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16152c00e099SJoe Hershberger		after the configured retry count, the call will fail
16162c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16172c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16182c00e099SJoe Hershberger		is not available.
16192c00e099SJoe Hershberger
1620fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1621fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1622fe389a82Sstroese		than one DNS serverip is offered to the client.
1623fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1624fe389a82Sstroese		serverip will be stored in the additional environment
1625fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1626fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16271fe80d79SJon Loeliger		is defined.
1628fe389a82Sstroese
1629fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1630fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1631fe389a82Sstroese		need the hostname of the DHCP requester.
16325d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16331fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16341fe80d79SJon Loeliger		option 12 to the DHCP server.
1635fe389a82Sstroese
1636d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1637d9a2f416SAras Vaichas
1638d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1639d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1640d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1641d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1642d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1643d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1644d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1645d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1646d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1647d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1648d9a2f416SAras Vaichas		this delay.
1649d9a2f416SAras Vaichas
1650d22c338eSJoe Hershberger - Link-local IP address negotiation:
1651d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1652d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1653d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1654d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1655d22c338eSJoe Hershberger
1656d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1657d22c338eSJoe Hershberger
1658a3d991bdSwdenk - CDP Options:
1659a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1660a3d991bdSwdenk
1661a3d991bdSwdenk		The device id used in CDP trigger frames.
1662a3d991bdSwdenk
1663a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1664a3d991bdSwdenk
1665a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1666a3d991bdSwdenk		of the device.
1667a3d991bdSwdenk
1668a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1669a3d991bdSwdenk
1670a3d991bdSwdenk		A printf format string which contains the ascii name of
1671a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
167211ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1673a3d991bdSwdenk
1674a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1675a3d991bdSwdenk
1676a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1677a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1678a3d991bdSwdenk
1679a3d991bdSwdenk		CONFIG_CDP_VERSION
1680a3d991bdSwdenk
1681a3d991bdSwdenk		An ascii string containing the version of the software.
1682a3d991bdSwdenk
1683a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1684a3d991bdSwdenk
1685a3d991bdSwdenk		An ascii string containing the name of the platform.
1686a3d991bdSwdenk
1687a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1688a3d991bdSwdenk
1689a3d991bdSwdenk		A 32bit integer sent on the trigger.
1690a3d991bdSwdenk
1691a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1692a3d991bdSwdenk
1693a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1694a3d991bdSwdenk		device in .1 of milliwatts.
1695a3d991bdSwdenk
1696a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1697a3d991bdSwdenk
1698a3d991bdSwdenk		A byte containing the id of the VLAN.
1699a3d991bdSwdenk
170079267eddSUri Mashiach- Status LED:	CONFIG_LED_STATUS
1701c609719bSwdenk
1702c609719bSwdenk		Several configurations allow to display the current
1703c609719bSwdenk		status using a LED. For instance, the LED will blink
1704c609719bSwdenk		fast while running U-Boot code, stop blinking as
1705c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1706c609719bSwdenk		start blinking slow once the Linux kernel is running
1707c609719bSwdenk		(supported by a status LED driver in the Linux
170879267eddSUri Mashiach		kernel). Defining CONFIG_LED_STATUS enables this
1709c609719bSwdenk		feature in U-Boot.
1710c609719bSwdenk
17111df7bbbaSIgor Grinberg		Additional options:
17121df7bbbaSIgor Grinberg
171379267eddSUri Mashiach		CONFIG_LED_STATUS_GPIO
17141df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
17151df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
171679267eddSUri Mashiach		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
17171df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
17181df7bbbaSIgor Grinberg
17199dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
17209dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
17219dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
17229dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
17239dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
17249dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
17259dfdcdfeSIgor Grinberg
17263f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1727c609719bSwdenk
17283f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
17293f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
17303f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
17313f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
17323f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
17333f4978c7SHeiko Schocher		interface.
17343f4978c7SHeiko Schocher
17353f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1736ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1737ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1738ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1739ea818dbbSHeiko Schocher		    for defining speed and slave address
1740ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1741ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1742ea818dbbSHeiko Schocher		    for defining speed and slave address
1743ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1744ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1745ea818dbbSHeiko Schocher		    for defining speed and slave address
1746ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1747ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1748ea818dbbSHeiko Schocher		    for defining speed and slave address
17493f4978c7SHeiko Schocher
175000f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
175100f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
175200f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
175300f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
175400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
175500f792e0SHeiko Schocher		    bus.
175600f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
175700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
175800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
175900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
176000f792e0SHeiko Schocher		    second bus.
176100f792e0SHeiko Schocher
17621f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
17631f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
17641f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
17651f2ba722SSimon Glass		    100000 and the slave addr 0!
17661f2ba722SSimon Glass
1767880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
1768880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1769880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1770880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1771880540deSDirk Eibach
1772fac96408Strem		- drivers/i2c/i2c_mxc.c
1773fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
177403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
177503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
177603544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
177703544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1778fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1779fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1780fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1781fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1782fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1783fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
178403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
178503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1786b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
1787fac96408Strem		for speed, and 0 for slave.
1788fac96408Strem
17891086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
17901086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
17911086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
17921086bfa9SNobuhiro Iwamatsu
17931086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
17941086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
17951086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
17961086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
17971086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
17981086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
17991086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
18001086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
18011086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
18021086bfa9SNobuhiro Iwamatsu
18032035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
18042035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
18052035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
18062035d77dSNobuhiro Iwamatsu
18072035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
18082035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
18092035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
18102035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
18112035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
18122035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
18132035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
18142035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
18152035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
18162035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1817b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
18182035d77dSNobuhiro Iwamatsu
18196789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
18206789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
18216789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
18226789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
18236789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
18246789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
18256789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
18266789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
18276789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
18286789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
18296789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
18306789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
18316789e84eSHeiko Schocher
18320bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
18330bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
18340bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
18350bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
18360bdffe71SHeiko Schocher
1837e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
1838e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
1839e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1840e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1841e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
1842e717fc6dSNaveen Krishna Ch
1843b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
1844b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
1845b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1846b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1847b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1848b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1849b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1850b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1851b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1852b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1853b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1854b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1855b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1856b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
1857071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1858071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1859071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1860071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1861071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1862071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1863071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1864071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1865071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
1866b46226bdSDirk Eibach
18673f4978c7SHeiko Schocher		additional defines:
18683f4978c7SHeiko Schocher
18693f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
1870945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
18713f4978c7SHeiko Schocher
18723f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
18733f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
18743f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
18753f4978c7SHeiko Schocher		omit this define.
18763f4978c7SHeiko Schocher
18773f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
18783f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
18793f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
18803f4978c7SHeiko Schocher		define.
18813f4978c7SHeiko Schocher
18823f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
1883b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
18843f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
18853f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
18863f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
18873f4978c7SHeiko Schocher
18883f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
18893f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
18903f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
18913f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
18923f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
18933f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
18943f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
18953f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
18963f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
18973f4978c7SHeiko Schocher					}
18983f4978c7SHeiko Schocher
18993f4978c7SHeiko Schocher		which defines
19003f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
1901ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1902ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1903ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1904ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1905ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
19063f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
1907ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1908ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
19093f4978c7SHeiko Schocher
19103f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
19113f4978c7SHeiko Schocher
1912ce3b5d69SSimon Glass- Legacy I2C Support:
1913ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
1914b37c7e5eSwdenk		then the following macros need to be defined (examples are
1915b37c7e5eSwdenk		from include/configs/lwmon.h):
1916c609719bSwdenk
1917c609719bSwdenk		I2C_INIT
1918c609719bSwdenk
1919b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1920c609719bSwdenk		controller or configure ports.
1921c609719bSwdenk
1922b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1923b37c7e5eSwdenk
1924c609719bSwdenk		I2C_ACTIVE
1925c609719bSwdenk
1926c609719bSwdenk		The code necessary to make the I2C data line active
1927c609719bSwdenk		(driven).  If the data line is open collector, this
1928c609719bSwdenk		define can be null.
1929c609719bSwdenk
1930b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1931b37c7e5eSwdenk
1932c609719bSwdenk		I2C_TRISTATE
1933c609719bSwdenk
1934c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1935c609719bSwdenk		(inactive).  If the data line is open collector, this
1936c609719bSwdenk		define can be null.
1937c609719bSwdenk
1938b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1939b37c7e5eSwdenk
1940c609719bSwdenk		I2C_READ
1941c609719bSwdenk
1942472d5460SYork Sun		Code that returns true if the I2C data line is high,
1943472d5460SYork Sun		false if it is low.
1944c609719bSwdenk
1945b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1946b37c7e5eSwdenk
1947c609719bSwdenk		I2C_SDA(bit)
1948c609719bSwdenk
1949472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
1950472d5460SYork Sun		is false, it clears it (low).
1951c609719bSwdenk
1952b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1953b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1954b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1955b37c7e5eSwdenk
1956c609719bSwdenk		I2C_SCL(bit)
1957c609719bSwdenk
1958472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
1959472d5460SYork Sun		is false, it clears it (low).
1960c609719bSwdenk
1961b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1962b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1963b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1964b37c7e5eSwdenk
1965c609719bSwdenk		I2C_DELAY
1966c609719bSwdenk
1967c609719bSwdenk		This delay is invoked four times per clock cycle so this
1968c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1969b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1970b37c7e5eSwdenk		like:
1971b37c7e5eSwdenk
1972b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1973c609719bSwdenk
1974793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1975793b5726SMike Frysinger
1976793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1977793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1978793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1979793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1980793b5726SMike Frysinger
1981793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1982793b5726SMike Frysinger		the generic GPIO functions.
1983793b5726SMike Frysinger
19846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
198547cd00faSwdenk
198647cd00faSwdenk		When a board is reset during an i2c bus transfer
198747cd00faSwdenk		chips might think that the current transfer is still
198847cd00faSwdenk		in progress. On some boards it is possible to access
198947cd00faSwdenk		the i2c SCLK line directly, either by using the
199047cd00faSwdenk		processor pin as a GPIO or by having a second pin
199147cd00faSwdenk		connected to the bus. If this option is defined a
199247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
199347cd00faSwdenk		is run early in the boot sequence.
199447cd00faSwdenk
1995bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1996bb99ad6dSBen Warren
1997bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1998bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1999bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2000bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2001bb99ad6dSBen Warren
20026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2003bb99ad6dSBen Warren
2004bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
20050f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
20060f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
20070f89c54bSPeter Tyser		a 1D array of device addresses
2008bb99ad6dSBen Warren
2009bb99ad6dSBen Warren		e.g.
2010bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
20116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2012bb99ad6dSBen Warren
2013bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2014bb99ad6dSBen Warren
2015bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2016945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2017bb99ad6dSBen Warren
2018bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2019bb99ad6dSBen Warren
20206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2021be5e6181STimur Tabi
2022be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2023be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2024be5e6181STimur Tabi
20256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
20260dc018ecSStefan Roese
20270dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
20280dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
20290dc018ecSStefan Roese
20302ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20312ac6985aSAndrew Dyer
20322ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20332ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20342ac6985aSAndrew Dyer		between writing the address pointer and reading the
20352ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20362ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20372ac6985aSAndrew Dyer		devices can use either method, but some require one or
20382ac6985aSAndrew Dyer		the other.
2039be5e6181STimur Tabi
2040c609719bSwdenk- SPI Support:	CONFIG_SPI
2041c609719bSwdenk
2042c609719bSwdenk		Enables SPI driver (so far only tested with
2043c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2044c609719bSwdenk		D/As on the SACSng board)
2045c609719bSwdenk
20466639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20476639562eSYoshihiro Shimoda
20486639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20496639562eSYoshihiro Shimoda		only SH7757 is supported.
20506639562eSYoshihiro Shimoda
2051c609719bSwdenk		CONFIG_SOFT_SPI
2052c609719bSwdenk
2053c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2054c609719bSwdenk		using hardware support. This is a general purpose
2055c609719bSwdenk		driver that only requires three general I/O port pins
2056c609719bSwdenk		(two outputs, one input) to function. If this is
2057c609719bSwdenk		defined, the board configuration must define several
2058c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2059c609719bSwdenk		an example, see include/configs/sacsng.h.
2060c609719bSwdenk
206104a9e118SBen Warren		CONFIG_HARD_SPI
206204a9e118SBen Warren
206304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
206404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
206504a9e118SBen Warren		must define a list of chip-select function pointers.
206604a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
206704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
206804a9e118SBen Warren
206938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
207038254f45SGuennadi Liakhovetski
207138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20722e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
207338254f45SGuennadi Liakhovetski
2074f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2075f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2076f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2077f659b573SHeiko Schocher
20780133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20790133502eSMatthias Fuchs
20800133502eSMatthias Fuchs		Enables FPGA subsystem.
20810133502eSMatthias Fuchs
20820133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20830133502eSMatthias Fuchs
20840133502eSMatthias Fuchs		Enables support for specific chip vendors.
20850133502eSMatthias Fuchs		(ALTERA, XILINX)
20860133502eSMatthias Fuchs
20870133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20880133502eSMatthias Fuchs
20890133502eSMatthias Fuchs		Enables support for FPGA family.
20900133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20910133502eSMatthias Fuchs
20920133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2093c609719bSwdenk
2094c609719bSwdenk		Specify the number of FPGA devices to support.
2095c609719bSwdenk
20966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2097c609719bSwdenk
2098c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2099c609719bSwdenk
21006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2101c609719bSwdenk
2102c609719bSwdenk		Enable checks on FPGA configuration interface busy
2103c609719bSwdenk		status by the configuration function. This option
2104c609719bSwdenk		will require a board or device specific function to
2105c609719bSwdenk		be written.
2106c609719bSwdenk
2107c609719bSwdenk		CONFIG_FPGA_DELAY
2108c609719bSwdenk
2109c609719bSwdenk		If defined, a function that provides delays in the FPGA
2110c609719bSwdenk		configuration driver.
2111c609719bSwdenk
21126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2113c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2114c609719bSwdenk
21156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2116c609719bSwdenk
2117c609719bSwdenk		Check for configuration errors during FPGA bitfile
2118c609719bSwdenk		loading. For example, abort during Virtex II
2119c609719bSwdenk		configuration if the INIT_B line goes low (which
2120c609719bSwdenk		indicated a CRC error).
2121c609719bSwdenk
21226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2123c609719bSwdenk
2124b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2125b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2126c609719bSwdenk		FPGA configuration sequence. The default time is 500
212711ccc33fSMarcel Ziswiler		ms.
2128c609719bSwdenk
21296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2130c609719bSwdenk
2131b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
213211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2133c609719bSwdenk
21346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2135c609719bSwdenk
2136c609719bSwdenk		Time to wait after FPGA configuration. The default is
213711ccc33fSMarcel Ziswiler		200 ms.
2138c609719bSwdenk
2139c609719bSwdenk- Configuration Management:
2140b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2141b2b8a696SStefan Roese
2142b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2143b2b8a696SStefan Roese		with a special header) as build targets. By defining
2144b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2145b2b8a696SStefan Roese		special image will be automatically built upon calling
21466de80f21SSimon Glass		make / buildman.
2147b2b8a696SStefan Roese
2148c609719bSwdenk		CONFIG_IDENT_STRING
2149c609719bSwdenk
2150c609719bSwdenk		If defined, this string will be added to the U-Boot
2151c609719bSwdenk		version information (U_BOOT_VERSION)
2152c609719bSwdenk
2153c609719bSwdenk- Vendor Parameter Protection:
2154c609719bSwdenk
2155c609719bSwdenk		U-Boot considers the values of the environment
2156c609719bSwdenk		variables "serial#" (Board Serial Number) and
21577152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2158c609719bSwdenk		are set once by the board vendor / manufacturer, and
2159c609719bSwdenk		protects these variables from casual modification by
2160c609719bSwdenk		the user. Once set, these variables are read-only,
2161c609719bSwdenk		and write or delete attempts are rejected. You can
216211ccc33fSMarcel Ziswiler		change this behaviour:
2163c609719bSwdenk
2164c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2165c609719bSwdenk		file, the write protection for vendor parameters is
216647cd00faSwdenk		completely disabled. Anybody can change or delete
2167c609719bSwdenk		these parameters.
2168c609719bSwdenk
216992ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
217092ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
217111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2172c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2173c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2174c609719bSwdenk		read-only.]
2175c609719bSwdenk
21762598090bSJoe Hershberger		The same can be accomplished in a more flexible way
21772598090bSJoe Hershberger		for any variable by configuring the type of access
21782598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
21792598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
21802598090bSJoe Hershberger
2181c609719bSwdenk- Protected RAM:
2182c609719bSwdenk		CONFIG_PRAM
2183c609719bSwdenk
2184c609719bSwdenk		Define this variable to enable the reservation of
2185c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2186c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2187c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2188c609719bSwdenk		this default value by defining an environment
2189c609719bSwdenk		variable "pram" to the number of kB you want to
2190c609719bSwdenk		reserve. Note that the board info structure will
2191c609719bSwdenk		still show the full amount of RAM. If pRAM is
2192c609719bSwdenk		reserved, a new environment variable "mem" will
2193c609719bSwdenk		automatically be defined to hold the amount of
2194c609719bSwdenk		remaining RAM in a form that can be passed as boot
2195c609719bSwdenk		argument to Linux, for instance like that:
2196c609719bSwdenk
2197fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2198c609719bSwdenk			saveenv
2199c609719bSwdenk
2200c609719bSwdenk		This way you can tell Linux not to use this memory,
2201c609719bSwdenk		either, which results in a memory region that will
2202c609719bSwdenk		not be affected by reboots.
2203c609719bSwdenk
2204c609719bSwdenk		*WARNING* If your board configuration uses automatic
2205c609719bSwdenk		detection of the RAM size, you must make sure that
2206c609719bSwdenk		this memory test is non-destructive. So far, the
2207c609719bSwdenk		following board configurations are known to be
2208c609719bSwdenk		"pRAM-clean":
2209c609719bSwdenk
22105b8e76c3SHeiko Schocher			IVMS8, IVML24, SPD8xx,
22111b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
22122eb48ff7SHeiko Schocher			FLAGADM
2213c609719bSwdenk
221440fef049SGabe Black- Access to physical memory region (> 4GB)
221540fef049SGabe Black		Some basic support is provided for operations on memory not
221640fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
221740fef049SGabe Black		support access to more than 4GB of memory on 32-bit
221840fef049SGabe Black		machines using physical address extension or similar.
221940fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
222040fef049SGabe Black		currently only supports clearing the memory.
222140fef049SGabe Black
2222c609719bSwdenk- Error Recovery:
2223c609719bSwdenk		CONFIG_PANIC_HANG
2224c609719bSwdenk
2225c609719bSwdenk		Define this variable to stop the system in case of a
2226c609719bSwdenk		fatal error, so that you have to reset it manually.
2227c609719bSwdenk		This is probably NOT a good idea for an embedded
222811ccc33fSMarcel Ziswiler		system where you want the system to reboot
2229c609719bSwdenk		automatically as fast as possible, but it may be
2230c609719bSwdenk		useful during development since you can try to debug
2231c609719bSwdenk		the conditions that lead to the situation.
2232c609719bSwdenk
2233c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2234c609719bSwdenk
2235c609719bSwdenk		This variable defines the number of retries for
2236c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2237c609719bSwdenk		before giving up the operation. If not defined, a
2238c609719bSwdenk		default value of 5 is used.
2239c609719bSwdenk
224040cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
224140cb90eeSGuennadi Liakhovetski
224240cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
224340cb90eeSGuennadi Liakhovetski
224448a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
224548a3e999STetsuyuki Kobayashi
224648a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
224748a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
224848a3e999STetsuyuki Kobayashi		try longer timeout such as
224948a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
225048a3e999STetsuyuki Kobayashi
2251c609719bSwdenk- Command Interpreter:
22528078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
225304a85b3bSwdenk
225404a85b3bSwdenk		Enable auto completion of commands using TAB.
225504a85b3bSwdenk
22566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2257c609719bSwdenk
2258c609719bSwdenk		This defines the secondary prompt string, which is
2259c609719bSwdenk		printed when the command interpreter needs more input
2260c609719bSwdenk		to complete a command. Usually "> ".
2261c609719bSwdenk
2262c609719bSwdenk	Note:
2263c609719bSwdenk
2264c609719bSwdenk		In the current implementation, the local variables
2265c609719bSwdenk		space and global environment variables space are
2266c609719bSwdenk		separated. Local variables are those you define by
22673b57fe0aSwdenk		simply typing `name=value'. To access a local
2268c609719bSwdenk		variable later on, you have write `$name' or
22693b57fe0aSwdenk		`${name}'; to execute the contents of a variable
22703b57fe0aSwdenk		directly type `$name' at the command prompt.
2271c609719bSwdenk
2272c609719bSwdenk		Global environment variables are those you use
2273c609719bSwdenk		setenv/printenv to work with. To run a command stored
2274c609719bSwdenk		in such a variable, you need to use the run command,
2275c609719bSwdenk		and you must not use the '$' sign to access them.
2276c609719bSwdenk
2277c609719bSwdenk		To store commands and special characters in a
2278c609719bSwdenk		variable, please use double quotation marks
2279c609719bSwdenk		surrounding the whole text of the variable, instead
2280c609719bSwdenk		of the backslashes before semicolons and special
2281c609719bSwdenk		symbols.
2282c609719bSwdenk
2283b445bbb4SJeremiah Mahler- Command Line Editing and History:
2284aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2285aa0c71acSWolfgang Denk
228611ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2287aa0c71acSWolfgang Denk		command line input operations
2288aa0c71acSWolfgang Denk
2289f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2290f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2291f3b267b3SMarek Vasut
2292f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2293f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2294f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2295f3b267b3SMarek Vasut		and PS2.
2296f3b267b3SMarek Vasut
2297a8c7c708Swdenk- Default Environment:
2298c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2299c609719bSwdenk
2300c609719bSwdenk		Define this to contain any number of null terminated
2301c609719bSwdenk		strings (variable = value pairs) that will be part of
23027152b1d0Swdenk		the default environment compiled into the boot image.
23032262cfeeSwdenk
2304c609719bSwdenk		For example, place something like this in your
2305c609719bSwdenk		board's config file:
2306c609719bSwdenk
2307c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2308c609719bSwdenk			"myvar1=value1\0" \
2309c609719bSwdenk			"myvar2=value2\0"
2310c609719bSwdenk
2311c609719bSwdenk		Warning: This method is based on knowledge about the
2312c609719bSwdenk		internal format how the environment is stored by the
23132262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2314c609719bSwdenk		interface! Although it is unlikely that this format
23157152b1d0Swdenk		will change soon, there is no guarantee either.
2316c609719bSwdenk		You better know what you are doing here.
2317c609719bSwdenk
2318c609719bSwdenk		Note: overly (ab)use of the default environment is
2319c609719bSwdenk		discouraged. Make sure to check other ways to preset
232074de7aefSWolfgang Denk		the environment like the "source" command or the
2321c609719bSwdenk		boot command first.
2322c609719bSwdenk
23235e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
23245e724ca2SStephen Warren
23255e724ca2SStephen Warren		Define this in order to add variables describing the
23265e724ca2SStephen Warren		U-Boot build configuration to the default environment.
23275e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
23285e724ca2SStephen Warren
23295e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
23305e724ca2SStephen Warren
23315e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23325e724ca2SStephen Warren		- CONFIG_SYS_CPU
23335e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23345e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23355e724ca2SStephen Warren		- CONFIG_SYS_SOC
23365e724ca2SStephen Warren
23377e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
23387e27f89fSTom Rini
23397e27f89fSTom Rini		Define this in order to add variables describing certain
23407e27f89fSTom Rini		run-time determined information about the hardware to the
23417e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
23427e27f89fSTom Rini
234306fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
234406fd8538SSimon Glass
234506fd8538SSimon Glass		Normally the environment is loaded when the board is
2346b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
234706fd8538SSimon Glass		that so that the environment is not available until
234806fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
234906fd8538SSimon Glass		this is instead controlled by the value of
235006fd8538SSimon Glass		/config/load-environment.
235106fd8538SSimon Glass
2352a8c7c708Swdenk- DataFlash Support:
23532abbe075Swdenk		CONFIG_HAS_DATAFLASH
23542abbe075Swdenk
23552abbe075Swdenk		Defining this option enables DataFlash features and
23562abbe075Swdenk		allows to read/write in Dataflash via the standard
23572abbe075Swdenk		commands cp, md...
23582abbe075Swdenk
2359f61ec45eSEric Nelson- Serial Flash support
236000fd59ddSSimon Glass		Usage requires an initial 'sf probe' to define the serial
2361f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2362f61ec45eSEric Nelson		commands.
2363f61ec45eSEric Nelson
2364f61ec45eSEric Nelson		The following defaults may be provided by the platform
2365f61ec45eSEric Nelson		to handle the common case when only a single serial
2366f61ec45eSEric Nelson		flash is present on the system.
2367f61ec45eSEric Nelson
2368f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2369f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2370f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2371f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2372f61ec45eSEric Nelson
23733f85ce27Swdenk		CONFIG_SYSTEMACE
23743f85ce27Swdenk
23753f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
23763f85ce27Swdenk		chips attached via some sort of local bus. The address
237711ccc33fSMarcel Ziswiler		of the chip must also be defined in the
23786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
23793f85ce27Swdenk
23803f85ce27Swdenk		#define CONFIG_SYSTEMACE
23816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
23823f85ce27Swdenk
23833f85ce27Swdenk		When SystemACE support is added, the "ace" device type
23843f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
23853f85ce27Swdenk
2386ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2387ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2388ecb0ccd9SWolfgang Denk
238928cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2390ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
239128cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2392ecb0ccd9SWolfgang Denk		number generator is used.
2393ecb0ccd9SWolfgang Denk
239428cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
239528cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
239628cb9375SWolfgang Denk		defined, the normal port 69 is used.
239728cb9375SWolfgang Denk
239828cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2399ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2400ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2401ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2402ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2403ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2404ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2405ecb0ccd9SWolfgang Denk
24069e50c406SHeiko Schocher- bootcount support:
24079e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
24089e50c406SHeiko Schocher
24099e50c406SHeiko Schocher		This enables the bootcounter support, see:
24109e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
24119e50c406SHeiko Schocher
24129e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
24139e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
24149e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
24159e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
24169e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
24179e50c406SHeiko Schocher		enable support for the bootcounter in RAM
24189e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
24199e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
24209e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
24219e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
24229e50c406SHeiko Schocher						    the bootcounter.
24239e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
242419c402afSSimon Glass
2425a8c7c708Swdenk- Show boot progress:
2426c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2427c609719bSwdenk
2428c609719bSwdenk		Defining this option allows to add some board-
2429c609719bSwdenk		specific code (calling a user-provided function
2430c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2431c609719bSwdenk		the system's boot progress on some display (for
2432c609719bSwdenk		example, some LED's) on your board. At the moment,
2433c609719bSwdenk		the following checkpoints are implemented:
2434c609719bSwdenk
243594fd1316SSimon Glass
24361372cce2SMarian BalakowiczLegacy uImage format:
24371372cce2SMarian Balakowicz
2438c609719bSwdenk  Arg	Where			When
2439c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2440c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2441c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2442c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2443c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2444c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2445c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2446c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2447c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
24481372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2449c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2450c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2451c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2452c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
24531372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2454c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
24551372cce2SMarian Balakowicz
24561372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
24571372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
24581372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
24591372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
24601372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
24611372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
24621372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
246311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
24641372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
24651372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
24661372cce2SMarian Balakowicz
2467ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2468c609719bSwdenk
2469a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
247063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
247163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
247263e73c9aSwdenk
2473566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2474566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2475566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2476566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2477566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2478566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2479566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2480566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2481566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2482566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2483566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2484566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2485566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2486566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2487566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2488566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2489566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2490566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2491566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2492566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2493566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2494566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2495566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2496566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2497566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2498566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2499566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2500566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2501566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2502566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2503566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2504566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2505566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2506566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2507566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2508566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2509566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2510566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2511566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2512566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2513566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2514566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2515566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2516566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2517566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2518566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2519566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2520c609719bSwdenk
2521566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2522c609719bSwdenk
2523566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2524566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2525566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2526206c60cbSwdenk
2527566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2528bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
2529bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
2530bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
2531566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2532566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
253374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
253474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2535566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2536c609719bSwdenk
25371372cce2SMarian BalakowiczFIT uImage format:
25381372cce2SMarian Balakowicz
25391372cce2SMarian Balakowicz  Arg	Where			When
25401372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
25411372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
25421372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
25431372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
25441372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
25451372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2546f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
25471372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
25481372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
25491372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
25501372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
25511372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
255211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
255311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
25541372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
25551372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
25561372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
25571372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
25581372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
25591372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
25601372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
25611372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
25621372cce2SMarian Balakowicz
25631372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
25641372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
25651372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
256611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
25671372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
25681372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
25691372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
25701372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
25711372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
25721372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
25731372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
25741372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
25751372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
25761372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
25771372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
25781372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
25791372cce2SMarian Balakowicz
258011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
25811372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
25821372cce2SMarian Balakowicz
258311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
25841372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
25851372cce2SMarian Balakowicz
258611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
25871372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
25881372cce2SMarian Balakowicz
258921d29f7fSHeiko Schocher- legacy image format:
259021d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
259121d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
259221d29f7fSHeiko Schocher
259321d29f7fSHeiko Schocher		Default:
259421d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
259521d29f7fSHeiko Schocher
259621d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
259721d29f7fSHeiko Schocher		disable the legacy image format
259821d29f7fSHeiko Schocher
259921d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
260021d29f7fSHeiko Schocher		enabled per default for backward compatibility.
260121d29f7fSHeiko Schocher
26024cf2609bSWolfgang Denk- Standalone program support:
26034cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
26044cf2609bSWolfgang Denk
26056feff899SWolfgang Denk		This option defines a board specific value for the
26066feff899SWolfgang Denk		address where standalone program gets loaded, thus
26076feff899SWolfgang Denk		overwriting the architecture dependent default
26084cf2609bSWolfgang Denk		settings.
26094cf2609bSWolfgang Denk
26104cf2609bSWolfgang Denk- Frame Buffer Address:
26114cf2609bSWolfgang Denk		CONFIG_FB_ADDR
26124cf2609bSWolfgang Denk
26134cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
261444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
261544a53b57SWolfgang Denk		when using a graphics controller has separate video
261644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
261744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
261844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
261944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
262044a53b57SWolfgang Denk		configured panel size.
26214cf2609bSWolfgang Denk
26224cf2609bSWolfgang Denk		Please see board_init_f function.
26234cf2609bSWolfgang Denk
2624cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2625cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2626cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2627cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2628cccfc2abSDetlev Zundel
2629cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2630cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2631cccfc2abSDetlev Zundel
2632cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2633cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2634cccfc2abSDetlev Zundel
2635cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2636cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2637cccfc2abSDetlev Zundel
2638cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2639cccfc2abSDetlev Zundel
2640cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2641cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2642cccfc2abSDetlev Zundel
264370c219cdSJoe Hershberger- UBI support
2644147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2645147162daSJoe Hershberger
2646147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2647147162daSJoe Hershberger		warnings and errors enabled.
2648147162daSJoe Hershberger
2649ff94bc40SHeiko Schocher
2650ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
2651ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
2652ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
2653ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
2654ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
2655ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
2656ff94bc40SHeiko Schocher
2657ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
2658ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
2659ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
2660ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
2661ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
2662ff94bc40SHeiko Schocher
2663ff94bc40SHeiko Schocher		default: 4096
2664ff94bc40SHeiko Schocher
2665ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
2666ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
2667ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
2668ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
2669ff94bc40SHeiko Schocher		flash), this value is ignored.
2670ff94bc40SHeiko Schocher
2671ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
2672ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
2673ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
2674ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2675ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
2676ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
2677ff94bc40SHeiko Schocher
2678ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
2679ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
2680ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
2681ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
2682ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
2683ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
2684ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
2685ff94bc40SHeiko Schocher		partition.
2686ff94bc40SHeiko Schocher
2687ff94bc40SHeiko Schocher		default: 20
2688ff94bc40SHeiko Schocher
2689ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
2690ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
2691ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
2692ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
2693ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
2694ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
2695ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
2696ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
2697ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2698ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
2699ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
2700ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2701ff94bc40SHeiko Schocher
2702ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2703ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
2704ff94bc40SHeiko Schocher		without a fastmap.
2705ff94bc40SHeiko Schocher		default: 0
2706ff94bc40SHeiko Schocher
27070195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
27080195a7bbSHeiko Schocher		Enable UBI fastmap debug
27090195a7bbSHeiko Schocher		default: 0
27100195a7bbSHeiko Schocher
271170c219cdSJoe Hershberger- UBIFS support
2712147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2713147162daSJoe Hershberger
2714147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2715147162daSJoe Hershberger		warnings and errors enabled.
2716147162daSJoe Hershberger
27176a11cf48SDaniel Schwierzeck- SPL framework
27186a11cf48SDaniel Schwierzeck		CONFIG_SPL
27196a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
27206a11cf48SDaniel Schwierzeck
272195579793STom Rini		CONFIG_SPL_LDSCRIPT
272295579793STom Rini		LDSCRIPT for linking the SPL binary.
272395579793STom Rini
27246ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
27256ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
27266ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
27276ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
27288960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
27296ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
27306ebc3461SAlbert ARIBAUD
273195579793STom Rini		CONFIG_SPL_MAX_SIZE
27326ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
27336ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
27346ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
27356ebc3461SAlbert ARIBAUD		not exceed it.
273695579793STom Rini
27376a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
27386a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
27396a11cf48SDaniel Schwierzeck
274094a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
274194a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
274294a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
274394a45bb1SScott Wood
274495579793STom Rini		CONFIG_SPL_BSS_START_ADDR
274595579793STom Rini		Link address for the BSS within the SPL binary.
274695579793STom Rini
274795579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
27486ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
27496ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
27506ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
27518960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
27526ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
275395579793STom Rini
275495579793STom Rini		CONFIG_SPL_STACK
275595579793STom Rini		Adress of the start of the stack SPL will use
275695579793STom Rini
27578c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
27588c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
27598c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
27608c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
27618c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
27628c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
27638c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
27648c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
27658c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
27668c80eb3bSAlbert ARIBAUD \(3ADEV\)
276794a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
276894a45bb1SScott Wood		Adress of the start of the stack SPL will use after
276994a45bb1SScott Wood		relocation.  If unspecified, this is equal to
277094a45bb1SScott Wood		CONFIG_SPL_STACK.
277194a45bb1SScott Wood
277295579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
277395579793STom Rini		Starting address of the malloc pool used in SPL.
27749ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
27759ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
27769ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
277795579793STom Rini
277895579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
277995579793STom Rini		The size of the malloc pool used in SPL.
27806a11cf48SDaniel Schwierzeck
278147f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
278247f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
278347f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
278447f7bcaeSTom Rini		NAND loading of the Linux Kernel.
278547f7bcaeSTom Rini
27869607faf2STom Rini		CONFIG_SPL_OS_BOOT
27879607faf2STom Rini		Enable booting directly to an OS from SPL.
27889607faf2STom Rini		See also: doc/README.falcon
27899607faf2STom Rini
2790861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2791861a86f4STom Rini		For ARM, enable an optional function to print more information
2792861a86f4STom Rini		about the running system.
2793861a86f4STom Rini
27944b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
27954b919725SScott Wood		Arch init code should be built for a very small image
27964b919725SScott Wood
2797b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2798b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2799b97300b6SPaul Kocialkowski		used in raw mode
2800b97300b6SPaul Kocialkowski
28012b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
28022b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
28032b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
28042b75b0adSPeter Korsgaard
28052b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
28062b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
28072b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
28082b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
28092b75b0adSPeter Korsgaard		(for falcon mode)
28102b75b0adSPeter Korsgaard
2811e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2812e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2813e2ccdf89SPaul Kocialkowski		used in fs mode
2814e2ccdf89SPaul Kocialkowski
2815fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
2816fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
2817fae81c72SGuillaume GARDET
2818fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
28197ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
2820fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
28217ad2cc79SPeter Korsgaard
2822fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
28237ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
2824fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
28257ad2cc79SPeter Korsgaard
282606f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
282706f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
282806f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
282906f60ae3SScott Wood		continuing (the hardware starts execution after just
283006f60ae3SScott Wood		loading the first page rather than the full 4K).
283106f60ae3SScott Wood
2832651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
2833651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
2834651fcf60SPrabhakar Kushwaha
28356f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
28366f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
28376f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
28386f2f01b9SScott Wood
28396f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
28406f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
28416f2f01b9SScott Wood
28426f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
28436f2f01b9SScott Wood		Include standard software ECC in the SPL
28446f2f01b9SScott Wood
284595579793STom Rini		CONFIG_SPL_NAND_SIMPLE
28467d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
28477d4b7955SScott Wood		expose the cmd_ctrl() interface.
284895579793STom Rini
28496f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
28506f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
28516f4e7d3cSThomas Gleixner		loader
28526f4e7d3cSThomas Gleixner
28530c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
28540c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
28550c3117b1SHeiko Schocher		if you need to save space.
28560c3117b1SHeiko Schocher
28577c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
28587c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
28597c8eea59SYing Zhang		SPL binary.
28607c8eea59SYing Zhang
286195579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
286295579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
286395579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
286495579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
286595579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
286695579793STom Rini		Defines the size and behavior of the NAND that SPL uses
28677d4b7955SScott Wood		to read U-Boot
286895579793STom Rini
2869fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
2870fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
2871fbe76ae4SPrabhakar Kushwaha
287295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
28737d4b7955SScott Wood		Location in NAND to read U-Boot from
28747d4b7955SScott Wood
28757d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
28767d4b7955SScott Wood		Location in memory to load U-Boot to
28777d4b7955SScott Wood
28787d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
28797d4b7955SScott Wood		Size of image to load
288095579793STom Rini
288195579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
28827d4b7955SScott Wood		Entry point in loaded image to jump to
288395579793STom Rini
288495579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
288595579793STom Rini		Define this if you need to first read the OOB and then the
2886b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
288795579793STom Rini
288895579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
288995579793STom Rini		Support for an OMAP3-specific set of functions to return the
289095579793STom Rini		ID and MFR of the first attached NAND chip, if present.
289195579793STom Rini
2892c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2893c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2894c57b953dSPavel Machek
289574752baaSScott Wood		CONFIG_SPL_PAD_TO
28966113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
28976113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
28986113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
28996113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
29006113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
290174752baaSScott Wood
2902ca2fca22SScott Wood		CONFIG_SPL_TARGET
2903ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
2904ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
2905ca2fca22SScott Wood		example if more than one image needs to be produced.
2906ca2fca22SScott Wood
290787ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
290887ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
290987ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
291087ebee39SSimon Glass		option to re-enable it. This will affect the output of the
291187ebee39SSimon Glass		bootm command when booting a FIT image.
291287ebee39SSimon Glass
29133aa29de0SYing Zhang- TPL framework
29143aa29de0SYing Zhang		CONFIG_TPL
29153aa29de0SYing Zhang		Enable building of TPL globally.
29163aa29de0SYing Zhang
29173aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
29183aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
29193aa29de0SYing Zhang		the TPL payload. By default, this is defined as
29203aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
29213aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
29223aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
29233aa29de0SYing Zhang
2924a8c7c708Swdenk- Interrupt support (PPC):
2925a8c7c708Swdenk
2926a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2927a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
292811ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2929a8c7c708Swdenk		should set decrementer_count to appropriate value. If
293011ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2931a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
293211ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2933a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2934a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2935a8c7c708Swdenk		general timer_interrupt().
2936a8c7c708Swdenk
2937c609719bSwdenk
29389660e442SHelmut RaigerBoard initialization settings:
29399660e442SHelmut Raiger------------------------------
29409660e442SHelmut Raiger
29419660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
29429660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
29439660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
29449660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
29459660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
29469660e442SHelmut Raigertypically in board_init_f() and board_init_r().
29479660e442SHelmut Raiger
29489660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
29499660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
29509660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
29519660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2952c609719bSwdenk
2953c609719bSwdenkConfiguration Settings:
2954c609719bSwdenk-----------------------
2955c609719bSwdenk
29564d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
29574d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
29584d1fd7f1SYork Sun
29596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2960c609719bSwdenk		undefine this when you're short of memory.
2961c609719bSwdenk
29622fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
29632fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
29642fb2604dSPeter Tyser
29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2966c609719bSwdenk		prompt for user input.
2967c609719bSwdenk
29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2969c609719bSwdenk
29706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2971c609719bSwdenk
29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2973c609719bSwdenk
29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2975c609719bSwdenk		the application (usually a Linux kernel) when it is
2976c609719bSwdenk		booted
2977c609719bSwdenk
29786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2979c609719bSwdenk		List of legal baudrate settings for this board.
2980c609719bSwdenk
29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2982c609719bSwdenk		Begin and End addresses of the area used by the
2983c609719bSwdenk		simple memory test.
2984c609719bSwdenk
29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2986c609719bSwdenk		Enable an alternate, more extensive memory test.
2987c609719bSwdenk
29886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
29895f535fe1Swdenk		Scratch address used by the alternate memory test
29905f535fe1Swdenk		You only need to set this if address zero isn't writeable
29915f535fe1Swdenk
2992e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
2993e61a7534SYork Sun		Only implemented for ARMv8 for now.
2994e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
2995e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
2996e8149522SYork Sun		This memory can be used as secure memory. A variable
2997e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
2998e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
2999e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3000e8149522SYork Sun
3001aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
30026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
300314f73ca6SStefan Roese		this specified memory area will get subtracted from the top
300411ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
300514f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
300614f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
300714f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
30085e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
300914f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
30105e12e75dSStefan Roese		will have to get fixed in Linux additionally.
301114f73ca6SStefan Roese
301214f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
301314f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
301414f73ca6SStefan Roese		be touched.
301514f73ca6SStefan Roese
301614f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
301714f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
301814f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
301914f73ca6SStefan Roese		non page size aligned address and this could cause major
302014f73ca6SStefan Roese		problems.
302114f73ca6SStefan Roese
30226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3023c609719bSwdenk		Enable temporary baudrate change while serial download
3024c609719bSwdenk
30256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3026c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3027c609719bSwdenk
30286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3029c609719bSwdenk		Physical start address of Flash memory.
3030c609719bSwdenk
30316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3032c609719bSwdenk		Physical start address of boot monitor code (set by
3033c609719bSwdenk		make config files to be same as the text base address
303414d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
30356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3036c609719bSwdenk
30376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
30383b57fe0aSwdenk		Size of memory reserved for monitor code, used to
30393b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
30403b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
30413b57fe0aSwdenk		flash sector.
3042c609719bSwdenk
30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3044c609719bSwdenk		Size of DRAM reserved for malloc() use.
3045c609719bSwdenk
3046d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3047d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3048d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3049d59476b6SSimon Glass		will become available before relocation. The address is just
3050d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3051d59476b6SSimon Glass		space.
3052d59476b6SSimon Glass
3053d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3054d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3055d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3056b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3057d59476b6SSimon Glass		U-Boot relocates itself.
3058d59476b6SSimon Glass
305938687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
306038687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
306138687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
306238687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
306338687ae6SSimon Glass
30641dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
30651dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
30661dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
30671dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
30681dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
30691dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
30701dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
30711dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
30721dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
30731dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
30741dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
30751dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
30761dfdd9baSThierry Reding		written to another region in the same cache-line. This can
30771dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
30781dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
30791dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
30801dfdd9baSThierry Reding
30811dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
30821dfdd9baSThierry Reding
30836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
308415940c9aSStefan Roese		Normally compressed uImages are limited to an
308515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
30866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
308715940c9aSStefan Roese		to adjust this setting to your needs.
3088c609719bSwdenk
30896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3090c609719bSwdenk		Maximum size of memory mapped by the startup code of
3091c609719bSwdenk		the Linux kernel; all data that must be processed by
30927d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
30937d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
30941bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
30957d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3096c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3097c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3098c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3099c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3100c609719bSwdenk
3101fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3102fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3103fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3104fca43cc8SJohn Rigby		is enabled.
3105fca43cc8SJohn Rigby
3106fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3107fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3108fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3109fca43cc8SJohn Rigby
3110fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3111fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3112fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3113fca43cc8SJohn Rigby
31146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3115c609719bSwdenk		Max number of Flash memory banks
3116c609719bSwdenk
31176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3118c609719bSwdenk		Max number of sectors on a Flash chip
3119c609719bSwdenk
31206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3121c609719bSwdenk		Timeout for Flash erase operations (in ms)
3122c609719bSwdenk
31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3124c609719bSwdenk		Timeout for Flash write operations (in ms)
3125c609719bSwdenk
31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
31278564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
31288564acf9Swdenk
31296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
31308564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
31318564acf9Swdenk
31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
31338564acf9Swdenk		If defined, hardware flash sectors protection is used
31348564acf9Swdenk		instead of U-Boot software protection.
31358564acf9Swdenk
31366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3137c609719bSwdenk
3138c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3139c609719bSwdenk		without this option such a download has to be
3140c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3141c609719bSwdenk		copy from RAM to flash.
3142c609719bSwdenk
3143c609719bSwdenk		The two-step approach is usually more reliable, since
3144c609719bSwdenk		you can check if the download worked before you erase
314511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
314611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3147c609719bSwdenk		downloaded image) this option may be very useful.
3148c609719bSwdenk
31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3150c609719bSwdenk		Define if the flash driver uses extra elements in the
31515653fc33Swdenk		common flash structure for storing flash geometry.
31525653fc33Swdenk
315300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
31545653fc33Swdenk		This option also enables the building of the cfi_flash driver
31555653fc33Swdenk		in the drivers directory
315653cf9435Sstroese
315791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
315891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
315991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
316091809ed5SPiotr Ziecik		to the MTD layer.
316191809ed5SPiotr Ziecik
31626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
316396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
316496ef831fSGuennadi Liakhovetski
316596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
316696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
316796ef831fSGuennadi Liakhovetski		write commands.
316896ef831fSGuennadi Liakhovetski
31696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
31705568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
31715568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
31725568e613SStefan Roese		is useful, if some of the configured banks are only
31735568e613SStefan Roese		optionally available.
31745568e613SStefan Roese
31759a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
31769a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
31779a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
31789a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
31799a042e9cSJerry Van Baren
3180352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3181352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3182352ef3f1SStefan Roese		against the source after the write operation. An error message
3183352ef3f1SStefan Roese		will be printed when the contents are not identical.
3184352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3185352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3186352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3187352ef3f1SStefan Roese		this option if you really know what you are doing.
3188352ef3f1SStefan Roese
31896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
319011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
319111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
319253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
319353cf9435Sstroese		buffers can be full shortly after enabling the interface
319411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
319553cf9435Sstroese		Defaults to 4 if not defined.
3196c609719bSwdenk
3197ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3198ea882bafSWolfgang Denk
3199ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3200ea882bafSWolfgang Denk	internally to store the environment settings. The default
3201ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3202ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3203ea882bafSWolfgang Denk	lib/hashtable.c for details.
3204ea882bafSWolfgang Denk
32052598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
32062598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
32071bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
32082598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
32092598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
32102598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
32112598090bSJoe Hershberger
32122598090bSJoe Hershberger	The format of the list is:
32132598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3214b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3215b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
32162598090bSJoe Hershberger		entry = variable_name[:attributes]
32172598090bSJoe Hershberger		list = entry[,list]
32182598090bSJoe Hershberger
32192598090bSJoe Hershberger	The type attributes are:
32202598090bSJoe Hershberger		s - String (default)
32212598090bSJoe Hershberger		d - Decimal
32222598090bSJoe Hershberger		x - Hexadecimal
32232598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
32242598090bSJoe Hershberger		i - IP address
32252598090bSJoe Hershberger		m - MAC address
32262598090bSJoe Hershberger
3227267541f7SJoe Hershberger	The access attributes are:
3228267541f7SJoe Hershberger		a - Any (default)
3229267541f7SJoe Hershberger		r - Read-only
3230267541f7SJoe Hershberger		o - Write-once
3231267541f7SJoe Hershberger		c - Change-default
3232267541f7SJoe Hershberger
32332598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
32342598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3235b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
32362598090bSJoe Hershberger
32372598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
32382598090bSJoe Hershberger		Define this to a list (string) to define validation that
32392598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
32402598090bSJoe Hershberger		environment variable.  To override a setting in the static
32412598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
32422598090bSJoe Hershberger		".flags" variable.
32432598090bSJoe Hershberger
3244bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3245bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3246bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3247bdf1fe4eSJoe Hershberger
3248267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3249267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3250267541f7SJoe Hershberger	access flags.
3251267541f7SJoe Hershberger
32520d296cc2SGabe Black- CONFIG_USE_STDINT
32530d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
32540d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
32550d296cc2SGabe Black	building U-Boot to enable this.
32560d296cc2SGabe Black
3257c609719bSwdenkThe following definitions that deal with the placement and management
3258c609719bSwdenkof environment data (variable area); in general, we support the
3259c609719bSwdenkfollowing configurations:
3260c609719bSwdenk
3261c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3262c3eb3fe4SMike Frysinger
3263c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3264c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3265c3eb3fe4SMike Frysinger
3266c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3267b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
326811ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3269c609719bSwdenkU-Boot will hang.
3270c609719bSwdenk
3271c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3272c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3273c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3274c609719bSwdenkto save the current settings.
3275c609719bSwdenk
32760a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
32770a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3278fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3279fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
32800a85a9e7SLiu Gang
3281b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3282b74ab737SGuennadi Liakhovetski
3283b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3284b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3285b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3286b74ab737SGuennadi Liakhovetski
3287e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3288c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3289*00caae6dSSimon Glasscreated; also, when using EEPROM you will have to use env_get_f()
3290c609719bSwdenkuntil then to read environment variables.
3291c609719bSwdenk
329285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
329385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
329485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
329585ec0bccSwdenknecessary, because the first environment variable we need is the
329685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
329785ec0bccSwdenkhave any device yet where we could complain.]
3298c609719bSwdenk
3299c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3300c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
330185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3302c609719bSwdenk
33036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3304fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3305fc3e2165Swdenk
33066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3307fc3e2165Swdenk		      also needs to be defined.
3308fc3e2165Swdenk
33096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3310fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3311c609719bSwdenk
3312f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3313f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3314f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3315f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3316f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3317f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3318f5675aa5SRon Madrid
3319b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3320b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3321b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3322b2b92f53SSimon Glass		to do this.
3323b2b92f53SSimon Glass
3324e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3325e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3326e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3327e2e3e2b1SSimon Glass		present.
3328e2e3e2b1SSimon Glass
3329feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
3330feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
3331feb85801SSascha Silbe		build system checks that the actual size does not
3332feb85801SSascha Silbe		exceed it.
3333feb85801SSascha Silbe
3334c609719bSwdenkLow Level (hardware related) configuration options:
3335dc7c9a1aSwdenk---------------------------------------------------
3336c609719bSwdenk
33376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3338c609719bSwdenk		Cache Line Size of the CPU.
3339c609719bSwdenk
3340e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3341e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3342e46fedfeSTimur Tabi		PowerPC SOCs.
3343e46fedfeSTimur Tabi
3344e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3345e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3346e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3347e46fedfeSTimur Tabi
3348e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3349e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3350e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3351e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3352e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3353e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3354e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3355e46fedfeSTimur Tabi
3356e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3357e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3358e46fedfeSTimur Tabi
3359e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3360e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3361e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3362e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3363e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3364e46fedfeSTimur Tabi
3365e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3366e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3367e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3368e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3369e46fedfeSTimur Tabi
3370e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3371e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3372e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3373e46fedfeSTimur Tabi
33747f6c2cbcSwdenk- Floppy Disk Support:
33756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
33767f6c2cbcSwdenk
33777f6c2cbcSwdenk		the default drive number (default value 0)
33787f6c2cbcSwdenk
33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
33807f6c2cbcSwdenk
338111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
33827f6c2cbcSwdenk		(default value 1)
33837f6c2cbcSwdenk
33846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
33857f6c2cbcSwdenk
33867f6c2cbcSwdenk		defines the offset of register from address. It
33877f6c2cbcSwdenk		depends on which part of the data bus is connected to
338811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
33897f6c2cbcSwdenk
33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
33916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
33927f6c2cbcSwdenk		default value.
33937f6c2cbcSwdenk
33946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
33957f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
33967f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
3397b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
33987f6c2cbcSwdenk		initializations.
33997f6c2cbcSwdenk
34000abddf82SMacpaul Lin- CONFIG_IDE_AHB:
34010abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
34020abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
34030abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
34040abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
34050abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
3406b445bbb4SJeremiah Mahler		is required.
34070abddf82SMacpaul Lin
34086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
340925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
3410907208c4SChristophe Leroy		doing! (11-4) [MPC8xx systems only]
3411c609719bSwdenk
34126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3413c609719bSwdenk
34147152b1d0Swdenk		Start address of memory area that can be used for
3415c609719bSwdenk		initial data and stack; please note that this must be
3416c609719bSwdenk		writable memory that is working WITHOUT special
3417c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3418c609719bSwdenk		will become available only after programming the
3419c609719bSwdenk		memory controller and running certain initialization
3420c609719bSwdenk		sequences.
3421c609719bSwdenk
3422c609719bSwdenk		U-Boot uses the following memory types:
3423907208c4SChristophe Leroy		- MPC8xx: IMMR (internal memory of the CPU)
3424c609719bSwdenk
34256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3426c609719bSwdenk
3427c609719bSwdenk		Offset of the initial data structure in the memory
34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
34296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3430c609719bSwdenk		data is located at the end of the available space
3431553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3432acd51f9dSSimon Glass		GENERATED_GBL_DATA_SIZE), and the initial stack is just
34336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
34346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3435c609719bSwdenk
3436c609719bSwdenk	Note:
3437c609719bSwdenk		On the MPC824X (or other systems that use the data
3438c609719bSwdenk		cache for initial memory) the address chosen for
34396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3440c609719bSwdenk		point to an otherwise UNUSED address space between
3441c609719bSwdenk		the top of RAM and the start of the PCI space.
3442c609719bSwdenk
34436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3444c609719bSwdenk
34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3446c609719bSwdenk		SDRAM timing
3447c609719bSwdenk
34486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3449c609719bSwdenk		periodic timer for refresh
3450c609719bSwdenk
34516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
34526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
34536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
34546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3455c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3456c609719bSwdenk
3457c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3460c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3461c609719bSwdenk
346269fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
3463b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
346469fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
346569fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
346669fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
346769fd2d3bSAndrew Sharp		by coreboot or similar.
346869fd2d3bSAndrew Sharp
3469842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
3470842033e6SGabor Juhos		Enable support for indirect PCI bridges.
3471842033e6SGabor Juhos
3472a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3473a09b9b68SKumar Gala		Chip has SRIO or not
3474a09b9b68SKumar Gala
3475a09b9b68SKumar Gala- CONFIG_SRIO1:
3476a09b9b68SKumar Gala		Board has SRIO 1 port available
3477a09b9b68SKumar Gala
3478a09b9b68SKumar Gala- CONFIG_SRIO2:
3479a09b9b68SKumar Gala		Board has SRIO 2 port available
3480a09b9b68SKumar Gala
3481c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
3482c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
3483c8b28152SLiu Gang
3484a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3485a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3486a09b9b68SKumar Gala
3487a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3488a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3489a09b9b68SKumar Gala
3490a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3491a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3492a09b9b68SKumar Gala
349366bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
349466bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
349566bd1846SFabio Estevam		a 16 bit bus.
349666bd1846SFabio Estevam		Not all NAND drivers use this symbol.
3497a430e916SFabio Estevam		Example of drivers that use it:
349866bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
3499a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
3500eced4626SAlex Waterman
3501eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3502eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3503eced4626SAlex Waterman		a default value will be used.
3504eced4626SAlex Waterman
3505bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3506218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3507218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3508218ca724SWolfgang Denk
3509bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3510bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3511bb99ad6dSBen Warren
35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3513218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3514218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3515218ca724SWolfgang Denk		to something your driver can deal with.
3516bb99ad6dSBen Warren
35171b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
35181b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
35191b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
35201b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
35211b3e3c4fSYork Sun		header files or board specific files.
35221b3e3c4fSYork Sun
35236f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
35246f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
35256f5e1dc5SYork Sun
3526e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
3527e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
3528e32d59a2SYork Sun
35294516ff81SYork Sun- CONFIG_FSL_DDR_BIST
35304516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
35314516ff81SYork Sun
35326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3533218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3534218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
35352ad6b513STimur Tabi
3536c26e454dSwdenk- CONFIG_RMII
3537c26e454dSwdenk		Enable RMII mode for all FECs.
3538c26e454dSwdenk		Note that this is a global option, we can't
3539c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3540c26e454dSwdenk
35415cf91d6bSwdenk- CONFIG_CRC32_VERIFY
35425cf91d6bSwdenk		Add a verify option to the crc32 command.
35435cf91d6bSwdenk		The syntax is:
35445cf91d6bSwdenk
35455cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
35465cf91d6bSwdenk
35475cf91d6bSwdenk		Where address/count indicate a memory area
35485cf91d6bSwdenk		and crc32 is the correct crc32 which the
35495cf91d6bSwdenk		area should have.
35505cf91d6bSwdenk
355156523f12Swdenk- CONFIG_LOOPW
355256523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3553493f420eSSimon Glass		the memory commands are activated globally (CONFIG_CMD_MEMORY).
355456523f12Swdenk
35557b466641Sstroese- CONFIG_MX_CYCLIC
35567b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
35577b466641Sstroese		"md/mw" commands.
35587b466641Sstroese		Examples:
35597b466641Sstroese
35607b466641Sstroese		=> mdc.b 10 4 500
35617b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
35627b466641Sstroese
35637b466641Sstroese		=> mwc.l 100 12345678 10
35647b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
35657b466641Sstroese
35667b466641Sstroese		This only takes effect if the memory commands are activated
3567493f420eSSimon Glass		globally (CONFIG_CMD_MEMORY).
35687b466641Sstroese
35698aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3570afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3571e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3572e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3573e03f3169SWolfgang Denk		relocate itself into RAM.
35748aa1a2d1Swdenk
3575e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3576e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3577e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3578e03f3169SWolfgang Denk		these initializations itself.
35798aa1a2d1Swdenk
3580b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
3581b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
358290211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
3583b5bd0982SSimon Glass		instruction cache) is still performed.
3584b5bd0982SSimon Glass
3585401bb30bSAneesh V- CONFIG_SPL_BUILD
3586df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3587df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3588df81238bSMagnus Lilja		compiling a NAND SPL.
3589400558b5Swdenk
35903aa29de0SYing Zhang- CONFIG_TPL_BUILD
35913aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
35923aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
35933aa29de0SYing Zhang		It is loaded by the SPL.
35943aa29de0SYing Zhang
35955df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
35965df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
35975df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
35985df572f0SYing Zhang		previous 4k of the .text section.
35995df572f0SYing Zhang
36004213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
36014213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
36024213fc29SSimon Glass		effective address. It is therefore not necessary to regard
36034213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
36044213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
36054213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
36064213fc29SSimon Glass		addressable memory. This option causes some memory accesses
36074213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
36084213fc29SSimon Glass
3609588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
3610588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
3611588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
3612b16f521aSGabe Black
361316678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
361416678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
361516678eb4SHeiko Schocher
3616999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
3617999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
3618999d7d32SKaricheri, Muralidharan		driver that uses this:
3619999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
3620999d7d32SKaricheri, Muralidharan
3621f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3622f2717b47STimur Tabi-----------------------------------
3623f2717b47STimur Tabi
3624f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3625f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3626f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3627f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3628f2717b47STimur Tabiwithin that device.
3629f2717b47STimur Tabi
3630dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
3631dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
3632dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3633dcf1d774SZhao Qiang	is also specified.
3634dcf1d774SZhao Qiang
3635dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
3636dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
3637f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3638f2717b47STimur Tabi	is also specified.
3639f2717b47STimur Tabi
3640f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3641f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3642f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3643f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3644f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3645f2717b47STimur Tabi
3646f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3647f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3648f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3649f2717b47STimur Tabi	virtual address in NOR flash.
3650f2717b47STimur Tabi
3651f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3652f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3653f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3654f2717b47STimur Tabi
3655f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3656f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3657f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3658f2717b47STimur Tabi
3659292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3660292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3661292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3662fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3663fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3664fc54c7faSLiu Gang	master's memory space.
3665f2717b47STimur Tabi
3666b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
3667b940ca64SJ. German Rivera---------------------------------------------------------
3668b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
3669b940ca64SJ. German Rivera"firmware".
3670b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
3671b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
3672b940ca64SJ. German Riverawithin that device.
3673b940ca64SJ. German Rivera
3674b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
3675b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
3676b940ca64SJ. German Rivera
36775c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
36785c055089SPrabhakar Kushwaha-------------------------------------------
36795c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
36805c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
36815c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
36825c055089SPrabhakar Kushwaha
3683c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
3684c0492141SYork Sun	Define alignment of reserved memory MC requires
36855c055089SPrabhakar Kushwaha
3686f3f431a7SPaul KocialkowskiReproducible builds
3687f3f431a7SPaul Kocialkowski-------------------
3688f3f431a7SPaul Kocialkowski
3689f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
3690f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
3691f3f431a7SPaul Kocialkowski
3692f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
3693f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
3694f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
3695f3f431a7SPaul Kocialkowski
3696f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
3697f3f431a7SPaul Kocialkowski
3698c609719bSwdenkBuilding the Software:
3699c609719bSwdenk======================
3700c609719bSwdenk
3701218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3702218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3703218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3704218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3705218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3706218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3707c609719bSwdenk
3708218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3709218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3710218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3711218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3712218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3713c609719bSwdenk
3714218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3715218ca724SWolfgang Denk	$ export CROSS_COMPILE
3716c609719bSwdenk
37172f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
37182f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
37192f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
37202f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
37212f8d396bSPeter Tyser
37222f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
37232f8d396bSPeter Tyser
37242f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
37252f8d396bSPeter Tyser      be executed on computers running Windows.
37262f8d396bSPeter Tyser
3727c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3728c609719bSwdenksources you must configure U-Boot for one specific board type. This
3729c609719bSwdenkis done by typing:
3730c609719bSwdenk
3731ab584d67SHolger Freyther	make NAME_defconfig
3732c609719bSwdenk
3733ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
37344d675ae6SMichael Jonesrations; see boards.cfg for supported names.
373554387ac9Swdenk
3736c609719bSwdenkNote: for some board special configuration names may exist; check if
3737c609719bSwdenk      additional information is available from the board vendor; for
37382729af9dSwdenk      instance, the TQM823L systems are available without (standard)
37392729af9dSwdenk      or with LCD support. You can select such additional "features"
374011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3741c609719bSwdenk
3742ab584d67SHolger Freyther      make TQM823L_defconfig
37432729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3744c609719bSwdenk
3745ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
3746c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3747c609719bSwdenk
3748c609719bSwdenk      etc.
3749c609719bSwdenk
3750c609719bSwdenk
3751c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
37527152b1d0Swdenkimages ready for download to / installation on your system:
3753c609719bSwdenk
3754c609719bSwdenk- "u-boot.bin" is a raw binary image
3755c609719bSwdenk- "u-boot" is an image in ELF binary format
3756c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3757c609719bSwdenk
3758baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3759baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3760baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3761baf31249SMarian Balakowicz
3762baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3763baf31249SMarian Balakowicz
3764baf31249SMarian Balakowicz	make O=/tmp/build distclean
3765ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
3766baf31249SMarian Balakowicz	make O=/tmp/build all
3767baf31249SMarian Balakowicz
3768adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
3769baf31249SMarian Balakowicz
3770adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
3771baf31249SMarian Balakowicz	make distclean
3772ab584d67SHolger Freyther	make NAME_defconfig
3773baf31249SMarian Balakowicz	make all
3774baf31249SMarian Balakowicz
3775adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3776baf31249SMarian Balakowiczvariable.
3777baf31249SMarian Balakowicz
3778c609719bSwdenk
3779c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3780c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3781c609719bSwdenknative "make".
3782c609719bSwdenk
3783c609719bSwdenk
3784c609719bSwdenkIf the system board that you have is not listed, then you will need
3785c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3786c609719bSwdenksteps:
3787c609719bSwdenk
37883c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
378985ec0bccSwdenk    files you need. In your board directory, you will need at least
37903c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
37913c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
37923c1496cdSPhil Sutter    your board.
3793c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3794c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
3795ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
3796c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3797c609719bSwdenk    to be installed on your target system.
379885ec0bccSwdenk6.  Debug and solve any problems that might arise.
3799c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3800c609719bSwdenk
3801c609719bSwdenk
3802c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3803c609719bSwdenk==============================================================
3804c609719bSwdenk
3805c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3806c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3807c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3808c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3809218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3810c609719bSwdenk
3811c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3812c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3813c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
38146de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
38156de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
38166de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
38176de80f21SSimon Glassfor documentation.
3818baf31249SMarian Balakowicz
3819baf31249SMarian Balakowicz
3820c609719bSwdenkSee also "U-Boot Porting Guide" below.
3821c609719bSwdenk
3822c609719bSwdenk
3823c609719bSwdenkMonitor Commands - Overview:
3824c609719bSwdenk============================
3825c609719bSwdenk
3826c609719bSwdenkgo	- start application at address 'addr'
3827c609719bSwdenkrun	- run commands in an environment variable
3828c609719bSwdenkbootm	- boot application image from memory
3829c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
383044f074c7SMarek Vasutbootz   - boot zImage from memory
3831c609719bSwdenktftpboot- boot image via network using TFTP protocol
3832c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3833c609719bSwdenk	       (and eventually "gatewayip")
38341fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3835c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3836c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3837c609719bSwdenkloads	- load S-Record file over serial line
3838c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3839c609719bSwdenkmd	- memory display
3840c609719bSwdenkmm	- memory modify (auto-incrementing)
3841c609719bSwdenknm	- memory modify (constant address)
3842c609719bSwdenkmw	- memory write (fill)
3843c609719bSwdenkcp	- memory copy
3844c609719bSwdenkcmp	- memory compare
3845c609719bSwdenkcrc32	- checksum calculation
38460f89c54bSPeter Tyseri2c	- I2C sub-system
3847c609719bSwdenksspi	- SPI utility commands
3848c609719bSwdenkbase	- print or set address offset
3849c609719bSwdenkprintenv- print environment variables
3850c609719bSwdenksetenv	- set environment variables
3851c609719bSwdenksaveenv - save environment variables to persistent storage
3852c609719bSwdenkprotect - enable or disable FLASH write protection
3853c609719bSwdenkerase	- erase FLASH memory
3854c609719bSwdenkflinfo	- print FLASH memory information
385510635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
3856c609719bSwdenkbdinfo	- print Board Info structure
3857c609719bSwdenkiminfo	- print header information for application image
3858c609719bSwdenkconinfo - print console devices and informations
3859c609719bSwdenkide	- IDE sub-system
3860c609719bSwdenkloop	- infinite loop on address range
386156523f12Swdenkloopw	- infinite write loop on address range
3862c609719bSwdenkmtest	- simple RAM test
3863c609719bSwdenkicache	- enable or disable instruction cache
3864c609719bSwdenkdcache	- enable or disable data cache
3865c609719bSwdenkreset	- Perform RESET of the CPU
3866c609719bSwdenkecho	- echo args to console
3867c609719bSwdenkversion - print monitor version
3868c609719bSwdenkhelp	- print online help
3869c609719bSwdenk?	- alias for 'help'
3870c609719bSwdenk
3871c609719bSwdenk
3872c609719bSwdenkMonitor Commands - Detailed Description:
3873c609719bSwdenk========================================
3874c609719bSwdenk
3875c609719bSwdenkTODO.
3876c609719bSwdenk
3877c609719bSwdenkFor now: just type "help <command>".
3878c609719bSwdenk
3879c609719bSwdenk
3880c609719bSwdenkEnvironment Variables:
3881c609719bSwdenk======================
3882c609719bSwdenk
3883c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3884c609719bSwdenkcan be made persistent by saving to Flash memory.
3885c609719bSwdenk
3886c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3887c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3888c609719bSwdenkwithout a value can be used to delete a variable from the
3889c609719bSwdenkenvironment. As long as you don't save the environment you are
3890c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3891c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3892c609719bSwdenk
3893c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3894c96f86eeSWolfgang Denk
3895c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3896c609719bSwdenk
3897c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3898c609719bSwdenk
3899c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3900c609719bSwdenk
3901c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3902c609719bSwdenk
3903c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3904c609719bSwdenk
3905c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3906c609719bSwdenk
39077d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
39087d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
39097d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
39107d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
39117d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
39127d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3913c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3914c3624e6eSGrant Likely		  bootm_mapsize.
3915c3624e6eSGrant Likely
3916c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3917c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3918c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3919c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3920c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3921c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3922c3624e6eSGrant Likely		  used otherwise.
39237d721e34SBartlomiej Sieka
39247d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
39257d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
39267d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
39277d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
39287d721e34SBartlomiej Sieka		  environment variable.
39297d721e34SBartlomiej Sieka
39304bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
39314bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
39324bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
39334bae9090SBartlomiej Sieka
3934c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3935c609719bSwdenk		  "bootp" will just load perform a lookup of the
3936c609719bSwdenk		  configuration from the BOOTP server, but not try to
3937c609719bSwdenk		  load any image using TFTP
3938c609719bSwdenk
3939c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3940c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3941c609719bSwdenk		  be automatically started (by internally calling
3942c609719bSwdenk		  "bootm")
3943c609719bSwdenk
39444a6fd34bSwdenk		  If set to "no", a standalone image passed to the
39454a6fd34bSwdenk		  "bootm" command will be copied to the load address
39464a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
39474a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
39484a6fd34bSwdenk		  data.
39494a6fd34bSwdenk
3950a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3951a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3952fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3953fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3954fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3955fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3956fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3957fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3958fa34f6b2SShawn Guo		  access it during the boot procedure.
3959fa34f6b2SShawn Guo
3960a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3961a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3962a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3963a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3964a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3965a28afca5SDavid A. Long		  must be accessible by the kernel.
3966a28afca5SDavid A. Long
3967eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3968eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3969eea63e05SSimon Glass		  defined.
3970eea63e05SSimon Glass
397117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
397217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
397317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
397417ea1177Swdenk		  initialization code. So, for changes to be effective
397517ea1177Swdenk		  it must be saved and board must be reset.
397617ea1177Swdenk
3977c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3978c609719bSwdenk		  If this variable is not set, initrd images will be
3979c609719bSwdenk		  copied to the highest possible address in RAM; this
3980c609719bSwdenk		  is usually what you want since it allows for
3981c609719bSwdenk		  maximum initrd size. If for some reason you want to
3982c609719bSwdenk		  make sure that the initrd image is loaded below the
39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3984c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3985c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3986c609719bSwdenk		  address to use (U-Boot will still check that it
3987c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3988c609719bSwdenk
3989c609719bSwdenk		  For instance, when you have a system with 16 MB
39907152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3991c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3992c609719bSwdenk		  the "bootargs" variable. However, now you must make
39937152b1d0Swdenk		  sure that the initrd image is placed in the first
3994c609719bSwdenk		  12 MB as well - this can be done with
3995c609719bSwdenk
3996c609719bSwdenk		  setenv initrd_high 00c00000
3997c609719bSwdenk
399838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
399938b99261Swdenk		  indication to U-Boot that all addresses are legal
400038b99261Swdenk		  for the Linux kernel, including addresses in flash
400138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
400238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
400338b99261Swdenk		  boot time on your system, but requires that this
400438b99261Swdenk		  feature is supported by your Linux kernel.
400538b99261Swdenk
4006c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4007c609719bSwdenk
4008c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4009dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4010c609719bSwdenk
4011c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4012c609719bSwdenk
4013c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4014c609719bSwdenk
4015c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4016c609719bSwdenk
4017c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4018c609719bSwdenk
4019c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4020c609719bSwdenk
4021e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4022a3d991bdSwdenk
4023e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4024e2a53458SMike Frysinger		  For example you can do the following
4025a3d991bdSwdenk
402648690d80SHeiko Schocher		  => setenv ethact FEC
402748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
402848690d80SHeiko Schocher		  => setenv ethact SCC
402948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4030a3d991bdSwdenk
4031e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4032e1692577SMatthias Fuchs		  available network interfaces.
4033e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4034e1692577SMatthias Fuchs
4035a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4036a3d991bdSwdenk		  either succeed or fail without retrying.
40376e592385Swdenk		  When set to "once" the network operation will
40386e592385Swdenk		  fail when all the available network interfaces
40396e592385Swdenk		  are tried once without success.
4040a3d991bdSwdenk		  Useful on scripts which control the retry operation
4041a3d991bdSwdenk		  themselves.
4042a3d991bdSwdenk
4043b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4044a1cf027aSJean-Christophe PLAGNIOL-VILLARD
4045b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
40468d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
40478d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
40488d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
40498d51aacdSSimon Glass		  is silent.
40508d51aacdSSimon Glass
4051f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
4052ecb0ccd9SWolfgang Denk		  UDP source port.
4053ecb0ccd9SWolfgang Denk
4054f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
405528cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
405628cb9375SWolfgang Denk
4057c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4058c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4059c96f86eeSWolfgang Denk
4060c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4061c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4062c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4063c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4064c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4065c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4066c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4067c96f86eeSWolfgang Denk
4068f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
4069f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
4070f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
4071f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
4072f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
4073f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
4074f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
4075f5fb7346SAlbert ARIBAUD \(3ADEV\)
4076a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
407711ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4078a3d991bdSwdenk		  VLAN tagged frames.
4079c609719bSwdenk
408050768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
408150768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
408250768f5bSAlexandre Messier		  be either the default (28000), or a value based on
408350768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
408450768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
408550768f5bSAlexandre Messier
4086dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4087dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4088dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4089dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4090dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4091dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4092dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4093dc0b7b0eSJason Hobbs
4094dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4095aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
4096dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4097dc0b7b0eSJason Hobbs
4098dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4099dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4100dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4101dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4102dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4103dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4104dc0b7b0eSJason Hobbs
4105c609719bSwdenkThe following environment variables may be used and automatically
4106c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4107c609719bSwdenkdepending the information provided by your boot server:
4108c609719bSwdenk
4109c609719bSwdenk  bootfile	- see above
4110c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4111fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4112c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4113c609719bSwdenk  hostname	- Target hostname
4114c609719bSwdenk  ipaddr	- see above
4115c609719bSwdenk  netmask	- Subnet Mask
4116c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4117c609719bSwdenk  serverip	- see above
4118c609719bSwdenk
4119c609719bSwdenk
4120c609719bSwdenkThere are two special Environment Variables:
4121c609719bSwdenk
4122c609719bSwdenk  serial#	- contains hardware identification information such
4123c609719bSwdenk		  as type string and/or serial number
4124c609719bSwdenk  ethaddr	- Ethernet address
4125c609719bSwdenk
4126c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4127c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4128c609719bSwdenkonce they have been set once.
4129c609719bSwdenk
4130c609719bSwdenk
4131c1551ea8SstroeseFurther special Environment Variables:
4132c1551ea8Sstroese
4133c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4134c1551ea8Sstroese		  with the "version" command. This variable is
4135c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4136c1551ea8Sstroese
4137c1551ea8Sstroese
4138c609719bSwdenkPlease note that changes to some configuration parameters may take
4139c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4140c609719bSwdenk
4141c609719bSwdenk
4142170ab110SJoe HershbergerCallback functions for environment variables:
4143170ab110SJoe Hershberger---------------------------------------------
4144170ab110SJoe Hershberger
4145170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4146b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
4147170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4148170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4149170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4150170ab110SJoe Hershberger
4151170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4152170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4153170ab110SJoe Hershberger
4154170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4155170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4156170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4157170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4158170ab110SJoe Hershberger
4159170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4160170ab110SJoe Hershberger	list = entry[,list]
4161170ab110SJoe Hershberger
4162170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4163170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4164170ab110SJoe Hershberger
4165170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4166170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4167170ab110SJoe Hershbergeroverride any association in the static list. You can define
4168170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4169b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
4170170ab110SJoe Hershberger
4171bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
4172bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
4173bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
4174bdf1fe4eSJoe Hershberger
4175170ab110SJoe Hershberger
4176f07771ccSwdenkCommand Line Parsing:
4177f07771ccSwdenk=====================
4178f07771ccSwdenk
4179f07771ccSwdenkThere are two different command line parsers available with U-Boot:
41807152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4181f07771ccSwdenk
4182f07771ccSwdenkOld, simple command line parser:
4183f07771ccSwdenk--------------------------------
4184f07771ccSwdenk
4185f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4186f07771ccSwdenk- several commands on one line, separated by ';'
4187fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4188f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4189f07771ccSwdenk  for example:
4190fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4191f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4192f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4193f07771ccSwdenk
4194f07771ccSwdenkHush shell:
4195f07771ccSwdenk-----------
4196f07771ccSwdenk
4197f07771ccSwdenk- similar to Bourne shell, with control structures like
4198f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4199f07771ccSwdenk  until...do...done, ...
4200f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4201f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4202f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4203f07771ccSwdenk  command
4204f07771ccSwdenk
4205f07771ccSwdenkGeneral rules:
4206f07771ccSwdenk--------------
4207f07771ccSwdenk
4208f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4209f07771ccSwdenk    command) contains several commands separated by semicolon, and
4210f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4211f07771ccSwdenk    executed anyway.
4212f07771ccSwdenk
4213f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
421411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4215f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4216f07771ccSwdenk    variables are not executed.
4217f07771ccSwdenk
4218c609719bSwdenkNote for Redundant Ethernet Interfaces:
4219c609719bSwdenk=======================================
4220c609719bSwdenk
422111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4222c609719bSwdenksuch configurations and is capable of automatic selection of a
42237152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4224c609719bSwdenk
4225c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4226c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4227c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4228c609719bSwdenk
4229c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4230c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4231c609719bSwdenkding setting in the environment; if the corresponding environment
4232c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4233c609719bSwdenk
4234c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4235c609719bSwdenk  environment, the SROM's address is used.
4236c609719bSwdenk
4237c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4238c609719bSwdenk  environment exists, then the value from the environment variable is
4239c609719bSwdenk  used.
4240c609719bSwdenk
4241c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4242c609719bSwdenk  both addresses are the same, this MAC address is used.
4243c609719bSwdenk
4244c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4245c609719bSwdenk  addresses differ, the value from the environment is used and a
4246c609719bSwdenk  warning is printed.
4247c609719bSwdenk
4248c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4249bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4250bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
4251c609719bSwdenk
4252ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4253ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4254ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4255ecee9324SBen WarrenThe naming convention is as follows:
4256ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4257c609719bSwdenk
4258c609719bSwdenkImage Formats:
4259c609719bSwdenk==============
4260c609719bSwdenk
42613310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
42623310c549SMarian Balakowiczimages in two formats:
42633310c549SMarian Balakowicz
42643310c549SMarian BalakowiczNew uImage format (FIT)
42653310c549SMarian Balakowicz-----------------------
42663310c549SMarian Balakowicz
42673310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
42683310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
42693310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
42703310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
42713310c549SMarian Balakowicz
42723310c549SMarian Balakowicz
42733310c549SMarian BalakowiczOld uImage format
42743310c549SMarian Balakowicz-----------------
42753310c549SMarian Balakowicz
42763310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
42773310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
42783310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4279c609719bSwdenk
4280c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4281c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4282f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4283f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4284f5ed9e39SPeter Tyser  INTEGRITY).
4285daab59acSAndy Shevchenko* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
4286afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4287daab59acSAndy Shevchenko  Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4288c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4289c609719bSwdenk* Load Address
4290c609719bSwdenk* Entry Point
4291c609719bSwdenk* Image Name
4292c609719bSwdenk* Image Timestamp
4293c609719bSwdenk
4294c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4295c609719bSwdenkand the data portions of the image are secured against corruption by
4296c609719bSwdenkCRC32 checksums.
4297c609719bSwdenk
4298c609719bSwdenk
4299c609719bSwdenkLinux Support:
4300c609719bSwdenk==============
4301c609719bSwdenk
4302c609719bSwdenkAlthough U-Boot should support any OS or standalone application
43037152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4304c609719bSwdenkU-Boot.
4305c609719bSwdenk
4306c609719bSwdenkU-Boot includes many features that so far have been part of some
4307c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4308c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4309c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
43107152b1d0Swdenkserves several purposes:
4311c609719bSwdenk
4312c609719bSwdenk- the same features can be used for other OS or standalone
4313c609719bSwdenk  applications (for instance: using compressed images to reduce the
4314c609719bSwdenk  Flash memory footprint)
4315c609719bSwdenk
4316c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
43177152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4318c609719bSwdenk
4319c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4320c609719bSwdenk  images; of course this also means that different kernel images can
4321c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4322c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4323c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4324c609719bSwdenk  software is easier now.
4325c609719bSwdenk
4326c609719bSwdenk
4327c609719bSwdenkLinux HOWTO:
4328c609719bSwdenk============
4329c609719bSwdenk
4330c609719bSwdenkPorting Linux to U-Boot based systems:
4331c609719bSwdenk---------------------------------------
4332c609719bSwdenk
4333c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4334c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4335c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4336c609719bSwdenkLinux :-).
4337c609719bSwdenk
4338a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4339c609719bSwdenk
4340c609719bSwdenkJust make sure your machine specific header file (for instance
4341c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
43421dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
43431dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
43446d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4345c609719bSwdenk
43462eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
43472eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
43482eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
43492eb31b13SSimon Glassdoc/driver-model.
43502eb31b13SSimon Glass
4351c609719bSwdenk
4352c609719bSwdenkConfiguring the Linux kernel:
4353c609719bSwdenk-----------------------------
4354c609719bSwdenk
4355c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4356c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4357c609719bSwdenk
4358c609719bSwdenk
4359c609719bSwdenkBuilding a Linux Image:
4360c609719bSwdenk-----------------------
4361c609719bSwdenk
436224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
436324ee89b9Swdenknot used. If you use recent kernel source, a new build target
436424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
436524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
436624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
436724ee89b9Swdenk100% compatible format.
4368c609719bSwdenk
4369c609719bSwdenkExample:
4370c609719bSwdenk
4371ab584d67SHolger Freyther	make TQM850L_defconfig
4372c609719bSwdenk	make oldconfig
4373c609719bSwdenk	make dep
437424ee89b9Swdenk	make uImage
4375c609719bSwdenk
437624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
437724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
437824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4379c609719bSwdenk
438024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
438124ee89b9Swdenk
438224ee89b9Swdenk* convert the kernel into a raw binary image:
438324ee89b9Swdenk
438424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
438524ee89b9Swdenk				 -R .note -R .comment \
438624ee89b9Swdenk				 -S vmlinux linux.bin
438724ee89b9Swdenk
438824ee89b9Swdenk* compress the binary image:
438924ee89b9Swdenk
439024ee89b9Swdenk	gzip -9 linux.bin
439124ee89b9Swdenk
439224ee89b9Swdenk* package compressed binary image for U-Boot:
439324ee89b9Swdenk
439424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
439524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
439624ee89b9Swdenk		-d linux.bin.gz uImage
439724ee89b9Swdenk
439824ee89b9Swdenk
439924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
440024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
440124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
440224ee89b9Swdenkbyte header containing information about target architecture,
440324ee89b9Swdenkoperating system, image type, compression method, entry points, time
440424ee89b9Swdenkstamp, CRC32 checksums, etc.
440524ee89b9Swdenk
440624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
440724ee89b9Swdenkprint the header information, or to build new images.
4408c609719bSwdenk
4409c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4410c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4411c609719bSwdenkchecksum verification:
4412c609719bSwdenk
4413c609719bSwdenk	tools/mkimage -l image
4414c609719bSwdenk	  -l ==> list image header information
4415c609719bSwdenk
4416c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4417c609719bSwdenkfrom a "data file" which is used as image payload:
4418c609719bSwdenk
4419c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4420c609719bSwdenk		      -n name -d data_file image
4421c609719bSwdenk	  -A ==> set architecture to 'arch'
4422c609719bSwdenk	  -O ==> set operating system to 'os'
4423c609719bSwdenk	  -T ==> set image type to 'type'
4424c609719bSwdenk	  -C ==> set compression type 'comp'
4425c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4426c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4427c609719bSwdenk	  -n ==> set image name to 'name'
4428c609719bSwdenk	  -d ==> use image data from 'datafile'
4429c609719bSwdenk
443069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
443169459791Swdenkaddress (0x00000000), but the entry point address depends on the
443269459791Swdenkkernel version:
4433c609719bSwdenk
4434c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
443524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4436c609719bSwdenk
4437c609719bSwdenkSo a typical call to build a U-Boot image would read:
4438c609719bSwdenk
443924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
444024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4441a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
444224ee89b9Swdenk	> examples/uImage.TQM850L
444324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4444c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4445c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4446c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4447c609719bSwdenk	Load Address: 0x00000000
444824ee89b9Swdenk	Entry Point:  0x00000000
4449c609719bSwdenk
4450c609719bSwdenkTo verify the contents of the image (or check for corruption):
4451c609719bSwdenk
445224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
445324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4454c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4455c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4456c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4457c609719bSwdenk	Load Address: 0x00000000
445824ee89b9Swdenk	Entry Point:  0x00000000
4459c609719bSwdenk
4460c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4461c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4462c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4463c609719bSwdenkneed to be uncompressed:
4464c609719bSwdenk
4465a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
446624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
446724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4468a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
446924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
447024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4471c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4472c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4473c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4474c609719bSwdenk	Load Address: 0x00000000
447524ee89b9Swdenk	Entry Point:  0x00000000
4476c609719bSwdenk
4477c609719bSwdenk
4478c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4479c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4480c609719bSwdenk
4481c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4482c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4483c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4484c609719bSwdenk	Image Name:   Simple Ramdisk Image
4485c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4486c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4487c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4488c609719bSwdenk	Load Address: 0x00000000
4489c609719bSwdenk	Entry Point:  0x00000000
4490c609719bSwdenk
4491a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
4492a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
4493a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
4494a804b5ceSGuilherme Maciel Ferreirafrom the image:
4495a804b5ceSGuilherme Maciel Ferreira
4496f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
4497f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
4498f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
4499f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
4500a804b5ceSGuilherme Maciel Ferreira
4501c609719bSwdenk
4502c609719bSwdenkInstalling a Linux Image:
4503c609719bSwdenk-------------------------
4504c609719bSwdenk
4505c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4506c609719bSwdenkyou must convert the image to S-Record format:
4507c609719bSwdenk
4508c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4509c609719bSwdenk
4510c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4511c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4512c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4513c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4514c609719bSwdenkcommand.
4515c609719bSwdenk
4516c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4517c609719bSwdenkTQM8xxL is in the first Flash bank):
4518c609719bSwdenk
4519c609719bSwdenk	=> erase 40100000 401FFFFF
4520c609719bSwdenk
4521c609719bSwdenk	.......... done
4522c609719bSwdenk	Erased 8 sectors
4523c609719bSwdenk
4524c609719bSwdenk	=> loads 40100000
4525c609719bSwdenk	## Ready for S-Record download ...
4526c609719bSwdenk	~>examples/image.srec
4527c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4528c609719bSwdenk	...
4529c609719bSwdenk	15989 15990 15991 15992
4530c609719bSwdenk	[file transfer complete]
4531c609719bSwdenk	[connected]
4532c609719bSwdenk	## Start Addr = 0x00000000
4533c609719bSwdenk
4534c609719bSwdenk
4535c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4536c609719bSwdenkthis includes a checksum verification so you can be sure no data
4537c609719bSwdenkcorruption happened:
4538c609719bSwdenk
4539c609719bSwdenk	=> imi 40100000
4540c609719bSwdenk
4541c609719bSwdenk	## Checking Image at 40100000 ...
4542c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4543c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4544c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4545c609719bSwdenk	   Load Address: 00000000
4546c609719bSwdenk	   Entry Point:	 0000000c
4547c609719bSwdenk	   Verifying Checksum ... OK
4548c609719bSwdenk
4549c609719bSwdenk
4550c609719bSwdenkBoot Linux:
4551c609719bSwdenk-----------
4552c609719bSwdenk
4553c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4554c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4555c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4556c609719bSwdenkparameters. You can check and modify this variable using the
4557c609719bSwdenk"printenv" and "setenv" commands:
4558c609719bSwdenk
4559c609719bSwdenk
4560c609719bSwdenk	=> printenv bootargs
4561c609719bSwdenk	bootargs=root=/dev/ram
4562c609719bSwdenk
4563c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4564c609719bSwdenk
4565c609719bSwdenk	=> printenv bootargs
4566c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4567c609719bSwdenk
4568c609719bSwdenk	=> bootm 40020000
4569c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4570c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4571c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4572c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4573c609719bSwdenk	   Load Address: 00000000
4574c609719bSwdenk	   Entry Point:	 0000000c
4575c609719bSwdenk	   Verifying Checksum ... OK
4576c609719bSwdenk	   Uncompressing Kernel Image ... OK
4577c609719bSwdenk	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
4578c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4579c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4580c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4581c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4582c609719bSwdenk	...
4583c609719bSwdenk
458411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
45857152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4586c609719bSwdenkformat!) to the "bootm" command:
4587c609719bSwdenk
4588c609719bSwdenk	=> imi 40100000 40200000
4589c609719bSwdenk
4590c609719bSwdenk	## Checking Image at 40100000 ...
4591c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4592c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4593c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4594c609719bSwdenk	   Load Address: 00000000
4595c609719bSwdenk	   Entry Point:	 0000000c
4596c609719bSwdenk	   Verifying Checksum ... OK
4597c609719bSwdenk
4598c609719bSwdenk	## Checking Image at 40200000 ...
4599c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4600c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4601c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4602c609719bSwdenk	   Load Address: 00000000
4603c609719bSwdenk	   Entry Point:	 00000000
4604c609719bSwdenk	   Verifying Checksum ... OK
4605c609719bSwdenk
4606c609719bSwdenk	=> bootm 40100000 40200000
4607c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4608c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4609c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4610c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4611c609719bSwdenk	   Load Address: 00000000
4612c609719bSwdenk	   Entry Point:	 0000000c
4613c609719bSwdenk	   Verifying Checksum ... OK
4614c609719bSwdenk	   Uncompressing Kernel Image ... OK
4615c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4616c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4617c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4618c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4619c609719bSwdenk	   Load Address: 00000000
4620c609719bSwdenk	   Entry Point:	 00000000
4621c609719bSwdenk	   Verifying Checksum ... OK
4622c609719bSwdenk	   Loading Ramdisk ... OK
4623c609719bSwdenk	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
4624c609719bSwdenk	Boot arguments: root=/dev/ram
4625c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4626c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4627c609719bSwdenk	...
4628c609719bSwdenk	RAMDISK: Compressed image found at block 0
4629c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4630c609719bSwdenk
4631c609719bSwdenk	bash#
4632c609719bSwdenk
46330267768eSMatthew McClintockBoot Linux and pass a flat device tree:
46340267768eSMatthew McClintock-----------
46350267768eSMatthew McClintock
46360267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
46370267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
46380267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
46390267768eSMatthew McClintockflat device tree:
46400267768eSMatthew McClintock
46410267768eSMatthew McClintock=> print oftaddr
46420267768eSMatthew McClintockoftaddr=0x300000
46430267768eSMatthew McClintock=> print oft
46440267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
46450267768eSMatthew McClintock=> tftp $oftaddr $oft
46460267768eSMatthew McClintockSpeed: 1000, full duplex
46470267768eSMatthew McClintockUsing TSEC0 device
46480267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
46490267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
46500267768eSMatthew McClintockLoad address: 0x300000
46510267768eSMatthew McClintockLoading: #
46520267768eSMatthew McClintockdone
46530267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
46540267768eSMatthew McClintock=> tftp $loadaddr $bootfile
46550267768eSMatthew McClintockSpeed: 1000, full duplex
46560267768eSMatthew McClintockUsing TSEC0 device
46570267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
46580267768eSMatthew McClintockFilename 'uImage'.
46590267768eSMatthew McClintockLoad address: 0x200000
46600267768eSMatthew McClintockLoading:############
46610267768eSMatthew McClintockdone
46620267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
46630267768eSMatthew McClintock=> print loadaddr
46640267768eSMatthew McClintockloadaddr=200000
46650267768eSMatthew McClintock=> print oftaddr
46660267768eSMatthew McClintockoftaddr=0x300000
46670267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
46680267768eSMatthew McClintock## Booting image at 00200000 ...
46690267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
46700267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
46710267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
46720267768eSMatthew McClintock   Load Address: 00000000
46730267768eSMatthew McClintock   Entry Point:	 00000000
46740267768eSMatthew McClintock   Verifying Checksum ... OK
46750267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
46760267768eSMatthew McClintockBooting using flat device tree at 0x300000
46770267768eSMatthew McClintockUsing MPC85xx ADS machine description
46780267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
46790267768eSMatthew McClintock[snip]
46800267768eSMatthew McClintock
46810267768eSMatthew McClintock
46826069ff26SwdenkMore About U-Boot Image Types:
46836069ff26Swdenk------------------------------
46846069ff26Swdenk
46856069ff26SwdenkU-Boot supports the following image types:
46866069ff26Swdenk
46876069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
46886069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
46896069ff26Swdenk	well) you can continue to work in U-Boot after return from
46906069ff26Swdenk	the Standalone Program.
46916069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
46926069ff26Swdenk	will take over control completely. Usually these programs
46936069ff26Swdenk	will install their own set of exception handlers, device
46946069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
46956069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
46966069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
46976069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
46986069ff26Swdenk	being started.
46996069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
47006069ff26Swdenk	(Linux) kernel image and one or more data images like
47016069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
47026069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
47036069ff26Swdenk	server provides just a single image file, but you want to get
47046069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
47056069ff26Swdenk
47066069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
47076069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
47086069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
47096069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
47106069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
47116069ff26Swdenk	a multiple of 4 bytes).
47126069ff26Swdenk
47136069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
47146069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
47156069ff26Swdenk	flash memory.
47166069ff26Swdenk
47176069ff26Swdenk   "Script files" are command sequences that will be executed by
47186069ff26Swdenk	U-Boot's command interpreter; this feature is especially
47196069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
47206069ff26Swdenk	as command interpreter.
47216069ff26Swdenk
472244f074c7SMarek VasutBooting the Linux zImage:
472344f074c7SMarek Vasut-------------------------
472444f074c7SMarek Vasut
472544f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
472644f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
472744f074c7SMarek Vasutas the syntax of "bootm" command.
472844f074c7SMarek Vasut
47298ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
4730017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4731017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4732017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4733017e1f3fSMarek Vasut
4734c609719bSwdenk
4735c609719bSwdenkStandalone HOWTO:
4736c609719bSwdenk=================
4737c609719bSwdenk
4738c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4739c609719bSwdenkrun "standalone" applications, which can use some resources of
4740c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4741c609719bSwdenk
4742c609719bSwdenkTwo simple examples are included with the sources:
4743c609719bSwdenk
4744c609719bSwdenk"Hello World" Demo:
4745c609719bSwdenk-------------------
4746c609719bSwdenk
4747c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4748c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4749c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4750c609719bSwdenklike that:
4751c609719bSwdenk
4752c609719bSwdenk	=> loads
4753c609719bSwdenk	## Ready for S-Record download ...
4754c609719bSwdenk	~>examples/hello_world.srec
4755c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4756c609719bSwdenk	[file transfer complete]
4757c609719bSwdenk	[connected]
4758c609719bSwdenk	## Start Addr = 0x00040004
4759c609719bSwdenk
4760c609719bSwdenk	=> go 40004 Hello World! This is a test.
4761c609719bSwdenk	## Starting application at 0x00040004 ...
4762c609719bSwdenk	Hello World
4763c609719bSwdenk	argc = 7
4764c609719bSwdenk	argv[0] = "40004"
4765c609719bSwdenk	argv[1] = "Hello"
4766c609719bSwdenk	argv[2] = "World!"
4767c609719bSwdenk	argv[3] = "This"
4768c609719bSwdenk	argv[4] = "is"
4769c609719bSwdenk	argv[5] = "a"
4770c609719bSwdenk	argv[6] = "test."
4771c609719bSwdenk	argv[7] = "<NULL>"
4772c609719bSwdenk	Hit any key to exit ...
4773c609719bSwdenk
4774c609719bSwdenk	## Application terminated, rc = 0x0
4775c609719bSwdenk
4776c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4777c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4778c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4779c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4780c609719bSwdenkcharacter, but this is just a demo program. The application can be
4781c609719bSwdenkcontrolled by the following keys:
4782c609719bSwdenk
4783c609719bSwdenk	? - print current values og the CPM Timer registers
4784c609719bSwdenk	b - enable interrupts and start timer
4785c609719bSwdenk	e - stop timer and disable interrupts
4786c609719bSwdenk	q - quit application
4787c609719bSwdenk
4788c609719bSwdenk	=> loads
4789c609719bSwdenk	## Ready for S-Record download ...
4790c609719bSwdenk	~>examples/timer.srec
4791c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4792c609719bSwdenk	[file transfer complete]
4793c609719bSwdenk	[connected]
4794c609719bSwdenk	## Start Addr = 0x00040004
4795c609719bSwdenk
4796c609719bSwdenk	=> go 40004
4797c609719bSwdenk	## Starting application at 0x00040004 ...
4798c609719bSwdenk	TIMERS=0xfff00980
4799c609719bSwdenk	Using timer 1
4800c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4801c609719bSwdenk
4802c609719bSwdenkHit 'b':
4803c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4804c609719bSwdenk	Enabling timer
4805c609719bSwdenkHit '?':
4806c609719bSwdenk	[q, b, e, ?] ........
4807c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4808c609719bSwdenkHit '?':
4809c609719bSwdenk	[q, b, e, ?] .
4810c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4811c609719bSwdenkHit '?':
4812c609719bSwdenk	[q, b, e, ?] .
4813c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4814c609719bSwdenkHit '?':
4815c609719bSwdenk	[q, b, e, ?] .
4816c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4817c609719bSwdenkHit 'e':
4818c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4819c609719bSwdenkHit 'q':
4820c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4821c609719bSwdenk
4822c609719bSwdenk
482385ec0bccSwdenkMinicom warning:
482485ec0bccSwdenk================
482585ec0bccSwdenk
48267152b1d0SwdenkOver time, many people have reported problems when trying to use the
482785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
482885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4829f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
483085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4831e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4832e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4833e53515a2SKarl O. Pincfor help with kermit.
4834e53515a2SKarl O. Pinc
483585ec0bccSwdenk
483652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
483752f52c14Swdenkconfiguration to your "File transfer protocols" section:
483852f52c14Swdenk
483952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
484052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
484152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
484252f52c14Swdenk
484352f52c14Swdenk
4844c609719bSwdenkNetBSD Notes:
4845c609719bSwdenk=============
4846c609719bSwdenk
4847c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4848c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4849c609719bSwdenk
4850c609719bSwdenkBuilding requires a cross environment; it is known to work on
4851c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4852c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4853c609719bSwdenkNote that the cross-powerpc package does not install include files;
4854c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4855c609719bSwdenkmissing.  This file has to be installed and patched manually:
4856c609719bSwdenk
4857c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4858c609719bSwdenk	# mkdir powerpc
4859c609719bSwdenk	# ln -s powerpc machine
4860c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4861c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4862c609719bSwdenk
4863c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4864c609719bSwdenkand U-Boot include files.
4865c609719bSwdenk
4866c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4867c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4868c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4869c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
48702a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4871c609719bSwdenk
4872c609719bSwdenk
4873c609719bSwdenkImplementation Internals:
4874c609719bSwdenk=========================
4875c609719bSwdenk
4876c609719bSwdenkThe following is not intended to be a complete description of every
4877c609719bSwdenkimplementation detail. However, it should help to understand the
4878c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4879c609719bSwdenkhardware.
4880c609719bSwdenk
4881c609719bSwdenk
4882c609719bSwdenkInitial Stack, Global Data:
4883c609719bSwdenk---------------------------
4884c609719bSwdenk
4885c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4886c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4887c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4888c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4889c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4890c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4891c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4892c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4893c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4894c609719bSwdenklocked as (mis-) used as memory, etc.
4895c609719bSwdenk
48967152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
48970668236bSWolfgang Denk	U-Boot mailing list:
489843d9616cSwdenk
489943d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
490043d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
490143d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
490243d9616cSwdenk	...
490343d9616cSwdenk
490443d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
490543d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
490643d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
490743d9616cSwdenk	is that the cache is being used as a temporary supply of
490843d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
490911ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
491043d9616cSwdenk	can see how this works by studying the cache architecture and
491143d9616cSwdenk	operation in the architecture and processor-specific manuals.
491243d9616cSwdenk
491343d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
491443d9616cSwdenk	is another option for the system designer to use as an
491511ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
491643d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
491743d9616cSwdenk	board designers haven't used it for something that would
491843d9616cSwdenk	cause you grief during the initial boot! It is frequently not
491943d9616cSwdenk	used.
492043d9616cSwdenk
49216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
492243d9616cSwdenk	with your processor/board/system design. The default value
492343d9616cSwdenk	you will find in any recent u-boot distribution in
49248a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
492543d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
492643d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
492743d9616cSwdenk	that are supposed to respond to that address! That code in
492843d9616cSwdenk	start.S has been around a while and should work as is when
492943d9616cSwdenk	you get the config right.
493043d9616cSwdenk
493143d9616cSwdenk	-Chris Hallinan
493243d9616cSwdenk	DS4.COM, Inc.
493343d9616cSwdenk
4934c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4935c609719bSwdenkcode for the initialization procedures:
4936c609719bSwdenk
4937c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4938c609719bSwdenk  to write it.
4939c609719bSwdenk
4940b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
4941c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
49427152b1d0Swdenk  zation is performed later (when relocating to RAM).
4943c609719bSwdenk
4944c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4945c609719bSwdenk  that.
4946c609719bSwdenk
4947c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4948b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
4949c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4950c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4951c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4952c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4953c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4954c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4955c609719bSwdenkreserve for this purpose.
4956c609719bSwdenk
49577152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4958c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4959c609719bSwdenkGCC's implementation.
4960c609719bSwdenk
4961c609719bSwdenkFor PowerPC, the following registers have specific use:
4962c609719bSwdenk	R1:	stack pointer
4963e7670f6cSWolfgang Denk	R2:	reserved for system use
4964c609719bSwdenk	R3-R4:	parameter passing and return values
4965c609719bSwdenk	R5-R10: parameter passing
4966c609719bSwdenk	R13:	small data area pointer
4967c609719bSwdenk	R30:	GOT pointer
4968c609719bSwdenk	R31:	frame pointer
4969c609719bSwdenk
4970e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4971e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4972e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4973c609719bSwdenk
4974e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4975c609719bSwdenk
4976c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4977c609719bSwdenk    address of the global data structure is known at compile time),
4978c609719bSwdenk    but it turned out that reserving a register results in somewhat
4979c609719bSwdenk    smaller code - although the code savings are not that big (on
4980c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4981c609719bSwdenk    624 text + 127 data).
4982c609719bSwdenk
4983c609719bSwdenkOn ARM, the following registers are used:
4984c609719bSwdenk
4985c609719bSwdenk	R0:	function argument word/integer result
4986c609719bSwdenk	R1-R3:	function argument word
498712eba1b4SJeroen Hofstee	R9:	platform specific
498812eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
4989c609719bSwdenk	R11:	argument (frame) pointer
4990c609719bSwdenk	R12:	temporary workspace
4991c609719bSwdenk	R13:	stack pointer
4992c609719bSwdenk	R14:	link register
4993c609719bSwdenk	R15:	program counter
4994c609719bSwdenk
499512eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
499612eba1b4SJeroen Hofstee
499712eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
4998c609719bSwdenk
49990df01fd3SThomas ChouOn Nios II, the ABI is documented here:
50000df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
50010df01fd3SThomas Chou
50020df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
50030df01fd3SThomas Chou
50040df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
50050df01fd3SThomas Chou    to access small data sections, so gp is free.
50060df01fd3SThomas Chou
5007afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5008afc1ce82SMacpaul Lin
5009afc1ce82SMacpaul Lin	R0-R1:	argument/return
5010afc1ce82SMacpaul Lin	R2-R5:	argument
5011afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5012afc1ce82SMacpaul Lin	R16:	trampoline register
5013afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5014afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5015afc1ce82SMacpaul Lin	R30:	link register (LP)
5016afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5017afc1ce82SMacpaul Lin	PC:	program counter (PC)
5018afc1ce82SMacpaul Lin
5019afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5020afc1ce82SMacpaul Lin
5021d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5022d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5023c609719bSwdenk
5024c609719bSwdenkMemory Management:
5025c609719bSwdenk------------------
5026c609719bSwdenk
5027c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5028c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5029c609719bSwdenk
5030c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5031c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5032c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5033c609719bSwdenkphysical memory banks.
5034c609719bSwdenk
5035c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5036c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5037c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5038c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
50396d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5040c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5041c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5042c609719bSwdenk
5043c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5044c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5045c609719bSwdenk
5046c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5047c609719bSwdenkthis:
5048c609719bSwdenk
5049c609719bSwdenk	0x0000 0000	Exception Vector code
5050c609719bSwdenk	      :
5051c609719bSwdenk	0x0000 1FFF
5052c609719bSwdenk	0x0000 2000	Free for Application Use
5053c609719bSwdenk	      :
5054c609719bSwdenk	      :
5055c609719bSwdenk
5056c609719bSwdenk	      :
5057c609719bSwdenk	      :
5058c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5059c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5060c609719bSwdenk	0x00FC 0000	Malloc Arena
5061c609719bSwdenk	      :
5062c609719bSwdenk	0x00FD FFFF
5063c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5064c609719bSwdenk	...		eventually: LCD or video framebuffer
5065c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5066c609719bSwdenk	0x00FF FFFF	[End of RAM]
5067c609719bSwdenk
5068c609719bSwdenk
5069c609719bSwdenkSystem Initialization:
5070c609719bSwdenk----------------------
5071c609719bSwdenk
5072c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
507311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5074c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
50757152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5076c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5077c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
50782eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data
50792eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and
50802eb48ff7SHeiko Schocherthe SIU.
5081c609719bSwdenk
5082c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5083c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5084c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5085c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5086c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5087c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5088c609719bSwdenkbanks.
5089c609719bSwdenk
5090c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
50917152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5092c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5093c609719bSwdenk0x00000000, with any additional banks following immediately to create
5094c609719bSwdenkcontiguous memory starting from 0.
5095c609719bSwdenk
5096c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5097c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5098c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5099c609719bSwdenkpages, and the final stack is set up.
5100c609719bSwdenk
5101c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5102c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5103c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5104c609719bSwdenknew address in RAM.
5105c609719bSwdenk
5106c609719bSwdenk
5107c609719bSwdenkU-Boot Porting Guide:
5108c609719bSwdenk----------------------
5109c609719bSwdenk
5110c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
51116aff3115Swdenklist, October 2002]
5112c609719bSwdenk
5113c609719bSwdenk
5114c609719bSwdenkint main(int argc, char *argv[])
5115c609719bSwdenk{
5116c609719bSwdenk	sighandler_t no_more_time;
5117c609719bSwdenk
5118c609719bSwdenk	signal(SIGALRM, no_more_time);
5119c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5120c609719bSwdenk
5121c609719bSwdenk	if (available_money > available_manpower) {
51226c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5123c609719bSwdenk		return 0;
5124c609719bSwdenk	}
5125c609719bSwdenk
5126c609719bSwdenk	Download latest U-Boot source;
5127c609719bSwdenk
51280668236bSWolfgang Denk	Subscribe to u-boot mailing list;
51296aff3115Swdenk
51306c3fef28SJerry Van Baren	if (clueless)
5131c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5132c609719bSwdenk
5133c609719bSwdenk	while (learning) {
5134c609719bSwdenk		Read the README file in the top level directory;
51357cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
51366c3fef28SJerry Van Baren		Read applicable doc/*.README;
5137c609719bSwdenk		Read the source, Luke;
51386c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5139c609719bSwdenk	}
5140c609719bSwdenk
51416c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
51426c3fef28SJerry Van Baren		Buy a BDI3000;
51436c3fef28SJerry Van Baren	else
5144c609719bSwdenk		Add a lot of aggravation and time;
5145c609719bSwdenk
51466c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
51476c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
51486c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
51496c3fef28SJerry Van Baren	} else {
5150c609719bSwdenk		Create your own board support subdirectory;
51516c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
51526c3fef28SJerry Van Baren	}
51536c3fef28SJerry Van Baren	Edit new board/<myboard> files
51546c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5155c609719bSwdenk
51566c3fef28SJerry Van Baren	while (!accepted) {
5157c609719bSwdenk		while (!running) {
5158c609719bSwdenk			do {
5159c609719bSwdenk				Add / modify source code;
5160c609719bSwdenk			} until (compiles);
5161c609719bSwdenk			Debug;
5162c609719bSwdenk			if (clueless)
5163c609719bSwdenk				email("Hi, I am having problems...");
5164c609719bSwdenk		}
51656c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
51666c3fef28SJerry Van Baren		if (reasonable critiques)
51676c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
51686c3fef28SJerry Van Baren		else
51696c3fef28SJerry Van Baren			Defend code as written;
51706c3fef28SJerry Van Baren	}
5171c609719bSwdenk
5172c609719bSwdenk	return 0;
5173c609719bSwdenk}
5174c609719bSwdenk
5175c609719bSwdenkvoid no_more_time (int sig)
5176c609719bSwdenk{
5177c609719bSwdenk      hire_a_guru();
5178c609719bSwdenk}
5179c609719bSwdenk
5180c609719bSwdenk
5181c609719bSwdenkCoding Standards:
5182c609719bSwdenk-----------------
5183c609719bSwdenk
5184c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
51852c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
51867ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5187c609719bSwdenk
51882c051651SDetlev ZundelSource files originating from a different project (for example the
51892c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
5190b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
51912c051651SDetlev Zundelsources.
51922c051651SDetlev Zundel
51932c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
51942c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
51952c051651SDetlev Zundelin your code.
5196c609719bSwdenk
5197c178d3daSwdenkPlease also stick to the following formatting rules:
5198180d3f74Swdenk- remove any trailing white space
51997ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5200180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
52017ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5202180d3f74Swdenk- do not add trailing empty lines to source files
5203180d3f74Swdenk
5204c609719bSwdenkSubmissions which do not conform to the standards may be returned
5205c609719bSwdenkwith a request to reformat the changes.
5206c609719bSwdenk
5207c609719bSwdenk
5208c609719bSwdenkSubmitting Patches:
5209c609719bSwdenk-------------------
5210c609719bSwdenk
5211c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5212c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5213c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5214c609719bSwdenk
52150d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5216218ca724SWolfgang Denk
52170668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
52180668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
52190668236bSWolfgang Denk
5220c609719bSwdenkWhen you send a patch, please include the following information with
5221c609719bSwdenkit:
5222c609719bSwdenk
5223c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5224c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5225c609719bSwdenk  patch actually fixes something.
5226c609719bSwdenk
5227c609719bSwdenk* For new features: a description of the feature and your
5228c609719bSwdenk  implementation.
5229c609719bSwdenk
5230c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5231c609719bSwdenk
52327207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
52337207b366SRobert P. J. Day  information and associated file and directory references.
5234c609719bSwdenk
523527af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
523627af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5237c609719bSwdenk
5238c609719bSwdenk* If your patch adds new configuration options, don't forget to
5239c609719bSwdenk  document these in the README file.
5240c609719bSwdenk
5241218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5242218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
52437ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5244218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5245218ca724SWolfgang Denk  with some other mail clients.
5246c609719bSwdenk
5247218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5248218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5249218ca724SWolfgang Denk  GNU diff.
52506dff5529Swdenk
5251218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5252218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5253218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5254218ca724SWolfgang Denk  affected files).
5255218ca724SWolfgang Denk
5256218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5257218ca724SWolfgang Denk  and compressed attachments must not be used.
5258c609719bSwdenk
525952f52c14Swdenk* If one logical set of modifications affects or creates several
526052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
526152f52c14Swdenk
526252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
526352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
526452f52c14Swdenk
526552f52c14Swdenk
5266c609719bSwdenkNotes:
5267c609719bSwdenk
52686de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
5269c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5270c609719bSwdenk  for any of the boards.
5271c609719bSwdenk
5272c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5273c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5274c609719bSwdenk  returned with a request to re-formatting / split it.
5275c609719bSwdenk
5276c609719bSwdenk* If you modify existing code, make sure that your new code does not
5277c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5278c609719bSwdenk  When adding new features, these should compile conditionally only
5279c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5280c609719bSwdenk  disabled must not need more memory than the old code without your
5281c609719bSwdenk  modification.
528290dc6704Swdenk
52830668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
52840668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
52850668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
52860668236bSWolfgang Denk  bigger than the size limit should be avoided.
5287