xref: /openbmc/u-boot/README (revision 945a18e6)
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
130360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
13193f19cc0Swdenk
13293f19cc0Swdenk
133c609719bSwdenkDirectory Hierarchy:
134c609719bSwdenk====================
135c609719bSwdenk
1368d321b81SPeter Tyser/arch			Architecture specific files
1376eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1388d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1398d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1408d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1418d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1428d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1438d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
144afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
1458d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
14633c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
147a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1487207b366SRobert P. J. Day  /sandbox		Files generic to HW-independent "sandbox"
1498d321b81SPeter Tyser  /sh			Files generic to SH architecture
1508d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
15133c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
1528d321b81SPeter Tyser/api			Machine/arch independent API for external apps
1538d321b81SPeter Tyser/board			Board dependent files
154740f7e5cSXu Ziyuan/cmd			U-Boot commands functions
1558d321b81SPeter Tyser/common			Misc architecture independent functions
1567207b366SRobert P. J. Day/configs		Board default configuration files
1578d321b81SPeter Tyser/disk			Code for disk drive partition handling
1588d321b81SPeter Tyser/doc			Documentation (don't expect too much)
1598d321b81SPeter Tyser/drivers		Commonly used device drivers
16033c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
1618d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
1628d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
1638d321b81SPeter Tyser/include		Header Files
1647207b366SRobert P. J. Day/lib			Library routines generic to all architectures
1657207b366SRobert P. J. Day/Licenses		Various license files
1668d321b81SPeter Tyser/net			Networking code
1678d321b81SPeter Tyser/post			Power On Self Test
1687207b366SRobert P. J. Day/scripts		Various build scripts and Makefiles
1697207b366SRobert P. J. Day/test			Various unit test files
1708d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
171c609719bSwdenk
172c609719bSwdenkSoftware Configuration:
173c609719bSwdenk=======================
174c609719bSwdenk
175c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
176c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
177c609719bSwdenk
178c609719bSwdenkThere are two classes of configuration variables:
179c609719bSwdenk
180c609719bSwdenk* Configuration _OPTIONS_:
181c609719bSwdenk  These are selectable by the user and have names beginning with
182c609719bSwdenk  "CONFIG_".
183c609719bSwdenk
184c609719bSwdenk* Configuration _SETTINGS_:
185c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
186c609719bSwdenk  you don't know what you're doing; they have names beginning with
1876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
188c609719bSwdenk
1897207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating
1907207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently,
1917207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel,
1927207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your
1937207b366SRobert P. J. Daybuild.
194c609719bSwdenk
195c609719bSwdenk
196c609719bSwdenkSelection of Processor Architecture and Board Type:
197c609719bSwdenk---------------------------------------------------
198c609719bSwdenk
199c609719bSwdenkFor all supported boards there are ready-to-use default
200ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
201c609719bSwdenk
202c609719bSwdenkExample: For a TQM823L module type:
203c609719bSwdenk
204c609719bSwdenk	cd u-boot
205ab584d67SHolger Freyther	make TQM823L_defconfig
206c609719bSwdenk
2077207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board
2087207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file
2097207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards.
210c609719bSwdenk
21175b3c3aaSSimon GlassSandbox Environment:
21275b3c3aaSSimon Glass--------------------
21375b3c3aaSSimon Glass
21475b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
21575b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
21675b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
21775b3c3aaSSimon Glassrun some of U-Boot's tests.
21875b3c3aaSSimon Glass
2196b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
22075b3c3aaSSimon Glass
22175b3c3aaSSimon Glass
222db910353SSimon GlassBoard Initialisation Flow:
223db910353SSimon Glass--------------------------
224db910353SSimon Glass
225db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
2267207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules).
227db910353SSimon Glass
2287207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in
2297207b366SRobert P. J. Daymore detail later in this file.
2307207b366SRobert P. J. Day
2317207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names
2327207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures
2337207b366SRobert P. J. Daymay not conform to this.  At least most ARM boards which use
2347207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this.
2357207b366SRobert P. J. Day
2367207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly
2377207b366SRobert P. J. DayCPU-specific) start.S file, such as:
2387207b366SRobert P. J. Day
2397207b366SRobert P. J. Day	- arch/arm/cpu/armv7/start.S
2407207b366SRobert P. J. Day	- arch/powerpc/cpu/mpc83xx/start.S
2417207b366SRobert P. J. Day	- arch/mips/cpu/start.S
2427207b366SRobert P. J. Day
2437207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and
2447207b366SRobert P. J. Daylimitations of each of these functions are described below.
245db910353SSimon Glass
246db910353SSimon Glasslowlevel_init():
247db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
248db910353SSimon Glass	- no global_data or BSS
249db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
250db910353SSimon Glass	- must not set up SDRAM or use console
251db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
252db910353SSimon Glass		board_init_f()
253db910353SSimon Glass	- this is almost never needed
254db910353SSimon Glass	- return normally from this function
255db910353SSimon Glass
256db910353SSimon Glassboard_init_f():
257db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
258db910353SSimon Glass		i.e. SDRAM and serial UART
259db910353SSimon Glass	- global_data is available
260db910353SSimon Glass	- stack is in SRAM
261db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
262db910353SSimon Glass		only stack variables and global_data
263db910353SSimon Glass
264db910353SSimon Glass	Non-SPL-specific notes:
265db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
266db910353SSimon Glass		can do nothing
267db910353SSimon Glass
268db910353SSimon Glass	SPL-specific notes:
269db910353SSimon Glass	- you can override the entire board_init_f() function with your own
270db910353SSimon Glass		version as needed.
271db910353SSimon Glass	- preloader_console_init() can be called here in extremis
272db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
273db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
274db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
275db910353SSimon Glass		directly)
276db910353SSimon Glass
277db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278db910353SSimon Glassthis point the stack and global_data are relocated to below
279db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280db910353SSimon Glassmemory.
281db910353SSimon Glass
282db910353SSimon Glassboard_init_r():
283db910353SSimon Glass	- purpose: main execution, common code
284db910353SSimon Glass	- global_data is available
285db910353SSimon Glass	- SDRAM is available
286db910353SSimon Glass	- BSS is available, all static/global variables can be used
287db910353SSimon Glass	- execution eventually continues to main_loop()
288db910353SSimon Glass
289db910353SSimon Glass	Non-SPL-specific notes:
290db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
291db910353SSimon Glass		there.
292db910353SSimon Glass
293db910353SSimon Glass	SPL-specific notes:
294db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
296db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
297db910353SSimon Glass		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298db910353SSimon Glass		spl_board_init() function containing this call
299db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
300db910353SSimon Glass
301db910353SSimon Glass
302db910353SSimon Glass
303c609719bSwdenkConfiguration Options:
304c609719bSwdenk----------------------
305c609719bSwdenk
306c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
307c609719bSwdenksuch information is kept in a configuration file
308c609719bSwdenk"include/configs/<board_name>.h".
309c609719bSwdenk
310c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
311c609719bSwdenk"include/configs/TQM823L.h".
312c609719bSwdenk
313c609719bSwdenk
3147f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3157f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3167f6c2cbcSwdenkbuild a config tool - later.
3177f6c2cbcSwdenk
3187f6c2cbcSwdenk
319c609719bSwdenkThe following options need to be configured:
320c609719bSwdenk
3212628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
322c609719bSwdenk
3232628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3246ccec449SWolfgang Denk
3256ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
32609ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
327c609719bSwdenk
328cf946c6dSLei Wen- Marvell Family Member
329cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
330cf946c6dSLei Wen					  multiple fs option at one time
331cf946c6dSLei Wen					  for marvell soc family
332cf946c6dSLei Wen
33311ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33566ca92a5Swdenk					  get_gclk_freq() cannot work
3365da627a4Swdenk					  e.g. if there is no 32KHz
3375da627a4Swdenk					  reference PIT/RTC clock
33866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33966ca92a5Swdenk					  or XTAL/EXTAL)
340c609719bSwdenk
34166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34575d1ea7fSwdenk			See doc/README.MPC866
34675d1ea7fSwdenk
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34875d1ea7fSwdenk
34975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35075d1ea7fSwdenk		of relying on the correctness of the configured
35175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35575d1ea7fSwdenk
356506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
357506f3918SHeiko Schocher
358506f3918SHeiko Schocher		Define this option if you want to enable the
359506f3918SHeiko Schocher		ICache only when Code runs from RAM.
360506f3918SHeiko Schocher
36166412c63SKumar Gala- 85xx CPU Options:
362ffd06e02SYork Sun		CONFIG_SYS_PPC64
363ffd06e02SYork Sun
364ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
365ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
366ffd06e02SYork Sun		compliance, among other possible reasons.
367ffd06e02SYork Sun
36866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36966412c63SKumar Gala
37066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37366412c63SKumar Gala
3748f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3758f29084aSKumar Gala
3768f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3778f29084aSKumar Gala		tree nodes for the given platform.
3788f29084aSKumar Gala
379afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
380afa6b551SPrabhakar Kushwaha
381afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
382afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
383afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
384afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
385afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
386afa6b551SPrabhakar Kushwaha		purpose.
387afa6b551SPrabhakar Kushwaha
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38933eee330SScott Wood
39033eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39133eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
39233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39333eee330SScott Wood
39433eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
39633eee330SScott Wood
39733eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39833eee330SScott Wood		for which the A004510 workaround should be applied.
39933eee330SScott Wood
40033eee330SScott Wood		The rest of SVR is either not relevant to the decision
40133eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
40233eee330SScott Wood		p2041) or is implied by the build target, which controls
40333eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40433eee330SScott Wood
40533eee330SScott Wood		See Freescale App Note 4493 for more information about
40633eee330SScott Wood		this erratum.
40733eee330SScott Wood
40874fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40974fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
410b445bbb4SJeremiah Mahler		required during NOR boot.
41174fa22edSPrabhakar Kushwaha
4129f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
4139f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
414b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
4159f074e67SPrabhakar Kushwaha
41633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41733eee330SScott Wood
41833eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41933eee330SScott Wood		according to the A004510 workaround.
42033eee330SScott Wood
42164501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
42264501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
42364501c66SPriyanka Jain		connected exclusively to the DSP cores.
42464501c66SPriyanka Jain
425765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
427765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
428765b0bdbSPriyanka Jain
42964501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
43064501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
43164501c66SPriyanka Jain		connected to the DSP core.
43264501c66SPriyanka Jain
433765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
435765b0bdbSPriyanka Jain
436b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
438b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
439b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
440b135991aSPriyanka Jain
441fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
442fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
443a187559eSBin Meng		time of U-Boot entry and is required to be re-initialized.
444fb4a2409SAneesh Bansal
445aade2004STang Yuantian		CONFIG_DEEP_SLEEP
446b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
447aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
448aade2004STang Yuantian
4496cb461b4SDaniel Schwierzeck- Generic CPU options:
4502a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4512a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4522a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4532a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4542a1680e3SYork Sun		should initialize global data before calling board_init_f().
4552a1680e3SYork Sun
4566cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4576cb461b4SDaniel Schwierzeck
4586cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4596cb461b4SDaniel Schwierzeck		values is arch specific.
4606cb461b4SDaniel Schwierzeck
4615614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4625614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4635614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4645614e71bSYork Sun		SoCs.
4655614e71bSYork Sun
4665614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4675614e71bSYork Sun		Freescale DDR memory-mapped register base.
4685614e71bSYork Sun
4695614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4705614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4715614e71bSYork Sun		deskew training are not available.
4725614e71bSYork Sun
4735614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4745614e71bSYork Sun		Freescale DDR1 controller.
4755614e71bSYork Sun
4765614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4775614e71bSYork Sun		Freescale DDR2 controller.
4785614e71bSYork Sun
4795614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4805614e71bSYork Sun		Freescale DDR3 controller.
4815614e71bSYork Sun
48234e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
48334e026f9SYork Sun		Freescale DDR4 controller.
48434e026f9SYork Sun
4859ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4869ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4879ac4ffbdSYork Sun
4885614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4895614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4905614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4915614e71bSYork Sun		implemetation.
4925614e71bSYork Sun
4935614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
49462a3b7ddSRobert P. J. Day		Board config to use DDR2. It can be enabled for SoCs with
4955614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4965614e71bSYork Sun		implementation.
4975614e71bSYork Sun
4985614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4995614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
50034e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
50134e026f9SYork Sun
50234e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
50334e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
50434e026f9SYork Sun		DDR3L controllers.
50534e026f9SYork Sun
50634e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
50734e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
50834e026f9SYork Sun		DDR4 controllers.
5095614e71bSYork Sun
5101b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
5111b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
5121b4175d6SPrabhakar Kushwaha
5131b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
5141b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
5151b4175d6SPrabhakar Kushwaha
516690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
517690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
518690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
519690e4258SPrabhakar Kushwaha
520690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
521690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
522690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
523690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
524690e4258SPrabhakar Kushwaha
52589ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
52689ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
52789ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
52889ad7be8SPrabhakar Kushwaha
5294e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5304e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5314e5b1bd0SYork Sun
5324e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5334e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5344e5b1bd0SYork Sun
5356b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5366b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5376b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5386b9e309aSYork Sun		it could be different for ARM SoCs.
5396b9e309aSYork Sun
5406b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5416b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5426b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5436b1e1254SYork Sun		SoCs with ARM core.
5446b1e1254SYork Sun
5451d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5461d71efbbSYork Sun		Number of controllers used as main memory.
5471d71efbbSYork Sun
5481d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5491d71efbbSYork Sun		Number of controllers used for other than main memory.
5501d71efbbSYork Sun
55144937214SPrabhakar Kushwaha		CONFIG_SYS_FSL_HAS_DP_DDR
55244937214SPrabhakar Kushwaha		Defines the SoC has DP-DDR used for DPAA.
55344937214SPrabhakar Kushwaha
554028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
555028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
556028dbb8dSRuchika Gupta
557028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
558028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
559028dbb8dSRuchika Gupta
56092bbd64eSDaniel Schwierzeck- MIPS CPU options:
56192bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
56292bbd64eSDaniel Schwierzeck
56392bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
56492bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
56592bbd64eSDaniel Schwierzeck		relocation.
56692bbd64eSDaniel Schwierzeck
56792bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
56892bbd64eSDaniel Schwierzeck
56992bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
57092bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
57192bbd64eSDaniel Schwierzeck		Possible values are:
57292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
57392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
57492bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
57592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
57692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
57792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
57892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
57992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
58092bbd64eSDaniel Schwierzeck
58192bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
58292bbd64eSDaniel Schwierzeck
58392bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
58492bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
58592bbd64eSDaniel Schwierzeck
58692bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
58792bbd64eSDaniel Schwierzeck
58892bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
58992bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
59092bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
59192bbd64eSDaniel Schwierzeck
592b67d8816SChristian Riesch- ARM options:
593b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
594b67d8816SChristian Riesch
595b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
596b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
597b67d8816SChristian Riesch
5985356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5995356f545SAneesh V
6005356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
6015356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
6025356f545SAneesh V		better code density. For ARM architectures that support
6035356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
6045356f545SAneesh V		GCC.
6055356f545SAneesh V
606c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
6070678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
6080678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
6090678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
610b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
611e392b923SIan Campbell		CONFIG_ARM_ERRATA_773022
612e392b923SIan Campbell		CONFIG_ARM_ERRATA_774769
613e392b923SIan Campbell		CONFIG_ARM_ERRATA_794072
6140678587fSStephen Warren
6150678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
6160678587fSStephen Warren		during U-Boot startup. Note that these options force the
6170678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
6180678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
6190678587fSStephen Warren		set these options unless they apply!
6200678587fSStephen Warren
621207774b2SYork Sun		COUNTER_FREQUENCY
622207774b2SYork Sun		Generic timer clock source frequency.
623207774b2SYork Sun
624207774b2SYork Sun		COUNTER_FREQUENCY_REAL
625207774b2SYork Sun		Generic timer clock source frequency if the real clock is
626207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
627207774b2SYork Sun		at run time.
628207774b2SYork Sun
629c616a0dfSNishanth Menon		NOTE: The following can be machine specific errata. These
630c616a0dfSNishanth Menon		do have ability to provide rudimentary version and machine
631c616a0dfSNishanth Menon		specific checks, but expect no product checks.
6325902f4ceSNishanth Menon		CONFIG_ARM_ERRATA_430973
633b45c48a7SNishanth Menon		CONFIG_ARM_ERRATA_454179
6349b4d65f9SNishanth Menon		CONFIG_ARM_ERRATA_621766
635c616a0dfSNishanth Menon		CONFIG_ARM_ERRATA_798870
636a615d0beSNishanth Menon		CONFIG_ARM_ERRATA_801819
637c616a0dfSNishanth Menon
63873c38934SStephen Warren- Tegra SoC options:
63973c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
64073c38934SStephen Warren
64173c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
64273c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
64373c38934SStephen Warren		such as ARM architectural timer initialization.
64473c38934SStephen Warren
6455da627a4Swdenk- Linux Kernel Interface:
646c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
647c609719bSwdenk
648c609719bSwdenk		U-Boot stores all clock information in Hz
649c609719bSwdenk		internally. For binary compatibility with older Linux
650c609719bSwdenk		kernels (which expect the clocks passed in the
651c609719bSwdenk		bd_info data to be in MHz) the environment variable
652c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
653c609719bSwdenk		converts clock data to MHZ before passing it to the
654c609719bSwdenk		Linux kernel.
655c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
656c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
657c609719bSwdenk		default environment.
658c609719bSwdenk
6595da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6605da627a4Swdenk
661b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
6625da627a4Swdenk		expect it to be in bytes, others in MB.
6635da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6645da627a4Swdenk
665fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
666f57f70aaSWolfgang Denk
667f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
668213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
669213bf8c8SGerald Van Baren		concepts).
670213bf8c8SGerald Van Baren
671213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
672213bf8c8SGerald Van Baren		 * New libfdt-based support
673213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6743bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
675213bf8c8SGerald Van Baren
676b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
677b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
678b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
679b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
680f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
681c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
682f57f70aaSWolfgang Denk
68311ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
68411ccc33fSMarcel Ziswiler		addresses
6853bb342fcSKim Phillips
6864e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6874e253137SKumar Gala
6884e253137SKumar Gala		Board code has addition modification that it wants to make
6894e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6906705d81eSwdenk
691c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
692c654b517SSimon Glass
693c654b517SSimon Glass		Other code has addition modification that it wants to make
694c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
695c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
696c654b517SSimon Glass		the kernel.
697c654b517SSimon Glass
6983887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6993887c3fbSHeiko Schocher
7003887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
7013887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
7023887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
7033887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
7043887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
7053887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
7063887c3fbSHeiko Schocher
7077eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
7087eb29398SIgor Grinberg
7097eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
7107eb29398SIgor Grinberg		machine type and must be used to specify the machine type
7117eb29398SIgor Grinberg		number as it appears in the ARM machine registry
7127eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
7137eb29398SIgor Grinberg		Only boards that have multiple machine types supported
7147eb29398SIgor Grinberg		in a single configuration file and the machine type is
7157eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
7167eb29398SIgor Grinberg
7170b2f4ecaSNiklaus Giger- vxWorks boot parameters:
7180b2f4ecaSNiklaus Giger
7190b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
7209e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
7219e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
7220b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
7230b2f4ecaSNiklaus Giger
7240b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
7250b2f4ecaSNiklaus Giger		the defaults discussed just above.
7260b2f4ecaSNiklaus Giger
7272c451f78SAneesh V- Cache Configuration:
7282c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
7292c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
7302c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7312c451f78SAneesh V
73293bc2193SAneesh V- Cache Configuration for ARM:
73393bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
73493bc2193SAneesh V				      controller
73593bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
73693bc2193SAneesh V					controller register space
73793bc2193SAneesh V
7386705d81eSwdenk- Serial Ports:
73948d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7406705d81eSwdenk
7416705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7426705d81eSwdenk
74348d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7446705d81eSwdenk
7456705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7466705d81eSwdenk
7476705d81eSwdenk		CONFIG_PL011_CLOCK
7486705d81eSwdenk
7496705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7506705d81eSwdenk		the clock speed of the UARTs.
7516705d81eSwdenk
7526705d81eSwdenk		CONFIG_PL01x_PORTS
7536705d81eSwdenk
7546705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7556705d81eSwdenk		define this to a list of base addresses for each (supported)
7566705d81eSwdenk		port. See e.g. include/configs/versatile.h
7576705d81eSwdenk
758d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
759d57dee57SKaricheri, Muralidharan
760d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
761d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
7626705d81eSwdenk
763c609719bSwdenk- Console Interface:
764c609719bSwdenk		Depending on board, define exactly one serial port
765c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
766c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
767c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
768c609719bSwdenk
769c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
770c609719bSwdenk		port routines must be defined elsewhere
771c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
772c609719bSwdenk
773c609719bSwdenk		CONFIG_CFB_CONSOLE
774c609719bSwdenk		Enables console device for a color framebuffer. Needs following
775c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
776c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
777c609719bSwdenk						(default big endian)
778c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
779c609719bSwdenk						rectangle fill
780c609719bSwdenk						(cf. smiLynxEM)
781c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
782c609719bSwdenk						bit-blit (cf. smiLynxEM)
783c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
784c609719bSwdenk						(cols=pitch)
785c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
786c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
787c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
788c609719bSwdenk						(0-5, cf. cfb_console.c)
789c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
790c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
79139f615edSSimon Glass						(i.e. rx51_kp_init())
792c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
79339f615edSSimon Glass						(i.e. rx51_kp_tstc)
794c609719bSwdenk			VIDEO_GETC_FCT		get char fct
79539f615edSSimon Glass						(i.e. rx51_kp_getc)
796c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
797c609719bSwdenk						upper left corner
798a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
799a6c7ad2fSwdenk						linux_logo.h for logo.
800a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
801c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
80211ccc33fSMarcel Ziswiler						additional board info beside
803c609719bSwdenk						the logo
804adde435fSTim Harvey			CONFIG_HIDE_LOGO_VERSION
805adde435fSTim Harvey						do not display bootloader
806adde435fSTim Harvey						version string
807c609719bSwdenk
80833a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
80933a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
81033a35bbbSPali Rohár		erase functions and limited graphics rendition control).
81133a35bbbSPali Rohár
812c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
813c609719bSwdenk		default i/o. Serial console can be forced with
814c609719bSwdenk		environment 'console=serial'.
815c609719bSwdenk
816a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
817a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
818a3ad8e26Swdenk		the "silent" environment variable. See
819a3ad8e26Swdenk		doc/README.silent for more information.
820a3ad8e26Swdenk
82145ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
82245ae2546SHeiko Schocher			is 0x00.
82345ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
82445ae2546SHeiko Schocher			is 0xa0.
82545ae2546SHeiko Schocher
826c609719bSwdenk- Console Baudrate:
827c609719bSwdenk		CONFIG_BAUDRATE - in bps
828c609719bSwdenk		Select one of the baudrates listed in
8296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
831c609719bSwdenk
832c92fac91SHeiko Schocher- Console Rx buffer length
833c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
834c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8352b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
836c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
837c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
838c92fac91SHeiko Schocher		the SMC.
839c92fac91SHeiko Schocher
8409558b48aSGraeme Russ- Pre-Console Buffer:
8419558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8429558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8439558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8449558b48aSGraeme Russ		buffer any console messages prior to the console being
8459558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8469558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8479558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8489558b48aSGraeme Russ		bytes are output before the console is initialised, the
8499558b48aSGraeme Russ		earlier bytes are discarded.
8509558b48aSGraeme Russ
851a8552c7cSHans de Goede		Note that when printing the buffer a copy is made on the
852a8552c7cSHans de Goede		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
853a8552c7cSHans de Goede
8549558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8559558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8569558b48aSGraeme Russ
857c609719bSwdenk- Autoboot Command:
858c609719bSwdenk		CONFIG_BOOTCOMMAND
859c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
860c609719bSwdenk		define a command string that is automatically executed
861c609719bSwdenk		when no character is read on the console interface
862c609719bSwdenk		within "Boot Delay" after reset.
863c609719bSwdenk
864c609719bSwdenk		CONFIG_BOOTARGS
865c609719bSwdenk		This can be used to pass arguments to the bootm
866c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
867c609719bSwdenk		environment value "bootargs".
868c609719bSwdenk
869c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
870c609719bSwdenk		The value of these goes into the environment as
871c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
872c609719bSwdenk		as a convenience, when switching between booting from
87311ccc33fSMarcel Ziswiler		RAM and NFS.
874c609719bSwdenk
875eda0ba38SHeiko Schocher- Bootcount:
876eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
877eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
878eda0ba38SHeiko Schocher		cycle, see:
879eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
880eda0ba38SHeiko Schocher
881eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
882eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
883eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
884eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
885eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
886eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
887eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
888eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
889eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
890eda0ba38SHeiko Schocher
891c609719bSwdenk- Pre-Boot Commands:
892c609719bSwdenk		CONFIG_PREBOOT
893c609719bSwdenk
894c609719bSwdenk		When this option is #defined, the existence of the
895c609719bSwdenk		environment variable "preboot" will be checked
896c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
897c609719bSwdenk		countdown and/or running the auto-boot command resp.
898c609719bSwdenk		entering interactive mode.
899c609719bSwdenk
900c609719bSwdenk		This feature is especially useful when "preboot" is
901c609719bSwdenk		automatically generated or modified. For an example
902c609719bSwdenk		see the LWMON board specific code: here "preboot" is
903c609719bSwdenk		modified when the user holds down a certain
904c609719bSwdenk		combination of keys on the (special) keyboard when
905c609719bSwdenk		booting the systems
906c609719bSwdenk
907c609719bSwdenk- Serial Download Echo Mode:
908c609719bSwdenk		CONFIG_LOADS_ECHO
909c609719bSwdenk		If defined to 1, all characters received during a
910c609719bSwdenk		serial download (using the "loads" command) are
911c609719bSwdenk		echoed back. This might be needed by some terminal
912c609719bSwdenk		emulations (like "cu"), but may as well just take
913c609719bSwdenk		time on others. This setting #define's the initial
914c609719bSwdenk		value of the "loads_echo" environment variable.
915c609719bSwdenk
916602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
917c609719bSwdenk		CONFIG_KGDB_BAUDRATE
918c609719bSwdenk		Select one of the baudrates listed in
9196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
920c609719bSwdenk
921c609719bSwdenk- Monitor Functions:
922602ad3b3SJon Loeliger		Monitor commands can be included or excluded
923602ad3b3SJon Loeliger		from the build by using the #include files
924c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
925ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
926c609719bSwdenk
927602ad3b3SJon Loeliger		The default command configuration includes all commands
928602ad3b3SJon Loeliger		except those marked below with a "*".
929602ad3b3SJon Loeliger
930b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
931602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
932602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
933602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
934602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
935602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
936602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
937d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
938602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
93908d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
940602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
941710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
942602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
943602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
944602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
945a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
946a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
947a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
948a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
949602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
950602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
951246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
952602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
953aa9e6044SNikita Kiryanov		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
954602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9555e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
956fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
95788733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9580c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
95903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
96003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
96116f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
96216f4d933SStephen Warren					  that work for multiple fs types
96359e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
964bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
965602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
96603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
967602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
968602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9694d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
97053fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
971a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
972a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
973bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
974602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
975602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
976602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9778fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9784d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
979602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
980aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
9810c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
982c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
983602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
984602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
985602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
986602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9874d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
988d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
989d22c338eSJoe Hershberger					  (169.254.*.*)
990602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
991602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9924d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
99302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
99415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
995602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
996a2681707SWolfgang Denk					  loop, loopw
9974d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
998602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
999602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1000602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
100168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1002602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1003602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10044d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1005e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1006e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1007602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1008602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1009602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1010602ad3b3SJon Loeliger					  host
1011602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1012ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1013602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1014602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1015d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1016602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1017c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
1018602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1019602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1020602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1021602ad3b3SJon Loeliger					  (4xx only)
1022f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10234d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
102402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10257d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
102674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1027602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10287a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10291fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1030da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1031da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1032602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1033602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1034c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10354d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
103689c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1037c609719bSwdenk
1038c609719bSwdenk		EXAMPLE: If you want all functions except of network
1039c609719bSwdenk		support you can write:
1040c609719bSwdenk
1041602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1042602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1043c609719bSwdenk
1044213bf8c8SGerald Van Baren	Other Commands:
1045213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1046c609719bSwdenk
1047c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1048602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1049c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1050c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1051c609719bSwdenk		8260 (where accesses to the IMMR region must be
1052c609719bSwdenk		uncached), and it cannot be disabled on all other
1053c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1054c609719bSwdenk		initial stack and some data.
1055c609719bSwdenk
1056c609719bSwdenk
1057c609719bSwdenk		XXX - this list needs to get updated!
1058c609719bSwdenk
1059302a6487SSimon Glass- Removal of commands
1060302a6487SSimon Glass		If no commands are needed to boot, you can disable
1061302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
1062302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
1063302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
1064302a6487SSimon Glass		instead. This can reduce image size significantly for very
1065302a6487SSimon Glass		simple boot procedures.
1066302a6487SSimon Glass
1067a5ecbe62SWolfgang Denk- Regular expression support:
1068a5ecbe62SWolfgang Denk		CONFIG_REGEX
1069a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1070a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1071a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1072a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1073a5ecbe62SWolfgang Denk
107445ba8077SSimon Glass- Device tree:
107545ba8077SSimon Glass		CONFIG_OF_CONTROL
107645ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
107745ba8077SSimon Glass		to configure its devices, instead of relying on statically
107845ba8077SSimon Glass		compiled #defines in the board file. This option is
107945ba8077SSimon Glass		experimental and only available on a few boards. The device
108045ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
108145ba8077SSimon Glass
10822c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10832c0f79e4SSimon Glass		be done using one of the two options below:
1084bbb0b128SSimon Glass
1085bbb0b128SSimon Glass		CONFIG_OF_EMBED
1086bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1087bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1088bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1089bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1090bbb0b128SSimon Glass		the global data structure as gd->blob.
109145ba8077SSimon Glass
10922c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10932c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10942c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10952c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10962c0f79e4SSimon Glass
10972c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10982c0f79e4SSimon Glass
10992c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
11002c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
11012c0f79e4SSimon Glass		still use the individual files if you need something more
11022c0f79e4SSimon Glass		exotic.
11032c0f79e4SSimon Glass
1104c609719bSwdenk- Watchdog:
1105c609719bSwdenk		CONFIG_WATCHDOG
1106c609719bSwdenk		If this variable is defined, it enables watchdog
11076abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11086abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11096abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11106abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11116abe6fb6SDetlev Zundel		available, then no further board specific code should
11126abe6fb6SDetlev Zundel		be needed to use it.
11136abe6fb6SDetlev Zundel
11146abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11156abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11166abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11176abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1118c609719bSwdenk
11197bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
11207bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
11217bae0d6fSHeiko Schocher
1122c1551ea8Sstroese- U-Boot Version:
1123c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1124c1551ea8Sstroese		If this variable is defined, an environment variable
1125c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1126c1551ea8Sstroese		version as printed by the "version" command.
1127a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1128a1ea8e51SBenoît Thébaudeau		next reset.
1129c1551ea8Sstroese
1130c609719bSwdenk- Real-Time Clock:
1131c609719bSwdenk
1132602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1133c609719bSwdenk		has to be selected, too. Define exactly one of the
1134c609719bSwdenk		following options:
1135c609719bSwdenk
1136c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1137c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11384e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1139c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11401cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1141c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11427f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1143412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
11443bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11459536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11464c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
114871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
114971d19f30SHeiko Schocher					  RV3029 RTC.
1150c609719bSwdenk
1151b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1152b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1153b37c7e5eSwdenk
1154e92739d3SPeter Tyser- GPIO Support:
1155e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1156e92739d3SPeter Tyser
11575dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11585dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11595dec49caSChris Packham		pins supported by a particular chip.
11605dec49caSChris Packham
1161e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1162e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1163e92739d3SPeter Tyser
1164aa53233aSSimon Glass- I/O tracing:
1165aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1166aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1167aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1168aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1169aa53233aSSimon Glass		the driver behaves the same way before and after a code
1170aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1171aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1172aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1173aa53233aSSimon Glass
1174aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1175aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1176aa53233aSSimon Glass		still continue to operate.
1177aa53233aSSimon Glass
1178aa53233aSSimon Glass			iotrace is enabled
1179aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1180aa53233aSSimon Glass			Size:   00010000	(buffer size)
1181aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1182aa53233aSSimon Glass			Output: 10000120	(start + offset)
1183aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1184aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1185aa53233aSSimon Glass
1186c609719bSwdenk- Timestamp Support:
1187c609719bSwdenk
1188c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1189c609719bSwdenk		(date and time) of an image is printed by image
1190c609719bSwdenk		commands like bootm or iminfo. This option is
1191602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1192c609719bSwdenk
1193923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1194923c46f9SKarl O. Pinc		Zero or more of the following:
1195923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1196923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1197923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1198923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1199923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1200923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1201923c46f9SKarl O. Pinc				       disk/part_efi.c
1202923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1203c609719bSwdenk
1204602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1205c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1206923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1207c609719bSwdenk
1208c609719bSwdenk- IDE Reset method:
12094d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
12104d13cbadSwdenk		board configurations files but used nowhere!
1211c609719bSwdenk
12124d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
12134d13cbadSwdenk		be performed by calling the function
12144d13cbadSwdenk			ide_set_reset(int reset)
12154d13cbadSwdenk		which has to be defined in a board specific file
1216c609719bSwdenk
1217c609719bSwdenk- ATAPI Support:
1218c609719bSwdenk		CONFIG_ATAPI
1219c609719bSwdenk
1220c609719bSwdenk		Set this to enable ATAPI support.
1221c609719bSwdenk
1222c40b2956Swdenk- LBA48 Support
1223c40b2956Swdenk		CONFIG_LBA48
1224c40b2956Swdenk
1225c40b2956Swdenk		Set this to enable support for disks larger than 137GB
12264b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1227c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1228c40b2956Swdenk		support disks up to 2.1TB.
1229c40b2956Swdenk
12306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1231c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1232c40b2956Swdenk			Default is 32bit.
1233c40b2956Swdenk
1234c609719bSwdenk- SCSI Support:
1235c609719bSwdenk		At the moment only there is only support for the
1236c609719bSwdenk		SYM53C8XX SCSI controller; define
1237c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1238c609719bSwdenk
12396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1242c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1243c609719bSwdenk		devices.
12446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1245c609719bSwdenk
1246447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1247447c031bSStefan Reinauer		SCSI devices found during the last scan.
1248447c031bSStefan Reinauer
1249c609719bSwdenk- NETWORK Support (PCI):
1250682011ffSwdenk		CONFIG_E1000
1251ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1252ce5207e1SKyle Moffett
1253ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1254ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1255ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1256ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1257ce5207e1SKyle Moffett
1258ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1259ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1260ce5207e1SKyle Moffett		example with the "sspi" command.
1261ce5207e1SKyle Moffett
1262ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1263ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1264ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1265682011ffSwdenk
1266c609719bSwdenk		CONFIG_EEPRO100
1267c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
126811ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1269c609719bSwdenk		write routine for first time initialisation.
1270c609719bSwdenk
1271c609719bSwdenk		CONFIG_TULIP
1272c609719bSwdenk		Support for Digital 2114x chips.
1273c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1274c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1275c609719bSwdenk
1276c609719bSwdenk		CONFIG_NATSEMI
1277c609719bSwdenk		Support for National dp83815 chips.
1278c609719bSwdenk
1279c609719bSwdenk		CONFIG_NS8382X
1280c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1281c609719bSwdenk
128245219c46Swdenk- NETWORK Support (other):
128345219c46Swdenk
1284c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1285c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1286c041e9d2SJens Scharsig
1287c041e9d2SJens Scharsig			CONFIG_RMII
1288c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1289c041e9d2SJens Scharsig
1290c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1291c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1292c041e9d2SJens Scharsig			The driver doen't show link status messages.
1293c041e9d2SJens Scharsig
1294efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1295efdd7319SRob Herring		Support for the Calxeda XGMAC device
1296efdd7319SRob Herring
12973bb46d23SAshok		CONFIG_LAN91C96
129845219c46Swdenk		Support for SMSC's LAN91C96 chips.
129945219c46Swdenk
130045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
130145219c46Swdenk			Define this to enable 32 bit addressing
130245219c46Swdenk
13033bb46d23SAshok		CONFIG_SMC91111
1304f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1305f39748aeSwdenk
1306f39748aeSwdenk			CONFIG_SMC91111_BASE
1307f39748aeSwdenk			Define this to hold the physical address
1308f39748aeSwdenk			of the device (I/O space)
1309f39748aeSwdenk
1310f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1311f39748aeSwdenk			Define this if data bus is 32 bits
1312f39748aeSwdenk
1313f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1314f39748aeSwdenk			Define this to use i/o functions instead of macros
1315f39748aeSwdenk			(some hardware wont work with macros)
1316f39748aeSwdenk
1317dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1318dc02badaSHeiko Schocher		Support for davinci emac
1319dc02badaSHeiko Schocher
1320dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1321dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1322dc02badaSHeiko Schocher
1323b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1324b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1325b3dbf4a5SMacpaul Lin
1326b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1327b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1328b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1329b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1330b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1331b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1332b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1333b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1334b3dbf4a5SMacpaul Lin
1335c2fff331SMike Rapoport		CONFIG_SMC911X
1336557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1337557b377dSJens Gehrlein
1338c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1339557b377dSJens Gehrlein			Define this to hold the physical address
1340557b377dSJens Gehrlein			of the device (I/O space)
1341557b377dSJens Gehrlein
1342c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1343557b377dSJens Gehrlein			Define this if data bus is 32 bits
1344557b377dSJens Gehrlein
1345c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1346557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1347557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1348c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1349557b377dSJens Gehrlein
13503d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13513d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13523d0075faSYoshihiro Shimoda
13533d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13543d0075faSYoshihiro Shimoda			Define the number of ports to be used
13553d0075faSYoshihiro Shimoda
13563d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13573d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13583d0075faSYoshihiro Shimoda
135968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
136068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
136168260aabSYoshihiro Shimoda
1362b2f97cf2SHeiko Schocher- PWM Support:
1363b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
1364b2f97cf2SHeiko Schocher		Support for PWM modul on the imx6.
1365b2f97cf2SHeiko Schocher
13665e124724SVadim Bendebury- TPM Support:
136790899cc0SChe-liang Chiou		CONFIG_TPM
136890899cc0SChe-liang Chiou		Support TPM devices.
136990899cc0SChe-liang Chiou
13700766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
13710766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
13721b393db5STom Wai-Hong Tam		per system is supported at this time.
13731b393db5STom Wai-Hong Tam
13741b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13751b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13761b393db5STom Wai-Hong Tam
13773aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
13783aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
13793aa74088SChristophe Ricard
13803aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
13813aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
13823aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
13833aa74088SChristophe Ricard
1384b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1385b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1386b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1387b75fdc11SChristophe Ricard
1388c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1389c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1390c01939c7SDirk Eibach
139190899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13925e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13935e124724SVadim Bendebury		per system is supported at this time.
13945e124724SVadim Bendebury
13955e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13965e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13975e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13985e124724SVadim Bendebury			0xfed40000.
13995e124724SVadim Bendebury
1400be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1401be6c1529SReinhard Pfau		Add tpm monitor functions.
1402be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1403be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1404be6c1529SReinhard Pfau
1405be6c1529SReinhard Pfau		CONFIG_TPM
1406be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1407be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1408be6c1529SReinhard Pfau		Requires support for a TPM device.
1409be6c1529SReinhard Pfau
1410be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1411be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1412be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1413be6c1529SReinhard Pfau
1414c609719bSwdenk- USB Support:
1415c609719bSwdenk		At the moment only the UHCI host controller is
14164d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1417c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1418c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
141930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1420c609719bSwdenk		storage devices.
1421c609719bSwdenk		Note:
1422c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1423c609719bSwdenk		(TEAC FD-05PUB).
14244d13cbadSwdenk		MPC5200 USB requires additional defines:
14254d13cbadSwdenk			CONFIG_USB_CLOCK
14264d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1427307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1428307ecb6dSEric Millbrandt				for USB on PSC3
14294d13cbadSwdenk			CONFIG_USB_CONFIG
14304d13cbadSwdenk				for differential drivers: 0x00001000
14314d13cbadSwdenk				for single ended drivers: 0x00005000
1432307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1433307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1435fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1436fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14374d13cbadSwdenk
14389ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14399ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14409ab4ce22SSimon Glass
14416e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
14426e9e0626SOleksandr Tymoshenko		HW module registers.
14436e9e0626SOleksandr Tymoshenko
144416c8d5e7SWolfgang Denk- USB Device:
144516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
144616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
144716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
144811ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
144916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
145016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
145116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
145216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
145316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
145416c8d5e7SWolfgang Denk		a Linux host by
145516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
145616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
145716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
145816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
145916c8d5e7SWolfgang Denk
146016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
146116c8d5e7SWolfgang Denk			Define this to build a UDC device
146216c8d5e7SWolfgang Denk
146316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
146416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
146516c8d5e7SWolfgang Denk			talk to the UDC device
146616c8d5e7SWolfgang Denk
1467f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1468f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1469f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1470f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1471f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1472f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1473f9da0f89SVipin KUMAR			speed.
1474f9da0f89SVipin KUMAR
14756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
147616c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
147716c8d5e7SWolfgang Denk			be set to usbtty.
147816c8d5e7SWolfgang Denk
147916c8d5e7SWolfgang Denk			mpc8xx:
14806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
148116c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
148316c8d5e7SWolfgang Denk
148416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
148516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
148616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
148716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
148816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
148916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
149016c8d5e7SWolfgang Denk
149116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
149216c8d5e7SWolfgang Denk			Define this string as the name of your company for
149316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
149416c8d5e7SWolfgang Denk
149516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
149616c8d5e7SWolfgang Denk			Define this string as the name of your product
149716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
149816c8d5e7SWolfgang Denk
149916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
150016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
150116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
150216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
150316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
150416c8d5e7SWolfgang Denk
150516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
150616c8d5e7SWolfgang Denk			Define this as the unique Product ID
150716c8d5e7SWolfgang Denk			for your device
150816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1509c609719bSwdenk
1510d70a560fSIgor Grinberg- ULPI Layer Support:
1511d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1512d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1513d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1514d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1515d70a560fSIgor Grinberg		viewport is supported.
1516d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1517d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
15186d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
15196d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15206d365ea0SLucas Stach		the appropriate value in Hz.
1521c609719bSwdenk
1522c609719bSwdenk- MMC Support:
1523c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1524c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1525c609719bSwdenk		accessed from the boot prompt by mapping the device
1526c609719bSwdenk		to physical memory similar to flash. Command line is
1527602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1528602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1529c609719bSwdenk
1530afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1531afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1532afb35666SYoshihiro Shimoda
1533afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1534afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1535afb35666SYoshihiro Shimoda
1536afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1537afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1538afb35666SYoshihiro Shimoda
15391fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
15401fd93c6eSPierre Aubert		Enable the generic MMC driver
15411fd93c6eSPierre Aubert
15421fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
15431fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
15441fd93c6eSPierre Aubert
15451fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
15461fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
15471fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
15481fd93c6eSPierre Aubert
1549b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
155001acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1551b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1552b3ba6e94STom Rini
1553b3ba6e94STom Rini		CONFIG_CMD_DFU
1554b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1555b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1556b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1557b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1558b3ba6e94STom Rini
1559b3ba6e94STom Rini		CONFIG_DFU_MMC
1560b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1561b3ba6e94STom Rini
1562c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1563c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1564c6631764SPantelis Antoniou
1565a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1566a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1567a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1568a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1569a9479f04SAfzal Mohammed		one that would help mostly the developer.
1570a9479f04SAfzal Mohammed
1571e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1572e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1573e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1574e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1575e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1576e7e75c70SHeiko Schocher
1577ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1578ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1579ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1580ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1581ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1582ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1583ea2453d5SPantelis Antoniou
1584001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1585001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1586001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1587001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1588001a8319SHeiko Schocher
1589001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1590001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1591001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1592001a8319SHeiko Schocher		sending again an USB request to the device.
1593001a8319SHeiko Schocher
15943aab70afSSebastian Siewior- USB Device Android Fastboot support:
159517da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
159617da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
159717da3c0cSPaul Kocialkowski
15983aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
15993aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
16003aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
16013aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
16023aab70afSSebastian Siewior		used on Android devices.
16033aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
16043aab70afSSebastian Siewior
16053aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
16063aab70afSSebastian Siewior		This enables support for booting images which use the Android
16073aab70afSSebastian Siewior		image format header.
16083aab70afSSebastian Siewior
1609a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
16103aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16113aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
16123aab70afSSebastian Siewior		downloaded images.
16133aab70afSSebastian Siewior
1614a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
16153aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
16163aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
16173aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
16183aab70afSSebastian Siewior
1619d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1620d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1621d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1622d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1623d1b5ed07SSteve Rae
1624d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1625d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1626d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1627d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1628d1b5ed07SSteve Rae
16290ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
16300ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
16310ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
16320ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
16330ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
16340ff7e585SSteve Rae		This occurs when the specified "partition name" on the
16350ff7e585SSteve Rae		"fastboot flash" command line matches this value.
16366f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
16370ff7e585SSteve Rae
1638b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1639b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1640b6dd69a4SPetr Kulhavy		image to DOS MBR.
1641b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1642b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1643b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1644b6dd69a4SPetr Kulhavy
16456705d81eSwdenk- Journaling Flash filesystem support:
1646b2482dffSSimon Glass		CONFIG_JFFS2_NAND
16476705d81eSwdenk		Define these for a default partition on a NAND device
16486705d81eSwdenk
16496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
16506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
16516705d81eSwdenk		Define these for a default partition on a NOR device
16526705d81eSwdenk
1653c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1654c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1655656f4c65SDonggeun Kim
1656656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1657656f4c65SDonggeun Kim		file in FAT formatted partition.
1658656f4c65SDonggeun Kim
1659656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1660656f4c65SDonggeun Kim		user to write files to FAT.
1661c30a15e5SDonggeun Kim
166284cd9327SGabe BlackCBFS (Coreboot Filesystem) support
166384cd9327SGabe Black		CONFIG_CMD_CBFS
166484cd9327SGabe Black
166584cd9327SGabe Black		Define this to enable support for reading from a Coreboot
166684cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
166784cd9327SGabe Black		and cbfsload.
166884cd9327SGabe Black
16694f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
16704f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
16714f0d1a2aSSiva Durga Prasad Paladugu
16724f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
16734f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
16744f0d1a2aSSiva Durga Prasad Paladugu
1675c609719bSwdenk- Keyboard Support:
167639f615edSSimon Glass		See Kconfig help for available keyboard drivers.
167739f615edSSimon Glass
167839f615edSSimon Glass		CONFIG_KEYBOARD
167939f615edSSimon Glass
168039f615edSSimon Glass		Define this to enable a custom keyboard support.
168139f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
168239f615edSSimon Glass		defined in your board-specific files. This option is deprecated
168339f615edSSimon Glass		and is only used by novena. For new boards, use driver model
168439f615edSSimon Glass		instead.
1685c609719bSwdenk
1686c609719bSwdenk- Video support:
1687c609719bSwdenk		CONFIG_VIDEO
1688c609719bSwdenk
1689c609719bSwdenk		Define this to enable video support (for output to
1690c609719bSwdenk		video).
1691c609719bSwdenk
1692c609719bSwdenk		CONFIG_VIDEO_CT69000
1693c609719bSwdenk
1694c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1695c609719bSwdenk
1696c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1697eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1698eeb1b77bSwdenk		video output is selected via environment 'videoout'
1699eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1700eeb1b77bSwdenk		assumed.
1701c609719bSwdenk
1702eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
170311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1704eeb1b77bSwdenk		are possible:
1705eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1706eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1707eeb1b77bSwdenk
1708eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1709eeb1b77bSwdenk		-------------+---------------------------------------------
1710eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1711eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1712eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1713eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1714eeb1b77bSwdenk		-------------+---------------------------------------------
1715c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1716c609719bSwdenk
1717eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
17187817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1719eeb1b77bSwdenk
1720eeb1b77bSwdenk
1721a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1722a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1723a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1724a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1725a6c7ad2fSwdenk
17267d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
17277d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
17287d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
17297d3053fbSTimur Tabi		support, and should also define these other macros:
17307d3053fbSTimur Tabi
17317d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
17327d3053fbSTimur Tabi			CONFIG_VIDEO
17337d3053fbSTimur Tabi			CONFIG_CMD_BMP
17347d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
17357d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
17367d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
17377d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
17387d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
17397d3053fbSTimur Tabi
1740ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1741ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
17428eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1743ba8e76bdSTimur Tabi		description of this variable.
17447d3053fbSTimur Tabi
1745c609719bSwdenk- LCD Support:	CONFIG_LCD
1746c609719bSwdenk
1747c609719bSwdenk		Define this to enable LCD support (for output to LCD
1748c609719bSwdenk		display); also select one of the supported displays
1749c609719bSwdenk		by defining one of these:
1750c609719bSwdenk
175139cf4804SStelian Pop		CONFIG_ATMEL_LCD:
175239cf4804SStelian Pop
175339cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
175439cf4804SStelian Pop
1755fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1756c609719bSwdenk
1757fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1758c609719bSwdenk
1759fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1760c609719bSwdenk
1761fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1762fd3103bbSwdenk			Active, color, single scan.
1763fd3103bbSwdenk
1764fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1765fd3103bbSwdenk
1766fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1767c609719bSwdenk			Active, color, single scan.
1768c609719bSwdenk
1769c609719bSwdenk		CONFIG_SHARP_16x9
1770c609719bSwdenk
1771c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1772c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1773c609719bSwdenk
1774c609719bSwdenk		CONFIG_SHARP_LQ64D341
1775c609719bSwdenk
1776c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1777c609719bSwdenk			Active, color, single scan.
1778c609719bSwdenk
1779c609719bSwdenk		CONFIG_HLD1045
1780c609719bSwdenk
1781c609719bSwdenk			HLD1045 display, 640x480.
1782c609719bSwdenk			Active, color, single scan.
1783c609719bSwdenk
1784c609719bSwdenk		CONFIG_OPTREX_BW
1785c609719bSwdenk
1786c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1787c609719bSwdenk			or
1788c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1789c609719bSwdenk			or
1790c609719bSwdenk			Hitachi	 SP14Q002
1791c609719bSwdenk
1792c609719bSwdenk			320x240. Black & white.
1793c609719bSwdenk
1794c609719bSwdenk		Normally display is black on white background; define
17956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1796c609719bSwdenk
1797676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1798676d319eSSimon Glass
1799b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1800676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1801676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1802676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1803676d319eSSimon Glass		a per-section basis.
1804676d319eSSimon Glass
18050d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
18060d89efefSSimon Glass
18070d89efefSSimon Glass		When the console need to be scrolled, this is the number of
18080d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
18090d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
18100d89efefSSimon Glass		is slow.
1811676d319eSSimon Glass
1812604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1813604c7d4aSHannes Petermaier
1814604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1815604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1816604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1817604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1818604c7d4aSHannes Petermaier		printed out.
1819604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1820604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1821604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1822604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1823604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1824604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1825604c7d4aSHannes Petermaier		1 = 90 degree rotation
1826604c7d4aSHannes Petermaier		2 = 180 degree rotation
1827604c7d4aSHannes Petermaier		3 = 270 degree rotation
1828604c7d4aSHannes Petermaier
1829604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1830604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1831604c7d4aSHannes Petermaier
183245d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
183345d7f525STom Wai-Hong Tam
183445d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
183545d7f525STom Wai-Hong Tam
1836735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1837735987c5STom Wai-Hong Tam
1838735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1839735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1840735987c5STom Wai-Hong Tam
18417152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1842d791b1dcSwdenk
1843d791b1dcSwdenk		If this option is set, the environment is checked for
1844d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1845d791b1dcSwdenk		of logo, copyright and system information on the LCD
1846e94d2cd9Swdenk		is suppressed and the BMP image at the address
1847d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1848d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1849d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1850d791b1dcSwdenk		loaded very quickly after power-on.
1851d791b1dcSwdenk
1852c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1853c0880485SNikita Kiryanov
1854c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1855c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1856ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1857c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1858c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1859c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1860c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1861c0880485SNikita Kiryanov		there is no need to set this option.
1862c0880485SNikita Kiryanov
18631ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
18641ca298ceSMatthias Weisser
18651ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
18661ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
18671ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
18681ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
18691ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
18701ca298ceSMatthias Weisser		specify 'm' for centering the image.
18711ca298ceSMatthias Weisser
18721ca298ceSMatthias Weisser		Example:
18731ca298ceSMatthias Weisser		setenv splashpos m,m
18741ca298ceSMatthias Weisser			=> image at center of screen
18751ca298ceSMatthias Weisser
18761ca298ceSMatthias Weisser		setenv splashpos 30,20
18771ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18781ca298ceSMatthias Weisser
18791ca298ceSMatthias Weisser		setenv splashpos -10,m
18801ca298ceSMatthias Weisser			=> vertically centered image
18811ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18821ca298ceSMatthias Weisser
188398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
188498f4a3dfSStefan Roese
188598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
188698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
188798f4a3dfSStefan Roese		splashscreen support or the bmp command.
188898f4a3dfSStefan Roese
1889d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1890d5011762SAnatolij Gustschin
1891d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1892d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1893d5011762SAnatolij Gustschin		bmp command.
1894d5011762SAnatolij Gustschin
1895b445bbb4SJeremiah Mahler- Do compressing for memory range:
1896f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1897f2b96dfbSLei Wen
1898f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1899f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1900f2b96dfbSLei Wen
1901c29fdfc1Swdenk- Compression support:
19028ef70478SKees Cook		CONFIG_GZIP
19038ef70478SKees Cook
19048ef70478SKees Cook		Enabled by default to support gzip compressed images.
19058ef70478SKees Cook
1906c29fdfc1Swdenk		CONFIG_BZIP2
1907c29fdfc1Swdenk
1908c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1909c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1910c29fdfc1Swdenk		compressed images are supported.
1911c29fdfc1Swdenk
1912c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
19136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1914c29fdfc1Swdenk		be at least 4MB.
1915d791b1dcSwdenk
1916fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1917fc9c1727SLuigi 'Comio' Mantellini
1918fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1919fc9c1727SLuigi 'Comio' Mantellini		images is included.
1920fc9c1727SLuigi 'Comio' Mantellini
1921fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1922fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1923fc9c1727SLuigi 'Comio' Mantellini		formula:
1924fc9c1727SLuigi 'Comio' Mantellini
1925fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1926fc9c1727SLuigi 'Comio' Mantellini
1927fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1928fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1929fc9c1727SLuigi 'Comio' Mantellini
1930fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1931fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1932fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1933fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1934fc9c1727SLuigi 'Comio' Mantellini
1935fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1936fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
19376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1938fc9c1727SLuigi 'Comio' Mantellini
19398ef70478SKees Cook		CONFIG_LZO
19408ef70478SKees Cook
19418ef70478SKees Cook		If this option is set, support for LZO compressed images
19428ef70478SKees Cook		is included.
19438ef70478SKees Cook
194417ea1177Swdenk- MII/PHY support:
194517ea1177Swdenk		CONFIG_PHY_ADDR
194617ea1177Swdenk
194717ea1177Swdenk		The address of PHY on MII bus.
194817ea1177Swdenk
194917ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
195017ea1177Swdenk
195117ea1177Swdenk		The clock frequency of the MII bus
195217ea1177Swdenk
195317ea1177Swdenk		CONFIG_PHY_GIGE
195417ea1177Swdenk
195517ea1177Swdenk		If this option is set, support for speed/duplex
195611ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
195717ea1177Swdenk
195817ea1177Swdenk		CONFIG_PHY_RESET_DELAY
195917ea1177Swdenk
196017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
196117ea1177Swdenk		reset before any MII register access is possible.
196217ea1177Swdenk		For such PHY, set this option to the usec delay
196317ea1177Swdenk		required. (minimum 300usec for LXT971A)
196417ea1177Swdenk
196517ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
196617ea1177Swdenk
196717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
196817ea1177Swdenk		command issued before MII status register can be read
196917ea1177Swdenk
1970c609719bSwdenk- IP address:
1971c609719bSwdenk		CONFIG_IPADDR
1972c609719bSwdenk
1973c609719bSwdenk		Define a default value for the IP address to use for
197411ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1975c609719bSwdenk		determined through e.g. bootp.
19761ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1977c609719bSwdenk
1978c609719bSwdenk- Server IP address:
1979c609719bSwdenk		CONFIG_SERVERIP
1980c609719bSwdenk
1981c609719bSwdenk		Defines a default value for the IP address of a TFTP
1982c609719bSwdenk		server to contact when using the "tftboot" command.
19831ebcd654SWolfgang Denk		(Environment variable "serverip")
1984c609719bSwdenk
198597cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
198697cfe861SRobin Getz
198797cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
198897cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
198997cfe861SRobin Getz
19901ebcd654SWolfgang Denk- Gateway IP address:
19911ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19921ebcd654SWolfgang Denk
19931ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19941ebcd654SWolfgang Denk		default router where packets to other networks are
19951ebcd654SWolfgang Denk		sent to.
19961ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19971ebcd654SWolfgang Denk
19981ebcd654SWolfgang Denk- Subnet mask:
19991ebcd654SWolfgang Denk		CONFIG_NETMASK
20001ebcd654SWolfgang Denk
20011ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
20021ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
20031ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
20041ebcd654SWolfgang Denk		forwarded through a router.
20051ebcd654SWolfgang Denk		(Environment variable "netmask")
20061ebcd654SWolfgang Denk
200753a5c424SDavid Updegraff- Multicast TFTP Mode:
200853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
200953a5c424SDavid Updegraff
201053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
201153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
201211ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
201353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
201453a5c424SDavid Updegraff		multicast group.
201553a5c424SDavid Updegraff
2016c609719bSwdenk- BOOTP Recovery Mode:
2017c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
2018c609719bSwdenk
2019c609719bSwdenk		If you have many targets in a network that try to
2020c609719bSwdenk		boot using BOOTP, you may want to avoid that all
2021c609719bSwdenk		systems send out BOOTP requests at precisely the same
2022c609719bSwdenk		moment (which would happen for instance at recovery
2023c609719bSwdenk		from a power failure, when all systems will try to
2024c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
2025c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2026c609719bSwdenk		inserted before sending out BOOTP requests. The
20276c33c785SWolfgang Denk		following delays are inserted then:
2028c609719bSwdenk
2029c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
2030c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
2031c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
2032c609719bSwdenk		4th and following
2033c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
2034c609719bSwdenk
203592ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
203692ac8accSThierry Reding
203792ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
203892ac8accSThierry Reding		server will copy the ID from client requests to responses and
203992ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
204092ac8accSThierry Reding		an incoming response. Some servers will check that addresses
204192ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
204292ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
204392ac8accSThierry Reding		respond. Network congestion may also influence the time it
204492ac8accSThierry Reding		takes for a response to make it back to the client. If that
204592ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
204692ac8accSThierry Reding		to allow earlier responses to still be accepted after these
204792ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
204892ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
204992ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
205092ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
205192ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
205292ac8accSThierry Reding
2053fe389a82Sstroese- DHCP Advanced Options:
20541fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
20551fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
2056fe389a82Sstroese
20571fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
20581fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
20591fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
20601fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
20611fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
20621fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
20631fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
20641fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
20651fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
20661fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
20671fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
20681fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
20692c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
2070fe389a82Sstroese
20715d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
20725d110f0aSWilson Callan		environment variable, not the BOOTP server.
2073fe389a82Sstroese
20742c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
20752c00e099SJoe Hershberger		after the configured retry count, the call will fail
20762c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
20772c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
20782c00e099SJoe Hershberger		is not available.
20792c00e099SJoe Hershberger
2080fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2081fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2082fe389a82Sstroese		than one DNS serverip is offered to the client.
2083fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2084fe389a82Sstroese		serverip will be stored in the additional environment
2085fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2086fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
20871fe80d79SJon Loeliger		is defined.
2088fe389a82Sstroese
2089fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2090fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2091fe389a82Sstroese		need the hostname of the DHCP requester.
20925d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20931fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20941fe80d79SJon Loeliger		option 12 to the DHCP server.
2095fe389a82Sstroese
2096d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2097d9a2f416SAras Vaichas
2098d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2099d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2100d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2101d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2102d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2103d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2104d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2105d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2106d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2107d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2108d9a2f416SAras Vaichas		this delay.
2109d9a2f416SAras Vaichas
2110d22c338eSJoe Hershberger - Link-local IP address negotiation:
2111d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2112d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2113d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2114d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2115d22c338eSJoe Hershberger
2116d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2117d22c338eSJoe Hershberger
2118a3d991bdSwdenk - CDP Options:
2119a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2120a3d991bdSwdenk
2121a3d991bdSwdenk		The device id used in CDP trigger frames.
2122a3d991bdSwdenk
2123a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2124a3d991bdSwdenk
2125a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2126a3d991bdSwdenk		of the device.
2127a3d991bdSwdenk
2128a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2129a3d991bdSwdenk
2130a3d991bdSwdenk		A printf format string which contains the ascii name of
2131a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
213211ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2133a3d991bdSwdenk
2134a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2135a3d991bdSwdenk
2136a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2137a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2138a3d991bdSwdenk
2139a3d991bdSwdenk		CONFIG_CDP_VERSION
2140a3d991bdSwdenk
2141a3d991bdSwdenk		An ascii string containing the version of the software.
2142a3d991bdSwdenk
2143a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2144a3d991bdSwdenk
2145a3d991bdSwdenk		An ascii string containing the name of the platform.
2146a3d991bdSwdenk
2147a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2148a3d991bdSwdenk
2149a3d991bdSwdenk		A 32bit integer sent on the trigger.
2150a3d991bdSwdenk
2151a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2152a3d991bdSwdenk
2153a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2154a3d991bdSwdenk		device in .1 of milliwatts.
2155a3d991bdSwdenk
2156a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2157a3d991bdSwdenk
2158a3d991bdSwdenk		A byte containing the id of the VLAN.
2159a3d991bdSwdenk
2160c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2161c609719bSwdenk
2162c609719bSwdenk		Several configurations allow to display the current
2163c609719bSwdenk		status using a LED. For instance, the LED will blink
2164c609719bSwdenk		fast while running U-Boot code, stop blinking as
2165c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2166c609719bSwdenk		start blinking slow once the Linux kernel is running
2167c609719bSwdenk		(supported by a status LED driver in the Linux
2168c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2169c609719bSwdenk		feature in U-Boot.
2170c609719bSwdenk
21711df7bbbaSIgor Grinberg		Additional options:
21721df7bbbaSIgor Grinberg
21731df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
21741df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
21751df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
21761df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
21771df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
21781df7bbbaSIgor Grinberg
21799dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
21809dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
21819dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
21829dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
21839dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
21849dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
21859dfdcdfeSIgor Grinberg
2186c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2187c609719bSwdenk
2188c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2189c609719bSwdenk		on those systems that support this (optional)
2190c609719bSwdenk		feature, like the TQM8xxL modules.
2191c609719bSwdenk
21923f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2193c609719bSwdenk
21943f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21953f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21963f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21973f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21983f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21993f4978c7SHeiko Schocher		interface.
22003f4978c7SHeiko Schocher
22013f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2202ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2203ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2204ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2205ea818dbbSHeiko Schocher		    for defining speed and slave address
2206ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2207ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2208ea818dbbSHeiko Schocher		    for defining speed and slave address
2209ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2210ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2211ea818dbbSHeiko Schocher		    for defining speed and slave address
2212ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2213ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2214ea818dbbSHeiko Schocher		    for defining speed and slave address
22153f4978c7SHeiko Schocher
221600f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
221700f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
221800f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
221900f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
222000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
222100f792e0SHeiko Schocher		    bus.
222200f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
222300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
222400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
222500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
222600f792e0SHeiko Schocher		    second bus.
222700f792e0SHeiko Schocher
22281f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
22291f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
22301f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
22311f2ba722SSimon Glass		    100000 and the slave addr 0!
22321f2ba722SSimon Glass
2233880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2234880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2235880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2236880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2237880540deSDirk Eibach
2238fac96408Strem		- drivers/i2c/i2c_mxc.c
2239fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
224003544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
224103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
224203544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
224303544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2244fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2245fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2246fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2247fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2248fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2249fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
225003544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
225103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2252b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2253fac96408Strem		for speed, and 0 for slave.
2254fac96408Strem
22551086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
22561086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
22571086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
22581086bfa9SNobuhiro Iwamatsu
22591086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
22601086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
22611086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
22621086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
22631086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
22641086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
22651086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
22661086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
22671086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
22681086bfa9SNobuhiro Iwamatsu
22692035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
22702035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
22712035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
22722035d77dSNobuhiro Iwamatsu
22732035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
22742035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
22752035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
22762035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
22772035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
22782035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
22792035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
22802035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
22812035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
22822035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2283b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
22842035d77dSNobuhiro Iwamatsu
22856789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
22866789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
22876789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
22886789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
22896789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
22906789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
22916789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
22926789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
22936789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22946789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22956789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22966789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22976789e84eSHeiko Schocher
22980bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22990bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
23000bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
23010bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
23020bdffe71SHeiko Schocher
2303e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2304e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2305e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2306e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2307e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2308e717fc6dSNaveen Krishna Ch
2309b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2310b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2311b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2312b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2313b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2314b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2315b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2316b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2317b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2318b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2319b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2320b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2321b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2322b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2323071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2324071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2325071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2326071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2327071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2328071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2329071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2330071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2331071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2332b46226bdSDirk Eibach
23333f4978c7SHeiko Schocher		additional defines:
23343f4978c7SHeiko Schocher
23353f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2336*945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
23373f4978c7SHeiko Schocher
23383f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
23393f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
23403f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
23413f4978c7SHeiko Schocher		omit this define.
23423f4978c7SHeiko Schocher
23433f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
23443f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
23453f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
23463f4978c7SHeiko Schocher		define.
23473f4978c7SHeiko Schocher
23483f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2349b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
23503f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
23513f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
23523f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
23533f4978c7SHeiko Schocher
23543f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
23553f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
23563f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
23573f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
23583f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
23593f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
23603f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
23613f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
23623f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
23633f4978c7SHeiko Schocher					}
23643f4978c7SHeiko Schocher
23653f4978c7SHeiko Schocher		which defines
23663f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2367ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2368ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2369ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2370ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2371ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
23723f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2373ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2374ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
23753f4978c7SHeiko Schocher
23763f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
23773f4978c7SHeiko Schocher
2378ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
23793f4978c7SHeiko Schocher
23803f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
23813f4978c7SHeiko Schocher		provides the following compelling advantages:
23823f4978c7SHeiko Schocher
23833f4978c7SHeiko Schocher		- more than one i2c adapter is usable
23843f4978c7SHeiko Schocher		- approved multibus support
23853f4978c7SHeiko Schocher		- better i2c mux support
23863f4978c7SHeiko Schocher
23873f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
23883f4978c7SHeiko Schocher
2389ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2390ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2391ea818dbbSHeiko Schocher		for the selected CPU.
2392c609719bSwdenk
2393b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2394602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2395b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2396b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2397c609719bSwdenk		command line interface.
2398c609719bSwdenk
2399bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2400c609719bSwdenk
2401b37c7e5eSwdenk		There are several other quantities that must also be
2402ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2403c609719bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2405b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
24066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
240711ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2408c609719bSwdenk
24098d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2410a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
24118d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
24128d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
24138d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2414b37c7e5eSwdenk
24155da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
24165da71efaSEric Millbrandt
24175da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
24185da71efaSEric Millbrandt		chips might think that the current transfer is still
24195da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
24205da71efaSEric Millbrandt		commands until the slave device responds.
24215da71efaSEric Millbrandt
2422b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2423b37c7e5eSwdenk
2424ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2425b37c7e5eSwdenk		then the following macros need to be defined (examples are
2426b37c7e5eSwdenk		from include/configs/lwmon.h):
2427c609719bSwdenk
2428c609719bSwdenk		I2C_INIT
2429c609719bSwdenk
2430b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2431c609719bSwdenk		controller or configure ports.
2432c609719bSwdenk
2433b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2434b37c7e5eSwdenk
2435c609719bSwdenk		I2C_PORT
2436c609719bSwdenk
2437c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2438c609719bSwdenk		assumes both bits are on the same port). Valid values
2439c609719bSwdenk		are 0..3 for ports A..D.
2440c609719bSwdenk
2441c609719bSwdenk		I2C_ACTIVE
2442c609719bSwdenk
2443c609719bSwdenk		The code necessary to make the I2C data line active
2444c609719bSwdenk		(driven).  If the data line is open collector, this
2445c609719bSwdenk		define can be null.
2446c609719bSwdenk
2447b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2448b37c7e5eSwdenk
2449c609719bSwdenk		I2C_TRISTATE
2450c609719bSwdenk
2451c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2452c609719bSwdenk		(inactive).  If the data line is open collector, this
2453c609719bSwdenk		define can be null.
2454c609719bSwdenk
2455b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2456b37c7e5eSwdenk
2457c609719bSwdenk		I2C_READ
2458c609719bSwdenk
2459472d5460SYork Sun		Code that returns true if the I2C data line is high,
2460472d5460SYork Sun		false if it is low.
2461c609719bSwdenk
2462b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2463b37c7e5eSwdenk
2464c609719bSwdenk		I2C_SDA(bit)
2465c609719bSwdenk
2466472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2467472d5460SYork Sun		is false, it clears it (low).
2468c609719bSwdenk
2469b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2470b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2471b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2472b37c7e5eSwdenk
2473c609719bSwdenk		I2C_SCL(bit)
2474c609719bSwdenk
2475472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2476472d5460SYork Sun		is false, it clears it (low).
2477c609719bSwdenk
2478b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2479b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2480b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2481b37c7e5eSwdenk
2482c609719bSwdenk		I2C_DELAY
2483c609719bSwdenk
2484c609719bSwdenk		This delay is invoked four times per clock cycle so this
2485c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2486b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2487b37c7e5eSwdenk		like:
2488b37c7e5eSwdenk
2489b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2490c609719bSwdenk
2491793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2492793b5726SMike Frysinger
2493793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2494793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2495793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2496793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2497793b5726SMike Frysinger
2498793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2499793b5726SMike Frysinger		the generic GPIO functions.
2500793b5726SMike Frysinger
25016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
250247cd00faSwdenk
250347cd00faSwdenk		When a board is reset during an i2c bus transfer
250447cd00faSwdenk		chips might think that the current transfer is still
250547cd00faSwdenk		in progress. On some boards it is possible to access
250647cd00faSwdenk		the i2c SCLK line directly, either by using the
250747cd00faSwdenk		processor pin as a GPIO or by having a second pin
250847cd00faSwdenk		connected to the bus. If this option is defined a
250947cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
251047cd00faSwdenk		is run early in the boot sequence.
251147cd00faSwdenk
251226a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
251326a33504SRichard Retanubun
251426a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
251526a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
251626a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
251726a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
251826a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
251926a33504SRichard Retanubun		controller provide such a method. It is called at the end of
252026a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
252126a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
252226a33504SRichard Retanubun
252317ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
252417ea1177Swdenk
252517ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
252617ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
252717ea1177Swdenk		variable "i2cfast". (see also i2cfast)
252817ea1177Swdenk
2529bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2530bb99ad6dSBen Warren
2531bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2532bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2533bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2534bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2535bb99ad6dSBen Warren
25366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2537bb99ad6dSBen Warren
2538bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
25390f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
25400f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
25410f89c54bSPeter Tyser		a 1D array of device addresses
2542bb99ad6dSBen Warren
2543bb99ad6dSBen Warren		e.g.
2544bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
25456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2546bb99ad6dSBen Warren
2547bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2548bb99ad6dSBen Warren
2549bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2550*945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2551bb99ad6dSBen Warren
2552bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2553bb99ad6dSBen Warren
25546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2555be5e6181STimur Tabi
2556be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2557be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2558be5e6181STimur Tabi
25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
25600dc018ecSStefan Roese
25610dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
25620dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
25630dc018ecSStefan Roese
25646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
25650dc018ecSStefan Roese
25660dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
25670dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
25680dc018ecSStefan Roese
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
25709ebbb54fSVictor Gallardo
25719ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
25729ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
25739ebbb54fSVictor Gallardo		specified DTT device.
25749ebbb54fSVictor Gallardo
25752ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
25762ac6985aSAndrew Dyer
25772ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
25782ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
25792ac6985aSAndrew Dyer		between writing the address pointer and reading the
25802ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
25812ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
25822ac6985aSAndrew Dyer		devices can use either method, but some require one or
25832ac6985aSAndrew Dyer		the other.
2584be5e6181STimur Tabi
2585c609719bSwdenk- SPI Support:	CONFIG_SPI
2586c609719bSwdenk
2587c609719bSwdenk		Enables SPI driver (so far only tested with
2588c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2589c609719bSwdenk		D/As on the SACSng board)
2590c609719bSwdenk
25916639562eSYoshihiro Shimoda		CONFIG_SH_SPI
25926639562eSYoshihiro Shimoda
25936639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
25946639562eSYoshihiro Shimoda		only SH7757 is supported.
25956639562eSYoshihiro Shimoda
2596c609719bSwdenk		CONFIG_SOFT_SPI
2597c609719bSwdenk
2598c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2599c609719bSwdenk		using hardware support. This is a general purpose
2600c609719bSwdenk		driver that only requires three general I/O port pins
2601c609719bSwdenk		(two outputs, one input) to function. If this is
2602c609719bSwdenk		defined, the board configuration must define several
2603c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2604c609719bSwdenk		an example, see include/configs/sacsng.h.
2605c609719bSwdenk
260604a9e118SBen Warren		CONFIG_HARD_SPI
260704a9e118SBen Warren
260804a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
260904a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
261004a9e118SBen Warren		must define a list of chip-select function pointers.
261104a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
261204a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
261304a9e118SBen Warren
261438254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
261538254f45SGuennadi Liakhovetski
261638254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
26172e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
261838254f45SGuennadi Liakhovetski
2619f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2620f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2621f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2622f659b573SHeiko Schocher
26230133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
26240133502eSMatthias Fuchs
26250133502eSMatthias Fuchs		Enables FPGA subsystem.
26260133502eSMatthias Fuchs
26270133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
26280133502eSMatthias Fuchs
26290133502eSMatthias Fuchs		Enables support for specific chip vendors.
26300133502eSMatthias Fuchs		(ALTERA, XILINX)
26310133502eSMatthias Fuchs
26320133502eSMatthias Fuchs		CONFIG_FPGA_<family>
26330133502eSMatthias Fuchs
26340133502eSMatthias Fuchs		Enables support for FPGA family.
26350133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
26360133502eSMatthias Fuchs
26370133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2638c609719bSwdenk
2639c609719bSwdenk		Specify the number of FPGA devices to support.
2640c609719bSwdenk
264164e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
264264e809afSSiva Durga Prasad Paladugu
264364e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
264464e809afSSiva Durga Prasad Paladugu
264567193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
264667193864SMichal Simek
264767193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
264867193864SMichal Simek
264967193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
265067193864SMichal Simek
265167193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
265267193864SMichal Simek		(Xilinx only)
265367193864SMichal Simek
26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2655c609719bSwdenk
2656c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2657c609719bSwdenk
26586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2659c609719bSwdenk
2660c609719bSwdenk		Enable checks on FPGA configuration interface busy
2661c609719bSwdenk		status by the configuration function. This option
2662c609719bSwdenk		will require a board or device specific function to
2663c609719bSwdenk		be written.
2664c609719bSwdenk
2665c609719bSwdenk		CONFIG_FPGA_DELAY
2666c609719bSwdenk
2667c609719bSwdenk		If defined, a function that provides delays in the FPGA
2668c609719bSwdenk		configuration driver.
2669c609719bSwdenk
26706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2671c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2672c609719bSwdenk
26736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2674c609719bSwdenk
2675c609719bSwdenk		Check for configuration errors during FPGA bitfile
2676c609719bSwdenk		loading. For example, abort during Virtex II
2677c609719bSwdenk		configuration if the INIT_B line goes low (which
2678c609719bSwdenk		indicated a CRC error).
2679c609719bSwdenk
26806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2681c609719bSwdenk
2682b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2683b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2684c609719bSwdenk		FPGA configuration sequence. The default time is 500
268511ccc33fSMarcel Ziswiler		ms.
2686c609719bSwdenk
26876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2688c609719bSwdenk
2689b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
269011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2691c609719bSwdenk
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2693c609719bSwdenk
2694c609719bSwdenk		Time to wait after FPGA configuration. The default is
269511ccc33fSMarcel Ziswiler		200 ms.
2696c609719bSwdenk
2697c609719bSwdenk- Configuration Management:
2698b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2699b2b8a696SStefan Roese
2700b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2701b2b8a696SStefan Roese		with a special header) as build targets. By defining
2702b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2703b2b8a696SStefan Roese		special image will be automatically built upon calling
27046de80f21SSimon Glass		make / buildman.
2705b2b8a696SStefan Roese
2706c609719bSwdenk		CONFIG_IDENT_STRING
2707c609719bSwdenk
2708c609719bSwdenk		If defined, this string will be added to the U-Boot
2709c609719bSwdenk		version information (U_BOOT_VERSION)
2710c609719bSwdenk
2711c609719bSwdenk- Vendor Parameter Protection:
2712c609719bSwdenk
2713c609719bSwdenk		U-Boot considers the values of the environment
2714c609719bSwdenk		variables "serial#" (Board Serial Number) and
27157152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2716c609719bSwdenk		are set once by the board vendor / manufacturer, and
2717c609719bSwdenk		protects these variables from casual modification by
2718c609719bSwdenk		the user. Once set, these variables are read-only,
2719c609719bSwdenk		and write or delete attempts are rejected. You can
272011ccc33fSMarcel Ziswiler		change this behaviour:
2721c609719bSwdenk
2722c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2723c609719bSwdenk		file, the write protection for vendor parameters is
272447cd00faSwdenk		completely disabled. Anybody can change or delete
2725c609719bSwdenk		these parameters.
2726c609719bSwdenk
272792ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
272892ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
272911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2730c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2731c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2732c609719bSwdenk		read-only.]
2733c609719bSwdenk
27342598090bSJoe Hershberger		The same can be accomplished in a more flexible way
27352598090bSJoe Hershberger		for any variable by configuring the type of access
27362598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
27372598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
27382598090bSJoe Hershberger
2739c609719bSwdenk- Protected RAM:
2740c609719bSwdenk		CONFIG_PRAM
2741c609719bSwdenk
2742c609719bSwdenk		Define this variable to enable the reservation of
2743c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2744c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2745c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2746c609719bSwdenk		this default value by defining an environment
2747c609719bSwdenk		variable "pram" to the number of kB you want to
2748c609719bSwdenk		reserve. Note that the board info structure will
2749c609719bSwdenk		still show the full amount of RAM. If pRAM is
2750c609719bSwdenk		reserved, a new environment variable "mem" will
2751c609719bSwdenk		automatically be defined to hold the amount of
2752c609719bSwdenk		remaining RAM in a form that can be passed as boot
2753c609719bSwdenk		argument to Linux, for instance like that:
2754c609719bSwdenk
2755fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2756c609719bSwdenk			saveenv
2757c609719bSwdenk
2758c609719bSwdenk		This way you can tell Linux not to use this memory,
2759c609719bSwdenk		either, which results in a memory region that will
2760c609719bSwdenk		not be affected by reboots.
2761c609719bSwdenk
2762c609719bSwdenk		*WARNING* If your board configuration uses automatic
2763c609719bSwdenk		detection of the RAM size, you must make sure that
2764c609719bSwdenk		this memory test is non-destructive. So far, the
2765c609719bSwdenk		following board configurations are known to be
2766c609719bSwdenk		"pRAM-clean":
2767c609719bSwdenk
27681b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
27691b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2770544d97e9SWolfgang Denk			FLAGADM, TQM8260
2771c609719bSwdenk
277240fef049SGabe Black- Access to physical memory region (> 4GB)
277340fef049SGabe Black		Some basic support is provided for operations on memory not
277440fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
277540fef049SGabe Black		support access to more than 4GB of memory on 32-bit
277640fef049SGabe Black		machines using physical address extension or similar.
277740fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
277840fef049SGabe Black		currently only supports clearing the memory.
277940fef049SGabe Black
2780c609719bSwdenk- Error Recovery:
2781c609719bSwdenk		CONFIG_PANIC_HANG
2782c609719bSwdenk
2783c609719bSwdenk		Define this variable to stop the system in case of a
2784c609719bSwdenk		fatal error, so that you have to reset it manually.
2785c609719bSwdenk		This is probably NOT a good idea for an embedded
278611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2787c609719bSwdenk		automatically as fast as possible, but it may be
2788c609719bSwdenk		useful during development since you can try to debug
2789c609719bSwdenk		the conditions that lead to the situation.
2790c609719bSwdenk
2791c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2792c609719bSwdenk
2793c609719bSwdenk		This variable defines the number of retries for
2794c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2795c609719bSwdenk		before giving up the operation. If not defined, a
2796c609719bSwdenk		default value of 5 is used.
2797c609719bSwdenk
279840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
279940cb90eeSGuennadi Liakhovetski
280040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
280140cb90eeSGuennadi Liakhovetski
280248a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
280348a3e999STetsuyuki Kobayashi
280448a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
280548a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
280648a3e999STetsuyuki Kobayashi		try longer timeout such as
280748a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
280848a3e999STetsuyuki Kobayashi
2809c609719bSwdenk- Command Interpreter:
28108078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
281104a85b3bSwdenk
281204a85b3bSwdenk		Enable auto completion of commands using TAB.
281304a85b3bSwdenk
28146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2815c609719bSwdenk
2816c609719bSwdenk		This defines the secondary prompt string, which is
2817c609719bSwdenk		printed when the command interpreter needs more input
2818c609719bSwdenk		to complete a command. Usually "> ".
2819c609719bSwdenk
2820c609719bSwdenk	Note:
2821c609719bSwdenk
2822c609719bSwdenk		In the current implementation, the local variables
2823c609719bSwdenk		space and global environment variables space are
2824c609719bSwdenk		separated. Local variables are those you define by
28253b57fe0aSwdenk		simply typing `name=value'. To access a local
2826c609719bSwdenk		variable later on, you have write `$name' or
28273b57fe0aSwdenk		`${name}'; to execute the contents of a variable
28283b57fe0aSwdenk		directly type `$name' at the command prompt.
2829c609719bSwdenk
2830c609719bSwdenk		Global environment variables are those you use
2831c609719bSwdenk		setenv/printenv to work with. To run a command stored
2832c609719bSwdenk		in such a variable, you need to use the run command,
2833c609719bSwdenk		and you must not use the '$' sign to access them.
2834c609719bSwdenk
2835c609719bSwdenk		To store commands and special characters in a
2836c609719bSwdenk		variable, please use double quotation marks
2837c609719bSwdenk		surrounding the whole text of the variable, instead
2838c609719bSwdenk		of the backslashes before semicolons and special
2839c609719bSwdenk		symbols.
2840c609719bSwdenk
2841b445bbb4SJeremiah Mahler- Command Line Editing and History:
2842aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2843aa0c71acSWolfgang Denk
284411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2845aa0c71acSWolfgang Denk		command line input operations
2846aa0c71acSWolfgang Denk
2847f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2848f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2849f3b267b3SMarek Vasut
2850f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2851f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2852f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2853f3b267b3SMarek Vasut		and PS2.
2854f3b267b3SMarek Vasut
2855a8c7c708Swdenk- Default Environment:
2856c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2857c609719bSwdenk
2858c609719bSwdenk		Define this to contain any number of null terminated
2859c609719bSwdenk		strings (variable = value pairs) that will be part of
28607152b1d0Swdenk		the default environment compiled into the boot image.
28612262cfeeSwdenk
2862c609719bSwdenk		For example, place something like this in your
2863c609719bSwdenk		board's config file:
2864c609719bSwdenk
2865c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2866c609719bSwdenk			"myvar1=value1\0" \
2867c609719bSwdenk			"myvar2=value2\0"
2868c609719bSwdenk
2869c609719bSwdenk		Warning: This method is based on knowledge about the
2870c609719bSwdenk		internal format how the environment is stored by the
28712262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2872c609719bSwdenk		interface! Although it is unlikely that this format
28737152b1d0Swdenk		will change soon, there is no guarantee either.
2874c609719bSwdenk		You better know what you are doing here.
2875c609719bSwdenk
2876c609719bSwdenk		Note: overly (ab)use of the default environment is
2877c609719bSwdenk		discouraged. Make sure to check other ways to preset
287874de7aefSWolfgang Denk		the environment like the "source" command or the
2879c609719bSwdenk		boot command first.
2880c609719bSwdenk
28815e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
28825e724ca2SStephen Warren
28835e724ca2SStephen Warren		Define this in order to add variables describing the
28845e724ca2SStephen Warren		U-Boot build configuration to the default environment.
28855e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
28865e724ca2SStephen Warren
28875e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
28885e724ca2SStephen Warren
28895e724ca2SStephen Warren		- CONFIG_SYS_ARCH
28905e724ca2SStephen Warren		- CONFIG_SYS_CPU
28915e724ca2SStephen Warren		- CONFIG_SYS_BOARD
28925e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
28935e724ca2SStephen Warren		- CONFIG_SYS_SOC
28945e724ca2SStephen Warren
28957e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
28967e27f89fSTom Rini
28977e27f89fSTom Rini		Define this in order to add variables describing certain
28987e27f89fSTom Rini		run-time determined information about the hardware to the
28997e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
29007e27f89fSTom Rini
290106fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
290206fd8538SSimon Glass
290306fd8538SSimon Glass		Normally the environment is loaded when the board is
2904b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
290506fd8538SSimon Glass		that so that the environment is not available until
290606fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
290706fd8538SSimon Glass		this is instead controlled by the value of
290806fd8538SSimon Glass		/config/load-environment.
290906fd8538SSimon Glass
29103b10cf12SChris Packham- Parallel Flash support:
29113b10cf12SChris Packham		CONFIG_SYS_NO_FLASH
29123b10cf12SChris Packham
2913a187559eSBin Meng		Traditionally U-Boot was run on systems with parallel NOR
29143b10cf12SChris Packham		flash. This option is used to disable support for parallel NOR
29153b10cf12SChris Packham		flash. This option should be defined if the board does not have
29163b10cf12SChris Packham		parallel flash.
29173b10cf12SChris Packham
29183b10cf12SChris Packham		If this option is not defined one of the generic flash drivers
29193b10cf12SChris Packham		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
29203b10cf12SChris Packham		selected or the board must provide an implementation of the
29213b10cf12SChris Packham		flash API (see include/flash.h).
29223b10cf12SChris Packham
2923a8c7c708Swdenk- DataFlash Support:
29242abbe075Swdenk		CONFIG_HAS_DATAFLASH
29252abbe075Swdenk
29262abbe075Swdenk		Defining this option enables DataFlash features and
29272abbe075Swdenk		allows to read/write in Dataflash via the standard
29282abbe075Swdenk		commands cp, md...
29292abbe075Swdenk
2930f61ec45eSEric Nelson- Serial Flash support
2931f61ec45eSEric Nelson		CONFIG_CMD_SF
2932f61ec45eSEric Nelson
2933f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2934f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2935f61ec45eSEric Nelson
2936f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2937f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2938f61ec45eSEric Nelson		commands.
2939f61ec45eSEric Nelson
2940f61ec45eSEric Nelson		The following defaults may be provided by the platform
2941f61ec45eSEric Nelson		to handle the common case when only a single serial
2942f61ec45eSEric Nelson		flash is present on the system.
2943f61ec45eSEric Nelson
2944f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2945f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2946f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2947f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2948f61ec45eSEric Nelson
294924007273SSimon Glass		CONFIG_CMD_SF_TEST
295024007273SSimon Glass
295124007273SSimon Glass		Define this option to include a destructive SPI flash
295224007273SSimon Glass		test ('sf test').
295324007273SSimon Glass
2954b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2955b902e07cSJagannadha Sutradharudu Teki
2956b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2957b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2958b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
2959b902e07cSJagannadha Sutradharudu Teki
29603f85ce27Swdenk- SystemACE Support:
29613f85ce27Swdenk		CONFIG_SYSTEMACE
29623f85ce27Swdenk
29633f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
29643f85ce27Swdenk		chips attached via some sort of local bus. The address
296511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
29666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
29673f85ce27Swdenk
29683f85ce27Swdenk		#define CONFIG_SYSTEMACE
29696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
29703f85ce27Swdenk
29713f85ce27Swdenk		When SystemACE support is added, the "ace" device type
29723f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
29733f85ce27Swdenk
2974ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2975ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2976ecb0ccd9SWolfgang Denk
297728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2978ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
297928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2980ecb0ccd9SWolfgang Denk		number generator is used.
2981ecb0ccd9SWolfgang Denk
298228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
298328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
298428cb9375SWolfgang Denk		defined, the normal port 69 is used.
298528cb9375SWolfgang Denk
298628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2987ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2988ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2989ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2990ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2991ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2992ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2993ecb0ccd9SWolfgang Denk
2994bf36c5d5SSimon Glass- Hashing support:
2995bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2996bf36c5d5SSimon Glass
2997bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2998bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2999bf36c5d5SSimon Glass
3000bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
3001bf36c5d5SSimon Glass
3002bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
3003bf36c5d5SSimon Glass		size a little.
3004bf36c5d5SSimon Glass
300594e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
300694e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
300794e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
300894e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
300994e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
301094e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
301194e3c8c4Sgaurav rana		This affects the 'hash' command and also the
301294e3c8c4Sgaurav rana		hash_lookup_algo() function.
301394e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
301494e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
301594e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
301694e3c8c4Sgaurav rana		is performed in hardware.
3017bf36c5d5SSimon Glass
3018bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
3019bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
3020bf36c5d5SSimon Glass
3021a11f1873SRobert Winkler- Freescale i.MX specific commands:
3022a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
3023a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
3024a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
3025a11f1873SRobert Winkler
3026a11f1873SRobert Winkler		CONFIG_CMD_BMODE
3027a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
3028a11f1873SRobert Winkler		a boot from specific media.
3029a11f1873SRobert Winkler
3030a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
3031a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
3032a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
3033a11f1873SRobert Winkler		will set it back to normal.  This command currently
3034a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
3035a11f1873SRobert Winkler
30369e50c406SHeiko Schocher- bootcount support:
30379e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
30389e50c406SHeiko Schocher
30399e50c406SHeiko Schocher		This enables the bootcounter support, see:
30409e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
30419e50c406SHeiko Schocher
30429e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
30439e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
30449e50c406SHeiko Schocher		CONFIG_BLACKFIN
30459e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
30469e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
30479e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
30489e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
30499e50c406SHeiko Schocher		enable support for the bootcounter in RAM
30509e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
30519e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
30529e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
30539e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
30549e50c406SHeiko Schocher						    the bootcounter.
30559e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
305619c402afSSimon Glass
3057a8c7c708Swdenk- Show boot progress:
3058c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
3059c609719bSwdenk
3060c609719bSwdenk		Defining this option allows to add some board-
3061c609719bSwdenk		specific code (calling a user-provided function
3062c609719bSwdenk		"show_boot_progress(int)") that enables you to show
3063c609719bSwdenk		the system's boot progress on some display (for
3064c609719bSwdenk		example, some LED's) on your board. At the moment,
3065c609719bSwdenk		the following checkpoints are implemented:
3066c609719bSwdenk
306794fd1316SSimon Glass
30681372cce2SMarian BalakowiczLegacy uImage format:
30691372cce2SMarian Balakowicz
3070c609719bSwdenk  Arg	Where			When
3071c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
3072c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
3073c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
3074c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
3075c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
3076c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
3077c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
3078c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3079c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
30801372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3081c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3082c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3083c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3084c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
30851372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3086c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30871372cce2SMarian Balakowicz
30881372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30891372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30901372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30911372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30921372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30931372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30941372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
309511ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30961372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30971372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30981372cce2SMarian Balakowicz
3099ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3100c609719bSwdenk
3101a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
310263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
310363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
310463e73c9aSwdenk
3105566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3106566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3107566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3108566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3109566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3110566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3111566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3112566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3113566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3114566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3115566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3116566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3117566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3118566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3119566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3120566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3121566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3122566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3123566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3124566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3125566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3126566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3127566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3128566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3129566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3130566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3131566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3132566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3133566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3134566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3135566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3136566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3137566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3138566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3139566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3140566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3141566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3142566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3143566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3144566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3145566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3146566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3147566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3148566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3149566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3150566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3151566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3152c609719bSwdenk
3153566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3154c609719bSwdenk
3155566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3156566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3157566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3158206c60cbSwdenk
3159566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3160bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
3161bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
3162bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
3163566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3164566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
316574de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
316674de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3167566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3168c609719bSwdenk
31691372cce2SMarian BalakowiczFIT uImage format:
31701372cce2SMarian Balakowicz
31711372cce2SMarian Balakowicz  Arg	Where			When
31721372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
31731372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
31741372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
31751372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
31761372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
31771372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3178f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
31791372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
31801372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
31811372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
31821372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
31831372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
318411ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
318511ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
31861372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31871372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31881372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31891372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31901372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31911372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31921372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31931372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31941372cce2SMarian Balakowicz
31951372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31961372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31971372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
319811ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31991372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
32001372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
32011372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
32021372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
32031372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
32041372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
32051372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
32061372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
32071372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
32081372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
32091372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
32101372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
32111372cce2SMarian Balakowicz
321211ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
32131372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
32141372cce2SMarian Balakowicz
321511ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
32161372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
32171372cce2SMarian Balakowicz
321811ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
32191372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
32201372cce2SMarian Balakowicz
322121d29f7fSHeiko Schocher- legacy image format:
322221d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
322321d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
322421d29f7fSHeiko Schocher
322521d29f7fSHeiko Schocher		Default:
322621d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
322721d29f7fSHeiko Schocher
322821d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
322921d29f7fSHeiko Schocher		disable the legacy image format
323021d29f7fSHeiko Schocher
323121d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
323221d29f7fSHeiko Schocher		enabled per default for backward compatibility.
323321d29f7fSHeiko Schocher
3234d95f6ec7SGabe Black- FIT image support:
32359a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
32369a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
32379a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
32389a4f479bSDirk Eibach		with this option.
32399a4f479bSDirk Eibach
324073223f0eSSimon Glass		TODO(sjg@chromium.org): Adjust this option to be positive,
324173223f0eSSimon Glass		and move it to Kconfig
324273223f0eSSimon Glass
32434cf2609bSWolfgang Denk- Standalone program support:
32444cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
32454cf2609bSWolfgang Denk
32466feff899SWolfgang Denk		This option defines a board specific value for the
32476feff899SWolfgang Denk		address where standalone program gets loaded, thus
32486feff899SWolfgang Denk		overwriting the architecture dependent default
32494cf2609bSWolfgang Denk		settings.
32504cf2609bSWolfgang Denk
32514cf2609bSWolfgang Denk- Frame Buffer Address:
32524cf2609bSWolfgang Denk		CONFIG_FB_ADDR
32534cf2609bSWolfgang Denk
32544cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
325544a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
325644a53b57SWolfgang Denk		when using a graphics controller has separate video
325744a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
325844a53b57SWolfgang Denk		the given address instead of dynamically reserving it
325944a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
326044a53b57SWolfgang Denk		the memory for the frame buffer depending on the
326144a53b57SWolfgang Denk		configured panel size.
32624cf2609bSWolfgang Denk
32634cf2609bSWolfgang Denk		Please see board_init_f function.
32644cf2609bSWolfgang Denk
3265cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3266cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3267cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3268cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3269cccfc2abSDetlev Zundel
3270cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3271cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3272cccfc2abSDetlev Zundel
3273cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3274cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3275cccfc2abSDetlev Zundel
3276cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3277cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3278cccfc2abSDetlev Zundel
3279cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3280cccfc2abSDetlev Zundel
3281cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3282cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3283cccfc2abSDetlev Zundel
328470c219cdSJoe Hershberger- UBI support
328570c219cdSJoe Hershberger		CONFIG_CMD_UBI
328670c219cdSJoe Hershberger
328770c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
328870c219cdSJoe Hershberger		with the UBI flash translation layer
328970c219cdSJoe Hershberger
329070c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
329170c219cdSJoe Hershberger
3292147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3293147162daSJoe Hershberger
3294147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3295147162daSJoe Hershberger		warnings and errors enabled.
3296147162daSJoe Hershberger
3297ff94bc40SHeiko Schocher
3298ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3299ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3300ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3301ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3302ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3303ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3304ff94bc40SHeiko Schocher
3305ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3306ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3307ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3308ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3309ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3310ff94bc40SHeiko Schocher
3311ff94bc40SHeiko Schocher		default: 4096
3312ff94bc40SHeiko Schocher
3313ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3314ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3315ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3316ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3317ff94bc40SHeiko Schocher		flash), this value is ignored.
3318ff94bc40SHeiko Schocher
3319ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3320ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3321ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3322ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3323ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3324ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3325ff94bc40SHeiko Schocher
3326ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3327ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3328ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3329ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3330ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3331ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3332ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3333ff94bc40SHeiko Schocher		partition.
3334ff94bc40SHeiko Schocher
3335ff94bc40SHeiko Schocher		default: 20
3336ff94bc40SHeiko Schocher
3337ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3338ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3339ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3340ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3341ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3342ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3343ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3344ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3345ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3346ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3347ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3348ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3349ff94bc40SHeiko Schocher
3350ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3351ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3352ff94bc40SHeiko Schocher		without a fastmap.
3353ff94bc40SHeiko Schocher		default: 0
3354ff94bc40SHeiko Schocher
33550195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
33560195a7bbSHeiko Schocher		Enable UBI fastmap debug
33570195a7bbSHeiko Schocher		default: 0
33580195a7bbSHeiko Schocher
335970c219cdSJoe Hershberger- UBIFS support
336070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
336170c219cdSJoe Hershberger
336270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
336370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
336470c219cdSJoe Hershberger
336570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
336670c219cdSJoe Hershberger
3367147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3368147162daSJoe Hershberger
3369147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3370147162daSJoe Hershberger		warnings and errors enabled.
3371147162daSJoe Hershberger
33726a11cf48SDaniel Schwierzeck- SPL framework
33736a11cf48SDaniel Schwierzeck		CONFIG_SPL
33746a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
33756a11cf48SDaniel Schwierzeck
337695579793STom Rini		CONFIG_SPL_LDSCRIPT
337795579793STom Rini		LDSCRIPT for linking the SPL binary.
337895579793STom Rini
33796ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
33806ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
33816ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
33826ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
33838960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
33846ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
33856ebc3461SAlbert ARIBAUD
338695579793STom Rini		CONFIG_SPL_MAX_SIZE
33876ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
33886ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
33896ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
33906ebc3461SAlbert ARIBAUD		not exceed it.
339195579793STom Rini
33926a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
33936a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
33946a11cf48SDaniel Schwierzeck
339594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
339694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
339794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
339894a45bb1SScott Wood
339995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
340095579793STom Rini		Link address for the BSS within the SPL binary.
340195579793STom Rini
340295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
34036ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
34046ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
34056ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
34068960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
34076ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
340895579793STom Rini
340995579793STom Rini		CONFIG_SPL_STACK
341095579793STom Rini		Adress of the start of the stack SPL will use
341195579793STom Rini
34128c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
34138c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
34148c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
34158c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
34168c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
34178c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
34188c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
34198c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
34208c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
34218c80eb3bSAlbert ARIBAUD \(3ADEV\)
3422e0727515SMarek Vasut		CONFIG_SPL_ABORT_ON_RAW_IMAGE
3423e0727515SMarek Vasut		When defined, SPL will proceed to another boot method
3424e0727515SMarek Vasut		if the image it has loaded does not have a signature.
3425e0727515SMarek Vasut
342694a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
342794a45bb1SScott Wood		Adress of the start of the stack SPL will use after
342894a45bb1SScott Wood		relocation.  If unspecified, this is equal to
342994a45bb1SScott Wood		CONFIG_SPL_STACK.
343094a45bb1SScott Wood
343195579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
343295579793STom Rini		Starting address of the malloc pool used in SPL.
34339ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
34349ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
34359ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
343695579793STom Rini
343795579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
343895579793STom Rini		The size of the malloc pool used in SPL.
34396a11cf48SDaniel Schwierzeck
344047f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
344147f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
344247f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
344347f7bcaeSTom Rini		NAND loading of the Linux Kernel.
344447f7bcaeSTom Rini
34459607faf2STom Rini		CONFIG_SPL_OS_BOOT
34469607faf2STom Rini		Enable booting directly to an OS from SPL.
34479607faf2STom Rini		See also: doc/README.falcon
34489607faf2STom Rini
3449861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3450861a86f4STom Rini		For ARM, enable an optional function to print more information
3451861a86f4STom Rini		about the running system.
3452861a86f4STom Rini
34534b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
34544b919725SScott Wood		Arch init code should be built for a very small image
34554b919725SScott Wood
345695579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
345795579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3458e2ccdf89SPaul Kocialkowski		Address and partition on the MMC to load U-Boot from
345995579793STom Rini		when the MMC is being used in raw mode.
346095579793STom Rini
3461b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3462b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3463b97300b6SPaul Kocialkowski		used in raw mode
3464b97300b6SPaul Kocialkowski
34652b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
34662b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
34672b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
34682b75b0adSPeter Korsgaard
34692b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
34702b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
34712b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
34722b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
34732b75b0adSPeter Korsgaard		(for falcon mode)
34742b75b0adSPeter Korsgaard
3475e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3476e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3477e2ccdf89SPaul Kocialkowski		used in fs mode
3478e2ccdf89SPaul Kocialkowski
3479fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3480fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3481fae81c72SGuillaume GARDET
3482fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
34837ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3484fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
34857ad2cc79SPeter Korsgaard
3486fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
34877ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3488fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
34897ad2cc79SPeter Korsgaard
349006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
349106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
349206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
349306f60ae3SScott Wood		continuing (the hardware starts execution after just
349406f60ae3SScott Wood		loading the first page rather than the full 4K).
349506f60ae3SScott Wood
3496651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3497651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3498651fcf60SPrabhakar Kushwaha
34996f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
35006f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
35016f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
35026f2f01b9SScott Wood
35036f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
35046f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
35056f2f01b9SScott Wood
35066f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
35076f2f01b9SScott Wood		Include standard software ECC in the SPL
35086f2f01b9SScott Wood
350995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
35107d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
35117d4b7955SScott Wood		expose the cmd_ctrl() interface.
351295579793STom Rini
35136f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
35146f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
35156f4e7d3cSThomas Gleixner		loader
35166f4e7d3cSThomas Gleixner
35170c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
35180c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
35190c3117b1SHeiko Schocher		if you need to save space.
35200c3117b1SHeiko Schocher
35217c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
35227c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
35237c8eea59SYing Zhang		SPL binary.
35247c8eea59SYing Zhang
352595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
352695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
352795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
352895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
352995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
353095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
35317d4b7955SScott Wood		to read U-Boot
353295579793STom Rini
3533fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3534fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3535fbe76ae4SPrabhakar Kushwaha
353695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
35377d4b7955SScott Wood		Location in NAND to read U-Boot from
35387d4b7955SScott Wood
35397d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
35407d4b7955SScott Wood		Location in memory to load U-Boot to
35417d4b7955SScott Wood
35427d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
35437d4b7955SScott Wood		Size of image to load
354495579793STom Rini
354595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
35467d4b7955SScott Wood		Entry point in loaded image to jump to
354795579793STom Rini
354895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
354995579793STom Rini		Define this if you need to first read the OOB and then the
3550b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
355195579793STom Rini
355295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
355395579793STom Rini		Support for an OMAP3-specific set of functions to return the
355495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
355595579793STom Rini
3556c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3557c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3558c57b953dSPavel Machek
355974752baaSScott Wood		CONFIG_SPL_PAD_TO
35606113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
35616113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
35626113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
35636113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
35646113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
356574752baaSScott Wood
3566ca2fca22SScott Wood		CONFIG_SPL_TARGET
3567ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3568ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3569ca2fca22SScott Wood		example if more than one image needs to be produced.
3570ca2fca22SScott Wood
357187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
357287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
357387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
357487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
357587ebee39SSimon Glass		bootm command when booting a FIT image.
357687ebee39SSimon Glass
35773aa29de0SYing Zhang- TPL framework
35783aa29de0SYing Zhang		CONFIG_TPL
35793aa29de0SYing Zhang		Enable building of TPL globally.
35803aa29de0SYing Zhang
35813aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
35823aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
35833aa29de0SYing Zhang		the TPL payload. By default, this is defined as
35843aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
35853aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
35863aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
35873aa29de0SYing Zhang
3588a8c7c708Swdenk- Interrupt support (PPC):
3589a8c7c708Swdenk
3590a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3591a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
359211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3593a8c7c708Swdenk		should set decrementer_count to appropriate value. If
359411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3595a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
359611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3597a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3598a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3599a8c7c708Swdenk		general timer_interrupt().
3600a8c7c708Swdenk
3601c609719bSwdenk
36029660e442SHelmut RaigerBoard initialization settings:
36039660e442SHelmut Raiger------------------------------
36049660e442SHelmut Raiger
36059660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
36069660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
36079660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
36089660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
36099660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
36109660e442SHelmut Raigertypically in board_init_f() and board_init_r().
36119660e442SHelmut Raiger
36129660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
36139660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
36149660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
36159660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3616c609719bSwdenk
3617c609719bSwdenkConfiguration Settings:
3618c609719bSwdenk-----------------------
3619c609719bSwdenk
36204d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
36214d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
36224d1fd7f1SYork Sun
36236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3624c609719bSwdenk		undefine this when you're short of memory.
3625c609719bSwdenk
36262fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
36272fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
36282fb2604dSPeter Tyser
36296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3630c609719bSwdenk		prompt for user input.
3631c609719bSwdenk
36326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3633c609719bSwdenk
36346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3635c609719bSwdenk
36366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3637c609719bSwdenk
36386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3639c609719bSwdenk		the application (usually a Linux kernel) when it is
3640c609719bSwdenk		booted
3641c609719bSwdenk
36426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3643c609719bSwdenk		List of legal baudrate settings for this board.
3644c609719bSwdenk
36456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3646c609719bSwdenk		Suppress display of console information at boot.
3647c609719bSwdenk
36486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3649c609719bSwdenk		If the board specific function
3650c609719bSwdenk			extern int overwrite_console (void);
3651c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3652c609719bSwdenk		serial port, else the settings in the environment are used.
3653c609719bSwdenk
36546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3655c609719bSwdenk		Enable the call to overwrite_console().
3656c609719bSwdenk
36576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3658c609719bSwdenk		Enable overwrite of previous console environment settings.
3659c609719bSwdenk
36606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3661c609719bSwdenk		Begin and End addresses of the area used by the
3662c609719bSwdenk		simple memory test.
3663c609719bSwdenk
36646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3665c609719bSwdenk		Enable an alternate, more extensive memory test.
3666c609719bSwdenk
36676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
36685f535fe1Swdenk		Scratch address used by the alternate memory test
36695f535fe1Swdenk		You only need to set this if address zero isn't writeable
36705f535fe1Swdenk
3671e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3672e61a7534SYork Sun		Only implemented for ARMv8 for now.
3673e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3674e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3675e8149522SYork Sun		This memory can be used as secure memory. A variable
3676e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3677e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3678e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3679e8149522SYork Sun
3680aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
36816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
368214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
368311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
368414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
368514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
368614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
36875e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
368814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
36895e12e75dSStefan Roese		will have to get fixed in Linux additionally.
369014f73ca6SStefan Roese
369114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
369214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
369314f73ca6SStefan Roese		be touched.
369414f73ca6SStefan Roese
369514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
369614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
369714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
369814f73ca6SStefan Roese		non page size aligned address and this could cause major
369914f73ca6SStefan Roese		problems.
370014f73ca6SStefan Roese
37016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3702c609719bSwdenk		Enable temporary baudrate change while serial download
3703c609719bSwdenk
37046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3705c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3706c609719bSwdenk
37076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3708c609719bSwdenk		Physical start address of Flash memory.
3709c609719bSwdenk
37106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3711c609719bSwdenk		Physical start address of boot monitor code (set by
3712c609719bSwdenk		make config files to be same as the text base address
371314d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
37146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3715c609719bSwdenk
37166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
37173b57fe0aSwdenk		Size of memory reserved for monitor code, used to
37183b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
37193b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
37203b57fe0aSwdenk		flash sector.
3721c609719bSwdenk
37226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3723c609719bSwdenk		Size of DRAM reserved for malloc() use.
3724c609719bSwdenk
3725d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3726d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3727d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3728d59476b6SSimon Glass		will become available before relocation. The address is just
3729d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3730d59476b6SSimon Glass		space.
3731d59476b6SSimon Glass
3732d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3733d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3734d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3735b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3736d59476b6SSimon Glass		U-Boot relocates itself.
3737d59476b6SSimon Glass
373838687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
373938687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
374038687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
374138687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
374238687ae6SSimon Glass
37431dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
37441dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
37451dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
37461dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
37471dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
37481dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
37491dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
37501dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
37511dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
37521dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
37531dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
37541dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
37551dfdd9baSThierry Reding		written to another region in the same cache-line. This can
37561dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
37571dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
37581dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
37591dfdd9baSThierry Reding
37601dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
37611dfdd9baSThierry Reding
37626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
376315940c9aSStefan Roese		Normally compressed uImages are limited to an
376415940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
37656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
376615940c9aSStefan Roese		to adjust this setting to your needs.
3767c609719bSwdenk
37686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3769c609719bSwdenk		Maximum size of memory mapped by the startup code of
3770c609719bSwdenk		the Linux kernel; all data that must be processed by
37717d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
37727d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
37731bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
37747d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3775c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3776c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3777c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3778c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3779c609719bSwdenk
3780fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3781fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3782fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3783fca43cc8SJohn Rigby		is enabled.
3784fca43cc8SJohn Rigby
3785fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3786fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3787fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3788fca43cc8SJohn Rigby
3789fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3790fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3791fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3792fca43cc8SJohn Rigby
37936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3794c609719bSwdenk		Max number of Flash memory banks
3795c609719bSwdenk
37966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3797c609719bSwdenk		Max number of sectors on a Flash chip
3798c609719bSwdenk
37996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3800c609719bSwdenk		Timeout for Flash erase operations (in ms)
3801c609719bSwdenk
38026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3803c609719bSwdenk		Timeout for Flash write operations (in ms)
3804c609719bSwdenk
38056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
38068564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
38078564acf9Swdenk
38086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
38098564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
38108564acf9Swdenk
38116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
38128564acf9Swdenk		If defined, hardware flash sectors protection is used
38138564acf9Swdenk		instead of U-Boot software protection.
38148564acf9Swdenk
38156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3816c609719bSwdenk
3817c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3818c609719bSwdenk		without this option such a download has to be
3819c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3820c609719bSwdenk		copy from RAM to flash.
3821c609719bSwdenk
3822c609719bSwdenk		The two-step approach is usually more reliable, since
3823c609719bSwdenk		you can check if the download worked before you erase
382411ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
382511ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3826c609719bSwdenk		downloaded image) this option may be very useful.
3827c609719bSwdenk
38286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3829c609719bSwdenk		Define if the flash driver uses extra elements in the
38305653fc33Swdenk		common flash structure for storing flash geometry.
38315653fc33Swdenk
383200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
38335653fc33Swdenk		This option also enables the building of the cfi_flash driver
38345653fc33Swdenk		in the drivers directory
383553cf9435Sstroese
383691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
383791809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
383891809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
383991809ed5SPiotr Ziecik		to the MTD layer.
384091809ed5SPiotr Ziecik
38416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
384296ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
384396ef831fSGuennadi Liakhovetski
384496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
384596ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
384696ef831fSGuennadi Liakhovetski		write commands.
384796ef831fSGuennadi Liakhovetski
38486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
38495568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
38505568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
38515568e613SStefan Roese		is useful, if some of the configured banks are only
38525568e613SStefan Roese		optionally available.
38535568e613SStefan Roese
38549a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
38559a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
38569a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
38579a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
38589a042e9cSJerry Van Baren
3859352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3860352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3861352ef3f1SStefan Roese		against the source after the write operation. An error message
3862352ef3f1SStefan Roese		will be printed when the contents are not identical.
3863352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3864352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3865352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3866352ef3f1SStefan Roese		this option if you really know what you are doing.
3867352ef3f1SStefan Roese
38686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
386911ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
387011ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
387153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
387253cf9435Sstroese		buffers can be full shortly after enabling the interface
387311ccc33fSMarcel Ziswiler		on high Ethernet traffic.
387453cf9435Sstroese		Defaults to 4 if not defined.
3875c609719bSwdenk
3876ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3877ea882bafSWolfgang Denk
3878ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3879ea882bafSWolfgang Denk	internally to store the environment settings. The default
3880ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3881ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3882ea882bafSWolfgang Denk	lib/hashtable.c for details.
3883ea882bafSWolfgang Denk
38842598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
38852598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
38861bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
38872598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
38882598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
38892598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
38902598090bSJoe Hershberger
38912598090bSJoe Hershberger	The format of the list is:
38922598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3893b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3894b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
38952598090bSJoe Hershberger		entry = variable_name[:attributes]
38962598090bSJoe Hershberger		list = entry[,list]
38972598090bSJoe Hershberger
38982598090bSJoe Hershberger	The type attributes are:
38992598090bSJoe Hershberger		s - String (default)
39002598090bSJoe Hershberger		d - Decimal
39012598090bSJoe Hershberger		x - Hexadecimal
39022598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
39032598090bSJoe Hershberger		i - IP address
39042598090bSJoe Hershberger		m - MAC address
39052598090bSJoe Hershberger
3906267541f7SJoe Hershberger	The access attributes are:
3907267541f7SJoe Hershberger		a - Any (default)
3908267541f7SJoe Hershberger		r - Read-only
3909267541f7SJoe Hershberger		o - Write-once
3910267541f7SJoe Hershberger		c - Change-default
3911267541f7SJoe Hershberger
39122598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
39132598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3914b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
39152598090bSJoe Hershberger
39162598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
39172598090bSJoe Hershberger		Define this to a list (string) to define validation that
39182598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
39192598090bSJoe Hershberger		environment variable.  To override a setting in the static
39202598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
39212598090bSJoe Hershberger		".flags" variable.
39222598090bSJoe Hershberger
3923bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3924bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3925bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3926bdf1fe4eSJoe Hershberger
3927267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3928267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3929267541f7SJoe Hershberger	access flags.
3930267541f7SJoe Hershberger
39310b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
39320b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
39330b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
3934b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
3935632efa74SSimon Glass
39360d296cc2SGabe Black- CONFIG_USE_STDINT
39370d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
39380d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
39390d296cc2SGabe Black	building U-Boot to enable this.
39400d296cc2SGabe Black
3941c609719bSwdenkThe following definitions that deal with the placement and management
3942c609719bSwdenkof environment data (variable area); in general, we support the
3943c609719bSwdenkfollowing configurations:
3944c609719bSwdenk
3945c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3946c3eb3fe4SMike Frysinger
3947c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3948c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3949c3eb3fe4SMike Frysinger
39505a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3951c609719bSwdenk
3952c609719bSwdenk	Define this if the environment is in flash memory.
3953c609719bSwdenk
3954c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3955c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3956c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3957c609719bSwdenk	   sector" type flash chips, which have several smaller
3958c609719bSwdenk	   sectors at the start or the end. For instance, such a
3959c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3960c609719bSwdenk	   such a case you would place the environment in one of the
3961c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3962c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3963c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3964c609719bSwdenk	   between U-Boot and the environment.
3965c609719bSwdenk
39660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3967c609719bSwdenk
3968c609719bSwdenk	   Offset of environment data (variable area) to the
3969c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3970c609719bSwdenk	   type flash chips the second sector can be used: the offset
3971c609719bSwdenk	   for this sector is given here.
3972c609719bSwdenk
39736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3974c609719bSwdenk
39750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3976c609719bSwdenk
3977c609719bSwdenk	   This is just another way to specify the start address of
3978c609719bSwdenk	   the flash sector containing the environment (instead of
39790e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3980c609719bSwdenk
39810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3982c609719bSwdenk
3983c609719bSwdenk	   Size of the sector containing the environment.
3984c609719bSwdenk
3985c609719bSwdenk
3986c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3987c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3988c609719bSwdenk	   the environment.
3989c609719bSwdenk
39900e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3991c609719bSwdenk
39925a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
39930e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3994c609719bSwdenk	   of this flash sector for the environment. This saves
3995c609719bSwdenk	   memory for the RAM copy of the environment.
3996c609719bSwdenk
3997c609719bSwdenk	   It may also save flash memory if you decide to use this
3998c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3999c609719bSwdenk	   since then the remainder of the flash sector could be used
4000c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
4001c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
4002c609719bSwdenk	   updating the environment in flash makes it always
4003c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
4004c609719bSwdenk	   wrong before the contents has been restored from a copy in
4005c609719bSwdenk	   RAM, your target system will be dead.
4006c609719bSwdenk
40070e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
40080e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
4009c609719bSwdenk
4010c609719bSwdenk	   These settings describe a second storage area used to hold
401111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
40123e38691eSwdenk	   a valid backup copy in case there is a power failure during
4013c609719bSwdenk	   a "saveenv" operation.
4014c609719bSwdenk
4015c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
4016c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
4017c609719bSwdenkaccordingly!
4018c609719bSwdenk
4019c609719bSwdenk
40209314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
4021c609719bSwdenk
4022c609719bSwdenk	Define this if you have some non-volatile memory device
4023c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
4024c609719bSwdenk	environment.
4025c609719bSwdenk
40260e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
40270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4028c609719bSwdenk
402911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
4030c609719bSwdenk	  want to use for environment. It is assumed that this memory
4031c609719bSwdenk	  can just be read and written to, without any special
4032c609719bSwdenk	  provision.
4033c609719bSwdenk
4034c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
4035b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
403611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
4037c609719bSwdenkU-Boot will hang.
4038c609719bSwdenk
4039c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
4040c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
4041c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
4042c609719bSwdenkto save the current settings.
4043c609719bSwdenk
4044c609719bSwdenk
4045bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
4046c609719bSwdenk
4047c609719bSwdenk	Use this if you have an EEPROM or similar serial access
4048c609719bSwdenk	device and a driver for it.
4049c609719bSwdenk
40500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
4052c609719bSwdenk
4053c609719bSwdenk	  These two #defines specify the offset and size of the
4054c609719bSwdenk	  environment area within the total memory of your EEPROM.
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
4057c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
4058c609719bSwdenk	  The default address is zero.
4059c609719bSwdenk
4060189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
4061189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
4062189d257bSChristian Gmeiner
40636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
4064c609719bSwdenk	  If defined, the number of bits used to address bytes in a
4065c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
4066c609719bSwdenk	  would require six bits.
4067c609719bSwdenk
40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
4069c609719bSwdenk	  If defined, the number of milliseconds to delay between
4070c609719bSwdenk	  page writes.	The default is zero milliseconds.
4071c609719bSwdenk
40726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
4073c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
4074c609719bSwdenk	  that this is NOT the chip address length!
4075c609719bSwdenk
40766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
40775cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
40785cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
40795cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
40805cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
40815cf91d6bSwdenk	  byte chips.
40825cf91d6bSwdenk
40835cf91d6bSwdenk	  Note that we consider the length of the address field to
40845cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
40855cf91d6bSwdenk	  in the chip address.
40865cf91d6bSwdenk
40876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
4088c609719bSwdenk	  The size in bytes of the EEPROM device.
4089c609719bSwdenk
4090548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
4091548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
4092548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
4093548738b4SHeiko Schocher
4094548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
4095548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
4096548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
4097548738b4SHeiko Schocher	  EEPROM. For example:
4098548738b4SHeiko Schocher
4099ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
4100548738b4SHeiko Schocher
4101548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
4102548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
4103c609719bSwdenk
4104057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
41055779d8d9Swdenk
41065779d8d9Swdenk	Define this if you have a DataFlash memory device which you
41075779d8d9Swdenk	want to use for the environment.
41085779d8d9Swdenk
41090e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
41110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
41125779d8d9Swdenk
41135779d8d9Swdenk	  These three #defines specify the offset and size of the
41145779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
41155779d8d9Swdenk	  at the specified address.
41165779d8d9Swdenk
4117bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
4118bd83b592SWu, Josh
4119bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
4120bd83b592SWu, Josh	want to use for the environment.
4121bd83b592SWu, Josh
4122bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
4123bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
4124bd83b592SWu, Josh
4125bd83b592SWu, Josh	  These two #defines specify the offset and size of the
4126bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4127bd83b592SWu, Josh	  aligned to an erase sector boundary.
4128bd83b592SWu, Josh
4129bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
4130bd83b592SWu, Josh
4131bd83b592SWu, Josh	  Define the SPI flash's sector size.
4132bd83b592SWu, Josh
4133bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
4134bd83b592SWu, Josh
4135bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4136bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4137bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
41389dd05fb8SSimon Glass	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
4139bd83b592SWu, Josh	  aligned to an erase sector boundary.
4140bd83b592SWu, Josh
4141bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4142bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4143bd83b592SWu, Josh
4144bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4145bd83b592SWu, Josh
4146bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4147bd83b592SWu, Josh
4148bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4149bd83b592SWu, Josh
4150bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4151bd83b592SWu, Josh
4152bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4153bd83b592SWu, Josh
41540a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
41550a85a9e7SLiu Gang
41560a85a9e7SLiu Gang	Define this if you have a remote memory space which you
41570a85a9e7SLiu Gang	want to use for the local device's environment.
41580a85a9e7SLiu Gang
41590a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
41600a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
41610a85a9e7SLiu Gang
41620a85a9e7SLiu Gang	  These two #defines specify the address and size of the
41630a85a9e7SLiu Gang	  environment area within the remote memory space. The
41640a85a9e7SLiu Gang	  local device can get the environment from remote memory
4165fc54c7faSLiu Gang	  space by SRIO or PCIE links.
41660a85a9e7SLiu Gang
41670a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
41680a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4169fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4170fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
41710a85a9e7SLiu Gang
417251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
417313a5695bSwdenk
417413a5695bSwdenk	Define this if you have a NAND device which you want to use
417513a5695bSwdenk	for the environment.
417613a5695bSwdenk
41770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
41780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
417913a5695bSwdenk
418013a5695bSwdenk	  These two #defines specify the offset and size of the environment
4181fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4182fdd813deSScott Wood	  aligned to an erase block boundary.
41835779d8d9Swdenk
4184fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4185e443c944SMarkus Klotzbuecher
41860e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4187fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4188fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
41899dd05fb8SSimon Glass	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
4190fdd813deSScott Wood	  aligned to an erase block boundary.
4191e443c944SMarkus Klotzbuecher
4192fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4193fdd813deSScott Wood
4194fdd813deSScott Wood	  Specifies the length of the region in which the environment
4195fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4196fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4197fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4198fdd813deSScott Wood	  the range to be avoided.
4199fdd813deSScott Wood
4200fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4201fdd813deSScott Wood
4202fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4203fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4204fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4205fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4206fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4207e443c944SMarkus Klotzbuecher
4208b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4209b74ab737SGuennadi Liakhovetski
4210b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4211b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4212b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4213b74ab737SGuennadi Liakhovetski
42142b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
42152b74433fSJoe Hershberger
42162b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
42172b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
42182b74433fSJoe Hershberger	accesses, which is important on NAND.
42192b74433fSJoe Hershberger
42202b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
42212b74433fSJoe Hershberger
42222b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
42232b74433fSJoe Hershberger
42242b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
42252b74433fSJoe Hershberger
42262b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
42272b74433fSJoe Hershberger	  environment in.
42282b74433fSJoe Hershberger
4229785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4230785881f7SJoe Hershberger
4231785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4232785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4233785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4234785881f7SJoe Hershberger
42352b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
42362b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
42372b74433fSJoe Hershberger
42382b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
42392b74433fSJoe Hershberger	  when storing the env in UBI.
42402b74433fSJoe Hershberger
4241d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4242d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4243d1db76f1SWu, Josh
4244d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4245d1db76f1SWu, Josh
4246d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4247d1db76f1SWu, Josh
4248d1db76f1SWu, Josh       - FAT_ENV_DEV_AND_PART:
4249d1db76f1SWu, Josh
4250d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4251d1db76f1SWu, Josh         be as following:
4252d1db76f1SWu, Josh
4253d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4254d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4255d1db76f1SWu, Josh                        partition table.
4256d1db76f1SWu, Josh               - "D:0": device D.
4257d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4258d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4259d1db76f1SWu, Josh                              table.
4260d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4261b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4262d1db76f1SWu, Josh                           partition table then means device D.
4263d1db76f1SWu, Josh
4264d1db76f1SWu, Josh       - FAT_ENV_FILE:
4265d1db76f1SWu, Josh
4266d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4267b445bbb4SJeremiah Mahler         environment.
4268d1db76f1SWu, Josh
4269d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4270b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4271d1db76f1SWu, Josh
427206e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
427306e4ae5fSStephen Warren
427406e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
427506e4ae5fSStephen Warren	environment.
427606e4ae5fSStephen Warren
427706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
427806e4ae5fSStephen Warren
427906e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
428006e4ae5fSStephen Warren
428106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
428206e4ae5fSStephen Warren
428306e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
428406e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
428506e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
428606e4ae5fSStephen Warren
428706e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
428806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
428906e4ae5fSStephen Warren
429006e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
429106e4ae5fSStephen Warren	  area within the specified MMC device.
429206e4ae5fSStephen Warren
42935c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
42945c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
42955c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
42965c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
42975c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
42985c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
42995c088ee8SStephen Warren	  maximum possible space before it, to store other data.
43005c088ee8SStephen Warren
430106e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
430206e4ae5fSStephen Warren	  MMC sector boundary.
430306e4ae5fSStephen Warren
430406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
430506e4ae5fSStephen Warren
430606e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
430706e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
430806e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
430906e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
431006e4ae5fSStephen Warren
43115c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
43125c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
43135c088ee8SStephen Warren
431406e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
431506e4ae5fSStephen Warren	  an MMC sector boundary.
431606e4ae5fSStephen Warren
431706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
431806e4ae5fSStephen Warren
431906e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
432006e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
432106e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
432206e4ae5fSStephen Warren
43236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4324c609719bSwdenk
4325c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4326c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4327c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4328c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4329c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4330c609719bSwdenk	to be a good choice since it makes it far enough from the
4331c609719bSwdenk	start of the data area as well as from the stack pointer.
4332c609719bSwdenk
4333e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4334c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4335cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4336c609719bSwdenkuntil then to read environment variables.
4337c609719bSwdenk
433885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
433985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
434085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
434185ec0bccSwdenknecessary, because the first environment variable we need is the
434285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
434385ec0bccSwdenkhave any device yet where we could complain.]
4344c609719bSwdenk
4345c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4346c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
434785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4348c609719bSwdenk
43496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4350fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4351fc3e2165Swdenk
43526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4353fc3e2165Swdenk		      also needs to be defined.
4354fc3e2165Swdenk
43556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4356fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4357c609719bSwdenk
4358f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4359f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4360f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4361f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4362f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4363f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4364f5675aa5SRon Madrid
4365b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4366b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4367b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4368b2b92f53SSimon Glass		to do this.
4369b2b92f53SSimon Glass
4370e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4371e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4372e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4373e2e3e2b1SSimon Glass		present.
4374e2e3e2b1SSimon Glass
4375feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4376feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4377feb85801SSascha Silbe		build system checks that the actual size does not
4378feb85801SSascha Silbe		exceed it.
4379feb85801SSascha Silbe
4380c609719bSwdenkLow Level (hardware related) configuration options:
4381dc7c9a1aSwdenk---------------------------------------------------
4382c609719bSwdenk
43836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4384c609719bSwdenk		Cache Line Size of the CPU.
4385c609719bSwdenk
43866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4387c609719bSwdenk		Default address of the IMMR after system reset.
43882535d602Swdenk
43892535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
43902535d602Swdenk		and RPXsuper) to be able to adjust the position of
43912535d602Swdenk		the IMMR register after a reset.
4392c609719bSwdenk
4393e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4394e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4395e46fedfeSTimur Tabi		PowerPC SOCs.
4396e46fedfeSTimur Tabi
4397e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4398e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4399e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4400e46fedfeSTimur Tabi
4401e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4402e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4403e46fedfeSTimur Tabi
4404e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4405e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4406e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4407e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4408e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4409e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4410e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4411e46fedfeSTimur Tabi
4412e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4413e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4414e46fedfeSTimur Tabi
4415e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4416e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4417e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4418e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4419e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4420e46fedfeSTimur Tabi
4421e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4422e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4423e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4424e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4425e46fedfeSTimur Tabi
4426e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4427e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4428e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4429e46fedfeSTimur Tabi
44307f6c2cbcSwdenk- Floppy Disk Support:
44316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
44327f6c2cbcSwdenk
44337f6c2cbcSwdenk		the default drive number (default value 0)
44347f6c2cbcSwdenk
44356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
44367f6c2cbcSwdenk
443711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
44387f6c2cbcSwdenk		(default value 1)
44397f6c2cbcSwdenk
44406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
44417f6c2cbcSwdenk
44427f6c2cbcSwdenk		defines the offset of register from address. It
44437f6c2cbcSwdenk		depends on which part of the data bus is connected to
444411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
44457f6c2cbcSwdenk
44466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
44476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
44487f6c2cbcSwdenk		default value.
44497f6c2cbcSwdenk
44506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
44517f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
44527f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4453b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
44547f6c2cbcSwdenk		initializations.
44557f6c2cbcSwdenk
44560abddf82SMacpaul Lin- CONFIG_IDE_AHB:
44570abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
44580abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
44590abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
44600abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
44610abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4462b445bbb4SJeremiah Mahler		is required.
44630abddf82SMacpaul Lin
44646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
446525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
446625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4467c609719bSwdenk
44686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4469c609719bSwdenk
44707152b1d0Swdenk		Start address of memory area that can be used for
4471c609719bSwdenk		initial data and stack; please note that this must be
4472c609719bSwdenk		writable memory that is working WITHOUT special
4473c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4474c609719bSwdenk		will become available only after programming the
4475c609719bSwdenk		memory controller and running certain initialization
4476c609719bSwdenk		sequences.
4477c609719bSwdenk
4478c609719bSwdenk		U-Boot uses the following memory types:
4479c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4480c609719bSwdenk		- MPC824X: data cache
4481c609719bSwdenk		- PPC4xx:  data cache
4482c609719bSwdenk
44836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4484c609719bSwdenk
4485c609719bSwdenk		Offset of the initial data structure in the memory
44866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
44876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4488c609719bSwdenk		data is located at the end of the available space
4489553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
44906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
44916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
44926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4493c609719bSwdenk
4494c609719bSwdenk	Note:
4495c609719bSwdenk		On the MPC824X (or other systems that use the data
4496c609719bSwdenk		cache for initial memory) the address chosen for
44976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4498c609719bSwdenk		point to an otherwise UNUSED address space between
4499c609719bSwdenk		the top of RAM and the start of the PCI space.
4500c609719bSwdenk
45016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4502c609719bSwdenk
45036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4504c609719bSwdenk
45056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4506c609719bSwdenk
45076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4508c609719bSwdenk
45096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4510c609719bSwdenk
45116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4512c609719bSwdenk
45136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4514c609719bSwdenk		SDRAM timing
4515c609719bSwdenk
45166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4517c609719bSwdenk		periodic timer for refresh
4518c609719bSwdenk
45196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4520c609719bSwdenk
45216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
45226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
45236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
45246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4525c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4526c609719bSwdenk
4527c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
45286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
45296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4530c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4531c609719bSwdenk
45326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
45336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4534c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4535c609719bSwdenk		Prescaler definitions (SDRAM timing)
4536c609719bSwdenk
45376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4538c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4539c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4540c609719bSwdenk
45416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4542b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4543b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4544b423d055SHeiko Schocher
45456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4546c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4547c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4548c609719bSwdenk
45496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4550c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4551c609719bSwdenk		wrong setting might damage your board. Read
4552c609719bSwdenk		doc/README.MBX before setting this variable!
4553c609719bSwdenk
45546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4555ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4556ea909b76Swdenk		(Power On Self Tests). This definition overrides
4557ea909b76Swdenk		#define'd default value in commproc.h resp.
4558ea909b76Swdenk		cpm_8260.h.
4559ea909b76Swdenk
45606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
45616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
45626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
45636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
45646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
45656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
45666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
45676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4568a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
45695d232d0eSwdenk
45709cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
45719cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
45729cacf4fcSDirk Eibach		required.
45739cacf4fcSDirk Eibach
457469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4575b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
457669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
457769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
457869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
457969fd2d3bSAndrew Sharp		by coreboot or similar.
458069fd2d3bSAndrew Sharp
4581842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4582842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4583842033e6SGabor Juhos
4584a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4585a09b9b68SKumar Gala		Chip has SRIO or not
4586a09b9b68SKumar Gala
4587a09b9b68SKumar Gala- CONFIG_SRIO1:
4588a09b9b68SKumar Gala		Board has SRIO 1 port available
4589a09b9b68SKumar Gala
4590a09b9b68SKumar Gala- CONFIG_SRIO2:
4591a09b9b68SKumar Gala		Board has SRIO 2 port available
4592a09b9b68SKumar Gala
4593c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4594c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4595c8b28152SLiu Gang
4596a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4597a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4598a09b9b68SKumar Gala
4599a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4600a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4601a09b9b68SKumar Gala
4602a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4603a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4604a09b9b68SKumar Gala
460566bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
460666bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
460766bd1846SFabio Estevam		a 16 bit bus.
460866bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4609a430e916SFabio Estevam		Example of drivers that use it:
461066bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4611a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4612eced4626SAlex Waterman
4613eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4614eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4615eced4626SAlex Waterman		a default value will be used.
4616eced4626SAlex Waterman
4617bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4618218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4619218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4620218ca724SWolfgang Denk
4621bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4622bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4623bb99ad6dSBen Warren
46246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4625218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4626218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4627218ca724SWolfgang Denk		to something your driver can deal with.
4628bb99ad6dSBen Warren
46291b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
46301b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
46311b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
46321b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
46331b3e3c4fSYork Sun		header files or board specific files.
46341b3e3c4fSYork Sun
46356f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
46366f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
46376f5e1dc5SYork Sun
4638e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4639e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4640e32d59a2SYork Sun
46414516ff81SYork Sun- CONFIG_FSL_DDR_BIST
46424516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
46434516ff81SYork Sun
46446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4645218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4646218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
46472ad6b513STimur Tabi
4648c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4649c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4650c26e454dSwdenk
4651c26e454dSwdenk- CONFIG_FEC[12]_PHY
4652c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
46536e592385Swdenk		to the given FEC; i. e.
4654c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4655c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4656c26e454dSwdenk
4657c26e454dSwdenk		When set to -1, means to probe for first available.
4658c26e454dSwdenk
4659c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4660c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4661c26e454dSwdenk		(so program the FEC to ignore it).
4662c26e454dSwdenk
4663c26e454dSwdenk- CONFIG_RMII
4664c26e454dSwdenk		Enable RMII mode for all FECs.
4665c26e454dSwdenk		Note that this is a global option, we can't
4666c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4667c26e454dSwdenk
46685cf91d6bSwdenk- CONFIG_CRC32_VERIFY
46695cf91d6bSwdenk		Add a verify option to the crc32 command.
46705cf91d6bSwdenk		The syntax is:
46715cf91d6bSwdenk
46725cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
46735cf91d6bSwdenk
46745cf91d6bSwdenk		Where address/count indicate a memory area
46755cf91d6bSwdenk		and crc32 is the correct crc32 which the
46765cf91d6bSwdenk		area should have.
46775cf91d6bSwdenk
467856523f12Swdenk- CONFIG_LOOPW
467956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4680602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
468156523f12Swdenk
46827b466641Sstroese- CONFIG_MX_CYCLIC
46837b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
46847b466641Sstroese		"md/mw" commands.
46857b466641Sstroese		Examples:
46867b466641Sstroese
46877b466641Sstroese		=> mdc.b 10 4 500
46887b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
46897b466641Sstroese
46907b466641Sstroese		=> mwc.l 100 12345678 10
46917b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
46927b466641Sstroese
46937b466641Sstroese		This only takes effect if the memory commands are activated
4694602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
46957b466641Sstroese
46968aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4697afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4698e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4699e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4700e03f3169SWolfgang Denk		relocate itself into RAM.
47018aa1a2d1Swdenk
4702e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4703e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4704e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4705e03f3169SWolfgang Denk		these initializations itself.
47068aa1a2d1Swdenk
4707b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4708b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
470990211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4710b5bd0982SSimon Glass		instruction cache) is still performed.
4711b5bd0982SSimon Glass
4712401bb30bSAneesh V- CONFIG_SPL_BUILD
4713df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4714df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4715df81238bSMagnus Lilja		compiling a NAND SPL.
4716400558b5Swdenk
47173aa29de0SYing Zhang- CONFIG_TPL_BUILD
47183aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
47193aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
47203aa29de0SYing Zhang		It is loaded by the SPL.
47213aa29de0SYing Zhang
47225df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
47235df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
47245df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
47255df572f0SYing Zhang		previous 4k of the .text section.
47265df572f0SYing Zhang
47274213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
47284213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
47294213fc29SSimon Glass		effective address. It is therefore not necessary to regard
47304213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
47314213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
47324213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
47334213fc29SSimon Glass		addressable memory. This option causes some memory accesses
47344213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
47354213fc29SSimon Glass
4736d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4737d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4738d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4739d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4740d8834a13SMatthias Weisser		conditions but may increase the binary size.
4741d8834a13SMatthias Weisser
4742588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4743588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4744588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4745b16f521aSGabe Black
4746fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4747fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4748fc33705eSMark Jackson
4749fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
47505b5ece9eSGabe Black
475116678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
475216678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
475316678eb4SHeiko Schocher
4754999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4755999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4756999d7d32SKaricheri, Muralidharan		driver that uses this:
4757999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4758999d7d32SKaricheri, Muralidharan
4759f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4760f2717b47STimur Tabi-----------------------------------
4761f2717b47STimur Tabi
4762f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4763f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4764f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4765f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4766f2717b47STimur Tabiwithin that device.
4767f2717b47STimur Tabi
4768dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4769dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4770dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4771dcf1d774SZhao Qiang	is also specified.
4772dcf1d774SZhao Qiang
4773dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4774dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4775f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4776f2717b47STimur Tabi	is also specified.
4777f2717b47STimur Tabi
4778f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4779f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4780f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4781f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4782f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4783f2717b47STimur Tabi
4784f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4785f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4786f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4787f2717b47STimur Tabi	virtual address in NOR flash.
4788f2717b47STimur Tabi
4789f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4790f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4791f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4792f2717b47STimur Tabi
4793f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4794f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4795f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4796f2717b47STimur Tabi
4797292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4798292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4799292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4800fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4801fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4802fc54c7faSLiu Gang	master's memory space.
4803f2717b47STimur Tabi
4804b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4805b940ca64SJ. German Rivera---------------------------------------------------------
4806b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4807b940ca64SJ. German Rivera"firmware".
4808b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4809b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4810b940ca64SJ. German Riverawithin that device.
4811b940ca64SJ. German Rivera
4812b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4813b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4814b940ca64SJ. German Rivera
48155c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
48165c055089SPrabhakar Kushwaha-------------------------------------------
48175c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
48185c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
48195c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
48205c055089SPrabhakar Kushwaha
4821c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4822c0492141SYork Sun	Define alignment of reserved memory MC requires
48235c055089SPrabhakar Kushwaha
4824f3f431a7SPaul KocialkowskiReproducible builds
4825f3f431a7SPaul Kocialkowski-------------------
4826f3f431a7SPaul Kocialkowski
4827f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4828f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4829f3f431a7SPaul Kocialkowski
4830f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4831f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4832f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4833f3f431a7SPaul Kocialkowski
4834f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4835f3f431a7SPaul Kocialkowski
4836c609719bSwdenkBuilding the Software:
4837c609719bSwdenk======================
4838c609719bSwdenk
4839218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4840218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4841218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4842218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4843218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4844218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4845c609719bSwdenk
4846218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4847218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4848218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4849218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4850218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4851c609719bSwdenk
4852218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4853218ca724SWolfgang Denk	$ export CROSS_COMPILE
4854c609719bSwdenk
48552f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
48562f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
48572f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
48582f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
48592f8d396bSPeter Tyser
48602f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
48612f8d396bSPeter Tyser
48622f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
48632f8d396bSPeter Tyser      be executed on computers running Windows.
48642f8d396bSPeter Tyser
4865c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4866c609719bSwdenksources you must configure U-Boot for one specific board type. This
4867c609719bSwdenkis done by typing:
4868c609719bSwdenk
4869ab584d67SHolger Freyther	make NAME_defconfig
4870c609719bSwdenk
4871ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
48724d675ae6SMichael Jonesrations; see boards.cfg for supported names.
487354387ac9Swdenk
4874c609719bSwdenkNote: for some board special configuration names may exist; check if
4875c609719bSwdenk      additional information is available from the board vendor; for
48762729af9dSwdenk      instance, the TQM823L systems are available without (standard)
48772729af9dSwdenk      or with LCD support. You can select such additional "features"
487811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4879c609719bSwdenk
4880ab584d67SHolger Freyther      make TQM823L_defconfig
48812729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4882c609719bSwdenk
4883ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4884c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4885c609719bSwdenk
4886c609719bSwdenk      etc.
4887c609719bSwdenk
4888c609719bSwdenk
4889c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
48907152b1d0Swdenkimages ready for download to / installation on your system:
4891c609719bSwdenk
4892c609719bSwdenk- "u-boot.bin" is a raw binary image
4893c609719bSwdenk- "u-boot" is an image in ELF binary format
4894c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4895c609719bSwdenk
4896baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4897baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4898baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4899baf31249SMarian Balakowicz
4900baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4901baf31249SMarian Balakowicz
4902baf31249SMarian Balakowicz	make O=/tmp/build distclean
4903ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4904baf31249SMarian Balakowicz	make O=/tmp/build all
4905baf31249SMarian Balakowicz
4906adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4907baf31249SMarian Balakowicz
4908adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4909baf31249SMarian Balakowicz	make distclean
4910ab584d67SHolger Freyther	make NAME_defconfig
4911baf31249SMarian Balakowicz	make all
4912baf31249SMarian Balakowicz
4913adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4914baf31249SMarian Balakowiczvariable.
4915baf31249SMarian Balakowicz
4916c609719bSwdenk
4917c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4918c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4919c609719bSwdenknative "make".
4920c609719bSwdenk
4921c609719bSwdenk
4922c609719bSwdenkIf the system board that you have is not listed, then you will need
4923c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4924c609719bSwdenksteps:
4925c609719bSwdenk
49263c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
492785ec0bccSwdenk    files you need. In your board directory, you will need at least
49283c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
49293c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
49303c1496cdSPhil Sutter    your board.
4931c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4932c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
4933ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
4934c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4935c609719bSwdenk    to be installed on your target system.
493685ec0bccSwdenk6.  Debug and solve any problems that might arise.
4937c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4938c609719bSwdenk
4939c609719bSwdenk
4940c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4941c609719bSwdenk==============================================================
4942c609719bSwdenk
4943c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4944c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4945c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4946c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4947218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4948c609719bSwdenk
4949c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4950c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4951c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
49526de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
49536de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
49546de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
49556de80f21SSimon Glassfor documentation.
4956baf31249SMarian Balakowicz
4957baf31249SMarian Balakowicz
4958c609719bSwdenkSee also "U-Boot Porting Guide" below.
4959c609719bSwdenk
4960c609719bSwdenk
4961c609719bSwdenkMonitor Commands - Overview:
4962c609719bSwdenk============================
4963c609719bSwdenk
4964c609719bSwdenkgo	- start application at address 'addr'
4965c609719bSwdenkrun	- run commands in an environment variable
4966c609719bSwdenkbootm	- boot application image from memory
4967c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
496844f074c7SMarek Vasutbootz   - boot zImage from memory
4969c609719bSwdenktftpboot- boot image via network using TFTP protocol
4970c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4971c609719bSwdenk	       (and eventually "gatewayip")
49721fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4973c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4974c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4975c609719bSwdenkloads	- load S-Record file over serial line
4976c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4977c609719bSwdenkmd	- memory display
4978c609719bSwdenkmm	- memory modify (auto-incrementing)
4979c609719bSwdenknm	- memory modify (constant address)
4980c609719bSwdenkmw	- memory write (fill)
4981c609719bSwdenkcp	- memory copy
4982c609719bSwdenkcmp	- memory compare
4983c609719bSwdenkcrc32	- checksum calculation
49840f89c54bSPeter Tyseri2c	- I2C sub-system
4985c609719bSwdenksspi	- SPI utility commands
4986c609719bSwdenkbase	- print or set address offset
4987c609719bSwdenkprintenv- print environment variables
4988c609719bSwdenksetenv	- set environment variables
4989c609719bSwdenksaveenv - save environment variables to persistent storage
4990c609719bSwdenkprotect - enable or disable FLASH write protection
4991c609719bSwdenkerase	- erase FLASH memory
4992c609719bSwdenkflinfo	- print FLASH memory information
499310635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4994c609719bSwdenkbdinfo	- print Board Info structure
4995c609719bSwdenkiminfo	- print header information for application image
4996c609719bSwdenkconinfo - print console devices and informations
4997c609719bSwdenkide	- IDE sub-system
4998c609719bSwdenkloop	- infinite loop on address range
499956523f12Swdenkloopw	- infinite write loop on address range
5000c609719bSwdenkmtest	- simple RAM test
5001c609719bSwdenkicache	- enable or disable instruction cache
5002c609719bSwdenkdcache	- enable or disable data cache
5003c609719bSwdenkreset	- Perform RESET of the CPU
5004c609719bSwdenkecho	- echo args to console
5005c609719bSwdenkversion - print monitor version
5006c609719bSwdenkhelp	- print online help
5007c609719bSwdenk?	- alias for 'help'
5008c609719bSwdenk
5009c609719bSwdenk
5010c609719bSwdenkMonitor Commands - Detailed Description:
5011c609719bSwdenk========================================
5012c609719bSwdenk
5013c609719bSwdenkTODO.
5014c609719bSwdenk
5015c609719bSwdenkFor now: just type "help <command>".
5016c609719bSwdenk
5017c609719bSwdenk
5018c609719bSwdenkEnvironment Variables:
5019c609719bSwdenk======================
5020c609719bSwdenk
5021c609719bSwdenkU-Boot supports user configuration using Environment Variables which
5022c609719bSwdenkcan be made persistent by saving to Flash memory.
5023c609719bSwdenk
5024c609719bSwdenkEnvironment Variables are set using "setenv", printed using
5025c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
5026c609719bSwdenkwithout a value can be used to delete a variable from the
5027c609719bSwdenkenvironment. As long as you don't save the environment you are
5028c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
5029c609719bSwdenkenvironment is erased by accident, a default environment is provided.
5030c609719bSwdenk
5031c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
5032c96f86eeSWolfgang Denk
5033c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
5034c609719bSwdenk
5035c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
5036c609719bSwdenk
5037c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
5038c609719bSwdenk
5039c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
5040c609719bSwdenk
5041c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
5042c609719bSwdenk
5043c609719bSwdenk  bootfile	- Name of the image to load with TFTP
5044c609719bSwdenk
50457d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
50467d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
50477d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
50487d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
50497d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
50507d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
5051c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5052c3624e6eSGrant Likely		  bootm_mapsize.
5053c3624e6eSGrant Likely
5054c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5055c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
5056c3624e6eSGrant Likely		  defines the size of the memory region starting at base
5057c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
5058c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
5059c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
5060c3624e6eSGrant Likely		  used otherwise.
50617d721e34SBartlomiej Sieka
50627d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
50637d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
50647d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
50657d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
50667d721e34SBartlomiej Sieka		  environment variable.
50677d721e34SBartlomiej Sieka
50684bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
50694bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
50704bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
50714bae9090SBartlomiej Sieka
5072c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
5073c609719bSwdenk		  "bootp" will just load perform a lookup of the
5074c609719bSwdenk		  configuration from the BOOTP server, but not try to
5075c609719bSwdenk		  load any image using TFTP
5076c609719bSwdenk
5077c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
5078c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
5079c609719bSwdenk		  be automatically started (by internally calling
5080c609719bSwdenk		  "bootm")
5081c609719bSwdenk
50824a6fd34bSwdenk		  If set to "no", a standalone image passed to the
50834a6fd34bSwdenk		  "bootm" command will be copied to the load address
50844a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
50854a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
50864a6fd34bSwdenk		  data.
50874a6fd34bSwdenk
5088a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
5089a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
5090fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
5091fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
5092fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
5093fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
5094fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
5095fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
5096fa34f6b2SShawn Guo		  access it during the boot procedure.
5097fa34f6b2SShawn Guo
5098a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
5099a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
5100a28afca5SDavid A. Long		  to work it must reside in writable memory, have
5101a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
5102a28afca5SDavid A. Long		  add the information it needs into it, and the memory
5103a28afca5SDavid A. Long		  must be accessible by the kernel.
5104a28afca5SDavid A. Long
5105eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
5106eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
5107eea63e05SSimon Glass		  defined.
5108eea63e05SSimon Glass
510917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
511017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
511117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
511217ea1177Swdenk		  initialization code. So, for changes to be effective
511317ea1177Swdenk		  it must be saved and board must be reset.
511417ea1177Swdenk
5115c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
5116c609719bSwdenk		  If this variable is not set, initrd images will be
5117c609719bSwdenk		  copied to the highest possible address in RAM; this
5118c609719bSwdenk		  is usually what you want since it allows for
5119c609719bSwdenk		  maximum initrd size. If for some reason you want to
5120c609719bSwdenk		  make sure that the initrd image is loaded below the
51216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
5122c609719bSwdenk		  variable to a value of "no" or "off" or "0".
5123c609719bSwdenk		  Alternatively, you can set it to a maximum upper
5124c609719bSwdenk		  address to use (U-Boot will still check that it
5125c609719bSwdenk		  does not overwrite the U-Boot stack and data).
5126c609719bSwdenk
5127c609719bSwdenk		  For instance, when you have a system with 16 MB
51287152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
5129c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
5130c609719bSwdenk		  the "bootargs" variable. However, now you must make
51317152b1d0Swdenk		  sure that the initrd image is placed in the first
5132c609719bSwdenk		  12 MB as well - this can be done with
5133c609719bSwdenk
5134c609719bSwdenk		  setenv initrd_high 00c00000
5135c609719bSwdenk
513638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
513738b99261Swdenk		  indication to U-Boot that all addresses are legal
513838b99261Swdenk		  for the Linux kernel, including addresses in flash
513938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
514038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
514138b99261Swdenk		  boot time on your system, but requires that this
514238b99261Swdenk		  feature is supported by your Linux kernel.
514338b99261Swdenk
5144c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5145c609719bSwdenk
5146c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5147dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5148c609719bSwdenk
5149c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5150c609719bSwdenk
5151c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5152c609719bSwdenk
5153c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5154c609719bSwdenk
5155c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5156c609719bSwdenk
5157c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5158c609719bSwdenk
5159e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5160a3d991bdSwdenk
5161e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5162e2a53458SMike Frysinger		  For example you can do the following
5163a3d991bdSwdenk
516448690d80SHeiko Schocher		  => setenv ethact FEC
516548690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
516648690d80SHeiko Schocher		  => setenv ethact SCC
516748690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5168a3d991bdSwdenk
5169e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5170e1692577SMatthias Fuchs		  available network interfaces.
5171e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5172e1692577SMatthias Fuchs
5173a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5174a3d991bdSwdenk		  either succeed or fail without retrying.
51756e592385Swdenk		  When set to "once" the network operation will
51766e592385Swdenk		  fail when all the available network interfaces
51776e592385Swdenk		  are tried once without success.
5178a3d991bdSwdenk		  Useful on scripts which control the retry operation
5179a3d991bdSwdenk		  themselves.
5180a3d991bdSwdenk
5181b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5182a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5183b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
51848d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
51858d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
51868d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
51878d51aacdSSimon Glass		  is silent.
51888d51aacdSSimon Glass
5189f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
5190ecb0ccd9SWolfgang Denk		  UDP source port.
5191ecb0ccd9SWolfgang Denk
5192f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
519328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
519428cb9375SWolfgang Denk
5195c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5196c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5197c96f86eeSWolfgang Denk
5198c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5199c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5200c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5201c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5202c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5203c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5204c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5205c96f86eeSWolfgang Denk
5206f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
5207f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
5208f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
5209f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
5210f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
5211f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
5212f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
5213f5fb7346SAlbert ARIBAUD \(3ADEV\)
5214a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
521511ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5216a3d991bdSwdenk		  VLAN tagged frames.
5217c609719bSwdenk
521850768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
521950768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
522050768f5bSAlexandre Messier		  be either the default (28000), or a value based on
522150768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
522250768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
522350768f5bSAlexandre Messier
5224dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5225dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5226dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5227dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5228dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5229dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5230dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5231dc0b7b0eSJason Hobbs
5232dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5233aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
5234dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5235dc0b7b0eSJason Hobbs
5236dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5237dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5238dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5239dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5240dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5241dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5242dc0b7b0eSJason Hobbs
5243c609719bSwdenkThe following environment variables may be used and automatically
5244c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5245c609719bSwdenkdepending the information provided by your boot server:
5246c609719bSwdenk
5247c609719bSwdenk  bootfile	- see above
5248c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5249fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5250c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5251c609719bSwdenk  hostname	- Target hostname
5252c609719bSwdenk  ipaddr	- see above
5253c609719bSwdenk  netmask	- Subnet Mask
5254c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5255c609719bSwdenk  serverip	- see above
5256c609719bSwdenk
5257c609719bSwdenk
5258c609719bSwdenkThere are two special Environment Variables:
5259c609719bSwdenk
5260c609719bSwdenk  serial#	- contains hardware identification information such
5261c609719bSwdenk		  as type string and/or serial number
5262c609719bSwdenk  ethaddr	- Ethernet address
5263c609719bSwdenk
5264c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5265c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5266c609719bSwdenkonce they have been set once.
5267c609719bSwdenk
5268c609719bSwdenk
5269c1551ea8SstroeseFurther special Environment Variables:
5270c1551ea8Sstroese
5271c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5272c1551ea8Sstroese		  with the "version" command. This variable is
5273c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5274c1551ea8Sstroese
5275c1551ea8Sstroese
5276c609719bSwdenkPlease note that changes to some configuration parameters may take
5277c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5278c609719bSwdenk
5279c609719bSwdenk
5280170ab110SJoe HershbergerCallback functions for environment variables:
5281170ab110SJoe Hershberger---------------------------------------------
5282170ab110SJoe Hershberger
5283170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5284b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5285170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5286170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5287170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5288170ab110SJoe Hershberger
5289170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5290170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5291170ab110SJoe Hershberger
5292170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5293170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5294170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5295170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5296170ab110SJoe Hershberger
5297170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5298170ab110SJoe Hershberger	list = entry[,list]
5299170ab110SJoe Hershberger
5300170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5301170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5302170ab110SJoe Hershberger
5303170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5304170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5305170ab110SJoe Hershbergeroverride any association in the static list. You can define
5306170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5307b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5308170ab110SJoe Hershberger
5309bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
5310bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
5311bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
5312bdf1fe4eSJoe Hershberger
5313170ab110SJoe Hershberger
5314f07771ccSwdenkCommand Line Parsing:
5315f07771ccSwdenk=====================
5316f07771ccSwdenk
5317f07771ccSwdenkThere are two different command line parsers available with U-Boot:
53187152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5319f07771ccSwdenk
5320f07771ccSwdenkOld, simple command line parser:
5321f07771ccSwdenk--------------------------------
5322f07771ccSwdenk
5323f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5324f07771ccSwdenk- several commands on one line, separated by ';'
5325fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5326f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5327f07771ccSwdenk  for example:
5328fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5329f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5330f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5331f07771ccSwdenk
5332f07771ccSwdenkHush shell:
5333f07771ccSwdenk-----------
5334f07771ccSwdenk
5335f07771ccSwdenk- similar to Bourne shell, with control structures like
5336f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5337f07771ccSwdenk  until...do...done, ...
5338f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5339f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5340f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5341f07771ccSwdenk  command
5342f07771ccSwdenk
5343f07771ccSwdenkGeneral rules:
5344f07771ccSwdenk--------------
5345f07771ccSwdenk
5346f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5347f07771ccSwdenk    command) contains several commands separated by semicolon, and
5348f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5349f07771ccSwdenk    executed anyway.
5350f07771ccSwdenk
5351f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
535211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5353f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5354f07771ccSwdenk    variables are not executed.
5355f07771ccSwdenk
5356c609719bSwdenkNote for Redundant Ethernet Interfaces:
5357c609719bSwdenk=======================================
5358c609719bSwdenk
535911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5360c609719bSwdenksuch configurations and is capable of automatic selection of a
53617152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5362c609719bSwdenk
5363c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5364c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5365c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5366c609719bSwdenk
5367c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5368c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5369c609719bSwdenkding setting in the environment; if the corresponding environment
5370c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5371c609719bSwdenk
5372c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5373c609719bSwdenk  environment, the SROM's address is used.
5374c609719bSwdenk
5375c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5376c609719bSwdenk  environment exists, then the value from the environment variable is
5377c609719bSwdenk  used.
5378c609719bSwdenk
5379c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5380c609719bSwdenk  both addresses are the same, this MAC address is used.
5381c609719bSwdenk
5382c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5383c609719bSwdenk  addresses differ, the value from the environment is used and a
5384c609719bSwdenk  warning is printed.
5385c609719bSwdenk
5386c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5387bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5388bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
5389c609719bSwdenk
5390ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5391ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5392ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5393ecee9324SBen WarrenThe naming convention is as follows:
5394ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5395c609719bSwdenk
5396c609719bSwdenkImage Formats:
5397c609719bSwdenk==============
5398c609719bSwdenk
53993310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
54003310c549SMarian Balakowiczimages in two formats:
54013310c549SMarian Balakowicz
54023310c549SMarian BalakowiczNew uImage format (FIT)
54033310c549SMarian Balakowicz-----------------------
54043310c549SMarian Balakowicz
54053310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
54063310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
54073310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
54083310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
54093310c549SMarian Balakowicz
54103310c549SMarian Balakowicz
54113310c549SMarian BalakowiczOld uImage format
54123310c549SMarian Balakowicz-----------------
54133310c549SMarian Balakowicz
54143310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
54153310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
54163310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5417c609719bSwdenk
5418c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5419c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5420f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5421f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5422f5ed9e39SPeter Tyser  INTEGRITY).
54237b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5424afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5425afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5426c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5427c609719bSwdenk* Load Address
5428c609719bSwdenk* Entry Point
5429c609719bSwdenk* Image Name
5430c609719bSwdenk* Image Timestamp
5431c609719bSwdenk
5432c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5433c609719bSwdenkand the data portions of the image are secured against corruption by
5434c609719bSwdenkCRC32 checksums.
5435c609719bSwdenk
5436c609719bSwdenk
5437c609719bSwdenkLinux Support:
5438c609719bSwdenk==============
5439c609719bSwdenk
5440c609719bSwdenkAlthough U-Boot should support any OS or standalone application
54417152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5442c609719bSwdenkU-Boot.
5443c609719bSwdenk
5444c609719bSwdenkU-Boot includes many features that so far have been part of some
5445c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5446c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5447c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
54487152b1d0Swdenkserves several purposes:
5449c609719bSwdenk
5450c609719bSwdenk- the same features can be used for other OS or standalone
5451c609719bSwdenk  applications (for instance: using compressed images to reduce the
5452c609719bSwdenk  Flash memory footprint)
5453c609719bSwdenk
5454c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
54557152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5456c609719bSwdenk
5457c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5458c609719bSwdenk  images; of course this also means that different kernel images can
5459c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5460c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5461c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5462c609719bSwdenk  software is easier now.
5463c609719bSwdenk
5464c609719bSwdenk
5465c609719bSwdenkLinux HOWTO:
5466c609719bSwdenk============
5467c609719bSwdenk
5468c609719bSwdenkPorting Linux to U-Boot based systems:
5469c609719bSwdenk---------------------------------------
5470c609719bSwdenk
5471c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5472c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5473c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5474c609719bSwdenkLinux :-).
5475c609719bSwdenk
5476a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5477c609719bSwdenk
5478c609719bSwdenkJust make sure your machine specific header file (for instance
5479c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
54801dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
54811dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
54826d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5483c609719bSwdenk
54842eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
54852eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
54862eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
54872eb31b13SSimon Glassdoc/driver-model.
54882eb31b13SSimon Glass
5489c609719bSwdenk
5490c609719bSwdenkConfiguring the Linux kernel:
5491c609719bSwdenk-----------------------------
5492c609719bSwdenk
5493c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5494c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5495c609719bSwdenk
5496c609719bSwdenk
5497c609719bSwdenkBuilding a Linux Image:
5498c609719bSwdenk-----------------------
5499c609719bSwdenk
550024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
550124ee89b9Swdenknot used. If you use recent kernel source, a new build target
550224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
550324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
550424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
550524ee89b9Swdenk100% compatible format.
5506c609719bSwdenk
5507c609719bSwdenkExample:
5508c609719bSwdenk
5509ab584d67SHolger Freyther	make TQM850L_defconfig
5510c609719bSwdenk	make oldconfig
5511c609719bSwdenk	make dep
551224ee89b9Swdenk	make uImage
5513c609719bSwdenk
551424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
551524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
551624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5517c609719bSwdenk
551824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
551924ee89b9Swdenk
552024ee89b9Swdenk* convert the kernel into a raw binary image:
552124ee89b9Swdenk
552224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
552324ee89b9Swdenk				 -R .note -R .comment \
552424ee89b9Swdenk				 -S vmlinux linux.bin
552524ee89b9Swdenk
552624ee89b9Swdenk* compress the binary image:
552724ee89b9Swdenk
552824ee89b9Swdenk	gzip -9 linux.bin
552924ee89b9Swdenk
553024ee89b9Swdenk* package compressed binary image for U-Boot:
553124ee89b9Swdenk
553224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
553324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
553424ee89b9Swdenk		-d linux.bin.gz uImage
553524ee89b9Swdenk
553624ee89b9Swdenk
553724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
553824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
553924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
554024ee89b9Swdenkbyte header containing information about target architecture,
554124ee89b9Swdenkoperating system, image type, compression method, entry points, time
554224ee89b9Swdenkstamp, CRC32 checksums, etc.
554324ee89b9Swdenk
554424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
554524ee89b9Swdenkprint the header information, or to build new images.
5546c609719bSwdenk
5547c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5548c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5549c609719bSwdenkchecksum verification:
5550c609719bSwdenk
5551c609719bSwdenk	tools/mkimage -l image
5552c609719bSwdenk	  -l ==> list image header information
5553c609719bSwdenk
5554c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5555c609719bSwdenkfrom a "data file" which is used as image payload:
5556c609719bSwdenk
5557c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5558c609719bSwdenk		      -n name -d data_file image
5559c609719bSwdenk	  -A ==> set architecture to 'arch'
5560c609719bSwdenk	  -O ==> set operating system to 'os'
5561c609719bSwdenk	  -T ==> set image type to 'type'
5562c609719bSwdenk	  -C ==> set compression type 'comp'
5563c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5564c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5565c609719bSwdenk	  -n ==> set image name to 'name'
5566c609719bSwdenk	  -d ==> use image data from 'datafile'
5567c609719bSwdenk
556869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
556969459791Swdenkaddress (0x00000000), but the entry point address depends on the
557069459791Swdenkkernel version:
5571c609719bSwdenk
5572c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
557324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5574c609719bSwdenk
5575c609719bSwdenkSo a typical call to build a U-Boot image would read:
5576c609719bSwdenk
557724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
557824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5579a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
558024ee89b9Swdenk	> examples/uImage.TQM850L
558124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5582c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5583c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5584c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5585c609719bSwdenk	Load Address: 0x00000000
558624ee89b9Swdenk	Entry Point:  0x00000000
5587c609719bSwdenk
5588c609719bSwdenkTo verify the contents of the image (or check for corruption):
5589c609719bSwdenk
559024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
559124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5592c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5593c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5594c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5595c609719bSwdenk	Load Address: 0x00000000
559624ee89b9Swdenk	Entry Point:  0x00000000
5597c609719bSwdenk
5598c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5599c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5600c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5601c609719bSwdenkneed to be uncompressed:
5602c609719bSwdenk
5603a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
560424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
560524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5606a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
560724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
560824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5609c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5610c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5611c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5612c609719bSwdenk	Load Address: 0x00000000
561324ee89b9Swdenk	Entry Point:  0x00000000
5614c609719bSwdenk
5615c609719bSwdenk
5616c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5617c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5618c609719bSwdenk
5619c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5620c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5621c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5622c609719bSwdenk	Image Name:   Simple Ramdisk Image
5623c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5624c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5625c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5626c609719bSwdenk	Load Address: 0x00000000
5627c609719bSwdenk	Entry Point:  0x00000000
5628c609719bSwdenk
5629a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5630a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5631a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5632a804b5ceSGuilherme Maciel Ferreirafrom the image:
5633a804b5ceSGuilherme Maciel Ferreira
5634f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5635f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5636f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5637f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5638a804b5ceSGuilherme Maciel Ferreira
5639c609719bSwdenk
5640c609719bSwdenkInstalling a Linux Image:
5641c609719bSwdenk-------------------------
5642c609719bSwdenk
5643c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5644c609719bSwdenkyou must convert the image to S-Record format:
5645c609719bSwdenk
5646c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5647c609719bSwdenk
5648c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5649c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5650c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5651c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5652c609719bSwdenkcommand.
5653c609719bSwdenk
5654c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5655c609719bSwdenkTQM8xxL is in the first Flash bank):
5656c609719bSwdenk
5657c609719bSwdenk	=> erase 40100000 401FFFFF
5658c609719bSwdenk
5659c609719bSwdenk	.......... done
5660c609719bSwdenk	Erased 8 sectors
5661c609719bSwdenk
5662c609719bSwdenk	=> loads 40100000
5663c609719bSwdenk	## Ready for S-Record download ...
5664c609719bSwdenk	~>examples/image.srec
5665c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5666c609719bSwdenk	...
5667c609719bSwdenk	15989 15990 15991 15992
5668c609719bSwdenk	[file transfer complete]
5669c609719bSwdenk	[connected]
5670c609719bSwdenk	## Start Addr = 0x00000000
5671c609719bSwdenk
5672c609719bSwdenk
5673c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5674c609719bSwdenkthis includes a checksum verification so you can be sure no data
5675c609719bSwdenkcorruption happened:
5676c609719bSwdenk
5677c609719bSwdenk	=> imi 40100000
5678c609719bSwdenk
5679c609719bSwdenk	## Checking Image at 40100000 ...
5680c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5681c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5682c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5683c609719bSwdenk	   Load Address: 00000000
5684c609719bSwdenk	   Entry Point:	 0000000c
5685c609719bSwdenk	   Verifying Checksum ... OK
5686c609719bSwdenk
5687c609719bSwdenk
5688c609719bSwdenkBoot Linux:
5689c609719bSwdenk-----------
5690c609719bSwdenk
5691c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5692c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5693c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5694c609719bSwdenkparameters. You can check and modify this variable using the
5695c609719bSwdenk"printenv" and "setenv" commands:
5696c609719bSwdenk
5697c609719bSwdenk
5698c609719bSwdenk	=> printenv bootargs
5699c609719bSwdenk	bootargs=root=/dev/ram
5700c609719bSwdenk
5701c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5702c609719bSwdenk
5703c609719bSwdenk	=> printenv bootargs
5704c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5705c609719bSwdenk
5706c609719bSwdenk	=> bootm 40020000
5707c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5708c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5709c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5710c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5711c609719bSwdenk	   Load Address: 00000000
5712c609719bSwdenk	   Entry Point:	 0000000c
5713c609719bSwdenk	   Verifying Checksum ... OK
5714c609719bSwdenk	   Uncompressing Kernel Image ... OK
5715c609719bSwdenk	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
5716c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5717c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5718c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5719c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5720c609719bSwdenk	...
5721c609719bSwdenk
572211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
57237152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5724c609719bSwdenkformat!) to the "bootm" command:
5725c609719bSwdenk
5726c609719bSwdenk	=> imi 40100000 40200000
5727c609719bSwdenk
5728c609719bSwdenk	## Checking Image at 40100000 ...
5729c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5730c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5731c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5732c609719bSwdenk	   Load Address: 00000000
5733c609719bSwdenk	   Entry Point:	 0000000c
5734c609719bSwdenk	   Verifying Checksum ... OK
5735c609719bSwdenk
5736c609719bSwdenk	## Checking Image at 40200000 ...
5737c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5738c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5739c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5740c609719bSwdenk	   Load Address: 00000000
5741c609719bSwdenk	   Entry Point:	 00000000
5742c609719bSwdenk	   Verifying Checksum ... OK
5743c609719bSwdenk
5744c609719bSwdenk	=> bootm 40100000 40200000
5745c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5746c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5747c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5748c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5749c609719bSwdenk	   Load Address: 00000000
5750c609719bSwdenk	   Entry Point:	 0000000c
5751c609719bSwdenk	   Verifying Checksum ... OK
5752c609719bSwdenk	   Uncompressing Kernel Image ... OK
5753c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5754c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5755c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5756c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5757c609719bSwdenk	   Load Address: 00000000
5758c609719bSwdenk	   Entry Point:	 00000000
5759c609719bSwdenk	   Verifying Checksum ... OK
5760c609719bSwdenk	   Loading Ramdisk ... OK
5761c609719bSwdenk	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
5762c609719bSwdenk	Boot arguments: root=/dev/ram
5763c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5764c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5765c609719bSwdenk	...
5766c609719bSwdenk	RAMDISK: Compressed image found at block 0
5767c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5768c609719bSwdenk
5769c609719bSwdenk	bash#
5770c609719bSwdenk
57710267768eSMatthew McClintockBoot Linux and pass a flat device tree:
57720267768eSMatthew McClintock-----------
57730267768eSMatthew McClintock
57740267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
57750267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
57760267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
57770267768eSMatthew McClintockflat device tree:
57780267768eSMatthew McClintock
57790267768eSMatthew McClintock=> print oftaddr
57800267768eSMatthew McClintockoftaddr=0x300000
57810267768eSMatthew McClintock=> print oft
57820267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
57830267768eSMatthew McClintock=> tftp $oftaddr $oft
57840267768eSMatthew McClintockSpeed: 1000, full duplex
57850267768eSMatthew McClintockUsing TSEC0 device
57860267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
57870267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
57880267768eSMatthew McClintockLoad address: 0x300000
57890267768eSMatthew McClintockLoading: #
57900267768eSMatthew McClintockdone
57910267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
57920267768eSMatthew McClintock=> tftp $loadaddr $bootfile
57930267768eSMatthew McClintockSpeed: 1000, full duplex
57940267768eSMatthew McClintockUsing TSEC0 device
57950267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
57960267768eSMatthew McClintockFilename 'uImage'.
57970267768eSMatthew McClintockLoad address: 0x200000
57980267768eSMatthew McClintockLoading:############
57990267768eSMatthew McClintockdone
58000267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
58010267768eSMatthew McClintock=> print loadaddr
58020267768eSMatthew McClintockloadaddr=200000
58030267768eSMatthew McClintock=> print oftaddr
58040267768eSMatthew McClintockoftaddr=0x300000
58050267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
58060267768eSMatthew McClintock## Booting image at 00200000 ...
58070267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
58080267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
58090267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
58100267768eSMatthew McClintock   Load Address: 00000000
58110267768eSMatthew McClintock   Entry Point:	 00000000
58120267768eSMatthew McClintock   Verifying Checksum ... OK
58130267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
58140267768eSMatthew McClintockBooting using flat device tree at 0x300000
58150267768eSMatthew McClintockUsing MPC85xx ADS machine description
58160267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
58170267768eSMatthew McClintock[snip]
58180267768eSMatthew McClintock
58190267768eSMatthew McClintock
58206069ff26SwdenkMore About U-Boot Image Types:
58216069ff26Swdenk------------------------------
58226069ff26Swdenk
58236069ff26SwdenkU-Boot supports the following image types:
58246069ff26Swdenk
58256069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
58266069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
58276069ff26Swdenk	well) you can continue to work in U-Boot after return from
58286069ff26Swdenk	the Standalone Program.
58296069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
58306069ff26Swdenk	will take over control completely. Usually these programs
58316069ff26Swdenk	will install their own set of exception handlers, device
58326069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
58336069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
58346069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
58356069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
58366069ff26Swdenk	being started.
58376069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
58386069ff26Swdenk	(Linux) kernel image and one or more data images like
58396069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
58406069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
58416069ff26Swdenk	server provides just a single image file, but you want to get
58426069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
58436069ff26Swdenk
58446069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
58456069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
58466069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
58476069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
58486069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
58496069ff26Swdenk	a multiple of 4 bytes).
58506069ff26Swdenk
58516069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
58526069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
58536069ff26Swdenk	flash memory.
58546069ff26Swdenk
58556069ff26Swdenk   "Script files" are command sequences that will be executed by
58566069ff26Swdenk	U-Boot's command interpreter; this feature is especially
58576069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
58586069ff26Swdenk	as command interpreter.
58596069ff26Swdenk
586044f074c7SMarek VasutBooting the Linux zImage:
586144f074c7SMarek Vasut-------------------------
586244f074c7SMarek Vasut
586344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
586444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
586544f074c7SMarek Vasutas the syntax of "bootm" command.
586644f074c7SMarek Vasut
58678ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5868017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5869017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5870017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5871017e1f3fSMarek Vasut
5872c609719bSwdenk
5873c609719bSwdenkStandalone HOWTO:
5874c609719bSwdenk=================
5875c609719bSwdenk
5876c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5877c609719bSwdenkrun "standalone" applications, which can use some resources of
5878c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5879c609719bSwdenk
5880c609719bSwdenkTwo simple examples are included with the sources:
5881c609719bSwdenk
5882c609719bSwdenk"Hello World" Demo:
5883c609719bSwdenk-------------------
5884c609719bSwdenk
5885c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5886c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5887c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5888c609719bSwdenklike that:
5889c609719bSwdenk
5890c609719bSwdenk	=> loads
5891c609719bSwdenk	## Ready for S-Record download ...
5892c609719bSwdenk	~>examples/hello_world.srec
5893c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5894c609719bSwdenk	[file transfer complete]
5895c609719bSwdenk	[connected]
5896c609719bSwdenk	## Start Addr = 0x00040004
5897c609719bSwdenk
5898c609719bSwdenk	=> go 40004 Hello World! This is a test.
5899c609719bSwdenk	## Starting application at 0x00040004 ...
5900c609719bSwdenk	Hello World
5901c609719bSwdenk	argc = 7
5902c609719bSwdenk	argv[0] = "40004"
5903c609719bSwdenk	argv[1] = "Hello"
5904c609719bSwdenk	argv[2] = "World!"
5905c609719bSwdenk	argv[3] = "This"
5906c609719bSwdenk	argv[4] = "is"
5907c609719bSwdenk	argv[5] = "a"
5908c609719bSwdenk	argv[6] = "test."
5909c609719bSwdenk	argv[7] = "<NULL>"
5910c609719bSwdenk	Hit any key to exit ...
5911c609719bSwdenk
5912c609719bSwdenk	## Application terminated, rc = 0x0
5913c609719bSwdenk
5914c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5915c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5916c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5917c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5918c609719bSwdenkcharacter, but this is just a demo program. The application can be
5919c609719bSwdenkcontrolled by the following keys:
5920c609719bSwdenk
5921c609719bSwdenk	? - print current values og the CPM Timer registers
5922c609719bSwdenk	b - enable interrupts and start timer
5923c609719bSwdenk	e - stop timer and disable interrupts
5924c609719bSwdenk	q - quit application
5925c609719bSwdenk
5926c609719bSwdenk	=> loads
5927c609719bSwdenk	## Ready for S-Record download ...
5928c609719bSwdenk	~>examples/timer.srec
5929c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5930c609719bSwdenk	[file transfer complete]
5931c609719bSwdenk	[connected]
5932c609719bSwdenk	## Start Addr = 0x00040004
5933c609719bSwdenk
5934c609719bSwdenk	=> go 40004
5935c609719bSwdenk	## Starting application at 0x00040004 ...
5936c609719bSwdenk	TIMERS=0xfff00980
5937c609719bSwdenk	Using timer 1
5938c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5939c609719bSwdenk
5940c609719bSwdenkHit 'b':
5941c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5942c609719bSwdenk	Enabling timer
5943c609719bSwdenkHit '?':
5944c609719bSwdenk	[q, b, e, ?] ........
5945c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5946c609719bSwdenkHit '?':
5947c609719bSwdenk	[q, b, e, ?] .
5948c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5949c609719bSwdenkHit '?':
5950c609719bSwdenk	[q, b, e, ?] .
5951c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5952c609719bSwdenkHit '?':
5953c609719bSwdenk	[q, b, e, ?] .
5954c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5955c609719bSwdenkHit 'e':
5956c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5957c609719bSwdenkHit 'q':
5958c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5959c609719bSwdenk
5960c609719bSwdenk
596185ec0bccSwdenkMinicom warning:
596285ec0bccSwdenk================
596385ec0bccSwdenk
59647152b1d0SwdenkOver time, many people have reported problems when trying to use the
596585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
596685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5967f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
596885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5969e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5970e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5971e53515a2SKarl O. Pincfor help with kermit.
5972e53515a2SKarl O. Pinc
597385ec0bccSwdenk
597452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
597552f52c14Swdenkconfiguration to your "File transfer protocols" section:
597652f52c14Swdenk
597752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
597852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
597952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
598052f52c14Swdenk
598152f52c14Swdenk
5982c609719bSwdenkNetBSD Notes:
5983c609719bSwdenk=============
5984c609719bSwdenk
5985c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5986c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5987c609719bSwdenk
5988c609719bSwdenkBuilding requires a cross environment; it is known to work on
5989c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5990c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5991c609719bSwdenkNote that the cross-powerpc package does not install include files;
5992c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5993c609719bSwdenkmissing.  This file has to be installed and patched manually:
5994c609719bSwdenk
5995c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5996c609719bSwdenk	# mkdir powerpc
5997c609719bSwdenk	# ln -s powerpc machine
5998c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5999c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
6000c609719bSwdenk
6001c609719bSwdenkNative builds *don't* work due to incompatibilities between native
6002c609719bSwdenkand U-Boot include files.
6003c609719bSwdenk
6004c609719bSwdenkBooting assumes that (the first part of) the image booted is a
6005c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
6006c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
6007c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
60082a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
6009c609719bSwdenk
6010c609719bSwdenk
6011c609719bSwdenkImplementation Internals:
6012c609719bSwdenk=========================
6013c609719bSwdenk
6014c609719bSwdenkThe following is not intended to be a complete description of every
6015c609719bSwdenkimplementation detail. However, it should help to understand the
6016c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
6017c609719bSwdenkhardware.
6018c609719bSwdenk
6019c609719bSwdenk
6020c609719bSwdenkInitial Stack, Global Data:
6021c609719bSwdenk---------------------------
6022c609719bSwdenk
6023c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
6024c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
6025c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
6026c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
6027c609719bSwdenkis not initialized as zero. To be able to get a C environment working
6028c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
6029c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
6030c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
6031c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
6032c609719bSwdenklocked as (mis-) used as memory, etc.
6033c609719bSwdenk
60347152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
60350668236bSWolfgang Denk	U-Boot mailing list:
603643d9616cSwdenk
603743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
603843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
603943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
604043d9616cSwdenk	...
604143d9616cSwdenk
604243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
604343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
604443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
604543d9616cSwdenk	is that the cache is being used as a temporary supply of
604643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
604711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
604843d9616cSwdenk	can see how this works by studying the cache architecture and
604943d9616cSwdenk	operation in the architecture and processor-specific manuals.
605043d9616cSwdenk
605143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
605243d9616cSwdenk	is another option for the system designer to use as an
605311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
605443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
605543d9616cSwdenk	board designers haven't used it for something that would
605643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
605743d9616cSwdenk	used.
605843d9616cSwdenk
60596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
606043d9616cSwdenk	with your processor/board/system design. The default value
606143d9616cSwdenk	you will find in any recent u-boot distribution in
60628a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
606343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
606443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
606543d9616cSwdenk	that are supposed to respond to that address! That code in
606643d9616cSwdenk	start.S has been around a while and should work as is when
606743d9616cSwdenk	you get the config right.
606843d9616cSwdenk
606943d9616cSwdenk	-Chris Hallinan
607043d9616cSwdenk	DS4.COM, Inc.
607143d9616cSwdenk
6072c609719bSwdenkIt is essential to remember this, since it has some impact on the C
6073c609719bSwdenkcode for the initialization procedures:
6074c609719bSwdenk
6075c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
6076c609719bSwdenk  to write it.
6077c609719bSwdenk
6078b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
6079c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
60807152b1d0Swdenk  zation is performed later (when relocating to RAM).
6081c609719bSwdenk
6082c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
6083c609719bSwdenk  that.
6084c609719bSwdenk
6085c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
6086b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
6087c609719bSwdenkturned out that the implementation of U-Boot can be greatly
6088c609719bSwdenksimplified by making a global data structure (gd_t) available to all
6089c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
6090c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
6091c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
6092c609719bSwdenkplace a pointer (gd) to the global data into a register which we
6093c609719bSwdenkreserve for this purpose.
6094c609719bSwdenk
60957152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
6096c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
6097c609719bSwdenkGCC's implementation.
6098c609719bSwdenk
6099c609719bSwdenkFor PowerPC, the following registers have specific use:
6100c609719bSwdenk	R1:	stack pointer
6101e7670f6cSWolfgang Denk	R2:	reserved for system use
6102c609719bSwdenk	R3-R4:	parameter passing and return values
6103c609719bSwdenk	R5-R10: parameter passing
6104c609719bSwdenk	R13:	small data area pointer
6105c609719bSwdenk	R30:	GOT pointer
6106c609719bSwdenk	R31:	frame pointer
6107c609719bSwdenk
6108e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
6109e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
6110e6bee808SJoakim Tjernlund	going back and forth between asm and C)
6111c609719bSwdenk
6112e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
6113c609719bSwdenk
6114c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
6115c609719bSwdenk    address of the global data structure is known at compile time),
6116c609719bSwdenk    but it turned out that reserving a register results in somewhat
6117c609719bSwdenk    smaller code - although the code savings are not that big (on
6118c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
6119c609719bSwdenk    624 text + 127 data).
6120c609719bSwdenk
6121c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
61224c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
61234c58eb55SMike Frysinger
6124c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
61254c58eb55SMike Frysinger
6126c609719bSwdenkOn ARM, the following registers are used:
6127c609719bSwdenk
6128c609719bSwdenk	R0:	function argument word/integer result
6129c609719bSwdenk	R1-R3:	function argument word
613012eba1b4SJeroen Hofstee	R9:	platform specific
613112eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
6132c609719bSwdenk	R11:	argument (frame) pointer
6133c609719bSwdenk	R12:	temporary workspace
6134c609719bSwdenk	R13:	stack pointer
6135c609719bSwdenk	R14:	link register
6136c609719bSwdenk	R15:	program counter
6137c609719bSwdenk
613812eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
613912eba1b4SJeroen Hofstee
614012eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6141c609719bSwdenk
61420df01fd3SThomas ChouOn Nios II, the ABI is documented here:
61430df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
61440df01fd3SThomas Chou
61450df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
61460df01fd3SThomas Chou
61470df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
61480df01fd3SThomas Chou    to access small data sections, so gp is free.
61490df01fd3SThomas Chou
6150afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6151afc1ce82SMacpaul Lin
6152afc1ce82SMacpaul Lin	R0-R1:	argument/return
6153afc1ce82SMacpaul Lin	R2-R5:	argument
6154afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6155afc1ce82SMacpaul Lin	R16:	trampoline register
6156afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6157afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6158afc1ce82SMacpaul Lin	R30:	link register (LP)
6159afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6160afc1ce82SMacpaul Lin	PC:	program counter (PC)
6161afc1ce82SMacpaul Lin
6162afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6163afc1ce82SMacpaul Lin
6164d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6165d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6166c609719bSwdenk
6167c609719bSwdenkMemory Management:
6168c609719bSwdenk------------------
6169c609719bSwdenk
6170c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6171c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6172c609719bSwdenk
6173c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6174c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6175c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6176c609719bSwdenkphysical memory banks.
6177c609719bSwdenk
6178c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6179c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6180c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6181c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
61826d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6183c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6184c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6185c609719bSwdenk
6186c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6187c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6188c609719bSwdenk
6189c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6190c609719bSwdenkthis:
6191c609719bSwdenk
6192c609719bSwdenk	0x0000 0000	Exception Vector code
6193c609719bSwdenk	      :
6194c609719bSwdenk	0x0000 1FFF
6195c609719bSwdenk	0x0000 2000	Free for Application Use
6196c609719bSwdenk	      :
6197c609719bSwdenk	      :
6198c609719bSwdenk
6199c609719bSwdenk	      :
6200c609719bSwdenk	      :
6201c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6202c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6203c609719bSwdenk	0x00FC 0000	Malloc Arena
6204c609719bSwdenk	      :
6205c609719bSwdenk	0x00FD FFFF
6206c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6207c609719bSwdenk	...		eventually: LCD or video framebuffer
6208c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6209c609719bSwdenk	0x00FF FFFF	[End of RAM]
6210c609719bSwdenk
6211c609719bSwdenk
6212c609719bSwdenkSystem Initialization:
6213c609719bSwdenk----------------------
6214c609719bSwdenk
6215c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
621611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6217c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
62187152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6219c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6220c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6221c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6222c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6223c609719bSwdenkthe caches and the SIU.
6224c609719bSwdenk
6225c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6226c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6227c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6228c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6229c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6230c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6231c609719bSwdenkbanks.
6232c609719bSwdenk
6233c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
62347152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6235c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6236c609719bSwdenk0x00000000, with any additional banks following immediately to create
6237c609719bSwdenkcontiguous memory starting from 0.
6238c609719bSwdenk
6239c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6240c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6241c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6242c609719bSwdenkpages, and the final stack is set up.
6243c609719bSwdenk
6244c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6245c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6246c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6247c609719bSwdenknew address in RAM.
6248c609719bSwdenk
6249c609719bSwdenk
6250c609719bSwdenkU-Boot Porting Guide:
6251c609719bSwdenk----------------------
6252c609719bSwdenk
6253c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
62546aff3115Swdenklist, October 2002]
6255c609719bSwdenk
6256c609719bSwdenk
6257c609719bSwdenkint main(int argc, char *argv[])
6258c609719bSwdenk{
6259c609719bSwdenk	sighandler_t no_more_time;
6260c609719bSwdenk
6261c609719bSwdenk	signal(SIGALRM, no_more_time);
6262c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6263c609719bSwdenk
6264c609719bSwdenk	if (available_money > available_manpower) {
62656c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6266c609719bSwdenk		return 0;
6267c609719bSwdenk	}
6268c609719bSwdenk
6269c609719bSwdenk	Download latest U-Boot source;
6270c609719bSwdenk
62710668236bSWolfgang Denk	Subscribe to u-boot mailing list;
62726aff3115Swdenk
62736c3fef28SJerry Van Baren	if (clueless)
6274c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6275c609719bSwdenk
6276c609719bSwdenk	while (learning) {
6277c609719bSwdenk		Read the README file in the top level directory;
62787cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
62796c3fef28SJerry Van Baren		Read applicable doc/*.README;
6280c609719bSwdenk		Read the source, Luke;
62816c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6282c609719bSwdenk	}
6283c609719bSwdenk
62846c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
62856c3fef28SJerry Van Baren		Buy a BDI3000;
62866c3fef28SJerry Van Baren	else
6287c609719bSwdenk		Add a lot of aggravation and time;
6288c609719bSwdenk
62896c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
62906c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
62916c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
62926c3fef28SJerry Van Baren	} else {
6293c609719bSwdenk		Create your own board support subdirectory;
62946c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
62956c3fef28SJerry Van Baren	}
62966c3fef28SJerry Van Baren	Edit new board/<myboard> files
62976c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6298c609719bSwdenk
62996c3fef28SJerry Van Baren	while (!accepted) {
6300c609719bSwdenk		while (!running) {
6301c609719bSwdenk			do {
6302c609719bSwdenk				Add / modify source code;
6303c609719bSwdenk			} until (compiles);
6304c609719bSwdenk			Debug;
6305c609719bSwdenk			if (clueless)
6306c609719bSwdenk				email("Hi, I am having problems...");
6307c609719bSwdenk		}
63086c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
63096c3fef28SJerry Van Baren		if (reasonable critiques)
63106c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
63116c3fef28SJerry Van Baren		else
63126c3fef28SJerry Van Baren			Defend code as written;
63136c3fef28SJerry Van Baren	}
6314c609719bSwdenk
6315c609719bSwdenk	return 0;
6316c609719bSwdenk}
6317c609719bSwdenk
6318c609719bSwdenkvoid no_more_time (int sig)
6319c609719bSwdenk{
6320c609719bSwdenk      hire_a_guru();
6321c609719bSwdenk}
6322c609719bSwdenk
6323c609719bSwdenk
6324c609719bSwdenkCoding Standards:
6325c609719bSwdenk-----------------
6326c609719bSwdenk
6327c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
63282c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
63297ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6330c609719bSwdenk
63312c051651SDetlev ZundelSource files originating from a different project (for example the
63322c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6333b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
63342c051651SDetlev Zundelsources.
63352c051651SDetlev Zundel
63362c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
63372c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
63382c051651SDetlev Zundelin your code.
6339c609719bSwdenk
6340c178d3daSwdenkPlease also stick to the following formatting rules:
6341180d3f74Swdenk- remove any trailing white space
63427ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6343180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
63447ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6345180d3f74Swdenk- do not add trailing empty lines to source files
6346180d3f74Swdenk
6347c609719bSwdenkSubmissions which do not conform to the standards may be returned
6348c609719bSwdenkwith a request to reformat the changes.
6349c609719bSwdenk
6350c609719bSwdenk
6351c609719bSwdenkSubmitting Patches:
6352c609719bSwdenk-------------------
6353c609719bSwdenk
6354c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6355c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6356c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6357c609719bSwdenk
63580d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6359218ca724SWolfgang Denk
63600668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
63610668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
63620668236bSWolfgang Denk
6363c609719bSwdenkWhen you send a patch, please include the following information with
6364c609719bSwdenkit:
6365c609719bSwdenk
6366c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6367c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6368c609719bSwdenk  patch actually fixes something.
6369c609719bSwdenk
6370c609719bSwdenk* For new features: a description of the feature and your
6371c609719bSwdenk  implementation.
6372c609719bSwdenk
6373c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6374c609719bSwdenk
63757207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
63767207b366SRobert P. J. Day  information and associated file and directory references.
6377c609719bSwdenk
637827af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
637927af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6380c609719bSwdenk
6381c609719bSwdenk* If your patch adds new configuration options, don't forget to
6382c609719bSwdenk  document these in the README file.
6383c609719bSwdenk
6384218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6385218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
63867ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6387218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6388218ca724SWolfgang Denk  with some other mail clients.
6389c609719bSwdenk
6390218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6391218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6392218ca724SWolfgang Denk  GNU diff.
63936dff5529Swdenk
6394218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6395218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6396218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6397218ca724SWolfgang Denk  affected files).
6398218ca724SWolfgang Denk
6399218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6400218ca724SWolfgang Denk  and compressed attachments must not be used.
6401c609719bSwdenk
640252f52c14Swdenk* If one logical set of modifications affects or creates several
640352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
640452f52c14Swdenk
640552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
640652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
640752f52c14Swdenk
640852f52c14Swdenk
6409c609719bSwdenkNotes:
6410c609719bSwdenk
64116de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
6412c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6413c609719bSwdenk  for any of the boards.
6414c609719bSwdenk
6415c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6416c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6417c609719bSwdenk  returned with a request to re-formatting / split it.
6418c609719bSwdenk
6419c609719bSwdenk* If you modify existing code, make sure that your new code does not
6420c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6421c609719bSwdenk  When adding new features, these should compile conditionally only
6422c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6423c609719bSwdenk  disabled must not need more memory than the old code without your
6424c609719bSwdenk  modification.
642590dc6704Swdenk
64260668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
64270668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
64280668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
64290668236bSWolfgang Denk  bigger than the size limit should be avoided.
6430