xref: /openbmc/u-boot/README (revision 41987784)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed
387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files
397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or
407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems.
41c609719bSwdenk
427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the
437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically
447207b366SRobert P. J. Dayfrom the Git log using:
45adb9d851SRobert P. J. Day
46adb9d851SRobert P. J. Day	make CHANGELOG
47adb9d851SRobert P. J. Day
48c609719bSwdenk
49c609719bSwdenkWhere to get help:
50c609719bSwdenk==================
51c609719bSwdenk
52c609719bSwdenkIn case you have questions about, problems with or contributions for
537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at
540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58c609719bSwdenk
59c609719bSwdenk
60218ca724SWolfgang DenkWhere to get source code:
61218ca724SWolfgang Denk=========================
62218ca724SWolfgang Denk
637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at
64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66218ca724SWolfgang Denk
67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70218ca724SWolfgang Denkdirectory.
71218ca724SWolfgang Denk
72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
74218ca724SWolfgang Denk
75218ca724SWolfgang Denk
76c609719bSwdenkWhere we come from:
77c609719bSwdenk===================
78c609719bSwdenk
79c609719bSwdenk- start from 8xxrom sources
8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
81c609719bSwdenk- clean up code
82c609719bSwdenk- make it easier to add custom boards
83c609719bSwdenk- make it possible to add other [PowerPC] CPUs
84c609719bSwdenk- extend functions, especially:
85c609719bSwdenk  * Provide extended interface to Linux boot loader
86c609719bSwdenk  * S-Record download
87c609719bSwdenk  * network boot
8811ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
90c609719bSwdenk- add other CPU families (starting with ARM)
9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9324ee89b9Swdenk
9424ee89b9Swdenk
9524ee89b9SwdenkNames and Spelling:
9624ee89b9Swdenk===================
9724ee89b9Swdenk
9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10024ee89b9Swdenkin source files etc.). Example:
10124ee89b9Swdenk
10224ee89b9Swdenk	This is the README file for the U-Boot project.
10324ee89b9Swdenk
10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10524ee89b9Swdenk
10624ee89b9Swdenk	include/asm-ppc/u-boot.h
10724ee89b9Swdenk
10824ee89b9Swdenk	#include <asm/u-boot.h>
10924ee89b9Swdenk
11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11224ee89b9Swdenk
11324ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11424ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
115c609719bSwdenk
116c609719bSwdenk
11793f19cc0SwdenkVersioning:
11893f19cc0Swdenk===========
11993f19cc0Swdenk
120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
123360d883aSThomas Webernames consisting of the calendar year and month of the release date.
124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
125360d883aSThomas Weberreleases in "stable" maintenance trees.
12693f19cc0Swdenk
127360d883aSThomas WeberExamples:
128360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
129360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
1300de21ecbSJelle van der Waa	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
13193f19cc0Swdenk
13293f19cc0Swdenk
133c609719bSwdenkDirectory Hierarchy:
134c609719bSwdenk====================
135c609719bSwdenk
1368d321b81SPeter Tyser/arch			Architecture specific files
1376eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1388d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1398d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1408d321b81SPeter Tyser  /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- Console Baudrate:
774c609719bSwdenk		CONFIG_BAUDRATE - in bps
775c609719bSwdenk		Select one of the baudrates listed in
7766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
778c609719bSwdenk
779c92fac91SHeiko Schocher- Console Rx buffer length
780c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
781c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7822b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
783c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
784c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
785c92fac91SHeiko Schocher		the SMC.
786c92fac91SHeiko Schocher
787c609719bSwdenk- Autoboot Command:
788c609719bSwdenk		CONFIG_BOOTCOMMAND
789c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
790c609719bSwdenk		define a command string that is automatically executed
791c609719bSwdenk		when no character is read on the console interface
792c609719bSwdenk		within "Boot Delay" after reset.
793c609719bSwdenk
794c609719bSwdenk		CONFIG_BOOTARGS
795c609719bSwdenk		This can be used to pass arguments to the bootm
796c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
797c609719bSwdenk		environment value "bootargs".
798c609719bSwdenk
799c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
800c609719bSwdenk		The value of these goes into the environment as
801c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
802c609719bSwdenk		as a convenience, when switching between booting from
80311ccc33fSMarcel Ziswiler		RAM and NFS.
804c609719bSwdenk
805eda0ba38SHeiko Schocher- Bootcount:
806eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
807eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
808eda0ba38SHeiko Schocher		cycle, see:
809eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
810eda0ba38SHeiko Schocher
811eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
812eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
813eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
814eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
815eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
816eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
817eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
818eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
819eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
820eda0ba38SHeiko Schocher
821c609719bSwdenk- Pre-Boot Commands:
822c609719bSwdenk		CONFIG_PREBOOT
823c609719bSwdenk
824c609719bSwdenk		When this option is #defined, the existence of the
825c609719bSwdenk		environment variable "preboot" will be checked
826c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
827c609719bSwdenk		countdown and/or running the auto-boot command resp.
828c609719bSwdenk		entering interactive mode.
829c609719bSwdenk
830c609719bSwdenk		This feature is especially useful when "preboot" is
831c609719bSwdenk		automatically generated or modified. For an example
832c609719bSwdenk		see the LWMON board specific code: here "preboot" is
833c609719bSwdenk		modified when the user holds down a certain
834c609719bSwdenk		combination of keys on the (special) keyboard when
835c609719bSwdenk		booting the systems
836c609719bSwdenk
837c609719bSwdenk- Serial Download Echo Mode:
838c609719bSwdenk		CONFIG_LOADS_ECHO
839c609719bSwdenk		If defined to 1, all characters received during a
840c609719bSwdenk		serial download (using the "loads" command) are
841c609719bSwdenk		echoed back. This might be needed by some terminal
842c609719bSwdenk		emulations (like "cu"), but may as well just take
843c609719bSwdenk		time on others. This setting #define's the initial
844c609719bSwdenk		value of the "loads_echo" environment variable.
845c609719bSwdenk
846602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
847c609719bSwdenk		CONFIG_KGDB_BAUDRATE
848c609719bSwdenk		Select one of the baudrates listed in
8496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
850c609719bSwdenk
851c609719bSwdenk- Monitor Functions:
852602ad3b3SJon Loeliger		Monitor commands can be included or excluded
853602ad3b3SJon Loeliger		from the build by using the #include files
854c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
855ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
856c609719bSwdenk
857602ad3b3SJon Loeliger		The default command configuration includes all commands
858602ad3b3SJon Loeliger		except those marked below with a "*".
859602ad3b3SJon Loeliger
860b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
861602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
862602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
863602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
864602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
865602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
866602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
867d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
868602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
86908d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
870602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
871710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
872602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
873602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
874602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
875a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
876a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
877a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
878a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
879602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
880602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
881246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
882602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
883aa9e6044SNikita Kiryanov		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
884602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8855e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
886fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
88788733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
8880c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
88903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
89003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
89116f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
89216f4d933SStephen Warren					  that work for multiple fs types
89359e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
894bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
895602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
89603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
897602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
898602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
8994d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
90053fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
901a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
902a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
903bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
904602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
905602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
906602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9078fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9084d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
909602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
910aa53233aSSimon Glass		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
9110c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
912c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
913602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
914602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
915602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
916602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9174d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
918d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
919d22c338eSJoe Hershberger					  (169.254.*.*)
920602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
921602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9224d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
92302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
92415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
925602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
926a2681707SWolfgang Denk					  loop, loopw
9274d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
928602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
929602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
930602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
93168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
932602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
933602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
9344d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
935e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
936e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
937602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
938602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
939602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
940602ad3b3SJon Loeliger					  host
941602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
942ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
943602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
944602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
945d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
946602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
947c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
948602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
949602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
950602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
951602ad3b3SJon Loeliger					  (4xx only)
952f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9534d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
95402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9557d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
95674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
957602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9587a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9591fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
960da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
961da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
962602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
963602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
964c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9654d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
96689c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
967c609719bSwdenk
968c609719bSwdenk		EXAMPLE: If you want all functions except of network
969c609719bSwdenk		support you can write:
970c609719bSwdenk
971602ad3b3SJon Loeliger		#include "config_cmd_all.h"
972602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
973c609719bSwdenk
974213bf8c8SGerald Van Baren	Other Commands:
975213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
976c609719bSwdenk
977c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
978602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
979c609719bSwdenk		what you (and your U-Boot users) are doing. Data
980c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
981c609719bSwdenk		8260 (where accesses to the IMMR region must be
982c609719bSwdenk		uncached), and it cannot be disabled on all other
983c609719bSwdenk		systems where we (mis-) use the data cache to hold an
984c609719bSwdenk		initial stack and some data.
985c609719bSwdenk
986c609719bSwdenk
987c609719bSwdenk		XXX - this list needs to get updated!
988c609719bSwdenk
989302a6487SSimon Glass- Removal of commands
990302a6487SSimon Glass		If no commands are needed to boot, you can disable
991302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
992302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
993302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
994302a6487SSimon Glass		instead. This can reduce image size significantly for very
995302a6487SSimon Glass		simple boot procedures.
996302a6487SSimon Glass
997a5ecbe62SWolfgang Denk- Regular expression support:
998a5ecbe62SWolfgang Denk		CONFIG_REGEX
999a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1000a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1001a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1002a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1003a5ecbe62SWolfgang Denk
100445ba8077SSimon Glass- Device tree:
100545ba8077SSimon Glass		CONFIG_OF_CONTROL
100645ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
100745ba8077SSimon Glass		to configure its devices, instead of relying on statically
100845ba8077SSimon Glass		compiled #defines in the board file. This option is
100945ba8077SSimon Glass		experimental and only available on a few boards. The device
101045ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
101145ba8077SSimon Glass
10122c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10132c0f79e4SSimon Glass		be done using one of the two options below:
1014bbb0b128SSimon Glass
1015bbb0b128SSimon Glass		CONFIG_OF_EMBED
1016bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1017bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1018bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1019bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1020bbb0b128SSimon Glass		the global data structure as gd->blob.
102145ba8077SSimon Glass
10222c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10232c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10242c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10252c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10262c0f79e4SSimon Glass
10272c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10282c0f79e4SSimon Glass
10292c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10302c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10312c0f79e4SSimon Glass		still use the individual files if you need something more
10322c0f79e4SSimon Glass		exotic.
10332c0f79e4SSimon Glass
1034c609719bSwdenk- Watchdog:
1035c609719bSwdenk		CONFIG_WATCHDOG
1036c609719bSwdenk		If this variable is defined, it enables watchdog
10376abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10386abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10396abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10406abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
10416abe6fb6SDetlev Zundel		available, then no further board specific code should
10426abe6fb6SDetlev Zundel		be needed to use it.
10436abe6fb6SDetlev Zundel
10446abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
10456abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10466abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10476abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1048c609719bSwdenk
10497bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
10507bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
10517bae0d6fSHeiko Schocher
1052c1551ea8Sstroese- U-Boot Version:
1053c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1054c1551ea8Sstroese		If this variable is defined, an environment variable
1055c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1056c1551ea8Sstroese		version as printed by the "version" command.
1057a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1058a1ea8e51SBenoît Thébaudeau		next reset.
1059c1551ea8Sstroese
1060c609719bSwdenk- Real-Time Clock:
1061c609719bSwdenk
1062602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1063c609719bSwdenk		has to be selected, too. Define exactly one of the
1064c609719bSwdenk		following options:
1065c609719bSwdenk
1066c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1067c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10684e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1069c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10701cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1071c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10727f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1073412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
10743bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10759536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10764c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
107871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
107971d19f30SHeiko Schocher					  RV3029 RTC.
1080c609719bSwdenk
1081b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1082b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1083b37c7e5eSwdenk
1084e92739d3SPeter Tyser- GPIO Support:
1085e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1086e92739d3SPeter Tyser
10875dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10885dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10895dec49caSChris Packham		pins supported by a particular chip.
10905dec49caSChris Packham
1091e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1092e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1093e92739d3SPeter Tyser
1094aa53233aSSimon Glass- I/O tracing:
1095aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1096aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
1097aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
1098aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1099aa53233aSSimon Glass		the driver behaves the same way before and after a code
1100aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1101aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1102aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1103aa53233aSSimon Glass
1104aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1105aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1106aa53233aSSimon Glass		still continue to operate.
1107aa53233aSSimon Glass
1108aa53233aSSimon Glass			iotrace is enabled
1109aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1110aa53233aSSimon Glass			Size:   00010000	(buffer size)
1111aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1112aa53233aSSimon Glass			Output: 10000120	(start + offset)
1113aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1114aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1115aa53233aSSimon Glass
1116c609719bSwdenk- Timestamp Support:
1117c609719bSwdenk
1118c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1119c609719bSwdenk		(date and time) of an image is printed by image
1120c609719bSwdenk		commands like bootm or iminfo. This option is
1121602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1122c609719bSwdenk
1123923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1124923c46f9SKarl O. Pinc		Zero or more of the following:
1125923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1126923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1127923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1128923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1129923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1130923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1131923c46f9SKarl O. Pinc				       disk/part_efi.c
1132923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1133c609719bSwdenk
1134602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1135c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1136923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1137c609719bSwdenk
1138c609719bSwdenk- IDE Reset method:
11394d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11404d13cbadSwdenk		board configurations files but used nowhere!
1141c609719bSwdenk
11424d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11434d13cbadSwdenk		be performed by calling the function
11444d13cbadSwdenk			ide_set_reset(int reset)
11454d13cbadSwdenk		which has to be defined in a board specific file
1146c609719bSwdenk
1147c609719bSwdenk- ATAPI Support:
1148c609719bSwdenk		CONFIG_ATAPI
1149c609719bSwdenk
1150c609719bSwdenk		Set this to enable ATAPI support.
1151c609719bSwdenk
1152c40b2956Swdenk- LBA48 Support
1153c40b2956Swdenk		CONFIG_LBA48
1154c40b2956Swdenk
1155c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11564b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1157c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1158c40b2956Swdenk		support disks up to 2.1TB.
1159c40b2956Swdenk
11606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1161c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1162c40b2956Swdenk			Default is 32bit.
1163c40b2956Swdenk
1164c609719bSwdenk- SCSI Support:
1165c609719bSwdenk		At the moment only there is only support for the
1166c609719bSwdenk		SYM53C8XX SCSI controller; define
1167c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1168c609719bSwdenk
11696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
11706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
11716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1172c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1173c609719bSwdenk		devices.
11746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1175c609719bSwdenk
1176447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1177447c031bSStefan Reinauer		SCSI devices found during the last scan.
1178447c031bSStefan Reinauer
1179c609719bSwdenk- NETWORK Support (PCI):
1180682011ffSwdenk		CONFIG_E1000
1181ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1182ce5207e1SKyle Moffett
1183ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1184ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1185ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1186ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1187ce5207e1SKyle Moffett
1188ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1189ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1190ce5207e1SKyle Moffett		example with the "sspi" command.
1191ce5207e1SKyle Moffett
1192ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1193ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1194ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1195682011ffSwdenk
1196c609719bSwdenk		CONFIG_EEPRO100
1197c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
119811ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1199c609719bSwdenk		write routine for first time initialisation.
1200c609719bSwdenk
1201c609719bSwdenk		CONFIG_TULIP
1202c609719bSwdenk		Support for Digital 2114x chips.
1203c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1204c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1205c609719bSwdenk
1206c609719bSwdenk		CONFIG_NATSEMI
1207c609719bSwdenk		Support for National dp83815 chips.
1208c609719bSwdenk
1209c609719bSwdenk		CONFIG_NS8382X
1210c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1211c609719bSwdenk
121245219c46Swdenk- NETWORK Support (other):
121345219c46Swdenk
1214c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1215c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1216c041e9d2SJens Scharsig
1217c041e9d2SJens Scharsig			CONFIG_RMII
1218c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1219c041e9d2SJens Scharsig
1220c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1221c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1222c041e9d2SJens Scharsig			The driver doen't show link status messages.
1223c041e9d2SJens Scharsig
1224efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1225efdd7319SRob Herring		Support for the Calxeda XGMAC device
1226efdd7319SRob Herring
12273bb46d23SAshok		CONFIG_LAN91C96
122845219c46Swdenk		Support for SMSC's LAN91C96 chips.
122945219c46Swdenk
123045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
123145219c46Swdenk			Define this to enable 32 bit addressing
123245219c46Swdenk
12333bb46d23SAshok		CONFIG_SMC91111
1234f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1235f39748aeSwdenk
1236f39748aeSwdenk			CONFIG_SMC91111_BASE
1237f39748aeSwdenk			Define this to hold the physical address
1238f39748aeSwdenk			of the device (I/O space)
1239f39748aeSwdenk
1240f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1241f39748aeSwdenk			Define this if data bus is 32 bits
1242f39748aeSwdenk
1243f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1244f39748aeSwdenk			Define this to use i/o functions instead of macros
1245f39748aeSwdenk			(some hardware wont work with macros)
1246f39748aeSwdenk
1247dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1248dc02badaSHeiko Schocher		Support for davinci emac
1249dc02badaSHeiko Schocher
1250dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1251dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1252dc02badaSHeiko Schocher
1253b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1254b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1255b3dbf4a5SMacpaul Lin
1256b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1257b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1258b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1259b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1260b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1261b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1262b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1263b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1264b3dbf4a5SMacpaul Lin
1265c2fff331SMike Rapoport		CONFIG_SMC911X
1266557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1267557b377dSJens Gehrlein
1268c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1269557b377dSJens Gehrlein			Define this to hold the physical address
1270557b377dSJens Gehrlein			of the device (I/O space)
1271557b377dSJens Gehrlein
1272c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1273557b377dSJens Gehrlein			Define this if data bus is 32 bits
1274557b377dSJens Gehrlein
1275c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1276557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1277557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1278c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1279557b377dSJens Gehrlein
12803d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12813d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12823d0075faSYoshihiro Shimoda
12833d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12843d0075faSYoshihiro Shimoda			Define the number of ports to be used
12853d0075faSYoshihiro Shimoda
12863d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12873d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12883d0075faSYoshihiro Shimoda
128968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
129068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
129168260aabSYoshihiro Shimoda
1292b2f97cf2SHeiko Schocher- PWM Support:
1293b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
12945052e819SRobert P. J. Day		Support for PWM module on the imx6.
1295b2f97cf2SHeiko Schocher
12965e124724SVadim Bendebury- TPM Support:
129790899cc0SChe-liang Chiou		CONFIG_TPM
129890899cc0SChe-liang Chiou		Support TPM devices.
129990899cc0SChe-liang Chiou
13000766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
13010766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
13021b393db5STom Wai-Hong Tam		per system is supported at this time.
13031b393db5STom Wai-Hong Tam
13041b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13051b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13061b393db5STom Wai-Hong Tam
13073aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
13083aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
13093aa74088SChristophe Ricard
13103aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
13113aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
13123aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
13133aa74088SChristophe Ricard
1314b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1315b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1316b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1317b75fdc11SChristophe Ricard
1318c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1319c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1320c01939c7SDirk Eibach
132190899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13225e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13235e124724SVadim Bendebury		per system is supported at this time.
13245e124724SVadim Bendebury
13255e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13265e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13275e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13285e124724SVadim Bendebury			0xfed40000.
13295e124724SVadim Bendebury
1330be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1331be6c1529SReinhard Pfau		Add tpm monitor functions.
1332be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1333be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1334be6c1529SReinhard Pfau
1335be6c1529SReinhard Pfau		CONFIG_TPM
1336be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1337be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1338be6c1529SReinhard Pfau		Requires support for a TPM device.
1339be6c1529SReinhard Pfau
1340be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1341be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1342be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1343be6c1529SReinhard Pfau
1344c609719bSwdenk- USB Support:
1345c609719bSwdenk		At the moment only the UHCI host controller is
13464d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1347c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1348c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
134930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1350c609719bSwdenk		storage devices.
1351c609719bSwdenk		Note:
1352c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1353c609719bSwdenk		(TEAC FD-05PUB).
13544d13cbadSwdenk		MPC5200 USB requires additional defines:
13554d13cbadSwdenk			CONFIG_USB_CLOCK
13564d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1357307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1358307ecb6dSEric Millbrandt				for USB on PSC3
13594d13cbadSwdenk			CONFIG_USB_CONFIG
13604d13cbadSwdenk				for differential drivers: 0x00001000
13614d13cbadSwdenk				for single ended drivers: 0x00005000
1362307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1363307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1365fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1366fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13674d13cbadSwdenk
13689ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
13699ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
13709ab4ce22SSimon Glass
13716e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
13726e9e0626SOleksandr Tymoshenko		HW module registers.
13736e9e0626SOleksandr Tymoshenko
137416c8d5e7SWolfgang Denk- USB Device:
137516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
137616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
137716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
137811ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
137916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
138016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
138116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
138216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
138316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
138416c8d5e7SWolfgang Denk		a Linux host by
138516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
138616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
138716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
138816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
138916c8d5e7SWolfgang Denk
139016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
139116c8d5e7SWolfgang Denk			Define this to build a UDC device
139216c8d5e7SWolfgang Denk
139316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
139416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
139516c8d5e7SWolfgang Denk			talk to the UDC device
139616c8d5e7SWolfgang Denk
1397f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1398f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1399f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1400f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1401f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1402f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1403f9da0f89SVipin KUMAR			speed.
1404f9da0f89SVipin KUMAR
14056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
140616c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
140716c8d5e7SWolfgang Denk			be set to usbtty.
140816c8d5e7SWolfgang Denk
140916c8d5e7SWolfgang Denk			mpc8xx:
14106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
141116c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
141316c8d5e7SWolfgang Denk
141416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
141516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
141616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
141716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
141816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
141916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
142016c8d5e7SWolfgang Denk
142116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
142216c8d5e7SWolfgang Denk			Define this string as the name of your company for
142316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
142416c8d5e7SWolfgang Denk
142516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
142616c8d5e7SWolfgang Denk			Define this string as the name of your product
142716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
142816c8d5e7SWolfgang Denk
142916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
143016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
143116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
143216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
143316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
143416c8d5e7SWolfgang Denk
143516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
143616c8d5e7SWolfgang Denk			Define this as the unique Product ID
143716c8d5e7SWolfgang Denk			for your device
143816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1439c609719bSwdenk
1440d70a560fSIgor Grinberg- ULPI Layer Support:
1441d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1442d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1443d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1444d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1445d70a560fSIgor Grinberg		viewport is supported.
1446d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1447d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14486d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14496d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14506d365ea0SLucas Stach		the appropriate value in Hz.
1451c609719bSwdenk
1452c609719bSwdenk- MMC Support:
1453c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1454c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1455c609719bSwdenk		accessed from the boot prompt by mapping the device
1456c609719bSwdenk		to physical memory similar to flash. Command line is
1457602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1458602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1459c609719bSwdenk
1460afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1461afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1462afb35666SYoshihiro Shimoda
1463afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1464afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1465afb35666SYoshihiro Shimoda
1466afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1467afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1468afb35666SYoshihiro Shimoda
14691fd93c6eSPierre Aubert		CONFIG_GENERIC_MMC
14701fd93c6eSPierre Aubert		Enable the generic MMC driver
14711fd93c6eSPierre Aubert
14721fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
14731fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
14741fd93c6eSPierre Aubert
14751fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
14761fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
14771fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
14781fd93c6eSPierre Aubert
1479b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
148001acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1481b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1482b3ba6e94STom Rini
1483b3ba6e94STom Rini		CONFIG_CMD_DFU
1484b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1485b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1486b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1487b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1488b3ba6e94STom Rini
1489b3ba6e94STom Rini		CONFIG_DFU_MMC
1490b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1491b3ba6e94STom Rini
1492c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1493c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1494c6631764SPantelis Antoniou
1495a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1496a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1497a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1498a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1499a9479f04SAfzal Mohammed		one that would help mostly the developer.
1500a9479f04SAfzal Mohammed
1501e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1502e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1503e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1504e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1505e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1506e7e75c70SHeiko Schocher
1507ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1508ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1509ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1510ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1511ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1512ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1513ea2453d5SPantelis Antoniou
1514001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1515001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1516001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1517001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1518001a8319SHeiko Schocher
1519001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1520001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1521001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1522001a8319SHeiko Schocher		sending again an USB request to the device.
1523001a8319SHeiko Schocher
15243aab70afSSebastian Siewior- USB Device Android Fastboot support:
152517da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
152617da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
152717da3c0cSPaul Kocialkowski
15283aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
15293aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
15303aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
15313aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
15323aab70afSSebastian Siewior		used on Android devices.
15333aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
15343aab70afSSebastian Siewior
15353aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
15363aab70afSSebastian Siewior		This enables support for booting images which use the Android
15373aab70afSSebastian Siewior		image format header.
15383aab70afSSebastian Siewior
1539a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
15403aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
15413aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
15423aab70afSSebastian Siewior		downloaded images.
15433aab70afSSebastian Siewior
1544a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
15453aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
15463aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
15473aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
15483aab70afSSebastian Siewior
1549d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1550d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1551d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1552d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1553d1b5ed07SSteve Rae
1554d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1555d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1556d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1557d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1558d1b5ed07SSteve Rae
15590ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
15600ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
15610ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
15620ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
15630ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
15640ff7e585SSteve Rae		This occurs when the specified "partition name" on the
15650ff7e585SSteve Rae		"fastboot flash" command line matches this value.
15666f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
15670ff7e585SSteve Rae
1568b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1569b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1570b6dd69a4SPetr Kulhavy		image to DOS MBR.
1571b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1572b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1573b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1574b6dd69a4SPetr Kulhavy
15756705d81eSwdenk- Journaling Flash filesystem support:
1576b2482dffSSimon Glass		CONFIG_JFFS2_NAND
15776705d81eSwdenk		Define these for a default partition on a NAND device
15786705d81eSwdenk
15796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15816705d81eSwdenk		Define these for a default partition on a NOR device
15826705d81eSwdenk
1583c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1584c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1585656f4c65SDonggeun Kim
1586656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1587656f4c65SDonggeun Kim		file in FAT formatted partition.
1588656f4c65SDonggeun Kim
1589656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1590656f4c65SDonggeun Kim		user to write files to FAT.
1591c30a15e5SDonggeun Kim
1592edb42dbaSAlexander von Gernler- CBFS (Coreboot Filesystem) support:
159384cd9327SGabe Black		CONFIG_CMD_CBFS
159484cd9327SGabe Black
159584cd9327SGabe Black		Define this to enable support for reading from a Coreboot
159684cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
159784cd9327SGabe Black		and cbfsload.
159884cd9327SGabe Black
15994f0d1a2aSSiva Durga Prasad Paladugu- FAT(File Allocation Table) filesystem cluster size:
16004f0d1a2aSSiva Durga Prasad Paladugu		CONFIG_FS_FAT_MAX_CLUSTSIZE
16014f0d1a2aSSiva Durga Prasad Paladugu
16024f0d1a2aSSiva Durga Prasad Paladugu		Define the max cluster size for fat operations else
16034f0d1a2aSSiva Durga Prasad Paladugu		a default value of 65536 will be defined.
16044f0d1a2aSSiva Durga Prasad Paladugu
1605c609719bSwdenk- Keyboard Support:
160639f615edSSimon Glass		See Kconfig help for available keyboard drivers.
160739f615edSSimon Glass
160839f615edSSimon Glass		CONFIG_KEYBOARD
160939f615edSSimon Glass
161039f615edSSimon Glass		Define this to enable a custom keyboard support.
161139f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
161239f615edSSimon Glass		defined in your board-specific files. This option is deprecated
161339f615edSSimon Glass		and is only used by novena. For new boards, use driver model
161439f615edSSimon Glass		instead.
1615c609719bSwdenk
1616c609719bSwdenk- Video support:
16177d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16187d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16197d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16207d3053fbSTimur Tabi		support, and should also define these other macros:
16217d3053fbSTimur Tabi
16227d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16237d3053fbSTimur Tabi			CONFIG_VIDEO
16247d3053fbSTimur Tabi			CONFIG_CMD_BMP
16257d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16267d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16277d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16287d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16297d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16307d3053fbSTimur Tabi
1631ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1632ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
16338eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1634ba8e76bdSTimur Tabi		description of this variable.
16357d3053fbSTimur Tabi
1636c609719bSwdenk- LCD Support:	CONFIG_LCD
1637c609719bSwdenk
1638c609719bSwdenk		Define this to enable LCD support (for output to LCD
1639c609719bSwdenk		display); also select one of the supported displays
1640c609719bSwdenk		by defining one of these:
1641c609719bSwdenk
164239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
164339cf4804SStelian Pop
164439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
164539cf4804SStelian Pop
1646fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1647c609719bSwdenk
1648fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1649c609719bSwdenk
1650fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1651c609719bSwdenk
1652fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1653fd3103bbSwdenk			Active, color, single scan.
1654fd3103bbSwdenk
1655fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1656fd3103bbSwdenk
1657fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1658c609719bSwdenk			Active, color, single scan.
1659c609719bSwdenk
1660c609719bSwdenk		CONFIG_SHARP_16x9
1661c609719bSwdenk
1662c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1663c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1664c609719bSwdenk
1665c609719bSwdenk		CONFIG_SHARP_LQ64D341
1666c609719bSwdenk
1667c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1668c609719bSwdenk			Active, color, single scan.
1669c609719bSwdenk
1670c609719bSwdenk		CONFIG_HLD1045
1671c609719bSwdenk
1672c609719bSwdenk			HLD1045 display, 640x480.
1673c609719bSwdenk			Active, color, single scan.
1674c609719bSwdenk
1675c609719bSwdenk		CONFIG_OPTREX_BW
1676c609719bSwdenk
1677c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1678c609719bSwdenk			or
1679c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1680c609719bSwdenk			or
1681c609719bSwdenk			Hitachi	 SP14Q002
1682c609719bSwdenk
1683c609719bSwdenk			320x240. Black & white.
1684c609719bSwdenk
1685c609719bSwdenk		Normally display is black on white background; define
16866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1687c609719bSwdenk
1688676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1689676d319eSSimon Glass
1690b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1691676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1692676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1693676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1694676d319eSSimon Glass		a per-section basis.
1695676d319eSSimon Glass
1696676d319eSSimon Glass
1697604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1698604c7d4aSHannes Petermaier
1699604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1700604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1701604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1702604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1703604c7d4aSHannes Petermaier		printed out.
1704604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1705604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1706604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1707604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1708604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1709604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1710604c7d4aSHannes Petermaier		1 = 90 degree rotation
1711604c7d4aSHannes Petermaier		2 = 180 degree rotation
1712604c7d4aSHannes Petermaier		3 = 270 degree rotation
1713604c7d4aSHannes Petermaier
1714604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1715604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1716604c7d4aSHannes Petermaier
171745d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
171845d7f525STom Wai-Hong Tam
171945d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
172045d7f525STom Wai-Hong Tam
1721735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1722735987c5STom Wai-Hong Tam
1723735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1724735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1725735987c5STom Wai-Hong Tam
17267152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1727d791b1dcSwdenk
1728d791b1dcSwdenk		If this option is set, the environment is checked for
1729d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1730d791b1dcSwdenk		of logo, copyright and system information on the LCD
1731e94d2cd9Swdenk		is suppressed and the BMP image at the address
1732d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1733d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1734d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1735d791b1dcSwdenk		loaded very quickly after power-on.
1736d791b1dcSwdenk
1737c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1738c0880485SNikita Kiryanov
1739c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1740c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1741ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1742c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1743c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1744c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1745c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1746c0880485SNikita Kiryanov		there is no need to set this option.
1747c0880485SNikita Kiryanov
17481ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17491ca298ceSMatthias Weisser
17501ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17511ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17521ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17531ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17541ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17551ca298ceSMatthias Weisser		specify 'm' for centering the image.
17561ca298ceSMatthias Weisser
17571ca298ceSMatthias Weisser		Example:
17581ca298ceSMatthias Weisser		setenv splashpos m,m
17591ca298ceSMatthias Weisser			=> image at center of screen
17601ca298ceSMatthias Weisser
17611ca298ceSMatthias Weisser		setenv splashpos 30,20
17621ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17631ca298ceSMatthias Weisser
17641ca298ceSMatthias Weisser		setenv splashpos -10,m
17651ca298ceSMatthias Weisser			=> vertically centered image
17661ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17671ca298ceSMatthias Weisser
176898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
176998f4a3dfSStefan Roese
177098f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
177198f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
177298f4a3dfSStefan Roese		splashscreen support or the bmp command.
177398f4a3dfSStefan Roese
1774d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1775d5011762SAnatolij Gustschin
1776d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1777d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1778d5011762SAnatolij Gustschin		bmp command.
1779d5011762SAnatolij Gustschin
1780b445bbb4SJeremiah Mahler- Do compressing for memory range:
1781f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1782f2b96dfbSLei Wen
1783f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1784f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1785f2b96dfbSLei Wen
1786c29fdfc1Swdenk- Compression support:
17878ef70478SKees Cook		CONFIG_GZIP
17888ef70478SKees Cook
17898ef70478SKees Cook		Enabled by default to support gzip compressed images.
17908ef70478SKees Cook
1791c29fdfc1Swdenk		CONFIG_BZIP2
1792c29fdfc1Swdenk
1793c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1794c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1795c29fdfc1Swdenk		compressed images are supported.
1796c29fdfc1Swdenk
1797c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1799c29fdfc1Swdenk		be at least 4MB.
1800d791b1dcSwdenk
1801fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1802fc9c1727SLuigi 'Comio' Mantellini
1803fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1804fc9c1727SLuigi 'Comio' Mantellini		images is included.
1805fc9c1727SLuigi 'Comio' Mantellini
1806fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1807fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1808fc9c1727SLuigi 'Comio' Mantellini		formula:
1809fc9c1727SLuigi 'Comio' Mantellini
1810fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1811fc9c1727SLuigi 'Comio' Mantellini
1812fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1813fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1814fc9c1727SLuigi 'Comio' Mantellini
1815fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1816fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1817fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1818fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1819fc9c1727SLuigi 'Comio' Mantellini
1820fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1821fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1823fc9c1727SLuigi 'Comio' Mantellini
18248ef70478SKees Cook		CONFIG_LZO
18258ef70478SKees Cook
18268ef70478SKees Cook		If this option is set, support for LZO compressed images
18278ef70478SKees Cook		is included.
18288ef70478SKees Cook
182917ea1177Swdenk- MII/PHY support:
183017ea1177Swdenk		CONFIG_PHY_ADDR
183117ea1177Swdenk
183217ea1177Swdenk		The address of PHY on MII bus.
183317ea1177Swdenk
183417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
183517ea1177Swdenk
183617ea1177Swdenk		The clock frequency of the MII bus
183717ea1177Swdenk
183817ea1177Swdenk		CONFIG_PHY_GIGE
183917ea1177Swdenk
184017ea1177Swdenk		If this option is set, support for speed/duplex
184111ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
184217ea1177Swdenk
184317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
184417ea1177Swdenk
184517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
184617ea1177Swdenk		reset before any MII register access is possible.
184717ea1177Swdenk		For such PHY, set this option to the usec delay
184817ea1177Swdenk		required. (minimum 300usec for LXT971A)
184917ea1177Swdenk
185017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
185117ea1177Swdenk
185217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
185317ea1177Swdenk		command issued before MII status register can be read
185417ea1177Swdenk
1855c609719bSwdenk- IP address:
1856c609719bSwdenk		CONFIG_IPADDR
1857c609719bSwdenk
1858c609719bSwdenk		Define a default value for the IP address to use for
185911ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1860c609719bSwdenk		determined through e.g. bootp.
18611ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1862c609719bSwdenk
1863c609719bSwdenk- Server IP address:
1864c609719bSwdenk		CONFIG_SERVERIP
1865c609719bSwdenk
1866c609719bSwdenk		Defines a default value for the IP address of a TFTP
1867c609719bSwdenk		server to contact when using the "tftboot" command.
18681ebcd654SWolfgang Denk		(Environment variable "serverip")
1869c609719bSwdenk
187097cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
187197cfe861SRobin Getz
187297cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
187397cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
187497cfe861SRobin Getz
18751ebcd654SWolfgang Denk- Gateway IP address:
18761ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18771ebcd654SWolfgang Denk
18781ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18791ebcd654SWolfgang Denk		default router where packets to other networks are
18801ebcd654SWolfgang Denk		sent to.
18811ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18821ebcd654SWolfgang Denk
18831ebcd654SWolfgang Denk- Subnet mask:
18841ebcd654SWolfgang Denk		CONFIG_NETMASK
18851ebcd654SWolfgang Denk
18861ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18871ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18881ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18891ebcd654SWolfgang Denk		forwarded through a router.
18901ebcd654SWolfgang Denk		(Environment variable "netmask")
18911ebcd654SWolfgang Denk
189253a5c424SDavid Updegraff- Multicast TFTP Mode:
189353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
189453a5c424SDavid Updegraff
189553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
189653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
189711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
189853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
189953a5c424SDavid Updegraff		multicast group.
190053a5c424SDavid Updegraff
1901c609719bSwdenk- BOOTP Recovery Mode:
1902c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1903c609719bSwdenk
1904c609719bSwdenk		If you have many targets in a network that try to
1905c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1906c609719bSwdenk		systems send out BOOTP requests at precisely the same
1907c609719bSwdenk		moment (which would happen for instance at recovery
1908c609719bSwdenk		from a power failure, when all systems will try to
1909c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1910c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1911c609719bSwdenk		inserted before sending out BOOTP requests. The
19126c33c785SWolfgang Denk		following delays are inserted then:
1913c609719bSwdenk
1914c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1915c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1916c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1917c609719bSwdenk		4th and following
1918c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1919c609719bSwdenk
192092ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
192192ac8accSThierry Reding
192292ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
192392ac8accSThierry Reding		server will copy the ID from client requests to responses and
192492ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
192592ac8accSThierry Reding		an incoming response. Some servers will check that addresses
192692ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
192792ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
192892ac8accSThierry Reding		respond. Network congestion may also influence the time it
192992ac8accSThierry Reding		takes for a response to make it back to the client. If that
193092ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
193192ac8accSThierry Reding		to allow earlier responses to still be accepted after these
193292ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
193392ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
193492ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
193592ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
193692ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
193792ac8accSThierry Reding
1938fe389a82Sstroese- DHCP Advanced Options:
19391fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19401fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1941fe389a82Sstroese
19421fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19431fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19441fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19451fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19461fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19471fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19481fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19491fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19501fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19511fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19521fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19531fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19542c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1955fe389a82Sstroese
19565d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19575d110f0aSWilson Callan		environment variable, not the BOOTP server.
1958fe389a82Sstroese
19592c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19602c00e099SJoe Hershberger		after the configured retry count, the call will fail
19612c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19622c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19632c00e099SJoe Hershberger		is not available.
19642c00e099SJoe Hershberger
1965fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1966fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1967fe389a82Sstroese		than one DNS serverip is offered to the client.
1968fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1969fe389a82Sstroese		serverip will be stored in the additional environment
1970fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1971fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19721fe80d79SJon Loeliger		is defined.
1973fe389a82Sstroese
1974fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1975fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1976fe389a82Sstroese		need the hostname of the DHCP requester.
19775d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
19781fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
19791fe80d79SJon Loeliger		option 12 to the DHCP server.
1980fe389a82Sstroese
1981d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1982d9a2f416SAras Vaichas
1983d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1984d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1985d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1986d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1987d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1988d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1989d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1990d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1991d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1992d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1993d9a2f416SAras Vaichas		this delay.
1994d9a2f416SAras Vaichas
1995d22c338eSJoe Hershberger - Link-local IP address negotiation:
1996d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1997d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1998d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1999d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2000d22c338eSJoe Hershberger
2001d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2002d22c338eSJoe Hershberger
2003a3d991bdSwdenk - CDP Options:
2004a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2005a3d991bdSwdenk
2006a3d991bdSwdenk		The device id used in CDP trigger frames.
2007a3d991bdSwdenk
2008a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2009a3d991bdSwdenk
2010a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2011a3d991bdSwdenk		of the device.
2012a3d991bdSwdenk
2013a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2014a3d991bdSwdenk
2015a3d991bdSwdenk		A printf format string which contains the ascii name of
2016a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
201711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2018a3d991bdSwdenk
2019a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2020a3d991bdSwdenk
2021a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2022a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2023a3d991bdSwdenk
2024a3d991bdSwdenk		CONFIG_CDP_VERSION
2025a3d991bdSwdenk
2026a3d991bdSwdenk		An ascii string containing the version of the software.
2027a3d991bdSwdenk
2028a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2029a3d991bdSwdenk
2030a3d991bdSwdenk		An ascii string containing the name of the platform.
2031a3d991bdSwdenk
2032a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2033a3d991bdSwdenk
2034a3d991bdSwdenk		A 32bit integer sent on the trigger.
2035a3d991bdSwdenk
2036a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2037a3d991bdSwdenk
2038a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2039a3d991bdSwdenk		device in .1 of milliwatts.
2040a3d991bdSwdenk
2041a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2042a3d991bdSwdenk
2043a3d991bdSwdenk		A byte containing the id of the VLAN.
2044a3d991bdSwdenk
2045c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2046c609719bSwdenk
2047c609719bSwdenk		Several configurations allow to display the current
2048c609719bSwdenk		status using a LED. For instance, the LED will blink
2049c609719bSwdenk		fast while running U-Boot code, stop blinking as
2050c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2051c609719bSwdenk		start blinking slow once the Linux kernel is running
2052c609719bSwdenk		(supported by a status LED driver in the Linux
2053c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2054c609719bSwdenk		feature in U-Boot.
2055c609719bSwdenk
20561df7bbbaSIgor Grinberg		Additional options:
20571df7bbbaSIgor Grinberg
20581df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20591df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20601df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20611df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20621df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20631df7bbbaSIgor Grinberg
20649dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20659dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20669dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20679dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20689dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20699dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20709dfdcdfeSIgor Grinberg
2071c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2072c609719bSwdenk
2073c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2074c609719bSwdenk		on those systems that support this (optional)
2075c609719bSwdenk		feature, like the TQM8xxL modules.
2076c609719bSwdenk
20773f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2078c609719bSwdenk
20793f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
20803f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
20813f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
20823f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
20833f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
20843f4978c7SHeiko Schocher		interface.
20853f4978c7SHeiko Schocher
20863f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2087ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2088ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2089ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2090ea818dbbSHeiko Schocher		    for defining speed and slave address
2091ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2092ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2093ea818dbbSHeiko Schocher		    for defining speed and slave address
2094ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2095ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2096ea818dbbSHeiko Schocher		    for defining speed and slave address
2097ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2098ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2099ea818dbbSHeiko Schocher		    for defining speed and slave address
21003f4978c7SHeiko Schocher
210100f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
210200f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
210300f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
210400f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
210500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
210600f792e0SHeiko Schocher		    bus.
210700f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
210800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
210900f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
211000f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
211100f792e0SHeiko Schocher		    second bus.
211200f792e0SHeiko Schocher
21131f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21141f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21151f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21161f2ba722SSimon Glass		    100000 and the slave addr 0!
21171f2ba722SSimon Glass
2118880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2119880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2120880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2121880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2122880540deSDirk Eibach
2123fac96408Strem		- drivers/i2c/i2c_mxc.c
2124fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
212503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
212603544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
212703544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
212803544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
2129fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2130fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2131fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2132fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2133fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2134fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
213503544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
213603544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2137b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
2138fac96408Strem		for speed, and 0 for slave.
2139fac96408Strem
21401086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21411086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21421086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21431086bfa9SNobuhiro Iwamatsu
21441086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21451086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21461086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21471086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21481086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21491086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21501086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21511086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21521086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21531086bfa9SNobuhiro Iwamatsu
21542035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21552035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21562035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21572035d77dSNobuhiro Iwamatsu
21582035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21592035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21602035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21612035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21622035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21632035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21642035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21652035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21662035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21672035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2168b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
21692035d77dSNobuhiro Iwamatsu
21706789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21716789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21726789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21736789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21746789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21756789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21766789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21776789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21786789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
21796789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
21806789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
21816789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
21826789e84eSHeiko Schocher
21830bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
21840bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
21850bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
21860bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
21870bdffe71SHeiko Schocher
2188e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2189e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2190e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2191e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2192e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2193e717fc6dSNaveen Krishna Ch
2194b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2195b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2196b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2197b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2198b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2199b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2200b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2201b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2202b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2203b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2204b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2205b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2206b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2207b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2208071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2209071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2210071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2211071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2212071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2213071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2214071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2215071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2216071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2217b46226bdSDirk Eibach
22183f4978c7SHeiko Schocher		additional defines:
22193f4978c7SHeiko Schocher
22203f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2221945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
22223f4978c7SHeiko Schocher
22233f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22243f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22253f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22263f4978c7SHeiko Schocher		omit this define.
22273f4978c7SHeiko Schocher
22283f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22293f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22303f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22313f4978c7SHeiko Schocher		define.
22323f4978c7SHeiko Schocher
22333f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2234b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
22353f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22363f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22373f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22383f4978c7SHeiko Schocher
22393f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22403f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22413f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22423f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22433f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22443f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22453f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22463f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22473f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22483f4978c7SHeiko Schocher					}
22493f4978c7SHeiko Schocher
22503f4978c7SHeiko Schocher		which defines
22513f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2252ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2253ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2254ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2255ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2256ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22573f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2258ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2259ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22603f4978c7SHeiko Schocher
22613f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22623f4978c7SHeiko Schocher
2263ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22643f4978c7SHeiko Schocher
22653f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22663f4978c7SHeiko Schocher		provides the following compelling advantages:
22673f4978c7SHeiko Schocher
22683f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22693f4978c7SHeiko Schocher		- approved multibus support
22703f4978c7SHeiko Schocher		- better i2c mux support
22713f4978c7SHeiko Schocher
22723f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22733f4978c7SHeiko Schocher
2274ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2275ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2276ea818dbbSHeiko Schocher		for the selected CPU.
2277c609719bSwdenk
2278b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2279602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2280b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2281b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2282c609719bSwdenk		command line interface.
2283c609719bSwdenk
2284bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2285c609719bSwdenk
2286b37c7e5eSwdenk		There are several other quantities that must also be
2287ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2288c609719bSwdenk
22896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2290b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
229211ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2293c609719bSwdenk
22948d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2295a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22968d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22978d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22988d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2299b37c7e5eSwdenk
23005da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23015da71efaSEric Millbrandt
23025da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23035da71efaSEric Millbrandt		chips might think that the current transfer is still
23045da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23055da71efaSEric Millbrandt		commands until the slave device responds.
23065da71efaSEric Millbrandt
2307b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2308b37c7e5eSwdenk
2309ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2310b37c7e5eSwdenk		then the following macros need to be defined (examples are
2311b37c7e5eSwdenk		from include/configs/lwmon.h):
2312c609719bSwdenk
2313c609719bSwdenk		I2C_INIT
2314c609719bSwdenk
2315b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2316c609719bSwdenk		controller or configure ports.
2317c609719bSwdenk
2318b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2319b37c7e5eSwdenk
2320c609719bSwdenk		I2C_PORT
2321c609719bSwdenk
2322c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2323c609719bSwdenk		assumes both bits are on the same port). Valid values
2324c609719bSwdenk		are 0..3 for ports A..D.
2325c609719bSwdenk
2326c609719bSwdenk		I2C_ACTIVE
2327c609719bSwdenk
2328c609719bSwdenk		The code necessary to make the I2C data line active
2329c609719bSwdenk		(driven).  If the data line is open collector, this
2330c609719bSwdenk		define can be null.
2331c609719bSwdenk
2332b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2333b37c7e5eSwdenk
2334c609719bSwdenk		I2C_TRISTATE
2335c609719bSwdenk
2336c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2337c609719bSwdenk		(inactive).  If the data line is open collector, this
2338c609719bSwdenk		define can be null.
2339c609719bSwdenk
2340b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2341b37c7e5eSwdenk
2342c609719bSwdenk		I2C_READ
2343c609719bSwdenk
2344472d5460SYork Sun		Code that returns true if the I2C data line is high,
2345472d5460SYork Sun		false if it is low.
2346c609719bSwdenk
2347b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2348b37c7e5eSwdenk
2349c609719bSwdenk		I2C_SDA(bit)
2350c609719bSwdenk
2351472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2352472d5460SYork Sun		is false, it clears it (low).
2353c609719bSwdenk
2354b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2355b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2356b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2357b37c7e5eSwdenk
2358c609719bSwdenk		I2C_SCL(bit)
2359c609719bSwdenk
2360472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2361472d5460SYork Sun		is false, it clears it (low).
2362c609719bSwdenk
2363b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2364b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2365b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2366b37c7e5eSwdenk
2367c609719bSwdenk		I2C_DELAY
2368c609719bSwdenk
2369c609719bSwdenk		This delay is invoked four times per clock cycle so this
2370c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2371b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2372b37c7e5eSwdenk		like:
2373b37c7e5eSwdenk
2374b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2375c609719bSwdenk
2376793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2377793b5726SMike Frysinger
2378793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2379793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2380793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2381793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2382793b5726SMike Frysinger
2383793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2384793b5726SMike Frysinger		the generic GPIO functions.
2385793b5726SMike Frysinger
23866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
238747cd00faSwdenk
238847cd00faSwdenk		When a board is reset during an i2c bus transfer
238947cd00faSwdenk		chips might think that the current transfer is still
239047cd00faSwdenk		in progress. On some boards it is possible to access
239147cd00faSwdenk		the i2c SCLK line directly, either by using the
239247cd00faSwdenk		processor pin as a GPIO or by having a second pin
239347cd00faSwdenk		connected to the bus. If this option is defined a
239447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
239547cd00faSwdenk		is run early in the boot sequence.
239647cd00faSwdenk
239726a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
239826a33504SRichard Retanubun
239926a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
240026a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
240126a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
240226a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
240326a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
240426a33504SRichard Retanubun		controller provide such a method. It is called at the end of
240526a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
240626a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
240726a33504SRichard Retanubun
240817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
240917ea1177Swdenk
241017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
241117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
241217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
241317ea1177Swdenk
2414bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2415bb99ad6dSBen Warren
2416bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2417bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2418bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2419bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2420bb99ad6dSBen Warren
24216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2422bb99ad6dSBen Warren
2423bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24240f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24250f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24260f89c54bSPeter Tyser		a 1D array of device addresses
2427bb99ad6dSBen Warren
2428bb99ad6dSBen Warren		e.g.
2429bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2431bb99ad6dSBen Warren
2432bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2433bb99ad6dSBen Warren
2434bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2435945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2436bb99ad6dSBen Warren
2437bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2438bb99ad6dSBen Warren
24396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2440be5e6181STimur Tabi
2441be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2442be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2443be5e6181STimur Tabi
24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24450dc018ecSStefan Roese
24460dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24470dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24480dc018ecSStefan Roese
24496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24500dc018ecSStefan Roese
24510dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24520dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24530dc018ecSStefan Roese
24546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24559ebbb54fSVictor Gallardo
24569ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24579ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24589ebbb54fSVictor Gallardo		specified DTT device.
24599ebbb54fSVictor Gallardo
24602ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24612ac6985aSAndrew Dyer
24622ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24632ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24642ac6985aSAndrew Dyer		between writing the address pointer and reading the
24652ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24662ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24672ac6985aSAndrew Dyer		devices can use either method, but some require one or
24682ac6985aSAndrew Dyer		the other.
2469be5e6181STimur Tabi
2470c609719bSwdenk- SPI Support:	CONFIG_SPI
2471c609719bSwdenk
2472c609719bSwdenk		Enables SPI driver (so far only tested with
2473c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2474c609719bSwdenk		D/As on the SACSng board)
2475c609719bSwdenk
24766639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24776639562eSYoshihiro Shimoda
24786639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24796639562eSYoshihiro Shimoda		only SH7757 is supported.
24806639562eSYoshihiro Shimoda
2481c609719bSwdenk		CONFIG_SOFT_SPI
2482c609719bSwdenk
2483c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2484c609719bSwdenk		using hardware support. This is a general purpose
2485c609719bSwdenk		driver that only requires three general I/O port pins
2486c609719bSwdenk		(two outputs, one input) to function. If this is
2487c609719bSwdenk		defined, the board configuration must define several
2488c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2489c609719bSwdenk		an example, see include/configs/sacsng.h.
2490c609719bSwdenk
249104a9e118SBen Warren		CONFIG_HARD_SPI
249204a9e118SBen Warren
249304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
249404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
249504a9e118SBen Warren		must define a list of chip-select function pointers.
249604a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
249704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
249804a9e118SBen Warren
249938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
250038254f45SGuennadi Liakhovetski
250138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25022e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
250338254f45SGuennadi Liakhovetski
2504f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2505f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2506f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2507f659b573SHeiko Schocher
25080133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25090133502eSMatthias Fuchs
25100133502eSMatthias Fuchs		Enables FPGA subsystem.
25110133502eSMatthias Fuchs
25120133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25130133502eSMatthias Fuchs
25140133502eSMatthias Fuchs		Enables support for specific chip vendors.
25150133502eSMatthias Fuchs		(ALTERA, XILINX)
25160133502eSMatthias Fuchs
25170133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25180133502eSMatthias Fuchs
25190133502eSMatthias Fuchs		Enables support for FPGA family.
25200133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25210133502eSMatthias Fuchs
25220133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2523c609719bSwdenk
2524c609719bSwdenk		Specify the number of FPGA devices to support.
2525c609719bSwdenk
252664e809afSSiva Durga Prasad Paladugu		CONFIG_CMD_FPGA_LOADMK
252764e809afSSiva Durga Prasad Paladugu
252864e809afSSiva Durga Prasad Paladugu		Enable support for fpga loadmk command
252964e809afSSiva Durga Prasad Paladugu
253067193864SMichal Simek		CONFIG_CMD_FPGA_LOADP
253167193864SMichal Simek
253267193864SMichal Simek		Enable support for fpga loadp command - load partial bitstream
253367193864SMichal Simek
253467193864SMichal Simek		CONFIG_CMD_FPGA_LOADBP
253567193864SMichal Simek
253667193864SMichal Simek		Enable support for fpga loadbp command - load partial bitstream
253767193864SMichal Simek		(Xilinx only)
253867193864SMichal Simek
25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2540c609719bSwdenk
2541c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2542c609719bSwdenk
25436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2544c609719bSwdenk
2545c609719bSwdenk		Enable checks on FPGA configuration interface busy
2546c609719bSwdenk		status by the configuration function. This option
2547c609719bSwdenk		will require a board or device specific function to
2548c609719bSwdenk		be written.
2549c609719bSwdenk
2550c609719bSwdenk		CONFIG_FPGA_DELAY
2551c609719bSwdenk
2552c609719bSwdenk		If defined, a function that provides delays in the FPGA
2553c609719bSwdenk		configuration driver.
2554c609719bSwdenk
25556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2556c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2557c609719bSwdenk
25586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2559c609719bSwdenk
2560c609719bSwdenk		Check for configuration errors during FPGA bitfile
2561c609719bSwdenk		loading. For example, abort during Virtex II
2562c609719bSwdenk		configuration if the INIT_B line goes low (which
2563c609719bSwdenk		indicated a CRC error).
2564c609719bSwdenk
25656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2566c609719bSwdenk
2567b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2568b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2569c609719bSwdenk		FPGA configuration sequence. The default time is 500
257011ccc33fSMarcel Ziswiler		ms.
2571c609719bSwdenk
25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2573c609719bSwdenk
2574b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
257511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2576c609719bSwdenk
25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2578c609719bSwdenk
2579c609719bSwdenk		Time to wait after FPGA configuration. The default is
258011ccc33fSMarcel Ziswiler		200 ms.
2581c609719bSwdenk
2582c609719bSwdenk- Configuration Management:
2583b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2584b2b8a696SStefan Roese
2585b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2586b2b8a696SStefan Roese		with a special header) as build targets. By defining
2587b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2588b2b8a696SStefan Roese		special image will be automatically built upon calling
25896de80f21SSimon Glass		make / buildman.
2590b2b8a696SStefan Roese
2591c609719bSwdenk		CONFIG_IDENT_STRING
2592c609719bSwdenk
2593c609719bSwdenk		If defined, this string will be added to the U-Boot
2594c609719bSwdenk		version information (U_BOOT_VERSION)
2595c609719bSwdenk
2596c609719bSwdenk- Vendor Parameter Protection:
2597c609719bSwdenk
2598c609719bSwdenk		U-Boot considers the values of the environment
2599c609719bSwdenk		variables "serial#" (Board Serial Number) and
26007152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2601c609719bSwdenk		are set once by the board vendor / manufacturer, and
2602c609719bSwdenk		protects these variables from casual modification by
2603c609719bSwdenk		the user. Once set, these variables are read-only,
2604c609719bSwdenk		and write or delete attempts are rejected. You can
260511ccc33fSMarcel Ziswiler		change this behaviour:
2606c609719bSwdenk
2607c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2608c609719bSwdenk		file, the write protection for vendor parameters is
260947cd00faSwdenk		completely disabled. Anybody can change or delete
2610c609719bSwdenk		these parameters.
2611c609719bSwdenk
261292ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
261392ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
261411ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2615c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2616c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2617c609719bSwdenk		read-only.]
2618c609719bSwdenk
26192598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26202598090bSJoe Hershberger		for any variable by configuring the type of access
26212598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26222598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26232598090bSJoe Hershberger
2624c609719bSwdenk- Protected RAM:
2625c609719bSwdenk		CONFIG_PRAM
2626c609719bSwdenk
2627c609719bSwdenk		Define this variable to enable the reservation of
2628c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2629c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2630c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2631c609719bSwdenk		this default value by defining an environment
2632c609719bSwdenk		variable "pram" to the number of kB you want to
2633c609719bSwdenk		reserve. Note that the board info structure will
2634c609719bSwdenk		still show the full amount of RAM. If pRAM is
2635c609719bSwdenk		reserved, a new environment variable "mem" will
2636c609719bSwdenk		automatically be defined to hold the amount of
2637c609719bSwdenk		remaining RAM in a form that can be passed as boot
2638c609719bSwdenk		argument to Linux, for instance like that:
2639c609719bSwdenk
2640fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2641c609719bSwdenk			saveenv
2642c609719bSwdenk
2643c609719bSwdenk		This way you can tell Linux not to use this memory,
2644c609719bSwdenk		either, which results in a memory region that will
2645c609719bSwdenk		not be affected by reboots.
2646c609719bSwdenk
2647c609719bSwdenk		*WARNING* If your board configuration uses automatic
2648c609719bSwdenk		detection of the RAM size, you must make sure that
2649c609719bSwdenk		this memory test is non-destructive. So far, the
2650c609719bSwdenk		following board configurations are known to be
2651c609719bSwdenk		"pRAM-clean":
2652c609719bSwdenk
26531b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26541b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2655544d97e9SWolfgang Denk			FLAGADM, TQM8260
2656c609719bSwdenk
265740fef049SGabe Black- Access to physical memory region (> 4GB)
265840fef049SGabe Black		Some basic support is provided for operations on memory not
265940fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
266040fef049SGabe Black		support access to more than 4GB of memory on 32-bit
266140fef049SGabe Black		machines using physical address extension or similar.
266240fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
266340fef049SGabe Black		currently only supports clearing the memory.
266440fef049SGabe Black
2665c609719bSwdenk- Error Recovery:
2666c609719bSwdenk		CONFIG_PANIC_HANG
2667c609719bSwdenk
2668c609719bSwdenk		Define this variable to stop the system in case of a
2669c609719bSwdenk		fatal error, so that you have to reset it manually.
2670c609719bSwdenk		This is probably NOT a good idea for an embedded
267111ccc33fSMarcel Ziswiler		system where you want the system to reboot
2672c609719bSwdenk		automatically as fast as possible, but it may be
2673c609719bSwdenk		useful during development since you can try to debug
2674c609719bSwdenk		the conditions that lead to the situation.
2675c609719bSwdenk
2676c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2677c609719bSwdenk
2678c609719bSwdenk		This variable defines the number of retries for
2679c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2680c609719bSwdenk		before giving up the operation. If not defined, a
2681c609719bSwdenk		default value of 5 is used.
2682c609719bSwdenk
268340cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
268440cb90eeSGuennadi Liakhovetski
268540cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
268640cb90eeSGuennadi Liakhovetski
268748a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
268848a3e999STetsuyuki Kobayashi
268948a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
269048a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
269148a3e999STetsuyuki Kobayashi		try longer timeout such as
269248a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
269348a3e999STetsuyuki Kobayashi
2694c609719bSwdenk- Command Interpreter:
26958078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
269604a85b3bSwdenk
269704a85b3bSwdenk		Enable auto completion of commands using TAB.
269804a85b3bSwdenk
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2700c609719bSwdenk
2701c609719bSwdenk		This defines the secondary prompt string, which is
2702c609719bSwdenk		printed when the command interpreter needs more input
2703c609719bSwdenk		to complete a command. Usually "> ".
2704c609719bSwdenk
2705c609719bSwdenk	Note:
2706c609719bSwdenk
2707c609719bSwdenk		In the current implementation, the local variables
2708c609719bSwdenk		space and global environment variables space are
2709c609719bSwdenk		separated. Local variables are those you define by
27103b57fe0aSwdenk		simply typing `name=value'. To access a local
2711c609719bSwdenk		variable later on, you have write `$name' or
27123b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27133b57fe0aSwdenk		directly type `$name' at the command prompt.
2714c609719bSwdenk
2715c609719bSwdenk		Global environment variables are those you use
2716c609719bSwdenk		setenv/printenv to work with. To run a command stored
2717c609719bSwdenk		in such a variable, you need to use the run command,
2718c609719bSwdenk		and you must not use the '$' sign to access them.
2719c609719bSwdenk
2720c609719bSwdenk		To store commands and special characters in a
2721c609719bSwdenk		variable, please use double quotation marks
2722c609719bSwdenk		surrounding the whole text of the variable, instead
2723c609719bSwdenk		of the backslashes before semicolons and special
2724c609719bSwdenk		symbols.
2725c609719bSwdenk
2726b445bbb4SJeremiah Mahler- Command Line Editing and History:
2727aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2728aa0c71acSWolfgang Denk
272911ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2730aa0c71acSWolfgang Denk		command line input operations
2731aa0c71acSWolfgang Denk
2732f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2733f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2734f3b267b3SMarek Vasut
2735f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2736f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2737f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2738f3b267b3SMarek Vasut		and PS2.
2739f3b267b3SMarek Vasut
2740a8c7c708Swdenk- Default Environment:
2741c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2742c609719bSwdenk
2743c609719bSwdenk		Define this to contain any number of null terminated
2744c609719bSwdenk		strings (variable = value pairs) that will be part of
27457152b1d0Swdenk		the default environment compiled into the boot image.
27462262cfeeSwdenk
2747c609719bSwdenk		For example, place something like this in your
2748c609719bSwdenk		board's config file:
2749c609719bSwdenk
2750c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2751c609719bSwdenk			"myvar1=value1\0" \
2752c609719bSwdenk			"myvar2=value2\0"
2753c609719bSwdenk
2754c609719bSwdenk		Warning: This method is based on knowledge about the
2755c609719bSwdenk		internal format how the environment is stored by the
27562262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2757c609719bSwdenk		interface! Although it is unlikely that this format
27587152b1d0Swdenk		will change soon, there is no guarantee either.
2759c609719bSwdenk		You better know what you are doing here.
2760c609719bSwdenk
2761c609719bSwdenk		Note: overly (ab)use of the default environment is
2762c609719bSwdenk		discouraged. Make sure to check other ways to preset
276374de7aefSWolfgang Denk		the environment like the "source" command or the
2764c609719bSwdenk		boot command first.
2765c609719bSwdenk
27665e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27675e724ca2SStephen Warren
27685e724ca2SStephen Warren		Define this in order to add variables describing the
27695e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27705e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27715e724ca2SStephen Warren
27725e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27735e724ca2SStephen Warren
27745e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27755e724ca2SStephen Warren		- CONFIG_SYS_CPU
27765e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27775e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27785e724ca2SStephen Warren		- CONFIG_SYS_SOC
27795e724ca2SStephen Warren
27807e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27817e27f89fSTom Rini
27827e27f89fSTom Rini		Define this in order to add variables describing certain
27837e27f89fSTom Rini		run-time determined information about the hardware to the
27847e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27857e27f89fSTom Rini
278606fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
278706fd8538SSimon Glass
278806fd8538SSimon Glass		Normally the environment is loaded when the board is
2789b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
279006fd8538SSimon Glass		that so that the environment is not available until
279106fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
279206fd8538SSimon Glass		this is instead controlled by the value of
279306fd8538SSimon Glass		/config/load-environment.
279406fd8538SSimon Glass
27953b10cf12SChris Packham- Parallel Flash support:
27963b10cf12SChris Packham		CONFIG_SYS_NO_FLASH
27973b10cf12SChris Packham
2798a187559eSBin Meng		Traditionally U-Boot was run on systems with parallel NOR
27993b10cf12SChris Packham		flash. This option is used to disable support for parallel NOR
28003b10cf12SChris Packham		flash. This option should be defined if the board does not have
28013b10cf12SChris Packham		parallel flash.
28023b10cf12SChris Packham
28033b10cf12SChris Packham		If this option is not defined one of the generic flash drivers
28043b10cf12SChris Packham		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
28053b10cf12SChris Packham		selected or the board must provide an implementation of the
28063b10cf12SChris Packham		flash API (see include/flash.h).
28073b10cf12SChris Packham
2808a8c7c708Swdenk- DataFlash Support:
28092abbe075Swdenk		CONFIG_HAS_DATAFLASH
28102abbe075Swdenk
28112abbe075Swdenk		Defining this option enables DataFlash features and
28122abbe075Swdenk		allows to read/write in Dataflash via the standard
28132abbe075Swdenk		commands cp, md...
28142abbe075Swdenk
2815f61ec45eSEric Nelson- Serial Flash support
2816f61ec45eSEric Nelson		CONFIG_CMD_SF
2817f61ec45eSEric Nelson
2818f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2819f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2820f61ec45eSEric Nelson
2821f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2822f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2823f61ec45eSEric Nelson		commands.
2824f61ec45eSEric Nelson
2825f61ec45eSEric Nelson		The following defaults may be provided by the platform
2826f61ec45eSEric Nelson		to handle the common case when only a single serial
2827f61ec45eSEric Nelson		flash is present on the system.
2828f61ec45eSEric Nelson
2829f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2830f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2831f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2832f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2833f61ec45eSEric Nelson
283424007273SSimon Glass		CONFIG_CMD_SF_TEST
283524007273SSimon Glass
283624007273SSimon Glass		Define this option to include a destructive SPI flash
283724007273SSimon Glass		test ('sf test').
283824007273SSimon Glass
2839b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2840b902e07cSJagannadha Sutradharudu Teki
2841b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2842b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2843b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
2844b902e07cSJagannadha Sutradharudu Teki
28453f85ce27Swdenk- SystemACE Support:
28463f85ce27Swdenk		CONFIG_SYSTEMACE
28473f85ce27Swdenk
28483f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28493f85ce27Swdenk		chips attached via some sort of local bus. The address
285011ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28523f85ce27Swdenk
28533f85ce27Swdenk		#define CONFIG_SYSTEMACE
28546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28553f85ce27Swdenk
28563f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28573f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28583f85ce27Swdenk
2859ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2860ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2861ecb0ccd9SWolfgang Denk
286228cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2863ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
286428cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2865ecb0ccd9SWolfgang Denk		number generator is used.
2866ecb0ccd9SWolfgang Denk
286728cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
286828cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
286928cb9375SWolfgang Denk		defined, the normal port 69 is used.
287028cb9375SWolfgang Denk
287128cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2872ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2873ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2874ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2875ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2876ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2877ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2878ecb0ccd9SWolfgang Denk
2879bf36c5d5SSimon Glass- Hashing support:
2880bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2881bf36c5d5SSimon Glass
2882bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2883bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2884bf36c5d5SSimon Glass
2885bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2886bf36c5d5SSimon Glass
2887bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2888bf36c5d5SSimon Glass		size a little.
2889bf36c5d5SSimon Glass
289094e3c8c4Sgaurav rana		CONFIG_SHA1 - This option enables support of hashing using SHA1
289194e3c8c4Sgaurav rana		algorithm. The hash is calculated in software.
289294e3c8c4Sgaurav rana		CONFIG_SHA256 - This option enables support of hashing using
289394e3c8c4Sgaurav rana		SHA256 algorithm. The hash is calculated in software.
289494e3c8c4Sgaurav rana		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
289594e3c8c4Sgaurav rana		for SHA1/SHA256 hashing.
289694e3c8c4Sgaurav rana		This affects the 'hash' command and also the
289794e3c8c4Sgaurav rana		hash_lookup_algo() function.
289894e3c8c4Sgaurav rana		CONFIG_SHA_PROG_HW_ACCEL - This option enables
289994e3c8c4Sgaurav rana		hardware-acceleration for SHA1/SHA256 progressive hashing.
290094e3c8c4Sgaurav rana		Data can be streamed in a block at a time and the hashing
290194e3c8c4Sgaurav rana		is performed in hardware.
2902bf36c5d5SSimon Glass
2903bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2904bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2905bf36c5d5SSimon Glass
2906a11f1873SRobert Winkler- Freescale i.MX specific commands:
2907a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2908a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2909a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2910a11f1873SRobert Winkler
2911a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2912a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2913a11f1873SRobert Winkler		a boot from specific media.
2914a11f1873SRobert Winkler
2915a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2916a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2917a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2918a11f1873SRobert Winkler		will set it back to normal.  This command currently
2919a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2920a11f1873SRobert Winkler
29219e50c406SHeiko Schocher- bootcount support:
29229e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29239e50c406SHeiko Schocher
29249e50c406SHeiko Schocher		This enables the bootcounter support, see:
29259e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29269e50c406SHeiko Schocher
29279e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29289e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29299e50c406SHeiko Schocher		CONFIG_BLACKFIN
29309e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29319e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29329e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29339e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29349e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29359e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29369e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29379e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29389e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29399e50c406SHeiko Schocher						    the bootcounter.
29409e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
294119c402afSSimon Glass
2942a8c7c708Swdenk- Show boot progress:
2943c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2944c609719bSwdenk
2945c609719bSwdenk		Defining this option allows to add some board-
2946c609719bSwdenk		specific code (calling a user-provided function
2947c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2948c609719bSwdenk		the system's boot progress on some display (for
2949c609719bSwdenk		example, some LED's) on your board. At the moment,
2950c609719bSwdenk		the following checkpoints are implemented:
2951c609719bSwdenk
295294fd1316SSimon Glass
29531372cce2SMarian BalakowiczLegacy uImage format:
29541372cce2SMarian Balakowicz
2955c609719bSwdenk  Arg	Where			When
2956c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2957c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2958c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2959c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2960c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2961c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2962c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2963c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2964c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29651372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2966c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2967c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2968c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2969c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29701372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2971c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
29721372cce2SMarian Balakowicz
29731372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
29741372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
29751372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
29761372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
29771372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
29781372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
29791372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
298011ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
29811372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
29821372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
29831372cce2SMarian Balakowicz
2984ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2985c609719bSwdenk
2986a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
298763e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
298863e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
298963e73c9aSwdenk
2990566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2991566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2992566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2993566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2994566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2995566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2996566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2997566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2998566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2999566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3000566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3001566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3002566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3003566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3004566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3005566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3006566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3007566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3008566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3009566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3010566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3011566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3012566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3013566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3014566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3015566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3016566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3017566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3018566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3019566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3020566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3021566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3022566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3023566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3024566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3025566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3026566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3027566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3028566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3029566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3030566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3031566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3032566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3033566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3034566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3035566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3036566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3037c609719bSwdenk
3038566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3039c609719bSwdenk
3040566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3041566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3042566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3043206c60cbSwdenk
3044566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3045bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
3046bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
3047bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
3048566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3049566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
305074de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
305174de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3052566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3053c609719bSwdenk
30541372cce2SMarian BalakowiczFIT uImage format:
30551372cce2SMarian Balakowicz
30561372cce2SMarian Balakowicz  Arg	Where			When
30571372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30581372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30591372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30601372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30611372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30621372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3063f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30641372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30651372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30661372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30671372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30681372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
306911ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
307011ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30711372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
30721372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
30731372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
30741372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
30751372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
30761372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
30771372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
30781372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
30791372cce2SMarian Balakowicz
30801372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
30811372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
30821372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
308311ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
30841372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
30851372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
30861372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
30871372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
30881372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
30891372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
30901372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
30911372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
30921372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
30931372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
30941372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
30951372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
30961372cce2SMarian Balakowicz
309711ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
30981372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
30991372cce2SMarian Balakowicz
310011ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31011372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31021372cce2SMarian Balakowicz
310311ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31041372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31051372cce2SMarian Balakowicz
310621d29f7fSHeiko Schocher- legacy image format:
310721d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
310821d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
310921d29f7fSHeiko Schocher
311021d29f7fSHeiko Schocher		Default:
311121d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
311221d29f7fSHeiko Schocher
311321d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
311421d29f7fSHeiko Schocher		disable the legacy image format
311521d29f7fSHeiko Schocher
311621d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
311721d29f7fSHeiko Schocher		enabled per default for backward compatibility.
311821d29f7fSHeiko Schocher
3119d95f6ec7SGabe Black- FIT image support:
31209a4f479bSDirk Eibach		CONFIG_FIT_DISABLE_SHA256
31219a4f479bSDirk Eibach		Supporting SHA256 hashes has quite an impact on binary size.
31229a4f479bSDirk Eibach		For constrained systems sha256 hash support can be disabled
31239a4f479bSDirk Eibach		with this option.
31249a4f479bSDirk Eibach
312573223f0eSSimon Glass		TODO(sjg@chromium.org): Adjust this option to be positive,
312673223f0eSSimon Glass		and move it to Kconfig
312773223f0eSSimon Glass
31284cf2609bSWolfgang Denk- Standalone program support:
31294cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31304cf2609bSWolfgang Denk
31316feff899SWolfgang Denk		This option defines a board specific value for the
31326feff899SWolfgang Denk		address where standalone program gets loaded, thus
31336feff899SWolfgang Denk		overwriting the architecture dependent default
31344cf2609bSWolfgang Denk		settings.
31354cf2609bSWolfgang Denk
31364cf2609bSWolfgang Denk- Frame Buffer Address:
31374cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31384cf2609bSWolfgang Denk
31394cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
314044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
314144a53b57SWolfgang Denk		when using a graphics controller has separate video
314244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
314344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
314444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
314544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
314644a53b57SWolfgang Denk		configured panel size.
31474cf2609bSWolfgang Denk
31484cf2609bSWolfgang Denk		Please see board_init_f function.
31494cf2609bSWolfgang Denk
3150cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3151cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3152cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3153cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3154cccfc2abSDetlev Zundel
3155cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3156cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3157cccfc2abSDetlev Zundel
3158cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3159cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3160cccfc2abSDetlev Zundel
3161cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3162cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3163cccfc2abSDetlev Zundel
3164cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3165cccfc2abSDetlev Zundel
3166cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3167cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3168cccfc2abSDetlev Zundel
316970c219cdSJoe Hershberger- UBI support
317070c219cdSJoe Hershberger		CONFIG_CMD_UBI
317170c219cdSJoe Hershberger
317270c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
317370c219cdSJoe Hershberger		with the UBI flash translation layer
317470c219cdSJoe Hershberger
317570c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
317670c219cdSJoe Hershberger
3177147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3178147162daSJoe Hershberger
3179147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3180147162daSJoe Hershberger		warnings and errors enabled.
3181147162daSJoe Hershberger
3182ff94bc40SHeiko Schocher
3183ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
3184ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
3185ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
3186ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
3187ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
3188ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
3189ff94bc40SHeiko Schocher
3190ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
3191ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
3192ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
3193ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
3194ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
3195ff94bc40SHeiko Schocher
3196ff94bc40SHeiko Schocher		default: 4096
3197ff94bc40SHeiko Schocher
3198ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
3199ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
3200ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
3201ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
3202ff94bc40SHeiko Schocher		flash), this value is ignored.
3203ff94bc40SHeiko Schocher
3204ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
3205ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
3206ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
3207ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3208ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
3209ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
3210ff94bc40SHeiko Schocher
3211ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
3212ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
3213ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
3214ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
3215ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
3216ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
3217ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
3218ff94bc40SHeiko Schocher		partition.
3219ff94bc40SHeiko Schocher
3220ff94bc40SHeiko Schocher		default: 20
3221ff94bc40SHeiko Schocher
3222ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
3223ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
3224ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
3225ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
3226ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
3227ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
3228ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
3229ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
3230ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3231ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
3232ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
3233ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3234ff94bc40SHeiko Schocher
3235ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3236ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
3237ff94bc40SHeiko Schocher		without a fastmap.
3238ff94bc40SHeiko Schocher		default: 0
3239ff94bc40SHeiko Schocher
32400195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
32410195a7bbSHeiko Schocher		Enable UBI fastmap debug
32420195a7bbSHeiko Schocher		default: 0
32430195a7bbSHeiko Schocher
324470c219cdSJoe Hershberger- UBIFS support
324570c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
324670c219cdSJoe Hershberger
324770c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
324870c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
324970c219cdSJoe Hershberger
325070c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
325170c219cdSJoe Hershberger
3252147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3253147162daSJoe Hershberger
3254147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3255147162daSJoe Hershberger		warnings and errors enabled.
3256147162daSJoe Hershberger
32576a11cf48SDaniel Schwierzeck- SPL framework
32586a11cf48SDaniel Schwierzeck		CONFIG_SPL
32596a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
32606a11cf48SDaniel Schwierzeck
326195579793STom Rini		CONFIG_SPL_LDSCRIPT
326295579793STom Rini		LDSCRIPT for linking the SPL binary.
326395579793STom Rini
32646ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
32656ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
32666ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32676ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32688960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32696ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32706ebc3461SAlbert ARIBAUD
327195579793STom Rini		CONFIG_SPL_MAX_SIZE
32726ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32736ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32746ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32756ebc3461SAlbert ARIBAUD		not exceed it.
327695579793STom Rini
32776a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32786a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32796a11cf48SDaniel Schwierzeck
328094a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
328194a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
328294a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
328394a45bb1SScott Wood
328495579793STom Rini		CONFIG_SPL_BSS_START_ADDR
328595579793STom Rini		Link address for the BSS within the SPL binary.
328695579793STom Rini
328795579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32886ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32896ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32906ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32918960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32926ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
329395579793STom Rini
329495579793STom Rini		CONFIG_SPL_STACK
329595579793STom Rini		Adress of the start of the stack SPL will use
329695579793STom Rini
32978c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
32988c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
32998c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
33008c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
33018c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
33028c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
33038c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
33048c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
33058c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
33068c80eb3bSAlbert ARIBAUD \(3ADEV\)
3307e0727515SMarek Vasut		CONFIG_SPL_ABORT_ON_RAW_IMAGE
3308e0727515SMarek Vasut		When defined, SPL will proceed to another boot method
3309e0727515SMarek Vasut		if the image it has loaded does not have a signature.
3310e0727515SMarek Vasut
331194a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
331294a45bb1SScott Wood		Adress of the start of the stack SPL will use after
331394a45bb1SScott Wood		relocation.  If unspecified, this is equal to
331494a45bb1SScott Wood		CONFIG_SPL_STACK.
331594a45bb1SScott Wood
331695579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
331795579793STom Rini		Starting address of the malloc pool used in SPL.
33189ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
33199ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
33209ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
332195579793STom Rini
332295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
332395579793STom Rini		The size of the malloc pool used in SPL.
33246a11cf48SDaniel Schwierzeck
332547f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
332647f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
332747f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
332847f7bcaeSTom Rini		NAND loading of the Linux Kernel.
332947f7bcaeSTom Rini
33309607faf2STom Rini		CONFIG_SPL_OS_BOOT
33319607faf2STom Rini		Enable booting directly to an OS from SPL.
33329607faf2STom Rini		See also: doc/README.falcon
33339607faf2STom Rini
3334861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3335861a86f4STom Rini		For ARM, enable an optional function to print more information
3336861a86f4STom Rini		about the running system.
3337861a86f4STom Rini
33384b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
33394b919725SScott Wood		Arch init code should be built for a very small image
33404b919725SScott Wood
3341b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3342b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3343b97300b6SPaul Kocialkowski		used in raw mode
3344b97300b6SPaul Kocialkowski
33452b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33462b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33472b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33482b75b0adSPeter Korsgaard
33492b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33502b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33512b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33522b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
33532b75b0adSPeter Korsgaard		(for falcon mode)
33542b75b0adSPeter Korsgaard
3355e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3356e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3357e2ccdf89SPaul Kocialkowski		used in fs mode
3358e2ccdf89SPaul Kocialkowski
3359fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3360fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3361fae81c72SGuillaume GARDET
3362fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
33637ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3364fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
33657ad2cc79SPeter Korsgaard
3366fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
33677ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3368fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
33697ad2cc79SPeter Korsgaard
337006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
337106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
337206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
337306f60ae3SScott Wood		continuing (the hardware starts execution after just
337406f60ae3SScott Wood		loading the first page rather than the full 4K).
337506f60ae3SScott Wood
3376651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3377651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3378651fcf60SPrabhakar Kushwaha
33796f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33806f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33816f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33826f2f01b9SScott Wood
33836f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33846f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33856f2f01b9SScott Wood
33866f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33876f2f01b9SScott Wood		Include standard software ECC in the SPL
33886f2f01b9SScott Wood
338995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33907d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33917d4b7955SScott Wood		expose the cmd_ctrl() interface.
339295579793STom Rini
33936f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
33946f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
33956f4e7d3cSThomas Gleixner		loader
33966f4e7d3cSThomas Gleixner
33970c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
33980c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
33990c3117b1SHeiko Schocher		if you need to save space.
34000c3117b1SHeiko Schocher
34017c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
34027c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
34037c8eea59SYing Zhang		SPL binary.
34047c8eea59SYing Zhang
340595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
340695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
340795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
340895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
340995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
341095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
34117d4b7955SScott Wood		to read U-Boot
341295579793STom Rini
3413fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3414fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3415fbe76ae4SPrabhakar Kushwaha
341695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
34177d4b7955SScott Wood		Location in NAND to read U-Boot from
34187d4b7955SScott Wood
34197d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
34207d4b7955SScott Wood		Location in memory to load U-Boot to
34217d4b7955SScott Wood
34227d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
34237d4b7955SScott Wood		Size of image to load
342495579793STom Rini
342595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
34267d4b7955SScott Wood		Entry point in loaded image to jump to
342795579793STom Rini
342895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
342995579793STom Rini		Define this if you need to first read the OOB and then the
3430b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
343195579793STom Rini
343295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
343395579793STom Rini		Support for an OMAP3-specific set of functions to return the
343495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
343595579793STom Rini
3436c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3437c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3438c57b953dSPavel Machek
343974752baaSScott Wood		CONFIG_SPL_PAD_TO
34406113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
34416113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
34426113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34436113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34446113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
344574752baaSScott Wood
3446ca2fca22SScott Wood		CONFIG_SPL_TARGET
3447ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3448ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3449ca2fca22SScott Wood		example if more than one image needs to be produced.
3450ca2fca22SScott Wood
345187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
345287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
345387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
345487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
345587ebee39SSimon Glass		bootm command when booting a FIT image.
345687ebee39SSimon Glass
34573aa29de0SYing Zhang- TPL framework
34583aa29de0SYing Zhang		CONFIG_TPL
34593aa29de0SYing Zhang		Enable building of TPL globally.
34603aa29de0SYing Zhang
34613aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34623aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34633aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34643aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34653aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34663aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34673aa29de0SYing Zhang
3468a8c7c708Swdenk- Interrupt support (PPC):
3469a8c7c708Swdenk
3470a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3471a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
347211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3473a8c7c708Swdenk		should set decrementer_count to appropriate value. If
347411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3475a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
347611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3477a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3478a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3479a8c7c708Swdenk		general timer_interrupt().
3480a8c7c708Swdenk
3481c609719bSwdenk
34829660e442SHelmut RaigerBoard initialization settings:
34839660e442SHelmut Raiger------------------------------
34849660e442SHelmut Raiger
34859660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34869660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34879660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
34889660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
34899660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
34909660e442SHelmut Raigertypically in board_init_f() and board_init_r().
34919660e442SHelmut Raiger
34929660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34939660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34949660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34959660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3496c609719bSwdenk
3497c609719bSwdenkConfiguration Settings:
3498c609719bSwdenk-----------------------
3499c609719bSwdenk
35004d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
35014d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
35024d1fd7f1SYork Sun
35036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3504c609719bSwdenk		undefine this when you're short of memory.
3505c609719bSwdenk
35062fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
35072fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
35082fb2604dSPeter Tyser
35096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3510c609719bSwdenk		prompt for user input.
3511c609719bSwdenk
35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3513c609719bSwdenk
35146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3515c609719bSwdenk
35166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3517c609719bSwdenk
35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3519c609719bSwdenk		the application (usually a Linux kernel) when it is
3520c609719bSwdenk		booted
3521c609719bSwdenk
35226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3523c609719bSwdenk		List of legal baudrate settings for this board.
3524c609719bSwdenk
35256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3526c609719bSwdenk		Begin and End addresses of the area used by the
3527c609719bSwdenk		simple memory test.
3528c609719bSwdenk
35296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3530c609719bSwdenk		Enable an alternate, more extensive memory test.
3531c609719bSwdenk
35326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35335f535fe1Swdenk		Scratch address used by the alternate memory test
35345f535fe1Swdenk		You only need to set this if address zero isn't writeable
35355f535fe1Swdenk
3536e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3537e61a7534SYork Sun		Only implemented for ARMv8 for now.
3538e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3539e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3540e8149522SYork Sun		This memory can be used as secure memory. A variable
3541e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3542e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3543e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3544e8149522SYork Sun
3545aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
354714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
354811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
354914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
355014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
355114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35525e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
355314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35545e12e75dSStefan Roese		will have to get fixed in Linux additionally.
355514f73ca6SStefan Roese
355614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
355714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
355814f73ca6SStefan Roese		be touched.
355914f73ca6SStefan Roese
356014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
356114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
356214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
356314f73ca6SStefan Roese		non page size aligned address and this could cause major
356414f73ca6SStefan Roese		problems.
356514f73ca6SStefan Roese
35666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3567c609719bSwdenk		Enable temporary baudrate change while serial download
3568c609719bSwdenk
35696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3570c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3571c609719bSwdenk
35726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3573c609719bSwdenk		Physical start address of Flash memory.
3574c609719bSwdenk
35756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3576c609719bSwdenk		Physical start address of boot monitor code (set by
3577c609719bSwdenk		make config files to be same as the text base address
357814d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
35796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3580c609719bSwdenk
35816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
35823b57fe0aSwdenk		Size of memory reserved for monitor code, used to
35833b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
35843b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
35853b57fe0aSwdenk		flash sector.
3586c609719bSwdenk
35876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3588c609719bSwdenk		Size of DRAM reserved for malloc() use.
3589c609719bSwdenk
3590d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3591d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3592d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3593d59476b6SSimon Glass		will become available before relocation. The address is just
3594d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3595d59476b6SSimon Glass		space.
3596d59476b6SSimon Glass
3597d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3598d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3599d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3600b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3601d59476b6SSimon Glass		U-Boot relocates itself.
3602d59476b6SSimon Glass
360338687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
360438687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
360538687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
360638687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
360738687ae6SSimon Glass
36081dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
36091dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
36101dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
36111dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
36121dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
36131dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
36141dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
36151dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
36161dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
36171dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
36181dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
36191dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
36201dfdd9baSThierry Reding		written to another region in the same cache-line. This can
36211dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
36221dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
36231dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
36241dfdd9baSThierry Reding
36251dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
36261dfdd9baSThierry Reding
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
362815940c9aSStefan Roese		Normally compressed uImages are limited to an
362915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
36306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
363115940c9aSStefan Roese		to adjust this setting to your needs.
3632c609719bSwdenk
36336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3634c609719bSwdenk		Maximum size of memory mapped by the startup code of
3635c609719bSwdenk		the Linux kernel; all data that must be processed by
36367d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
36377d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
36381bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
36397d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3640c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3641c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3642c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3643c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3644c609719bSwdenk
3645fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3646fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3647fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3648fca43cc8SJohn Rigby		is enabled.
3649fca43cc8SJohn Rigby
3650fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3651fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3652fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3653fca43cc8SJohn Rigby
3654fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3655fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3656fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3657fca43cc8SJohn Rigby
36586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3659c609719bSwdenk		Max number of Flash memory banks
3660c609719bSwdenk
36616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3662c609719bSwdenk		Max number of sectors on a Flash chip
3663c609719bSwdenk
36646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3665c609719bSwdenk		Timeout for Flash erase operations (in ms)
3666c609719bSwdenk
36676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3668c609719bSwdenk		Timeout for Flash write operations (in ms)
3669c609719bSwdenk
36706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36718564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36728564acf9Swdenk
36736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36748564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36758564acf9Swdenk
36766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36778564acf9Swdenk		If defined, hardware flash sectors protection is used
36788564acf9Swdenk		instead of U-Boot software protection.
36798564acf9Swdenk
36806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3681c609719bSwdenk
3682c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3683c609719bSwdenk		without this option such a download has to be
3684c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3685c609719bSwdenk		copy from RAM to flash.
3686c609719bSwdenk
3687c609719bSwdenk		The two-step approach is usually more reliable, since
3688c609719bSwdenk		you can check if the download worked before you erase
368911ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
369011ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3691c609719bSwdenk		downloaded image) this option may be very useful.
3692c609719bSwdenk
36936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3694c609719bSwdenk		Define if the flash driver uses extra elements in the
36955653fc33Swdenk		common flash structure for storing flash geometry.
36965653fc33Swdenk
369700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36985653fc33Swdenk		This option also enables the building of the cfi_flash driver
36995653fc33Swdenk		in the drivers directory
370053cf9435Sstroese
370191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
370291809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
370391809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
370491809ed5SPiotr Ziecik		to the MTD layer.
370591809ed5SPiotr Ziecik
37066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
370796ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
370896ef831fSGuennadi Liakhovetski
370996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
371096ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
371196ef831fSGuennadi Liakhovetski		write commands.
371296ef831fSGuennadi Liakhovetski
37136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
37145568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
37155568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
37165568e613SStefan Roese		is useful, if some of the configured banks are only
37175568e613SStefan Roese		optionally available.
37185568e613SStefan Roese
37199a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
37209a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
37219a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
37229a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
37239a042e9cSJerry Van Baren
3724352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3725352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3726352ef3f1SStefan Roese		against the source after the write operation. An error message
3727352ef3f1SStefan Roese		will be printed when the contents are not identical.
3728352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3729352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3730352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3731352ef3f1SStefan Roese		this option if you really know what you are doing.
3732352ef3f1SStefan Roese
37336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
373411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
373511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
373653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
373753cf9435Sstroese		buffers can be full shortly after enabling the interface
373811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
373953cf9435Sstroese		Defaults to 4 if not defined.
3740c609719bSwdenk
3741ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3742ea882bafSWolfgang Denk
3743ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3744ea882bafSWolfgang Denk	internally to store the environment settings. The default
3745ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3746ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3747ea882bafSWolfgang Denk	lib/hashtable.c for details.
3748ea882bafSWolfgang Denk
37492598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
37502598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
37511bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
37522598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37532598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37542598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37552598090bSJoe Hershberger
37562598090bSJoe Hershberger	The format of the list is:
37572598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3758b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3759b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
37602598090bSJoe Hershberger		entry = variable_name[:attributes]
37612598090bSJoe Hershberger		list = entry[,list]
37622598090bSJoe Hershberger
37632598090bSJoe Hershberger	The type attributes are:
37642598090bSJoe Hershberger		s - String (default)
37652598090bSJoe Hershberger		d - Decimal
37662598090bSJoe Hershberger		x - Hexadecimal
37672598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37682598090bSJoe Hershberger		i - IP address
37692598090bSJoe Hershberger		m - MAC address
37702598090bSJoe Hershberger
3771267541f7SJoe Hershberger	The access attributes are:
3772267541f7SJoe Hershberger		a - Any (default)
3773267541f7SJoe Hershberger		r - Read-only
3774267541f7SJoe Hershberger		o - Write-once
3775267541f7SJoe Hershberger		c - Change-default
3776267541f7SJoe Hershberger
37772598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37782598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3779b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
37802598090bSJoe Hershberger
37812598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37822598090bSJoe Hershberger		Define this to a list (string) to define validation that
37832598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37842598090bSJoe Hershberger		environment variable.  To override a setting in the static
37852598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37862598090bSJoe Hershberger		".flags" variable.
37872598090bSJoe Hershberger
3788bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3789bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3790bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3791bdf1fe4eSJoe Hershberger
3792267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3793267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3794267541f7SJoe Hershberger	access flags.
3795267541f7SJoe Hershberger
37960b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37970b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37980b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
3799b445bbb4SJeremiah Mahler	the value can be calculated on a given board.
3800632efa74SSimon Glass
38010d296cc2SGabe Black- CONFIG_USE_STDINT
38020d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
38030d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
38040d296cc2SGabe Black	building U-Boot to enable this.
38050d296cc2SGabe Black
3806c609719bSwdenkThe following definitions that deal with the placement and management
3807c609719bSwdenkof environment data (variable area); in general, we support the
3808c609719bSwdenkfollowing configurations:
3809c609719bSwdenk
3810c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3811c3eb3fe4SMike Frysinger
3812c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3813c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3814c3eb3fe4SMike Frysinger
38155a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3816c609719bSwdenk
3817c609719bSwdenk	Define this if the environment is in flash memory.
3818c609719bSwdenk
3819c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3820c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3821c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3822c609719bSwdenk	   sector" type flash chips, which have several smaller
3823c609719bSwdenk	   sectors at the start or the end. For instance, such a
3824c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3825c609719bSwdenk	   such a case you would place the environment in one of the
3826c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3827c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3828c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3829c609719bSwdenk	   between U-Boot and the environment.
3830c609719bSwdenk
38310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3832c609719bSwdenk
3833c609719bSwdenk	   Offset of environment data (variable area) to the
3834c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3835c609719bSwdenk	   type flash chips the second sector can be used: the offset
3836c609719bSwdenk	   for this sector is given here.
3837c609719bSwdenk
38386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3839c609719bSwdenk
38400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3841c609719bSwdenk
3842c609719bSwdenk	   This is just another way to specify the start address of
3843c609719bSwdenk	   the flash sector containing the environment (instead of
38440e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3845c609719bSwdenk
38460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3847c609719bSwdenk
3848c609719bSwdenk	   Size of the sector containing the environment.
3849c609719bSwdenk
3850c609719bSwdenk
3851c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3852c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3853c609719bSwdenk	   the environment.
3854c609719bSwdenk
38550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3856c609719bSwdenk
38575a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38580e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3859c609719bSwdenk	   of this flash sector for the environment. This saves
3860c609719bSwdenk	   memory for the RAM copy of the environment.
3861c609719bSwdenk
3862c609719bSwdenk	   It may also save flash memory if you decide to use this
3863c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3864c609719bSwdenk	   since then the remainder of the flash sector could be used
3865c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3866c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3867c609719bSwdenk	   updating the environment in flash makes it always
3868c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3869c609719bSwdenk	   wrong before the contents has been restored from a copy in
3870c609719bSwdenk	   RAM, your target system will be dead.
3871c609719bSwdenk
38720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38730e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3874c609719bSwdenk
3875c609719bSwdenk	   These settings describe a second storage area used to hold
387611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38773e38691eSwdenk	   a valid backup copy in case there is a power failure during
3878c609719bSwdenk	   a "saveenv" operation.
3879c609719bSwdenk
3880c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3881c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3882c609719bSwdenkaccordingly!
3883c609719bSwdenk
3884c609719bSwdenk
38859314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3886c609719bSwdenk
3887c609719bSwdenk	Define this if you have some non-volatile memory device
3888c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3889c609719bSwdenk	environment.
3890c609719bSwdenk
38910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3893c609719bSwdenk
389411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3895c609719bSwdenk	  want to use for environment. It is assumed that this memory
3896c609719bSwdenk	  can just be read and written to, without any special
3897c609719bSwdenk	  provision.
3898c609719bSwdenk
3899c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3900b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
390111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3902c609719bSwdenkU-Boot will hang.
3903c609719bSwdenk
3904c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3905c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3906c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3907c609719bSwdenkto save the current settings.
3908c609719bSwdenk
3909c609719bSwdenk
3910bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3911c609719bSwdenk
3912c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3913c609719bSwdenk	device and a driver for it.
3914c609719bSwdenk
39150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3917c609719bSwdenk
3918c609719bSwdenk	  These two #defines specify the offset and size of the
3919c609719bSwdenk	  environment area within the total memory of your EEPROM.
3920c609719bSwdenk
39216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3922c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3923c609719bSwdenk	  The default address is zero.
3924c609719bSwdenk
3925189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
3926189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
3927189d257bSChristian Gmeiner
39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3929c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3930c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3931c609719bSwdenk	  would require six bits.
3932c609719bSwdenk
39336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3934c609719bSwdenk	  If defined, the number of milliseconds to delay between
3935c609719bSwdenk	  page writes.	The default is zero milliseconds.
3936c609719bSwdenk
39376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3938c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3939c609719bSwdenk	  that this is NOT the chip address length!
3940c609719bSwdenk
39416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
39425cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
39435cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
39445cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
39455cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
39465cf91d6bSwdenk	  byte chips.
39475cf91d6bSwdenk
39485cf91d6bSwdenk	  Note that we consider the length of the address field to
39495cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
39505cf91d6bSwdenk	  in the chip address.
39515cf91d6bSwdenk
39526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3953c609719bSwdenk	  The size in bytes of the EEPROM device.
3954c609719bSwdenk
3955548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3956548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3957548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3958548738b4SHeiko Schocher
3959548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3960548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3961548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3962548738b4SHeiko Schocher	  EEPROM. For example:
3963548738b4SHeiko Schocher
3964ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3965548738b4SHeiko Schocher
3966548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3967548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3968c609719bSwdenk
3969057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39705779d8d9Swdenk
39715779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39725779d8d9Swdenk	want to use for the environment.
39735779d8d9Swdenk
39740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39775779d8d9Swdenk
39785779d8d9Swdenk	  These three #defines specify the offset and size of the
39795779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39805779d8d9Swdenk	  at the specified address.
39815779d8d9Swdenk
3982bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
3983bd83b592SWu, Josh
3984bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
3985bd83b592SWu, Josh	want to use for the environment.
3986bd83b592SWu, Josh
3987bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
3988bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
3989bd83b592SWu, Josh
3990bd83b592SWu, Josh	  These two #defines specify the offset and size of the
3991bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3992bd83b592SWu, Josh	  aligned to an erase sector boundary.
3993bd83b592SWu, Josh
3994bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
3995bd83b592SWu, Josh
3996bd83b592SWu, Josh	  Define the SPI flash's sector size.
3997bd83b592SWu, Josh
3998bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
3999bd83b592SWu, Josh
4000bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
4001bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
4002bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
40039dd05fb8SSimon Glass	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
4004bd83b592SWu, Josh	  aligned to an erase sector boundary.
4005bd83b592SWu, Josh
4006bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
4007bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
4008bd83b592SWu, Josh
4009bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
4010bd83b592SWu, Josh
4011bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
4012bd83b592SWu, Josh
4013bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
4014bd83b592SWu, Josh
4015bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
4016bd83b592SWu, Josh
4017bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
4018bd83b592SWu, Josh
40190a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
40200a85a9e7SLiu Gang
40210a85a9e7SLiu Gang	Define this if you have a remote memory space which you
40220a85a9e7SLiu Gang	want to use for the local device's environment.
40230a85a9e7SLiu Gang
40240a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
40250a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
40260a85a9e7SLiu Gang
40270a85a9e7SLiu Gang	  These two #defines specify the address and size of the
40280a85a9e7SLiu Gang	  environment area within the remote memory space. The
40290a85a9e7SLiu Gang	  local device can get the environment from remote memory
4030fc54c7faSLiu Gang	  space by SRIO or PCIE links.
40310a85a9e7SLiu Gang
40320a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
40330a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
4034fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
4035fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
40360a85a9e7SLiu Gang
403751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
403813a5695bSwdenk
403913a5695bSwdenk	Define this if you have a NAND device which you want to use
404013a5695bSwdenk	for the environment.
404113a5695bSwdenk
40420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
40430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
404413a5695bSwdenk
404513a5695bSwdenk	  These two #defines specify the offset and size of the environment
4046fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
4047fdd813deSScott Wood	  aligned to an erase block boundary.
40485779d8d9Swdenk
4049fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
4050e443c944SMarkus Klotzbuecher
40510e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
4052fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
4053fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
40549dd05fb8SSimon Glass	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
4055fdd813deSScott Wood	  aligned to an erase block boundary.
4056e443c944SMarkus Klotzbuecher
4057fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4058fdd813deSScott Wood
4059fdd813deSScott Wood	  Specifies the length of the region in which the environment
4060fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4061fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4062fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4063fdd813deSScott Wood	  the range to be avoided.
4064fdd813deSScott Wood
4065fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4066fdd813deSScott Wood
4067fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4068fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4069fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4070fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4071fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4072e443c944SMarkus Klotzbuecher
4073b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4074b74ab737SGuennadi Liakhovetski
4075b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4076b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4077b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4078b74ab737SGuennadi Liakhovetski
40792b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
40802b74433fSJoe Hershberger
40812b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
40822b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
40832b74433fSJoe Hershberger	accesses, which is important on NAND.
40842b74433fSJoe Hershberger
40852b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
40862b74433fSJoe Hershberger
40872b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
40882b74433fSJoe Hershberger
40892b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
40902b74433fSJoe Hershberger
40912b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40922b74433fSJoe Hershberger	  environment in.
40932b74433fSJoe Hershberger
4094785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4095785881f7SJoe Hershberger
4096785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4097785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4098785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4099785881f7SJoe Hershberger
41002b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
41012b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
41022b74433fSJoe Hershberger
41032b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
41042b74433fSJoe Hershberger	  when storing the env in UBI.
41052b74433fSJoe Hershberger
4106d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
4107d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
4108d1db76f1SWu, Josh
4109d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
4110d1db76f1SWu, Josh
4111d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
4112d1db76f1SWu, Josh
4113*41987784SNicolae Rosia       - FAT_ENV_DEVICE_AND_PART:
4114d1db76f1SWu, Josh
4115d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
4116d1db76f1SWu, Josh         be as following:
4117d1db76f1SWu, Josh
4118d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4119d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
4120d1db76f1SWu, Josh                        partition table.
4121d1db76f1SWu, Josh               - "D:0": device D.
4122d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
4123d1db76f1SWu, Josh                              table, or the whole device D if has no partition
4124d1db76f1SWu, Josh                              table.
4125d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
4126b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
4127d1db76f1SWu, Josh                           partition table then means device D.
4128d1db76f1SWu, Josh
4129d1db76f1SWu, Josh       - FAT_ENV_FILE:
4130d1db76f1SWu, Josh
4131d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
4132b445bbb4SJeremiah Mahler         environment.
4133d1db76f1SWu, Josh
4134d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
4135b445bbb4SJeremiah Mahler         This should be defined. Otherwise it cannot save the environment file.
4136d1db76f1SWu, Josh
413706e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
413806e4ae5fSStephen Warren
413906e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
414006e4ae5fSStephen Warren	environment.
414106e4ae5fSStephen Warren
414206e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
414306e4ae5fSStephen Warren
414406e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
414506e4ae5fSStephen Warren
414606e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
414706e4ae5fSStephen Warren
414806e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
414906e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
415006e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
415106e4ae5fSStephen Warren
415206e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
415306e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
415406e4ae5fSStephen Warren
415506e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
415606e4ae5fSStephen Warren	  area within the specified MMC device.
415706e4ae5fSStephen Warren
41585c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
41595c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
41605c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
41615c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
41625c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
41635c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
41645c088ee8SStephen Warren	  maximum possible space before it, to store other data.
41655c088ee8SStephen Warren
416606e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
416706e4ae5fSStephen Warren	  MMC sector boundary.
416806e4ae5fSStephen Warren
416906e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
417006e4ae5fSStephen Warren
417106e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
417206e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
417306e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
417406e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
417506e4ae5fSStephen Warren
41765c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
41775c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
41785c088ee8SStephen Warren
417906e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
418006e4ae5fSStephen Warren	  an MMC sector boundary.
418106e4ae5fSStephen Warren
418206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
418306e4ae5fSStephen Warren
418406e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
418506e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
418606e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
418706e4ae5fSStephen Warren
41886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4189c609719bSwdenk
4190c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4191c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4192c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4193c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4194c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4195c609719bSwdenk	to be a good choice since it makes it far enough from the
4196c609719bSwdenk	start of the data area as well as from the stack pointer.
4197c609719bSwdenk
4198e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4199c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4200cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4201c609719bSwdenkuntil then to read environment variables.
4202c609719bSwdenk
420385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
420485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
420585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
420685ec0bccSwdenknecessary, because the first environment variable we need is the
420785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
420885ec0bccSwdenkhave any device yet where we could complain.]
4209c609719bSwdenk
4210c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4211c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
421285ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4213c609719bSwdenk
42146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4215fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4216fc3e2165Swdenk
42176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4218fc3e2165Swdenk		      also needs to be defined.
4219fc3e2165Swdenk
42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4221fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4222c609719bSwdenk
4223f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4224f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4225f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4226f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4227f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4228f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4229f5675aa5SRon Madrid
4230b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4231b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4232b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4233b2b92f53SSimon Glass		to do this.
4234b2b92f53SSimon Glass
4235e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4236e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4237e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4238e2e3e2b1SSimon Glass		present.
4239e2e3e2b1SSimon Glass
4240feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
4241feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
4242feb85801SSascha Silbe		build system checks that the actual size does not
4243feb85801SSascha Silbe		exceed it.
4244feb85801SSascha Silbe
4245c609719bSwdenkLow Level (hardware related) configuration options:
4246dc7c9a1aSwdenk---------------------------------------------------
4247c609719bSwdenk
42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4249c609719bSwdenk		Cache Line Size of the CPU.
4250c609719bSwdenk
42516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4252c609719bSwdenk		Default address of the IMMR after system reset.
42532535d602Swdenk
42542535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
42552535d602Swdenk		and RPXsuper) to be able to adjust the position of
42562535d602Swdenk		the IMMR register after a reset.
4257c609719bSwdenk
4258e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4259e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4260e46fedfeSTimur Tabi		PowerPC SOCs.
4261e46fedfeSTimur Tabi
4262e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4263e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4264e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4265e46fedfeSTimur Tabi
4266e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4267e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4268e46fedfeSTimur Tabi
4269e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4270e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4271e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4272e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4273e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4274e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4275e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4276e46fedfeSTimur Tabi
4277e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4278e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4279e46fedfeSTimur Tabi
4280e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4281e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4282e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4283e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4284e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4285e46fedfeSTimur Tabi
4286e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4287e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4288e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4289e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4290e46fedfeSTimur Tabi
4291e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4292e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4293e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4294e46fedfeSTimur Tabi
42957f6c2cbcSwdenk- Floppy Disk Support:
42966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
42977f6c2cbcSwdenk
42987f6c2cbcSwdenk		the default drive number (default value 0)
42997f6c2cbcSwdenk
43006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
43017f6c2cbcSwdenk
430211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
43037f6c2cbcSwdenk		(default value 1)
43047f6c2cbcSwdenk
43056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
43067f6c2cbcSwdenk
43077f6c2cbcSwdenk		defines the offset of register from address. It
43087f6c2cbcSwdenk		depends on which part of the data bus is connected to
430911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
43107f6c2cbcSwdenk
43116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
43137f6c2cbcSwdenk		default value.
43147f6c2cbcSwdenk
43156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
43167f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
43177f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
4318b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
43197f6c2cbcSwdenk		initializations.
43207f6c2cbcSwdenk
43210abddf82SMacpaul Lin- CONFIG_IDE_AHB:
43220abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
43230abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
43240abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
43250abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
43260abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4327b445bbb4SJeremiah Mahler		is required.
43280abddf82SMacpaul Lin
43296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
433025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
433125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4332c609719bSwdenk
43336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4334c609719bSwdenk
43357152b1d0Swdenk		Start address of memory area that can be used for
4336c609719bSwdenk		initial data and stack; please note that this must be
4337c609719bSwdenk		writable memory that is working WITHOUT special
4338c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4339c609719bSwdenk		will become available only after programming the
4340c609719bSwdenk		memory controller and running certain initialization
4341c609719bSwdenk		sequences.
4342c609719bSwdenk
4343c609719bSwdenk		U-Boot uses the following memory types:
4344c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4345c609719bSwdenk		- MPC824X: data cache
4346c609719bSwdenk		- PPC4xx:  data cache
4347c609719bSwdenk
43486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4349c609719bSwdenk
4350c609719bSwdenk		Offset of the initial data structure in the memory
43516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
43526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4353c609719bSwdenk		data is located at the end of the available space
4354553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4355acd51f9dSSimon Glass		GENERATED_GBL_DATA_SIZE), and the initial stack is just
43566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
43576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4358c609719bSwdenk
4359c609719bSwdenk	Note:
4360c609719bSwdenk		On the MPC824X (or other systems that use the data
4361c609719bSwdenk		cache for initial memory) the address chosen for
43626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4363c609719bSwdenk		point to an otherwise UNUSED address space between
4364c609719bSwdenk		the top of RAM and the start of the PCI space.
4365c609719bSwdenk
43666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4367c609719bSwdenk
43686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4369c609719bSwdenk
43706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4371c609719bSwdenk
43726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4373c609719bSwdenk
43746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4375c609719bSwdenk
43766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4377c609719bSwdenk
43786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4379c609719bSwdenk		SDRAM timing
4380c609719bSwdenk
43816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4382c609719bSwdenk		periodic timer for refresh
4383c609719bSwdenk
43846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4385c609719bSwdenk
43866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
43876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
43886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
43896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4390c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4391c609719bSwdenk
4392c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
43936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
43946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4395c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4396c609719bSwdenk
43976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
43986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4399c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4400c609719bSwdenk		Prescaler definitions (SDRAM timing)
4401c609719bSwdenk
44026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4403c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4404c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4405c609719bSwdenk
44066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4407b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4408b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4409b423d055SHeiko Schocher
44106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4411c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4412c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4413c609719bSwdenk
44146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4415ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4416ea909b76Swdenk		(Power On Self Tests). This definition overrides
4417ea909b76Swdenk		#define'd default value in commproc.h resp.
4418ea909b76Swdenk		cpm_8260.h.
4419ea909b76Swdenk
44206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
44216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
44226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
44236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
44246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
44256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
44266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
44276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4428a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
44295d232d0eSwdenk
44309cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
44319cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
44329cacf4fcSDirk Eibach		required.
44339cacf4fcSDirk Eibach
443469fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4435b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
443669fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
443769fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
443869fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
443969fd2d3bSAndrew Sharp		by coreboot or similar.
444069fd2d3bSAndrew Sharp
4441842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4442842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4443842033e6SGabor Juhos
4444a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4445a09b9b68SKumar Gala		Chip has SRIO or not
4446a09b9b68SKumar Gala
4447a09b9b68SKumar Gala- CONFIG_SRIO1:
4448a09b9b68SKumar Gala		Board has SRIO 1 port available
4449a09b9b68SKumar Gala
4450a09b9b68SKumar Gala- CONFIG_SRIO2:
4451a09b9b68SKumar Gala		Board has SRIO 2 port available
4452a09b9b68SKumar Gala
4453c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4454c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4455c8b28152SLiu Gang
4456a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4457a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4458a09b9b68SKumar Gala
4459a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4460a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4461a09b9b68SKumar Gala
4462a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4463a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4464a09b9b68SKumar Gala
446566bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
446666bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
446766bd1846SFabio Estevam		a 16 bit bus.
446866bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4469a430e916SFabio Estevam		Example of drivers that use it:
447066bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4471a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4472eced4626SAlex Waterman
4473eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4474eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4475eced4626SAlex Waterman		a default value will be used.
4476eced4626SAlex Waterman
4477bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4478218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4479218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4480218ca724SWolfgang Denk
4481bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4482bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4483bb99ad6dSBen Warren
44846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4485218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4486218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4487218ca724SWolfgang Denk		to something your driver can deal with.
4488bb99ad6dSBen Warren
44891b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
44901b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
44911b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
44921b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
44931b3e3c4fSYork Sun		header files or board specific files.
44941b3e3c4fSYork Sun
44956f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44966f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44976f5e1dc5SYork Sun
4498e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4499e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4500e32d59a2SYork Sun
45014516ff81SYork Sun- CONFIG_FSL_DDR_BIST
45024516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
45034516ff81SYork Sun
45046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4505218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4506218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
45072ad6b513STimur Tabi
4508c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4509c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4510c26e454dSwdenk
4511c26e454dSwdenk- CONFIG_FEC[12]_PHY
4512c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
45136e592385Swdenk		to the given FEC; i. e.
4514c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4515c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4516c26e454dSwdenk
4517c26e454dSwdenk		When set to -1, means to probe for first available.
4518c26e454dSwdenk
4519c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4520c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4521c26e454dSwdenk		(so program the FEC to ignore it).
4522c26e454dSwdenk
4523c26e454dSwdenk- CONFIG_RMII
4524c26e454dSwdenk		Enable RMII mode for all FECs.
4525c26e454dSwdenk		Note that this is a global option, we can't
4526c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4527c26e454dSwdenk
45285cf91d6bSwdenk- CONFIG_CRC32_VERIFY
45295cf91d6bSwdenk		Add a verify option to the crc32 command.
45305cf91d6bSwdenk		The syntax is:
45315cf91d6bSwdenk
45325cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
45335cf91d6bSwdenk
45345cf91d6bSwdenk		Where address/count indicate a memory area
45355cf91d6bSwdenk		and crc32 is the correct crc32 which the
45365cf91d6bSwdenk		area should have.
45375cf91d6bSwdenk
453856523f12Swdenk- CONFIG_LOOPW
453956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4540602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
454156523f12Swdenk
45427b466641Sstroese- CONFIG_MX_CYCLIC
45437b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
45447b466641Sstroese		"md/mw" commands.
45457b466641Sstroese		Examples:
45467b466641Sstroese
45477b466641Sstroese		=> mdc.b 10 4 500
45487b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
45497b466641Sstroese
45507b466641Sstroese		=> mwc.l 100 12345678 10
45517b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
45527b466641Sstroese
45537b466641Sstroese		This only takes effect if the memory commands are activated
4554602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
45557b466641Sstroese
45568aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4557afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4558e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4559e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4560e03f3169SWolfgang Denk		relocate itself into RAM.
45618aa1a2d1Swdenk
4562e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4563e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4564e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4565e03f3169SWolfgang Denk		these initializations itself.
45668aa1a2d1Swdenk
4567b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4568b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
456990211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4570b5bd0982SSimon Glass		instruction cache) is still performed.
4571b5bd0982SSimon Glass
4572401bb30bSAneesh V- CONFIG_SPL_BUILD
4573df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4574df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4575df81238bSMagnus Lilja		compiling a NAND SPL.
4576400558b5Swdenk
45773aa29de0SYing Zhang- CONFIG_TPL_BUILD
45783aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
45793aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
45803aa29de0SYing Zhang		It is loaded by the SPL.
45813aa29de0SYing Zhang
45825df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
45835df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
45845df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
45855df572f0SYing Zhang		previous 4k of the .text section.
45865df572f0SYing Zhang
45874213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
45884213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
45894213fc29SSimon Glass		effective address. It is therefore not necessary to regard
45904213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
45914213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
45924213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
45934213fc29SSimon Glass		addressable memory. This option causes some memory accesses
45944213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
45954213fc29SSimon Glass
4596d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4597d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4598d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4599d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4600d8834a13SMatthias Weisser		conditions but may increase the binary size.
4601d8834a13SMatthias Weisser
4602588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4603588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4604588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4605b16f521aSGabe Black
4606fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4607fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4608fc33705eSMark Jackson
4609fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
46105b5ece9eSGabe Black
461116678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
461216678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
461316678eb4SHeiko Schocher
4614999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4615999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4616999d7d32SKaricheri, Muralidharan		driver that uses this:
4617999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4618999d7d32SKaricheri, Muralidharan
4619f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4620f2717b47STimur Tabi-----------------------------------
4621f2717b47STimur Tabi
4622f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4623f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4624f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4625f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4626f2717b47STimur Tabiwithin that device.
4627f2717b47STimur Tabi
4628dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4629dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4630dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4631dcf1d774SZhao Qiang	is also specified.
4632dcf1d774SZhao Qiang
4633dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4634dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4635f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4636f2717b47STimur Tabi	is also specified.
4637f2717b47STimur Tabi
4638f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4639f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4640f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4641f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4642f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4643f2717b47STimur Tabi
4644f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4645f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4646f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4647f2717b47STimur Tabi	virtual address in NOR flash.
4648f2717b47STimur Tabi
4649f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4650f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4651f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4652f2717b47STimur Tabi
4653f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4654f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4655f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4656f2717b47STimur Tabi
4657292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4658292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4659292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4660fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4661fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4662fc54c7faSLiu Gang	master's memory space.
4663f2717b47STimur Tabi
4664b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4665b940ca64SJ. German Rivera---------------------------------------------------------
4666b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4667b940ca64SJ. German Rivera"firmware".
4668b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4669b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4670b940ca64SJ. German Riverawithin that device.
4671b940ca64SJ. German Rivera
4672b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4673b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4674b940ca64SJ. German Rivera
46755c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
46765c055089SPrabhakar Kushwaha-------------------------------------------
46775c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
46785c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
46795c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
46805c055089SPrabhakar Kushwaha
4681c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4682c0492141SYork Sun	Define alignment of reserved memory MC requires
46835c055089SPrabhakar Kushwaha
4684f3f431a7SPaul KocialkowskiReproducible builds
4685f3f431a7SPaul Kocialkowski-------------------
4686f3f431a7SPaul Kocialkowski
4687f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4688f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4689f3f431a7SPaul Kocialkowski
4690f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4691f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4692f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4693f3f431a7SPaul Kocialkowski
4694f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4695f3f431a7SPaul Kocialkowski
4696c609719bSwdenkBuilding the Software:
4697c609719bSwdenk======================
4698c609719bSwdenk
4699218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4700218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4701218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4702218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4703218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4704218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4705c609719bSwdenk
4706218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4707218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4708218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4709218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4710218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4711c609719bSwdenk
4712218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4713218ca724SWolfgang Denk	$ export CROSS_COMPILE
4714c609719bSwdenk
47152f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
47162f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
47172f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
47182f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
47192f8d396bSPeter Tyser
47202f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
47212f8d396bSPeter Tyser
47222f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
47232f8d396bSPeter Tyser      be executed on computers running Windows.
47242f8d396bSPeter Tyser
4725c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4726c609719bSwdenksources you must configure U-Boot for one specific board type. This
4727c609719bSwdenkis done by typing:
4728c609719bSwdenk
4729ab584d67SHolger Freyther	make NAME_defconfig
4730c609719bSwdenk
4731ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
47324d675ae6SMichael Jonesrations; see boards.cfg for supported names.
473354387ac9Swdenk
4734c609719bSwdenkNote: for some board special configuration names may exist; check if
4735c609719bSwdenk      additional information is available from the board vendor; for
47362729af9dSwdenk      instance, the TQM823L systems are available without (standard)
47372729af9dSwdenk      or with LCD support. You can select such additional "features"
473811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4739c609719bSwdenk
4740ab584d67SHolger Freyther      make TQM823L_defconfig
47412729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4742c609719bSwdenk
4743ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4744c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4745c609719bSwdenk
4746c609719bSwdenk      etc.
4747c609719bSwdenk
4748c609719bSwdenk
4749c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
47507152b1d0Swdenkimages ready for download to / installation on your system:
4751c609719bSwdenk
4752c609719bSwdenk- "u-boot.bin" is a raw binary image
4753c609719bSwdenk- "u-boot" is an image in ELF binary format
4754c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4755c609719bSwdenk
4756baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4757baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4758baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4759baf31249SMarian Balakowicz
4760baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4761baf31249SMarian Balakowicz
4762baf31249SMarian Balakowicz	make O=/tmp/build distclean
4763ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4764baf31249SMarian Balakowicz	make O=/tmp/build all
4765baf31249SMarian Balakowicz
4766adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4767baf31249SMarian Balakowicz
4768adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4769baf31249SMarian Balakowicz	make distclean
4770ab584d67SHolger Freyther	make NAME_defconfig
4771baf31249SMarian Balakowicz	make all
4772baf31249SMarian Balakowicz
4773adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4774baf31249SMarian Balakowiczvariable.
4775baf31249SMarian Balakowicz
4776c609719bSwdenk
4777c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4778c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4779c609719bSwdenknative "make".
4780c609719bSwdenk
4781c609719bSwdenk
4782c609719bSwdenkIf the system board that you have is not listed, then you will need
4783c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4784c609719bSwdenksteps:
4785c609719bSwdenk
47863c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
478785ec0bccSwdenk    files you need. In your board directory, you will need at least
47883c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
47893c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
47903c1496cdSPhil Sutter    your board.
4791c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4792c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
4793ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
4794c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4795c609719bSwdenk    to be installed on your target system.
479685ec0bccSwdenk6.  Debug and solve any problems that might arise.
4797c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4798c609719bSwdenk
4799c609719bSwdenk
4800c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4801c609719bSwdenk==============================================================
4802c609719bSwdenk
4803c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4804c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4805c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4806c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4807218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4808c609719bSwdenk
4809c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4810c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4811c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
48126de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
48136de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
48146de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
48156de80f21SSimon Glassfor documentation.
4816baf31249SMarian Balakowicz
4817baf31249SMarian Balakowicz
4818c609719bSwdenkSee also "U-Boot Porting Guide" below.
4819c609719bSwdenk
4820c609719bSwdenk
4821c609719bSwdenkMonitor Commands - Overview:
4822c609719bSwdenk============================
4823c609719bSwdenk
4824c609719bSwdenkgo	- start application at address 'addr'
4825c609719bSwdenkrun	- run commands in an environment variable
4826c609719bSwdenkbootm	- boot application image from memory
4827c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
482844f074c7SMarek Vasutbootz   - boot zImage from memory
4829c609719bSwdenktftpboot- boot image via network using TFTP protocol
4830c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4831c609719bSwdenk	       (and eventually "gatewayip")
48321fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4833c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4834c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4835c609719bSwdenkloads	- load S-Record file over serial line
4836c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4837c609719bSwdenkmd	- memory display
4838c609719bSwdenkmm	- memory modify (auto-incrementing)
4839c609719bSwdenknm	- memory modify (constant address)
4840c609719bSwdenkmw	- memory write (fill)
4841c609719bSwdenkcp	- memory copy
4842c609719bSwdenkcmp	- memory compare
4843c609719bSwdenkcrc32	- checksum calculation
48440f89c54bSPeter Tyseri2c	- I2C sub-system
4845c609719bSwdenksspi	- SPI utility commands
4846c609719bSwdenkbase	- print or set address offset
4847c609719bSwdenkprintenv- print environment variables
4848c609719bSwdenksetenv	- set environment variables
4849c609719bSwdenksaveenv - save environment variables to persistent storage
4850c609719bSwdenkprotect - enable or disable FLASH write protection
4851c609719bSwdenkerase	- erase FLASH memory
4852c609719bSwdenkflinfo	- print FLASH memory information
485310635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4854c609719bSwdenkbdinfo	- print Board Info structure
4855c609719bSwdenkiminfo	- print header information for application image
4856c609719bSwdenkconinfo - print console devices and informations
4857c609719bSwdenkide	- IDE sub-system
4858c609719bSwdenkloop	- infinite loop on address range
485956523f12Swdenkloopw	- infinite write loop on address range
4860c609719bSwdenkmtest	- simple RAM test
4861c609719bSwdenkicache	- enable or disable instruction cache
4862c609719bSwdenkdcache	- enable or disable data cache
4863c609719bSwdenkreset	- Perform RESET of the CPU
4864c609719bSwdenkecho	- echo args to console
4865c609719bSwdenkversion - print monitor version
4866c609719bSwdenkhelp	- print online help
4867c609719bSwdenk?	- alias for 'help'
4868c609719bSwdenk
4869c609719bSwdenk
4870c609719bSwdenkMonitor Commands - Detailed Description:
4871c609719bSwdenk========================================
4872c609719bSwdenk
4873c609719bSwdenkTODO.
4874c609719bSwdenk
4875c609719bSwdenkFor now: just type "help <command>".
4876c609719bSwdenk
4877c609719bSwdenk
4878c609719bSwdenkEnvironment Variables:
4879c609719bSwdenk======================
4880c609719bSwdenk
4881c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4882c609719bSwdenkcan be made persistent by saving to Flash memory.
4883c609719bSwdenk
4884c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4885c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4886c609719bSwdenkwithout a value can be used to delete a variable from the
4887c609719bSwdenkenvironment. As long as you don't save the environment you are
4888c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4889c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4890c609719bSwdenk
4891c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4892c96f86eeSWolfgang Denk
4893c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4894c609719bSwdenk
4895c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4896c609719bSwdenk
4897c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4898c609719bSwdenk
4899c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4900c609719bSwdenk
4901c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4902c609719bSwdenk
4903c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4904c609719bSwdenk
49057d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
49067d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
49077d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
49087d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
49097d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
49107d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4911c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4912c3624e6eSGrant Likely		  bootm_mapsize.
4913c3624e6eSGrant Likely
4914c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4915c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4916c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4917c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4918c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4919c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4920c3624e6eSGrant Likely		  used otherwise.
49217d721e34SBartlomiej Sieka
49227d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
49237d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
49247d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
49257d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
49267d721e34SBartlomiej Sieka		  environment variable.
49277d721e34SBartlomiej Sieka
49284bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
49294bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
49304bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
49314bae9090SBartlomiej Sieka
4932c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4933c609719bSwdenk		  "bootp" will just load perform a lookup of the
4934c609719bSwdenk		  configuration from the BOOTP server, but not try to
4935c609719bSwdenk		  load any image using TFTP
4936c609719bSwdenk
4937c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4938c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4939c609719bSwdenk		  be automatically started (by internally calling
4940c609719bSwdenk		  "bootm")
4941c609719bSwdenk
49424a6fd34bSwdenk		  If set to "no", a standalone image passed to the
49434a6fd34bSwdenk		  "bootm" command will be copied to the load address
49444a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
49454a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
49464a6fd34bSwdenk		  data.
49474a6fd34bSwdenk
4948a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4949a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4950fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4951fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4952fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4953fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4954fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4955fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4956fa34f6b2SShawn Guo		  access it during the boot procedure.
4957fa34f6b2SShawn Guo
4958a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4959a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4960a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4961a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4962a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4963a28afca5SDavid A. Long		  must be accessible by the kernel.
4964a28afca5SDavid A. Long
4965eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4966eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4967eea63e05SSimon Glass		  defined.
4968eea63e05SSimon Glass
496917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
497017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
497117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
497217ea1177Swdenk		  initialization code. So, for changes to be effective
497317ea1177Swdenk		  it must be saved and board must be reset.
497417ea1177Swdenk
4975c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4976c609719bSwdenk		  If this variable is not set, initrd images will be
4977c609719bSwdenk		  copied to the highest possible address in RAM; this
4978c609719bSwdenk		  is usually what you want since it allows for
4979c609719bSwdenk		  maximum initrd size. If for some reason you want to
4980c609719bSwdenk		  make sure that the initrd image is loaded below the
49816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4982c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4983c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4984c609719bSwdenk		  address to use (U-Boot will still check that it
4985c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4986c609719bSwdenk
4987c609719bSwdenk		  For instance, when you have a system with 16 MB
49887152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4989c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4990c609719bSwdenk		  the "bootargs" variable. However, now you must make
49917152b1d0Swdenk		  sure that the initrd image is placed in the first
4992c609719bSwdenk		  12 MB as well - this can be done with
4993c609719bSwdenk
4994c609719bSwdenk		  setenv initrd_high 00c00000
4995c609719bSwdenk
499638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
499738b99261Swdenk		  indication to U-Boot that all addresses are legal
499838b99261Swdenk		  for the Linux kernel, including addresses in flash
499938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
500038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
500138b99261Swdenk		  boot time on your system, but requires that this
500238b99261Swdenk		  feature is supported by your Linux kernel.
500338b99261Swdenk
5004c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
5005c609719bSwdenk
5006c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
5007dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
5008c609719bSwdenk
5009c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
5010c609719bSwdenk
5011c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
5012c609719bSwdenk
5013c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
5014c609719bSwdenk
5015c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5016c609719bSwdenk
5017c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
5018c609719bSwdenk
5019e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
5020a3d991bdSwdenk
5021e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
5022e2a53458SMike Frysinger		  For example you can do the following
5023a3d991bdSwdenk
502448690d80SHeiko Schocher		  => setenv ethact FEC
502548690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
502648690d80SHeiko Schocher		  => setenv ethact SCC
502748690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
5028a3d991bdSwdenk
5029e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
5030e1692577SMatthias Fuchs		  available network interfaces.
5031e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
5032e1692577SMatthias Fuchs
5033a3d991bdSwdenk  netretry	- When set to "no" each network operation will
5034a3d991bdSwdenk		  either succeed or fail without retrying.
50356e592385Swdenk		  When set to "once" the network operation will
50366e592385Swdenk		  fail when all the available network interfaces
50376e592385Swdenk		  are tried once without success.
5038a3d991bdSwdenk		  Useful on scripts which control the retry operation
5039a3d991bdSwdenk		  themselves.
5040a3d991bdSwdenk
5041b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
5042a1cf027aSJean-Christophe PLAGNIOL-VILLARD
5043b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
50448d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
50458d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
50468d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
50478d51aacdSSimon Glass		  is silent.
50488d51aacdSSimon Glass
5049f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
5050ecb0ccd9SWolfgang Denk		  UDP source port.
5051ecb0ccd9SWolfgang Denk
5052f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
505328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
505428cb9375SWolfgang Denk
5055c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
5056c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
5057c96f86eeSWolfgang Denk
5058c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
5059c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
5060c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
5061c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
5062c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
5063c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
5064c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
5065c96f86eeSWolfgang Denk
5066f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
5067f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
5068f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
5069f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
5070f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
5071f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
5072f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
5073f5fb7346SAlbert ARIBAUD \(3ADEV\)
5074a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
507511ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
5076a3d991bdSwdenk		  VLAN tagged frames.
5077c609719bSwdenk
507850768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
507950768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
508050768f5bSAlexandre Messier		  be either the default (28000), or a value based on
508150768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
508250768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
508350768f5bSAlexandre Messier
5084dc0b7b0eSJason HobbsThe following image location variables contain the location of images
5085dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
5086dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
5087dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
5088dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
5089dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
5090dc0b7b0eSJason Hobbsflash or offset in NAND flash.
5091dc0b7b0eSJason Hobbs
5092dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
5093aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
5094dc0b7b0eSJason Hobbsboards use these variables for other purposes.
5095dc0b7b0eSJason Hobbs
5096dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
5097dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
5098dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
5099dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
5100dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
5101dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5102dc0b7b0eSJason Hobbs
5103c609719bSwdenkThe following environment variables may be used and automatically
5104c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
5105c609719bSwdenkdepending the information provided by your boot server:
5106c609719bSwdenk
5107c609719bSwdenk  bootfile	- see above
5108c609719bSwdenk  dnsip		- IP address of your Domain Name Server
5109fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
5110c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
5111c609719bSwdenk  hostname	- Target hostname
5112c609719bSwdenk  ipaddr	- see above
5113c609719bSwdenk  netmask	- Subnet Mask
5114c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
5115c609719bSwdenk  serverip	- see above
5116c609719bSwdenk
5117c609719bSwdenk
5118c609719bSwdenkThere are two special Environment Variables:
5119c609719bSwdenk
5120c609719bSwdenk  serial#	- contains hardware identification information such
5121c609719bSwdenk		  as type string and/or serial number
5122c609719bSwdenk  ethaddr	- Ethernet address
5123c609719bSwdenk
5124c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5125c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5126c609719bSwdenkonce they have been set once.
5127c609719bSwdenk
5128c609719bSwdenk
5129c1551ea8SstroeseFurther special Environment Variables:
5130c1551ea8Sstroese
5131c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5132c1551ea8Sstroese		  with the "version" command. This variable is
5133c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5134c1551ea8Sstroese
5135c1551ea8Sstroese
5136c609719bSwdenkPlease note that changes to some configuration parameters may take
5137c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5138c609719bSwdenk
5139c609719bSwdenk
5140170ab110SJoe HershbergerCallback functions for environment variables:
5141170ab110SJoe Hershberger---------------------------------------------
5142170ab110SJoe Hershberger
5143170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5144b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
5145170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5146170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5147170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5148170ab110SJoe Hershberger
5149170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5150170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5151170ab110SJoe Hershberger
5152170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5153170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5154170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5155170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5156170ab110SJoe Hershberger
5157170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5158170ab110SJoe Hershberger	list = entry[,list]
5159170ab110SJoe Hershberger
5160170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5161170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5162170ab110SJoe Hershberger
5163170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5164170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5165170ab110SJoe Hershbergeroverride any association in the static list. You can define
5166170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5167b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
5168170ab110SJoe Hershberger
5169bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
5170bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
5171bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
5172bdf1fe4eSJoe Hershberger
5173170ab110SJoe Hershberger
5174f07771ccSwdenkCommand Line Parsing:
5175f07771ccSwdenk=====================
5176f07771ccSwdenk
5177f07771ccSwdenkThere are two different command line parsers available with U-Boot:
51787152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5179f07771ccSwdenk
5180f07771ccSwdenkOld, simple command line parser:
5181f07771ccSwdenk--------------------------------
5182f07771ccSwdenk
5183f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5184f07771ccSwdenk- several commands on one line, separated by ';'
5185fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5186f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5187f07771ccSwdenk  for example:
5188fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5189f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5190f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5191f07771ccSwdenk
5192f07771ccSwdenkHush shell:
5193f07771ccSwdenk-----------
5194f07771ccSwdenk
5195f07771ccSwdenk- similar to Bourne shell, with control structures like
5196f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5197f07771ccSwdenk  until...do...done, ...
5198f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5199f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5200f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5201f07771ccSwdenk  command
5202f07771ccSwdenk
5203f07771ccSwdenkGeneral rules:
5204f07771ccSwdenk--------------
5205f07771ccSwdenk
5206f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5207f07771ccSwdenk    command) contains several commands separated by semicolon, and
5208f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5209f07771ccSwdenk    executed anyway.
5210f07771ccSwdenk
5211f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
521211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5213f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5214f07771ccSwdenk    variables are not executed.
5215f07771ccSwdenk
5216c609719bSwdenkNote for Redundant Ethernet Interfaces:
5217c609719bSwdenk=======================================
5218c609719bSwdenk
521911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5220c609719bSwdenksuch configurations and is capable of automatic selection of a
52217152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5222c609719bSwdenk
5223c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5224c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5225c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5226c609719bSwdenk
5227c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5228c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5229c609719bSwdenkding setting in the environment; if the corresponding environment
5230c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5231c609719bSwdenk
5232c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5233c609719bSwdenk  environment, the SROM's address is used.
5234c609719bSwdenk
5235c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5236c609719bSwdenk  environment exists, then the value from the environment variable is
5237c609719bSwdenk  used.
5238c609719bSwdenk
5239c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5240c609719bSwdenk  both addresses are the same, this MAC address is used.
5241c609719bSwdenk
5242c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5243c609719bSwdenk  addresses differ, the value from the environment is used and a
5244c609719bSwdenk  warning is printed.
5245c609719bSwdenk
5246c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5247bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5248bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
5249c609719bSwdenk
5250ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5251ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5252ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5253ecee9324SBen WarrenThe naming convention is as follows:
5254ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5255c609719bSwdenk
5256c609719bSwdenkImage Formats:
5257c609719bSwdenk==============
5258c609719bSwdenk
52593310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
52603310c549SMarian Balakowiczimages in two formats:
52613310c549SMarian Balakowicz
52623310c549SMarian BalakowiczNew uImage format (FIT)
52633310c549SMarian Balakowicz-----------------------
52643310c549SMarian Balakowicz
52653310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
52663310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
52673310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
52683310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
52693310c549SMarian Balakowicz
52703310c549SMarian Balakowicz
52713310c549SMarian BalakowiczOld uImage format
52723310c549SMarian Balakowicz-----------------
52733310c549SMarian Balakowicz
52743310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
52753310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
52763310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5277c609719bSwdenk
5278c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5279c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5280f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5281f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5282f5ed9e39SPeter Tyser  INTEGRITY).
52837b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5284afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5285afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5286c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5287c609719bSwdenk* Load Address
5288c609719bSwdenk* Entry Point
5289c609719bSwdenk* Image Name
5290c609719bSwdenk* Image Timestamp
5291c609719bSwdenk
5292c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5293c609719bSwdenkand the data portions of the image are secured against corruption by
5294c609719bSwdenkCRC32 checksums.
5295c609719bSwdenk
5296c609719bSwdenk
5297c609719bSwdenkLinux Support:
5298c609719bSwdenk==============
5299c609719bSwdenk
5300c609719bSwdenkAlthough U-Boot should support any OS or standalone application
53017152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5302c609719bSwdenkU-Boot.
5303c609719bSwdenk
5304c609719bSwdenkU-Boot includes many features that so far have been part of some
5305c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5306c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5307c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
53087152b1d0Swdenkserves several purposes:
5309c609719bSwdenk
5310c609719bSwdenk- the same features can be used for other OS or standalone
5311c609719bSwdenk  applications (for instance: using compressed images to reduce the
5312c609719bSwdenk  Flash memory footprint)
5313c609719bSwdenk
5314c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
53157152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5316c609719bSwdenk
5317c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5318c609719bSwdenk  images; of course this also means that different kernel images can
5319c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5320c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5321c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5322c609719bSwdenk  software is easier now.
5323c609719bSwdenk
5324c609719bSwdenk
5325c609719bSwdenkLinux HOWTO:
5326c609719bSwdenk============
5327c609719bSwdenk
5328c609719bSwdenkPorting Linux to U-Boot based systems:
5329c609719bSwdenk---------------------------------------
5330c609719bSwdenk
5331c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5332c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5333c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5334c609719bSwdenkLinux :-).
5335c609719bSwdenk
5336a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5337c609719bSwdenk
5338c609719bSwdenkJust make sure your machine specific header file (for instance
5339c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
53401dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
53411dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
53426d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5343c609719bSwdenk
53442eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
53452eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
53462eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
53472eb31b13SSimon Glassdoc/driver-model.
53482eb31b13SSimon Glass
5349c609719bSwdenk
5350c609719bSwdenkConfiguring the Linux kernel:
5351c609719bSwdenk-----------------------------
5352c609719bSwdenk
5353c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5354c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5355c609719bSwdenk
5356c609719bSwdenk
5357c609719bSwdenkBuilding a Linux Image:
5358c609719bSwdenk-----------------------
5359c609719bSwdenk
536024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
536124ee89b9Swdenknot used. If you use recent kernel source, a new build target
536224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
536324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
536424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
536524ee89b9Swdenk100% compatible format.
5366c609719bSwdenk
5367c609719bSwdenkExample:
5368c609719bSwdenk
5369ab584d67SHolger Freyther	make TQM850L_defconfig
5370c609719bSwdenk	make oldconfig
5371c609719bSwdenk	make dep
537224ee89b9Swdenk	make uImage
5373c609719bSwdenk
537424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
537524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
537624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5377c609719bSwdenk
537824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
537924ee89b9Swdenk
538024ee89b9Swdenk* convert the kernel into a raw binary image:
538124ee89b9Swdenk
538224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
538324ee89b9Swdenk				 -R .note -R .comment \
538424ee89b9Swdenk				 -S vmlinux linux.bin
538524ee89b9Swdenk
538624ee89b9Swdenk* compress the binary image:
538724ee89b9Swdenk
538824ee89b9Swdenk	gzip -9 linux.bin
538924ee89b9Swdenk
539024ee89b9Swdenk* package compressed binary image for U-Boot:
539124ee89b9Swdenk
539224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
539324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
539424ee89b9Swdenk		-d linux.bin.gz uImage
539524ee89b9Swdenk
539624ee89b9Swdenk
539724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
539824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
539924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
540024ee89b9Swdenkbyte header containing information about target architecture,
540124ee89b9Swdenkoperating system, image type, compression method, entry points, time
540224ee89b9Swdenkstamp, CRC32 checksums, etc.
540324ee89b9Swdenk
540424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
540524ee89b9Swdenkprint the header information, or to build new images.
5406c609719bSwdenk
5407c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5408c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5409c609719bSwdenkchecksum verification:
5410c609719bSwdenk
5411c609719bSwdenk	tools/mkimage -l image
5412c609719bSwdenk	  -l ==> list image header information
5413c609719bSwdenk
5414c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5415c609719bSwdenkfrom a "data file" which is used as image payload:
5416c609719bSwdenk
5417c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5418c609719bSwdenk		      -n name -d data_file image
5419c609719bSwdenk	  -A ==> set architecture to 'arch'
5420c609719bSwdenk	  -O ==> set operating system to 'os'
5421c609719bSwdenk	  -T ==> set image type to 'type'
5422c609719bSwdenk	  -C ==> set compression type 'comp'
5423c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5424c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5425c609719bSwdenk	  -n ==> set image name to 'name'
5426c609719bSwdenk	  -d ==> use image data from 'datafile'
5427c609719bSwdenk
542869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
542969459791Swdenkaddress (0x00000000), but the entry point address depends on the
543069459791Swdenkkernel version:
5431c609719bSwdenk
5432c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
543324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5434c609719bSwdenk
5435c609719bSwdenkSo a typical call to build a U-Boot image would read:
5436c609719bSwdenk
543724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
543824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5439a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
544024ee89b9Swdenk	> examples/uImage.TQM850L
544124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5442c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5443c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5444c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5445c609719bSwdenk	Load Address: 0x00000000
544624ee89b9Swdenk	Entry Point:  0x00000000
5447c609719bSwdenk
5448c609719bSwdenkTo verify the contents of the image (or check for corruption):
5449c609719bSwdenk
545024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
545124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5452c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5453c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5454c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5455c609719bSwdenk	Load Address: 0x00000000
545624ee89b9Swdenk	Entry Point:  0x00000000
5457c609719bSwdenk
5458c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5459c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5460c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5461c609719bSwdenkneed to be uncompressed:
5462c609719bSwdenk
5463a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
546424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
546524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5466a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
546724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
546824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5469c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5470c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5471c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5472c609719bSwdenk	Load Address: 0x00000000
547324ee89b9Swdenk	Entry Point:  0x00000000
5474c609719bSwdenk
5475c609719bSwdenk
5476c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5477c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5478c609719bSwdenk
5479c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5480c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5481c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5482c609719bSwdenk	Image Name:   Simple Ramdisk Image
5483c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5484c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5485c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5486c609719bSwdenk	Load Address: 0x00000000
5487c609719bSwdenk	Entry Point:  0x00000000
5488c609719bSwdenk
5489a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5490a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5491a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5492a804b5ceSGuilherme Maciel Ferreirafrom the image:
5493a804b5ceSGuilherme Maciel Ferreira
5494f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5495f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5496f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5497f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5498a804b5ceSGuilherme Maciel Ferreira
5499c609719bSwdenk
5500c609719bSwdenkInstalling a Linux Image:
5501c609719bSwdenk-------------------------
5502c609719bSwdenk
5503c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5504c609719bSwdenkyou must convert the image to S-Record format:
5505c609719bSwdenk
5506c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5507c609719bSwdenk
5508c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5509c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5510c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5511c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5512c609719bSwdenkcommand.
5513c609719bSwdenk
5514c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5515c609719bSwdenkTQM8xxL is in the first Flash bank):
5516c609719bSwdenk
5517c609719bSwdenk	=> erase 40100000 401FFFFF
5518c609719bSwdenk
5519c609719bSwdenk	.......... done
5520c609719bSwdenk	Erased 8 sectors
5521c609719bSwdenk
5522c609719bSwdenk	=> loads 40100000
5523c609719bSwdenk	## Ready for S-Record download ...
5524c609719bSwdenk	~>examples/image.srec
5525c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5526c609719bSwdenk	...
5527c609719bSwdenk	15989 15990 15991 15992
5528c609719bSwdenk	[file transfer complete]
5529c609719bSwdenk	[connected]
5530c609719bSwdenk	## Start Addr = 0x00000000
5531c609719bSwdenk
5532c609719bSwdenk
5533c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5534c609719bSwdenkthis includes a checksum verification so you can be sure no data
5535c609719bSwdenkcorruption happened:
5536c609719bSwdenk
5537c609719bSwdenk	=> imi 40100000
5538c609719bSwdenk
5539c609719bSwdenk	## Checking Image at 40100000 ...
5540c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5541c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5542c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5543c609719bSwdenk	   Load Address: 00000000
5544c609719bSwdenk	   Entry Point:	 0000000c
5545c609719bSwdenk	   Verifying Checksum ... OK
5546c609719bSwdenk
5547c609719bSwdenk
5548c609719bSwdenkBoot Linux:
5549c609719bSwdenk-----------
5550c609719bSwdenk
5551c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5552c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5553c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5554c609719bSwdenkparameters. You can check and modify this variable using the
5555c609719bSwdenk"printenv" and "setenv" commands:
5556c609719bSwdenk
5557c609719bSwdenk
5558c609719bSwdenk	=> printenv bootargs
5559c609719bSwdenk	bootargs=root=/dev/ram
5560c609719bSwdenk
5561c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5562c609719bSwdenk
5563c609719bSwdenk	=> printenv bootargs
5564c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5565c609719bSwdenk
5566c609719bSwdenk	=> bootm 40020000
5567c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5568c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5569c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5570c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5571c609719bSwdenk	   Load Address: 00000000
5572c609719bSwdenk	   Entry Point:	 0000000c
5573c609719bSwdenk	   Verifying Checksum ... OK
5574c609719bSwdenk	   Uncompressing Kernel Image ... OK
5575c609719bSwdenk	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
5576c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5577c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5578c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5579c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5580c609719bSwdenk	...
5581c609719bSwdenk
558211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
55837152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5584c609719bSwdenkformat!) to the "bootm" command:
5585c609719bSwdenk
5586c609719bSwdenk	=> imi 40100000 40200000
5587c609719bSwdenk
5588c609719bSwdenk	## Checking Image at 40100000 ...
5589c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5590c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5591c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5592c609719bSwdenk	   Load Address: 00000000
5593c609719bSwdenk	   Entry Point:	 0000000c
5594c609719bSwdenk	   Verifying Checksum ... OK
5595c609719bSwdenk
5596c609719bSwdenk	## Checking Image at 40200000 ...
5597c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5598c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5599c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5600c609719bSwdenk	   Load Address: 00000000
5601c609719bSwdenk	   Entry Point:	 00000000
5602c609719bSwdenk	   Verifying Checksum ... OK
5603c609719bSwdenk
5604c609719bSwdenk	=> bootm 40100000 40200000
5605c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5606c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5607c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5608c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5609c609719bSwdenk	   Load Address: 00000000
5610c609719bSwdenk	   Entry Point:	 0000000c
5611c609719bSwdenk	   Verifying Checksum ... OK
5612c609719bSwdenk	   Uncompressing Kernel Image ... OK
5613c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5614c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5615c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5616c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5617c609719bSwdenk	   Load Address: 00000000
5618c609719bSwdenk	   Entry Point:	 00000000
5619c609719bSwdenk	   Verifying Checksum ... OK
5620c609719bSwdenk	   Loading Ramdisk ... OK
5621c609719bSwdenk	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
5622c609719bSwdenk	Boot arguments: root=/dev/ram
5623c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5624c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5625c609719bSwdenk	...
5626c609719bSwdenk	RAMDISK: Compressed image found at block 0
5627c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5628c609719bSwdenk
5629c609719bSwdenk	bash#
5630c609719bSwdenk
56310267768eSMatthew McClintockBoot Linux and pass a flat device tree:
56320267768eSMatthew McClintock-----------
56330267768eSMatthew McClintock
56340267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
56350267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
56360267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
56370267768eSMatthew McClintockflat device tree:
56380267768eSMatthew McClintock
56390267768eSMatthew McClintock=> print oftaddr
56400267768eSMatthew McClintockoftaddr=0x300000
56410267768eSMatthew McClintock=> print oft
56420267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
56430267768eSMatthew McClintock=> tftp $oftaddr $oft
56440267768eSMatthew McClintockSpeed: 1000, full duplex
56450267768eSMatthew McClintockUsing TSEC0 device
56460267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
56470267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
56480267768eSMatthew McClintockLoad address: 0x300000
56490267768eSMatthew McClintockLoading: #
56500267768eSMatthew McClintockdone
56510267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
56520267768eSMatthew McClintock=> tftp $loadaddr $bootfile
56530267768eSMatthew McClintockSpeed: 1000, full duplex
56540267768eSMatthew McClintockUsing TSEC0 device
56550267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
56560267768eSMatthew McClintockFilename 'uImage'.
56570267768eSMatthew McClintockLoad address: 0x200000
56580267768eSMatthew McClintockLoading:############
56590267768eSMatthew McClintockdone
56600267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
56610267768eSMatthew McClintock=> print loadaddr
56620267768eSMatthew McClintockloadaddr=200000
56630267768eSMatthew McClintock=> print oftaddr
56640267768eSMatthew McClintockoftaddr=0x300000
56650267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
56660267768eSMatthew McClintock## Booting image at 00200000 ...
56670267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
56680267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
56690267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
56700267768eSMatthew McClintock   Load Address: 00000000
56710267768eSMatthew McClintock   Entry Point:	 00000000
56720267768eSMatthew McClintock   Verifying Checksum ... OK
56730267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
56740267768eSMatthew McClintockBooting using flat device tree at 0x300000
56750267768eSMatthew McClintockUsing MPC85xx ADS machine description
56760267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
56770267768eSMatthew McClintock[snip]
56780267768eSMatthew McClintock
56790267768eSMatthew McClintock
56806069ff26SwdenkMore About U-Boot Image Types:
56816069ff26Swdenk------------------------------
56826069ff26Swdenk
56836069ff26SwdenkU-Boot supports the following image types:
56846069ff26Swdenk
56856069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
56866069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
56876069ff26Swdenk	well) you can continue to work in U-Boot after return from
56886069ff26Swdenk	the Standalone Program.
56896069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
56906069ff26Swdenk	will take over control completely. Usually these programs
56916069ff26Swdenk	will install their own set of exception handlers, device
56926069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
56936069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
56946069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
56956069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
56966069ff26Swdenk	being started.
56976069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
56986069ff26Swdenk	(Linux) kernel image and one or more data images like
56996069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
57006069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
57016069ff26Swdenk	server provides just a single image file, but you want to get
57026069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
57036069ff26Swdenk
57046069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
57056069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
57066069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
57076069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
57086069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
57096069ff26Swdenk	a multiple of 4 bytes).
57106069ff26Swdenk
57116069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
57126069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
57136069ff26Swdenk	flash memory.
57146069ff26Swdenk
57156069ff26Swdenk   "Script files" are command sequences that will be executed by
57166069ff26Swdenk	U-Boot's command interpreter; this feature is especially
57176069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
57186069ff26Swdenk	as command interpreter.
57196069ff26Swdenk
572044f074c7SMarek VasutBooting the Linux zImage:
572144f074c7SMarek Vasut-------------------------
572244f074c7SMarek Vasut
572344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
572444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
572544f074c7SMarek Vasutas the syntax of "bootm" command.
572644f074c7SMarek Vasut
57278ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5728017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5729017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5730017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5731017e1f3fSMarek Vasut
5732c609719bSwdenk
5733c609719bSwdenkStandalone HOWTO:
5734c609719bSwdenk=================
5735c609719bSwdenk
5736c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5737c609719bSwdenkrun "standalone" applications, which can use some resources of
5738c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5739c609719bSwdenk
5740c609719bSwdenkTwo simple examples are included with the sources:
5741c609719bSwdenk
5742c609719bSwdenk"Hello World" Demo:
5743c609719bSwdenk-------------------
5744c609719bSwdenk
5745c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5746c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5747c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5748c609719bSwdenklike that:
5749c609719bSwdenk
5750c609719bSwdenk	=> loads
5751c609719bSwdenk	## Ready for S-Record download ...
5752c609719bSwdenk	~>examples/hello_world.srec
5753c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5754c609719bSwdenk	[file transfer complete]
5755c609719bSwdenk	[connected]
5756c609719bSwdenk	## Start Addr = 0x00040004
5757c609719bSwdenk
5758c609719bSwdenk	=> go 40004 Hello World! This is a test.
5759c609719bSwdenk	## Starting application at 0x00040004 ...
5760c609719bSwdenk	Hello World
5761c609719bSwdenk	argc = 7
5762c609719bSwdenk	argv[0] = "40004"
5763c609719bSwdenk	argv[1] = "Hello"
5764c609719bSwdenk	argv[2] = "World!"
5765c609719bSwdenk	argv[3] = "This"
5766c609719bSwdenk	argv[4] = "is"
5767c609719bSwdenk	argv[5] = "a"
5768c609719bSwdenk	argv[6] = "test."
5769c609719bSwdenk	argv[7] = "<NULL>"
5770c609719bSwdenk	Hit any key to exit ...
5771c609719bSwdenk
5772c609719bSwdenk	## Application terminated, rc = 0x0
5773c609719bSwdenk
5774c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5775c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5776c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5777c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5778c609719bSwdenkcharacter, but this is just a demo program. The application can be
5779c609719bSwdenkcontrolled by the following keys:
5780c609719bSwdenk
5781c609719bSwdenk	? - print current values og the CPM Timer registers
5782c609719bSwdenk	b - enable interrupts and start timer
5783c609719bSwdenk	e - stop timer and disable interrupts
5784c609719bSwdenk	q - quit application
5785c609719bSwdenk
5786c609719bSwdenk	=> loads
5787c609719bSwdenk	## Ready for S-Record download ...
5788c609719bSwdenk	~>examples/timer.srec
5789c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5790c609719bSwdenk	[file transfer complete]
5791c609719bSwdenk	[connected]
5792c609719bSwdenk	## Start Addr = 0x00040004
5793c609719bSwdenk
5794c609719bSwdenk	=> go 40004
5795c609719bSwdenk	## Starting application at 0x00040004 ...
5796c609719bSwdenk	TIMERS=0xfff00980
5797c609719bSwdenk	Using timer 1
5798c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5799c609719bSwdenk
5800c609719bSwdenkHit 'b':
5801c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5802c609719bSwdenk	Enabling timer
5803c609719bSwdenkHit '?':
5804c609719bSwdenk	[q, b, e, ?] ........
5805c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5806c609719bSwdenkHit '?':
5807c609719bSwdenk	[q, b, e, ?] .
5808c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5809c609719bSwdenkHit '?':
5810c609719bSwdenk	[q, b, e, ?] .
5811c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5812c609719bSwdenkHit '?':
5813c609719bSwdenk	[q, b, e, ?] .
5814c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5815c609719bSwdenkHit 'e':
5816c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5817c609719bSwdenkHit 'q':
5818c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5819c609719bSwdenk
5820c609719bSwdenk
582185ec0bccSwdenkMinicom warning:
582285ec0bccSwdenk================
582385ec0bccSwdenk
58247152b1d0SwdenkOver time, many people have reported problems when trying to use the
582585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
582685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5827f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
582885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5829e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5830e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5831e53515a2SKarl O. Pincfor help with kermit.
5832e53515a2SKarl O. Pinc
583385ec0bccSwdenk
583452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
583552f52c14Swdenkconfiguration to your "File transfer protocols" section:
583652f52c14Swdenk
583752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
583852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
583952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
584052f52c14Swdenk
584152f52c14Swdenk
5842c609719bSwdenkNetBSD Notes:
5843c609719bSwdenk=============
5844c609719bSwdenk
5845c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5846c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5847c609719bSwdenk
5848c609719bSwdenkBuilding requires a cross environment; it is known to work on
5849c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5850c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5851c609719bSwdenkNote that the cross-powerpc package does not install include files;
5852c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5853c609719bSwdenkmissing.  This file has to be installed and patched manually:
5854c609719bSwdenk
5855c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5856c609719bSwdenk	# mkdir powerpc
5857c609719bSwdenk	# ln -s powerpc machine
5858c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5859c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5860c609719bSwdenk
5861c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5862c609719bSwdenkand U-Boot include files.
5863c609719bSwdenk
5864c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5865c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5866c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5867c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
58682a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5869c609719bSwdenk
5870c609719bSwdenk
5871c609719bSwdenkImplementation Internals:
5872c609719bSwdenk=========================
5873c609719bSwdenk
5874c609719bSwdenkThe following is not intended to be a complete description of every
5875c609719bSwdenkimplementation detail. However, it should help to understand the
5876c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5877c609719bSwdenkhardware.
5878c609719bSwdenk
5879c609719bSwdenk
5880c609719bSwdenkInitial Stack, Global Data:
5881c609719bSwdenk---------------------------
5882c609719bSwdenk
5883c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5884c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5885c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5886c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5887c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5888c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5889c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5890c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5891c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5892c609719bSwdenklocked as (mis-) used as memory, etc.
5893c609719bSwdenk
58947152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
58950668236bSWolfgang Denk	U-Boot mailing list:
589643d9616cSwdenk
589743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
589843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
589943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
590043d9616cSwdenk	...
590143d9616cSwdenk
590243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
590343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
590443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
590543d9616cSwdenk	is that the cache is being used as a temporary supply of
590643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
590711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
590843d9616cSwdenk	can see how this works by studying the cache architecture and
590943d9616cSwdenk	operation in the architecture and processor-specific manuals.
591043d9616cSwdenk
591143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
591243d9616cSwdenk	is another option for the system designer to use as an
591311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
591443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
591543d9616cSwdenk	board designers haven't used it for something that would
591643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
591743d9616cSwdenk	used.
591843d9616cSwdenk
59196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
592043d9616cSwdenk	with your processor/board/system design. The default value
592143d9616cSwdenk	you will find in any recent u-boot distribution in
59228a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
592343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
592443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
592543d9616cSwdenk	that are supposed to respond to that address! That code in
592643d9616cSwdenk	start.S has been around a while and should work as is when
592743d9616cSwdenk	you get the config right.
592843d9616cSwdenk
592943d9616cSwdenk	-Chris Hallinan
593043d9616cSwdenk	DS4.COM, Inc.
593143d9616cSwdenk
5932c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5933c609719bSwdenkcode for the initialization procedures:
5934c609719bSwdenk
5935c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5936c609719bSwdenk  to write it.
5937c609719bSwdenk
5938b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
5939c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
59407152b1d0Swdenk  zation is performed later (when relocating to RAM).
5941c609719bSwdenk
5942c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5943c609719bSwdenk  that.
5944c609719bSwdenk
5945c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5946b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
5947c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5948c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5949c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5950c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5951c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5952c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5953c609719bSwdenkreserve for this purpose.
5954c609719bSwdenk
59557152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5956c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5957c609719bSwdenkGCC's implementation.
5958c609719bSwdenk
5959c609719bSwdenkFor PowerPC, the following registers have specific use:
5960c609719bSwdenk	R1:	stack pointer
5961e7670f6cSWolfgang Denk	R2:	reserved for system use
5962c609719bSwdenk	R3-R4:	parameter passing and return values
5963c609719bSwdenk	R5-R10: parameter passing
5964c609719bSwdenk	R13:	small data area pointer
5965c609719bSwdenk	R30:	GOT pointer
5966c609719bSwdenk	R31:	frame pointer
5967c609719bSwdenk
5968e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5969e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5970e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5971c609719bSwdenk
5972e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5973c609719bSwdenk
5974c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5975c609719bSwdenk    address of the global data structure is known at compile time),
5976c609719bSwdenk    but it turned out that reserving a register results in somewhat
5977c609719bSwdenk    smaller code - although the code savings are not that big (on
5978c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5979c609719bSwdenk    624 text + 127 data).
5980c609719bSwdenk
5981c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
59824c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
59834c58eb55SMike Frysinger
5984c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
59854c58eb55SMike Frysinger
5986c609719bSwdenkOn ARM, the following registers are used:
5987c609719bSwdenk
5988c609719bSwdenk	R0:	function argument word/integer result
5989c609719bSwdenk	R1-R3:	function argument word
599012eba1b4SJeroen Hofstee	R9:	platform specific
599112eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5992c609719bSwdenk	R11:	argument (frame) pointer
5993c609719bSwdenk	R12:	temporary workspace
5994c609719bSwdenk	R13:	stack pointer
5995c609719bSwdenk	R14:	link register
5996c609719bSwdenk	R15:	program counter
5997c609719bSwdenk
599812eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
599912eba1b4SJeroen Hofstee
600012eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
6001c609719bSwdenk
60020df01fd3SThomas ChouOn Nios II, the ABI is documented here:
60030df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
60040df01fd3SThomas Chou
60050df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
60060df01fd3SThomas Chou
60070df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
60080df01fd3SThomas Chou    to access small data sections, so gp is free.
60090df01fd3SThomas Chou
6010afc1ce82SMacpaul LinOn NDS32, the following registers are used:
6011afc1ce82SMacpaul Lin
6012afc1ce82SMacpaul Lin	R0-R1:	argument/return
6013afc1ce82SMacpaul Lin	R2-R5:	argument
6014afc1ce82SMacpaul Lin	R15:	temporary register for assembler
6015afc1ce82SMacpaul Lin	R16:	trampoline register
6016afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
6017afc1ce82SMacpaul Lin	R29:	global pointer (GP)
6018afc1ce82SMacpaul Lin	R30:	link register (LP)
6019afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
6020afc1ce82SMacpaul Lin	PC:	program counter (PC)
6021afc1ce82SMacpaul Lin
6022afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
6023afc1ce82SMacpaul Lin
6024d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6025d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
6026c609719bSwdenk
6027c609719bSwdenkMemory Management:
6028c609719bSwdenk------------------
6029c609719bSwdenk
6030c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
6031c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
6032c609719bSwdenk
6033c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
6034c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
6035c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
6036c609719bSwdenkphysical memory banks.
6037c609719bSwdenk
6038c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
6039c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6040c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
6041c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
60426d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
6043c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
6044c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
6045c609719bSwdenk
6046c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
6047c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
6048c609719bSwdenk
6049c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
6050c609719bSwdenkthis:
6051c609719bSwdenk
6052c609719bSwdenk	0x0000 0000	Exception Vector code
6053c609719bSwdenk	      :
6054c609719bSwdenk	0x0000 1FFF
6055c609719bSwdenk	0x0000 2000	Free for Application Use
6056c609719bSwdenk	      :
6057c609719bSwdenk	      :
6058c609719bSwdenk
6059c609719bSwdenk	      :
6060c609719bSwdenk	      :
6061c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
6062c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
6063c609719bSwdenk	0x00FC 0000	Malloc Arena
6064c609719bSwdenk	      :
6065c609719bSwdenk	0x00FD FFFF
6066c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
6067c609719bSwdenk	...		eventually: LCD or video framebuffer
6068c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
6069c609719bSwdenk	0x00FF FFFF	[End of RAM]
6070c609719bSwdenk
6071c609719bSwdenk
6072c609719bSwdenkSystem Initialization:
6073c609719bSwdenk----------------------
6074c609719bSwdenk
6075c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
607611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
6077c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
60787152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
6079c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
6080c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
6081c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
6082c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
6083c609719bSwdenkthe caches and the SIU.
6084c609719bSwdenk
6085c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
6086c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
6087c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6088c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6089c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
6090c609719bSwdenksimple memory test is run that determines the size of the SDRAM
6091c609719bSwdenkbanks.
6092c609719bSwdenk
6093c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
60947152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
6095c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
6096c609719bSwdenk0x00000000, with any additional banks following immediately to create
6097c609719bSwdenkcontiguous memory starting from 0.
6098c609719bSwdenk
6099c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
6100c609719bSwdenkand allocates memory for use by malloc() and for the global Board
6101c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
6102c609719bSwdenkpages, and the final stack is set up.
6103c609719bSwdenk
6104c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
6105c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
6106c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
6107c609719bSwdenknew address in RAM.
6108c609719bSwdenk
6109c609719bSwdenk
6110c609719bSwdenkU-Boot Porting Guide:
6111c609719bSwdenk----------------------
6112c609719bSwdenk
6113c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
61146aff3115Swdenklist, October 2002]
6115c609719bSwdenk
6116c609719bSwdenk
6117c609719bSwdenkint main(int argc, char *argv[])
6118c609719bSwdenk{
6119c609719bSwdenk	sighandler_t no_more_time;
6120c609719bSwdenk
6121c609719bSwdenk	signal(SIGALRM, no_more_time);
6122c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
6123c609719bSwdenk
6124c609719bSwdenk	if (available_money > available_manpower) {
61256c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
6126c609719bSwdenk		return 0;
6127c609719bSwdenk	}
6128c609719bSwdenk
6129c609719bSwdenk	Download latest U-Boot source;
6130c609719bSwdenk
61310668236bSWolfgang Denk	Subscribe to u-boot mailing list;
61326aff3115Swdenk
61336c3fef28SJerry Van Baren	if (clueless)
6134c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6135c609719bSwdenk
6136c609719bSwdenk	while (learning) {
6137c609719bSwdenk		Read the README file in the top level directory;
61387cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
61396c3fef28SJerry Van Baren		Read applicable doc/*.README;
6140c609719bSwdenk		Read the source, Luke;
61416c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6142c609719bSwdenk	}
6143c609719bSwdenk
61446c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
61456c3fef28SJerry Van Baren		Buy a BDI3000;
61466c3fef28SJerry Van Baren	else
6147c609719bSwdenk		Add a lot of aggravation and time;
6148c609719bSwdenk
61496c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
61506c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
61516c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
61526c3fef28SJerry Van Baren	} else {
6153c609719bSwdenk		Create your own board support subdirectory;
61546c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
61556c3fef28SJerry Van Baren	}
61566c3fef28SJerry Van Baren	Edit new board/<myboard> files
61576c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6158c609719bSwdenk
61596c3fef28SJerry Van Baren	while (!accepted) {
6160c609719bSwdenk		while (!running) {
6161c609719bSwdenk			do {
6162c609719bSwdenk				Add / modify source code;
6163c609719bSwdenk			} until (compiles);
6164c609719bSwdenk			Debug;
6165c609719bSwdenk			if (clueless)
6166c609719bSwdenk				email("Hi, I am having problems...");
6167c609719bSwdenk		}
61686c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
61696c3fef28SJerry Van Baren		if (reasonable critiques)
61706c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
61716c3fef28SJerry Van Baren		else
61726c3fef28SJerry Van Baren			Defend code as written;
61736c3fef28SJerry Van Baren	}
6174c609719bSwdenk
6175c609719bSwdenk	return 0;
6176c609719bSwdenk}
6177c609719bSwdenk
6178c609719bSwdenkvoid no_more_time (int sig)
6179c609719bSwdenk{
6180c609719bSwdenk      hire_a_guru();
6181c609719bSwdenk}
6182c609719bSwdenk
6183c609719bSwdenk
6184c609719bSwdenkCoding Standards:
6185c609719bSwdenk-----------------
6186c609719bSwdenk
6187c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
61882c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
61897ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6190c609719bSwdenk
61912c051651SDetlev ZundelSource files originating from a different project (for example the
61922c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
6193b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
61942c051651SDetlev Zundelsources.
61952c051651SDetlev Zundel
61962c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
61972c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
61982c051651SDetlev Zundelin your code.
6199c609719bSwdenk
6200c178d3daSwdenkPlease also stick to the following formatting rules:
6201180d3f74Swdenk- remove any trailing white space
62027ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6203180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
62047ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6205180d3f74Swdenk- do not add trailing empty lines to source files
6206180d3f74Swdenk
6207c609719bSwdenkSubmissions which do not conform to the standards may be returned
6208c609719bSwdenkwith a request to reformat the changes.
6209c609719bSwdenk
6210c609719bSwdenk
6211c609719bSwdenkSubmitting Patches:
6212c609719bSwdenk-------------------
6213c609719bSwdenk
6214c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6215c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6216c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6217c609719bSwdenk
62180d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6219218ca724SWolfgang Denk
62200668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
62210668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
62220668236bSWolfgang Denk
6223c609719bSwdenkWhen you send a patch, please include the following information with
6224c609719bSwdenkit:
6225c609719bSwdenk
6226c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6227c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6228c609719bSwdenk  patch actually fixes something.
6229c609719bSwdenk
6230c609719bSwdenk* For new features: a description of the feature and your
6231c609719bSwdenk  implementation.
6232c609719bSwdenk
6233c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6234c609719bSwdenk
62357207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
62367207b366SRobert P. J. Day  information and associated file and directory references.
6237c609719bSwdenk
623827af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
623927af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6240c609719bSwdenk
6241c609719bSwdenk* If your patch adds new configuration options, don't forget to
6242c609719bSwdenk  document these in the README file.
6243c609719bSwdenk
6244218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6245218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
62467ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6247218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6248218ca724SWolfgang Denk  with some other mail clients.
6249c609719bSwdenk
6250218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6251218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6252218ca724SWolfgang Denk  GNU diff.
62536dff5529Swdenk
6254218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6255218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6256218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6257218ca724SWolfgang Denk  affected files).
6258218ca724SWolfgang Denk
6259218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6260218ca724SWolfgang Denk  and compressed attachments must not be used.
6261c609719bSwdenk
626252f52c14Swdenk* If one logical set of modifications affects or creates several
626352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
626452f52c14Swdenk
626552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
626652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
626752f52c14Swdenk
626852f52c14Swdenk
6269c609719bSwdenkNotes:
6270c609719bSwdenk
62716de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
6272c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6273c609719bSwdenk  for any of the boards.
6274c609719bSwdenk
6275c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6276c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6277c609719bSwdenk  returned with a request to re-formatting / split it.
6278c609719bSwdenk
6279c609719bSwdenk* If you modify existing code, make sure that your new code does not
6280c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6281c609719bSwdenk  When adding new features, these should compile conditionally only
6282c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6283c609719bSwdenk  disabled must not need more memory than the old code without your
6284c609719bSwdenk  modification.
628590dc6704Swdenk
62860668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
62870668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
62880668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
62890668236bSWolfgang Denk  bigger than the size limit should be avoided.
6290