xref: /openbmc/u-boot/README (revision 4e5b1bd0dff216b00d7ce9a5201dfe173805a06c)
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
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1458d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1468d321b81SPeter Tyser    /lib		Architecture specific library files
1478d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1488d321b81SPeter Tyser    /cpu		CPU specific files
1498d321b81SPeter Tyser    /lib		Architecture specific library files
1508d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1518d321b81SPeter Tyser    /cpu		CPU specific files
1528d321b81SPeter Tyser    /lib		Architecture specific library files
1538d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1548d321b81SPeter Tyser    /cpu		CPU specific files
1558d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1568d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1578d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1588d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1598d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
16692bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16780421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1688d321b81SPeter Tyser    /lib		Architecture specific library files
169afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
170afc1ce82SMacpaul Lin    /cpu		CPU specific files
171afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
172afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1738d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1748d321b81SPeter Tyser    /cpu		CPU specific files
1758d321b81SPeter Tyser    /lib		Architecture specific library files
17633c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17733c7731bSRobert P. J. Day    /cpu		CPU specific files
17833c7731bSRobert P. J. Day    /lib		Architecture specific library files
179a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1808d321b81SPeter Tyser    /cpu		CPU specific files
1818d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1828d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1838d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1848d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1858d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1868d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1878d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1888d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1898d321b81SPeter Tyser    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /sh			Files generic to SH architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1938d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1948d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1958d321b81SPeter Tyser    /lib		Architecture specific library files
1968d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1978d321b81SPeter Tyser    /cpu		CPU specific files
1988d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
1998d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2008d321b81SPeter Tyser    /lib		Architecture specific library files
20133c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20233c7731bSRobert P. J. Day    /cpu		CPU specific files
20333c7731bSRobert P. J. Day    /lib		Architecture specific library files
2048d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2058d321b81SPeter Tyser/board			Board dependent files
2068d321b81SPeter Tyser/common			Misc architecture independent functions
2078d321b81SPeter Tyser/disk			Code for disk drive partition handling
2088d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2098d321b81SPeter Tyser/drivers		Commonly used device drivers
21033c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2118d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2128d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2138d321b81SPeter Tyser/include		Header Files
2148d321b81SPeter Tyser/lib			Files generic to all architectures
2158d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2168d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2178d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2188d321b81SPeter Tyser/net			Networking code
2198d321b81SPeter Tyser/post			Power On Self Test
22033c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2218d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
222c609719bSwdenk
223c609719bSwdenkSoftware Configuration:
224c609719bSwdenk=======================
225c609719bSwdenk
226c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
227c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
228c609719bSwdenk
229c609719bSwdenkThere are two classes of configuration variables:
230c609719bSwdenk
231c609719bSwdenk* Configuration _OPTIONS_:
232c609719bSwdenk  These are selectable by the user and have names beginning with
233c609719bSwdenk  "CONFIG_".
234c609719bSwdenk
235c609719bSwdenk* Configuration _SETTINGS_:
236c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
237c609719bSwdenk  you don't know what you're doing; they have names beginning with
2386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
239c609719bSwdenk
240c609719bSwdenkLater we will add a configuration tool - probably similar to or even
241c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
242c609719bSwdenkdo the configuration by hand, which means creating some symbolic
243c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
244c609719bSwdenkas an example here.
245c609719bSwdenk
246c609719bSwdenk
247c609719bSwdenkSelection of Processor Architecture and Board Type:
248c609719bSwdenk---------------------------------------------------
249c609719bSwdenk
250c609719bSwdenkFor all supported boards there are ready-to-use default
251c609719bSwdenkconfigurations available; just type "make <board_name>_config".
252c609719bSwdenk
253c609719bSwdenkExample: For a TQM823L module type:
254c609719bSwdenk
255c609719bSwdenk	cd u-boot
256c609719bSwdenk	make TQM823L_config
257c609719bSwdenk
25811ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
259c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
260c609719bSwdenkdirectory according to the instructions in cogent/README.
261c609719bSwdenk
262c609719bSwdenk
263c609719bSwdenkConfiguration Options:
264c609719bSwdenk----------------------
265c609719bSwdenk
266c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
267c609719bSwdenksuch information is kept in a configuration file
268c609719bSwdenk"include/configs/<board_name>.h".
269c609719bSwdenk
270c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
271c609719bSwdenk"include/configs/TQM823L.h".
272c609719bSwdenk
273c609719bSwdenk
2747f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2757f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2767f6c2cbcSwdenkbuild a config tool - later.
2777f6c2cbcSwdenk
2787f6c2cbcSwdenk
279c609719bSwdenkThe following options need to be configured:
280c609719bSwdenk
2812628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
282c609719bSwdenk
2832628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2846ccec449SWolfgang Denk
2856ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28609ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
287c609719bSwdenk
288c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
289c609719bSwdenk		Define exactly one of
290c609719bSwdenk		CONFIG_CMA286_60_OLD
291c609719bSwdenk--- FIXME --- not tested yet:
292c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
293c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
294c609719bSwdenk
295c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
296c609719bSwdenk		Define exactly one of
297c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
298c609719bSwdenk
299c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define one or more of
301c609719bSwdenk		CONFIG_CMA302
302c609719bSwdenk
303c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
304c609719bSwdenk		Define one or more of
305c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30611ccc33fSMarcel Ziswiler					  the LCD display every second with
307c609719bSwdenk					  a "rotator" |\-/|\-/
308c609719bSwdenk
3092535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3102535d602Swdenk		CONFIG_ADSTYPE
3112535d602Swdenk		Possible values are:
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3162535d602Swdenk
317cf946c6dSLei Wen- Marvell Family Member
318cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
319cf946c6dSLei Wen					  multiple fs option at one time
320cf946c6dSLei Wen					  for marvell soc family
321cf946c6dSLei Wen
322c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
323c609719bSwdenk		Define exactly one of
324c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
325c609719bSwdenk
32611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32866ca92a5Swdenk					  get_gclk_freq() cannot work
3295da627a4Swdenk					  e.g. if there is no 32KHz
3305da627a4Swdenk					  reference PIT/RTC clock
33166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33266ca92a5Swdenk					  or XTAL/EXTAL)
333c609719bSwdenk
33466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33875d1ea7fSwdenk			See doc/README.MPC866
33975d1ea7fSwdenk
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34175d1ea7fSwdenk
34275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34375d1ea7fSwdenk		of relying on the correctness of the configured
34475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34875d1ea7fSwdenk
349506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
350506f3918SHeiko Schocher
351506f3918SHeiko Schocher		Define this option if you want to enable the
352506f3918SHeiko Schocher		ICache only when Code runs from RAM.
353506f3918SHeiko Schocher
35466412c63SKumar Gala- 85xx CPU Options:
355ffd06e02SYork Sun		CONFIG_SYS_PPC64
356ffd06e02SYork Sun
357ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
358ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
359ffd06e02SYork Sun		compliance, among other possible reasons.
360ffd06e02SYork Sun
36166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36266412c63SKumar Gala
36366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36666412c63SKumar Gala
3678f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3688f29084aSKumar Gala
3698f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3708f29084aSKumar Gala		tree nodes for the given platform.
3718f29084aSKumar Gala
372afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
373afa6b551SPrabhakar Kushwaha
374afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
375afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
376afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
377afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
378afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
379afa6b551SPrabhakar Kushwaha		purpose.
380afa6b551SPrabhakar Kushwaha
38133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38233eee330SScott Wood
38333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38633eee330SScott Wood
38733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
38933eee330SScott Wood
39033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39133eee330SScott Wood		for which the A004510 workaround should be applied.
39233eee330SScott Wood
39333eee330SScott Wood		The rest of SVR is either not relevant to the decision
39433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39533eee330SScott Wood		p2041) or is implied by the build target, which controls
39633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39733eee330SScott Wood
39833eee330SScott Wood		See Freescale App Note 4493 for more information about
39933eee330SScott Wood		this erratum.
40033eee330SScott Wood
40174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40374fa22edSPrabhakar Kushwaha		requred during NOR boot.
40474fa22edSPrabhakar Kushwaha
40533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40633eee330SScott Wood
40733eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40833eee330SScott Wood		according to the A004510 workaround.
40933eee330SScott Wood
41064501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41164501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41264501c66SPriyanka Jain		connected exclusively to the DSP cores.
41364501c66SPriyanka Jain
414765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
416765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
417765b0bdbSPriyanka Jain
41864501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
41964501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42064501c66SPriyanka Jain		connected to the DSP core.
42164501c66SPriyanka Jain
422765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
424765b0bdbSPriyanka Jain
425b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
427b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
428b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
429b135991aSPriyanka Jain
4306cb461b4SDaniel Schwierzeck- Generic CPU options:
4316cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4326cb461b4SDaniel Schwierzeck
4336cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4346cb461b4SDaniel Schwierzeck		values is arch specific.
4356cb461b4SDaniel Schwierzeck
4365614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4375614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4385614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4395614e71bSYork Sun		SoCs.
4405614e71bSYork Sun
4415614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4425614e71bSYork Sun		Freescale DDR memory-mapped register base.
4435614e71bSYork Sun
4445614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4455614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4465614e71bSYork Sun		deskew training are not available.
4475614e71bSYork Sun
4485614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4495614e71bSYork Sun		Freescale DDR1 controller.
4505614e71bSYork Sun
4515614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4525614e71bSYork Sun		Freescale DDR2 controller.
4535614e71bSYork Sun
4545614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4555614e71bSYork Sun		Freescale DDR3 controller.
4565614e71bSYork Sun
4579ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4589ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4599ac4ffbdSYork Sun
4605614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4615614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4625614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4635614e71bSYork Sun		implemetation.
4645614e71bSYork Sun
4655614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4665614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4675614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4685614e71bSYork Sun		implementation.
4695614e71bSYork Sun
4705614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4715614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
4725614e71bSYork Sun		Freescale DDR3 controllers.
4735614e71bSYork Sun
4741b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4751b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4761b4175d6SPrabhakar Kushwaha
4771b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4781b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4791b4175d6SPrabhakar Kushwaha
480690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
481690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
482690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
483690e4258SPrabhakar Kushwaha
484690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
485690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
486690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
487690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
488690e4258SPrabhakar Kushwaha
489*4e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
490*4e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
491*4e5b1bd0SYork Sun
492*4e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
493*4e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
494*4e5b1bd0SYork Sun
4950b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4970b953ffcSMarkus Klotzbuecher
4980b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4990b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5000b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5010b953ffcSMarkus Klotzbuecher
5026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5030b953ffcSMarkus Klotzbuecher
5040b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5050b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5060b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5070b953ffcSMarkus Klotzbuecher		by this value.
5080b953ffcSMarkus Klotzbuecher
50992bbd64eSDaniel Schwierzeck- MIPS CPU options:
51092bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
51192bbd64eSDaniel Schwierzeck
51292bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
51392bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
51492bbd64eSDaniel Schwierzeck		relocation.
51592bbd64eSDaniel Schwierzeck
51692bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
51792bbd64eSDaniel Schwierzeck
51892bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
51992bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
52092bbd64eSDaniel Schwierzeck		Possible values are:
52192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
52292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
52392bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
52492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
52592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
52692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
52792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
52892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
52992bbd64eSDaniel Schwierzeck
53092bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
53192bbd64eSDaniel Schwierzeck
53292bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
53392bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
53492bbd64eSDaniel Schwierzeck
53592bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
53692bbd64eSDaniel Schwierzeck
53792bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
53892bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
53992bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
54092bbd64eSDaniel Schwierzeck
541b67d8816SChristian Riesch- ARM options:
542b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
543b67d8816SChristian Riesch
544b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
545b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
546b67d8816SChristian Riesch
5475356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5485356f545SAneesh V
5495356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5505356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5515356f545SAneesh V		better code density. For ARM architectures that support
5525356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5535356f545SAneesh V		GCC.
5545356f545SAneesh V
555c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5560678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5570678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5580678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5590678587fSStephen Warren
5600678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5610678587fSStephen Warren		during U-Boot startup. Note that these options force the
5620678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5630678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5640678587fSStephen Warren		set these options unless they apply!
5650678587fSStephen Warren
566795659dcSStephen Warren- CPU timer options:
567795659dcSStephen Warren		CONFIG_SYS_HZ
568795659dcSStephen Warren
569795659dcSStephen Warren		The frequency of the timer returned by get_timer().
570795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
571795659dcSStephen Warren		option must be set to 1000.
572795659dcSStephen Warren
5735da627a4Swdenk- Linux Kernel Interface:
574c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
575c609719bSwdenk
576c609719bSwdenk		U-Boot stores all clock information in Hz
577c609719bSwdenk		internally. For binary compatibility with older Linux
578c609719bSwdenk		kernels (which expect the clocks passed in the
579c609719bSwdenk		bd_info data to be in MHz) the environment variable
580c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
581c609719bSwdenk		converts clock data to MHZ before passing it to the
582c609719bSwdenk		Linux kernel.
583c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
584c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
585c609719bSwdenk		default environment.
586c609719bSwdenk
5875da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5885da627a4Swdenk
58911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5905da627a4Swdenk		expect it to be in bytes, others in MB.
5915da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5925da627a4Swdenk
593fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
594f57f70aaSWolfgang Denk
595f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
596213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
597213bf8c8SGerald Van Baren		concepts).
598213bf8c8SGerald Van Baren
599213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
600213bf8c8SGerald Van Baren		 * New libfdt-based support
601213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6023bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
603213bf8c8SGerald Van Baren
604b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
605b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
606b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
607b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
608f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
609c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
610f57f70aaSWolfgang Denk
61111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
61211ccc33fSMarcel Ziswiler		addresses
6133bb342fcSKim Phillips
6144e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6154e253137SKumar Gala
6164e253137SKumar Gala		Board code has addition modification that it wants to make
6174e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6186705d81eSwdenk
6190267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6200267768eSMatthew McClintock
62111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6220267768eSMatthew McClintock		param header, the default value is zero if undefined.
6230267768eSMatthew McClintock
6243887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6253887c3fbSHeiko Schocher
6263887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6273887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6283887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6293887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6303887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6313887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6323887c3fbSHeiko Schocher
6337eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6347eb29398SIgor Grinberg
6357eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6367eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6377eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6387eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6397eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6407eb29398SIgor Grinberg		in a single configuration file and the machine type is
6417eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6427eb29398SIgor Grinberg
6430b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6440b2f4ecaSNiklaus Giger
6450b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6460b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6470b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6480b2f4ecaSNiklaus Giger
6490b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6500b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6510b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6520b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6530b2f4ecaSNiklaus Giger
6540b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6550b2f4ecaSNiklaus Giger
6560b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6570b2f4ecaSNiklaus Giger
6580b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6590b2f4ecaSNiklaus Giger		the defaults discussed just above.
6600b2f4ecaSNiklaus Giger
6612c451f78SAneesh V- Cache Configuration:
6622c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6632c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6642c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6652c451f78SAneesh V
66693bc2193SAneesh V- Cache Configuration for ARM:
66793bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
66893bc2193SAneesh V				      controller
66993bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
67093bc2193SAneesh V					controller register space
67193bc2193SAneesh V
6726705d81eSwdenk- Serial Ports:
67348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6746705d81eSwdenk
6756705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6766705d81eSwdenk
67748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6786705d81eSwdenk
6796705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6806705d81eSwdenk
6816705d81eSwdenk		CONFIG_PL011_CLOCK
6826705d81eSwdenk
6836705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6846705d81eSwdenk		the clock speed of the UARTs.
6856705d81eSwdenk
6866705d81eSwdenk		CONFIG_PL01x_PORTS
6876705d81eSwdenk
6886705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6896705d81eSwdenk		define this to a list of base addresses for each (supported)
6906705d81eSwdenk		port. See e.g. include/configs/versatile.h
6916705d81eSwdenk
692910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
693910f1ae3SJohn Rigby
694910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
695910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
696910f1ae3SJohn Rigby		this variable to initialize the extra register.
697910f1ae3SJohn Rigby
698910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
699910f1ae3SJohn Rigby
700910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
701910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
702910f1ae3SJohn Rigby		variable to flush the UART at init time.
703910f1ae3SJohn Rigby
7046705d81eSwdenk
705c609719bSwdenk- Console Interface:
706c609719bSwdenk		Depending on board, define exactly one serial port
707c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
708c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
709c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
710c609719bSwdenk
711c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
712c609719bSwdenk		port routines must be defined elsewhere
713c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
714c609719bSwdenk
715c609719bSwdenk		CONFIG_CFB_CONSOLE
716c609719bSwdenk		Enables console device for a color framebuffer. Needs following
717c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
718c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
719c609719bSwdenk						(default big endian)
720c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
721c609719bSwdenk						rectangle fill
722c609719bSwdenk						(cf. smiLynxEM)
723c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
724c609719bSwdenk						bit-blit (cf. smiLynxEM)
725c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
726c609719bSwdenk						(cols=pitch)
727c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
728c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
729c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
730c609719bSwdenk						(0-5, cf. cfb_console.c)
731c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
732c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
733c609719bSwdenk						(i.e. i8042_kbd_init())
734c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
735c609719bSwdenk						(i.e. i8042_tstc)
736c609719bSwdenk			VIDEO_GETC_FCT		get char fct
737c609719bSwdenk						(i.e. i8042_getc)
738c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
739c609719bSwdenk						(requires blink timer
740c609719bSwdenk						cf. i8042.c)
7416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
742c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
743c609719bSwdenk						upper right corner
744602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
745c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
746c609719bSwdenk						upper left corner
747a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
748a6c7ad2fSwdenk						linux_logo.h for logo.
749a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
750c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
75111ccc33fSMarcel Ziswiler						additional board info beside
752c609719bSwdenk						the logo
753c609719bSwdenk
75433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
75533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
75633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
75733a35bbbSPali Rohár
758c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
759c609719bSwdenk		default i/o. Serial console can be forced with
760c609719bSwdenk		environment 'console=serial'.
761c609719bSwdenk
762a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
763a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
764a3ad8e26Swdenk		the "silent" environment variable. See
765a3ad8e26Swdenk		doc/README.silent for more information.
766a3ad8e26Swdenk
76745ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
76845ae2546SHeiko Schocher			is 0x00.
76945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
77045ae2546SHeiko Schocher			is 0xa0.
77145ae2546SHeiko Schocher
772c609719bSwdenk- Console Baudrate:
773c609719bSwdenk		CONFIG_BAUDRATE - in bps
774c609719bSwdenk		Select one of the baudrates listed in
7756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
777c609719bSwdenk
778c92fac91SHeiko Schocher- Console Rx buffer length
779c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
780c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7812b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
782c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
783c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
784c92fac91SHeiko Schocher		the SMC.
785c92fac91SHeiko Schocher
7869558b48aSGraeme Russ- Pre-Console Buffer:
7879558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7889558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7899558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7909558b48aSGraeme Russ		buffer any console messages prior to the console being
7919558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7929558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7939558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7949558b48aSGraeme Russ		bytes are output before the console is initialised, the
7959558b48aSGraeme Russ		earlier bytes are discarded.
7969558b48aSGraeme Russ
7979558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7989558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7999558b48aSGraeme Russ
800046a37bdSSonny Rao- Safe printf() functions
801046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
802046a37bdSSonny Rao		the printf() functions. These are defined in
803046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
804046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
805046a37bdSSonny Rao		If this option is not given then these functions will
806046a37bdSSonny Rao		silently discard their buffer size argument - this means
807046a37bdSSonny Rao		you are not getting any overflow checking in this case.
808046a37bdSSonny Rao
809c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
810c609719bSwdenk		Delay before automatically booting the default image;
811c609719bSwdenk		set to -1 to disable autoboot.
81293d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
81393d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
814c609719bSwdenk
815c609719bSwdenk		See doc/README.autoboot for these options that
816c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
817c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
818c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
819c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
820c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
821c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
822c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
823c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
824c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
825c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
826c609719bSwdenk		CONFIG_RESET_TO_RETRY
827c609719bSwdenk
828c609719bSwdenk- Autoboot Command:
829c609719bSwdenk		CONFIG_BOOTCOMMAND
830c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
831c609719bSwdenk		define a command string that is automatically executed
832c609719bSwdenk		when no character is read on the console interface
833c609719bSwdenk		within "Boot Delay" after reset.
834c609719bSwdenk
835c609719bSwdenk		CONFIG_BOOTARGS
836c609719bSwdenk		This can be used to pass arguments to the bootm
837c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
838c609719bSwdenk		environment value "bootargs".
839c609719bSwdenk
840c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
841c609719bSwdenk		The value of these goes into the environment as
842c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
843c609719bSwdenk		as a convenience, when switching between booting from
84411ccc33fSMarcel Ziswiler		RAM and NFS.
845c609719bSwdenk
846eda0ba38SHeiko Schocher- Bootcount:
847eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
848eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
849eda0ba38SHeiko Schocher		cycle, see:
850eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
851eda0ba38SHeiko Schocher
852eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
853eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
854eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
855eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
856eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
857eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
858eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
859eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
860eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
861eda0ba38SHeiko Schocher
862c609719bSwdenk- Pre-Boot Commands:
863c609719bSwdenk		CONFIG_PREBOOT
864c609719bSwdenk
865c609719bSwdenk		When this option is #defined, the existence of the
866c609719bSwdenk		environment variable "preboot" will be checked
867c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
868c609719bSwdenk		countdown and/or running the auto-boot command resp.
869c609719bSwdenk		entering interactive mode.
870c609719bSwdenk
871c609719bSwdenk		This feature is especially useful when "preboot" is
872c609719bSwdenk		automatically generated or modified. For an example
873c609719bSwdenk		see the LWMON board specific code: here "preboot" is
874c609719bSwdenk		modified when the user holds down a certain
875c609719bSwdenk		combination of keys on the (special) keyboard when
876c609719bSwdenk		booting the systems
877c609719bSwdenk
878c609719bSwdenk- Serial Download Echo Mode:
879c609719bSwdenk		CONFIG_LOADS_ECHO
880c609719bSwdenk		If defined to 1, all characters received during a
881c609719bSwdenk		serial download (using the "loads" command) are
882c609719bSwdenk		echoed back. This might be needed by some terminal
883c609719bSwdenk		emulations (like "cu"), but may as well just take
884c609719bSwdenk		time on others. This setting #define's the initial
885c609719bSwdenk		value of the "loads_echo" environment variable.
886c609719bSwdenk
887602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
888c609719bSwdenk		CONFIG_KGDB_BAUDRATE
889c609719bSwdenk		Select one of the baudrates listed in
8906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
891c609719bSwdenk
892c609719bSwdenk- Monitor Functions:
893602ad3b3SJon Loeliger		Monitor commands can be included or excluded
894602ad3b3SJon Loeliger		from the build by using the #include files
895c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
896c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
897602ad3b3SJon Loeliger		and augmenting with additional #define's
898602ad3b3SJon Loeliger		for wanted commands.
899c609719bSwdenk
900602ad3b3SJon Loeliger		The default command configuration includes all commands
901602ad3b3SJon Loeliger		except those marked below with a "*".
902602ad3b3SJon Loeliger
903602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
904602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
905602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
906602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
907602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
908602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
909602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
91008d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
911602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
912710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
913602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
914602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
915602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
916a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
917a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
918a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
919a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
920602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
921602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
922246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
923602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
924602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9255e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
926fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
92788733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9280c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
92903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
93003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
93116f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
93216f4d933SStephen Warren					  that work for multiple fs types
933bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
934602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
93503e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
936602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
937602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9384d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
93953fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
940a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
941a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
942bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
943602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
944602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
945602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
946602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9478fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9484d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
949602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9500c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
951c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
952602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
953602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
954602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
955602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9564d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
957d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
958d22c338eSJoe Hershberger					  (169.254.*.*)
959602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
960602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9614d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
96202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
96315a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
964602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
965a2681707SWolfgang Denk					  loop, loopw
9664d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
967602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
968602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
969602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
97068d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
971602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
972602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
9734d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
974e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
975e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
976602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
977602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
978602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
979602ad3b3SJon Loeliger					  host
980602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
981ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
982602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
983602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
984d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
985602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
986602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
987602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
988602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
989602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
990602ad3b3SJon Loeliger					  (4xx only)
991f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9924d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
99302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9947d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
99574de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
996602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9977a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9981fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
999da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1000da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1001602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1002602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1003c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10044d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
1005c609719bSwdenk
1006c609719bSwdenk
1007c609719bSwdenk		EXAMPLE: If you want all functions except of network
1008c609719bSwdenk		support you can write:
1009c609719bSwdenk
1010602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1011602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1012c609719bSwdenk
1013213bf8c8SGerald Van Baren	Other Commands:
1014213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1015c609719bSwdenk
1016c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1017602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1018c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1019c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1020c609719bSwdenk		8260 (where accesses to the IMMR region must be
1021c609719bSwdenk		uncached), and it cannot be disabled on all other
1022c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1023c609719bSwdenk		initial stack and some data.
1024c609719bSwdenk
1025c609719bSwdenk
1026c609719bSwdenk		XXX - this list needs to get updated!
1027c609719bSwdenk
1028a5ecbe62SWolfgang Denk- Regular expression support:
1029a5ecbe62SWolfgang Denk		CONFIG_REGEX
1030a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1031a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1032a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1033a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1034a5ecbe62SWolfgang Denk
103545ba8077SSimon Glass- Device tree:
103645ba8077SSimon Glass		CONFIG_OF_CONTROL
103745ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
103845ba8077SSimon Glass		to configure its devices, instead of relying on statically
103945ba8077SSimon Glass		compiled #defines in the board file. This option is
104045ba8077SSimon Glass		experimental and only available on a few boards. The device
104145ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
104245ba8077SSimon Glass
10432c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10442c0f79e4SSimon Glass		be done using one of the two options below:
1045bbb0b128SSimon Glass
1046bbb0b128SSimon Glass		CONFIG_OF_EMBED
1047bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1048bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1049bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1050bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1051bbb0b128SSimon Glass		the global data structure as gd->blob.
105245ba8077SSimon Glass
10532c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10542c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10552c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10562c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10572c0f79e4SSimon Glass
10582c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10592c0f79e4SSimon Glass
10602c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10612c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10622c0f79e4SSimon Glass		still use the individual files if you need something more
10632c0f79e4SSimon Glass		exotic.
10642c0f79e4SSimon Glass
1065c609719bSwdenk- Watchdog:
1066c609719bSwdenk		CONFIG_WATCHDOG
1067c609719bSwdenk		If this variable is defined, it enables watchdog
10686abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10696abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10706abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10716abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
10726abe6fb6SDetlev Zundel		available, then no further board specific code should
10736abe6fb6SDetlev Zundel		be needed to use it.
10746abe6fb6SDetlev Zundel
10756abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
10766abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10776abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10786abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1079c609719bSwdenk
1080c1551ea8Sstroese- U-Boot Version:
1081c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1082c1551ea8Sstroese		If this variable is defined, an environment variable
1083c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1084c1551ea8Sstroese		version as printed by the "version" command.
1085a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1086a1ea8e51SBenoît Thébaudeau		next reset.
1087c1551ea8Sstroese
1088c609719bSwdenk- Real-Time Clock:
1089c609719bSwdenk
1090602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1091c609719bSwdenk		has to be selected, too. Define exactly one of the
1092c609719bSwdenk		following options:
1093c609719bSwdenk
1094c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1095c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10964e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1097c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10981cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1099c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11007f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11013bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11029536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11034c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
110571d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
110671d19f30SHeiko Schocher					  RV3029 RTC.
1107c609719bSwdenk
1108b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1109b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1110b37c7e5eSwdenk
1111e92739d3SPeter Tyser- GPIO Support:
1112e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1113e92739d3SPeter Tyser
11145dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11155dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11165dec49caSChris Packham		pins supported by a particular chip.
11175dec49caSChris Packham
1118e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1119e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1120e92739d3SPeter Tyser
1121c609719bSwdenk- Timestamp Support:
1122c609719bSwdenk
1123c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1124c609719bSwdenk		(date and time) of an image is printed by image
1125c609719bSwdenk		commands like bootm or iminfo. This option is
1126602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1127c609719bSwdenk
1128923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1129923c46f9SKarl O. Pinc		Zero or more of the following:
1130923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1131923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1132923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1133923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1134923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1135923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1136923c46f9SKarl O. Pinc				       disk/part_efi.c
1137923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1138c609719bSwdenk
1139602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1140218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1141923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1142c609719bSwdenk
1143c609719bSwdenk- IDE Reset method:
11444d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11454d13cbadSwdenk		board configurations files but used nowhere!
1146c609719bSwdenk
11474d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11484d13cbadSwdenk		be performed by calling the function
11494d13cbadSwdenk			ide_set_reset(int reset)
11504d13cbadSwdenk		which has to be defined in a board specific file
1151c609719bSwdenk
1152c609719bSwdenk- ATAPI Support:
1153c609719bSwdenk		CONFIG_ATAPI
1154c609719bSwdenk
1155c609719bSwdenk		Set this to enable ATAPI support.
1156c609719bSwdenk
1157c40b2956Swdenk- LBA48 Support
1158c40b2956Swdenk		CONFIG_LBA48
1159c40b2956Swdenk
1160c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11614b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1162c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1163c40b2956Swdenk		support disks up to 2.1TB.
1164c40b2956Swdenk
11656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1166c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1167c40b2956Swdenk			Default is 32bit.
1168c40b2956Swdenk
1169c609719bSwdenk- SCSI Support:
1170c609719bSwdenk		At the moment only there is only support for the
1171c609719bSwdenk		SYM53C8XX SCSI controller; define
1172c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1173c609719bSwdenk
11746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
11756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
11766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1177c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1178c609719bSwdenk		devices.
11796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1180c609719bSwdenk
1181447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1182447c031bSStefan Reinauer		SCSI devices found during the last scan.
1183447c031bSStefan Reinauer
1184c609719bSwdenk- NETWORK Support (PCI):
1185682011ffSwdenk		CONFIG_E1000
1186ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1187ce5207e1SKyle Moffett
1188ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1189ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1190ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1191ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1192ce5207e1SKyle Moffett
1193ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1194ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1195ce5207e1SKyle Moffett		example with the "sspi" command.
1196ce5207e1SKyle Moffett
1197ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1198ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1199ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1200682011ffSwdenk
1201ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
120211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1203ac3315c2SAndre Schwarz
1204c609719bSwdenk		CONFIG_EEPRO100
1205c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
120611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1207c609719bSwdenk		write routine for first time initialisation.
1208c609719bSwdenk
1209c609719bSwdenk		CONFIG_TULIP
1210c609719bSwdenk		Support for Digital 2114x chips.
1211c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1212c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1213c609719bSwdenk
1214c609719bSwdenk		CONFIG_NATSEMI
1215c609719bSwdenk		Support for National dp83815 chips.
1216c609719bSwdenk
1217c609719bSwdenk		CONFIG_NS8382X
1218c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1219c609719bSwdenk
122045219c46Swdenk- NETWORK Support (other):
122145219c46Swdenk
1222c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1223c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1224c041e9d2SJens Scharsig
1225c041e9d2SJens Scharsig			CONFIG_RMII
1226c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1227c041e9d2SJens Scharsig
1228c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1229c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1230c041e9d2SJens Scharsig			The driver doen't show link status messages.
1231c041e9d2SJens Scharsig
1232efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1233efdd7319SRob Herring		Support for the Calxeda XGMAC device
1234efdd7319SRob Herring
12353bb46d23SAshok		CONFIG_LAN91C96
123645219c46Swdenk		Support for SMSC's LAN91C96 chips.
123745219c46Swdenk
123845219c46Swdenk			CONFIG_LAN91C96_BASE
123945219c46Swdenk			Define this to hold the physical address
124045219c46Swdenk			of the LAN91C96's I/O space
124145219c46Swdenk
124245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
124345219c46Swdenk			Define this to enable 32 bit addressing
124445219c46Swdenk
12453bb46d23SAshok		CONFIG_SMC91111
1246f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1247f39748aeSwdenk
1248f39748aeSwdenk			CONFIG_SMC91111_BASE
1249f39748aeSwdenk			Define this to hold the physical address
1250f39748aeSwdenk			of the device (I/O space)
1251f39748aeSwdenk
1252f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1253f39748aeSwdenk			Define this if data bus is 32 bits
1254f39748aeSwdenk
1255f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1256f39748aeSwdenk			Define this to use i/o functions instead of macros
1257f39748aeSwdenk			(some hardware wont work with macros)
1258f39748aeSwdenk
1259dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1260dc02badaSHeiko Schocher		Support for davinci emac
1261dc02badaSHeiko Schocher
1262dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1263dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1264dc02badaSHeiko Schocher
1265b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1266b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1267b3dbf4a5SMacpaul Lin
1268b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1269b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1270b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1271b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1272b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1273b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1274b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1275b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1276b3dbf4a5SMacpaul Lin
1277c2fff331SMike Rapoport		CONFIG_SMC911X
1278557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1279557b377dSJens Gehrlein
1280c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1281557b377dSJens Gehrlein			Define this to hold the physical address
1282557b377dSJens Gehrlein			of the device (I/O space)
1283557b377dSJens Gehrlein
1284c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1285557b377dSJens Gehrlein			Define this if data bus is 32 bits
1286557b377dSJens Gehrlein
1287c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1288557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1289557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1290c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1291557b377dSJens Gehrlein
12923d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12933d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12943d0075faSYoshihiro Shimoda
12953d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12963d0075faSYoshihiro Shimoda			Define the number of ports to be used
12973d0075faSYoshihiro Shimoda
12983d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12993d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13003d0075faSYoshihiro Shimoda
130168260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
130268260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
130368260aabSYoshihiro Shimoda
13045e124724SVadim Bendebury- TPM Support:
130590899cc0SChe-liang Chiou		CONFIG_TPM
130690899cc0SChe-liang Chiou		Support TPM devices.
130790899cc0SChe-liang Chiou
13081b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13091b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13101b393db5STom Wai-Hong Tam		per system is supported at this time.
13111b393db5STom Wai-Hong Tam
13121b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13131b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13141b393db5STom Wai-Hong Tam
13151b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13161b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13171b393db5STom Wai-Hong Tam
13181b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13191b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13201b393db5STom Wai-Hong Tam
1321c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1322c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1323c01939c7SDirk Eibach
132490899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13255e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13265e124724SVadim Bendebury		per system is supported at this time.
13275e124724SVadim Bendebury
13285e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13295e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13305e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13315e124724SVadim Bendebury			0xfed40000.
13325e124724SVadim Bendebury
1333be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1334be6c1529SReinhard Pfau		Add tpm monitor functions.
1335be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1336be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1337be6c1529SReinhard Pfau
1338be6c1529SReinhard Pfau		CONFIG_TPM
1339be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1340be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1341be6c1529SReinhard Pfau		Requires support for a TPM device.
1342be6c1529SReinhard Pfau
1343be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1344be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1345be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1346be6c1529SReinhard Pfau
1347c609719bSwdenk- USB Support:
1348c609719bSwdenk		At the moment only the UHCI host controller is
13494d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1350c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1351c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
135230d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1353c609719bSwdenk		storage devices.
1354c609719bSwdenk		Note:
1355c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1356c609719bSwdenk		(TEAC FD-05PUB).
13574d13cbadSwdenk		MPC5200 USB requires additional defines:
13584d13cbadSwdenk			CONFIG_USB_CLOCK
13594d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1360307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1361307ecb6dSEric Millbrandt				for USB on PSC3
13624d13cbadSwdenk			CONFIG_USB_CONFIG
13634d13cbadSwdenk				for differential drivers: 0x00001000
13644d13cbadSwdenk				for single ended drivers: 0x00005000
1365307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1366307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1368fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1369fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13704d13cbadSwdenk
13719ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
13729ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
13739ab4ce22SSimon Glass
1374aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1375aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1376aa155058SKuo-Jung Su
137716c8d5e7SWolfgang Denk- USB Device:
137816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
137916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
138016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
138111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
138216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
138316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
138416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
138516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
138616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
138716c8d5e7SWolfgang Denk		a Linux host by
138816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
138916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
139016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
139116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
139216c8d5e7SWolfgang Denk
139316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
139416c8d5e7SWolfgang Denk			Define this to build a UDC device
139516c8d5e7SWolfgang Denk
139616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
139716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
139816c8d5e7SWolfgang Denk			talk to the UDC device
139916c8d5e7SWolfgang Denk
1400f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1401f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1402f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1403f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1404f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1405f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1406f9da0f89SVipin KUMAR			speed.
1407f9da0f89SVipin KUMAR
14086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
140916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
141016c8d5e7SWolfgang Denk			be set to usbtty.
141116c8d5e7SWolfgang Denk
141216c8d5e7SWolfgang Denk			mpc8xx:
14136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
141416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
141616c8d5e7SWolfgang Denk
14176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
141816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
142016c8d5e7SWolfgang Denk
142116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
142216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
142316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
142416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
142516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
142616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
142716c8d5e7SWolfgang Denk
142816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
142916c8d5e7SWolfgang Denk			Define this string as the name of your company for
143016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
143116c8d5e7SWolfgang Denk
143216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
143316c8d5e7SWolfgang Denk			Define this string as the name of your product
143416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
143516c8d5e7SWolfgang Denk
143616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
143716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
143816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
143916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
144016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
144116c8d5e7SWolfgang Denk
144216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
144316c8d5e7SWolfgang Denk			Define this as the unique Product ID
144416c8d5e7SWolfgang Denk			for your device
144516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1446c609719bSwdenk
1447351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1448351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1449351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1450351e9b20SPrzemyslaw Marczak			This enables function definition:
1451351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1452351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1453351e9b20SPrzemyslaw Marczak
1454d70a560fSIgor Grinberg- ULPI Layer Support:
1455d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1456d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1457d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1458d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1459d70a560fSIgor Grinberg		viewport is supported.
1460d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1461d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14626d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14636d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14646d365ea0SLucas Stach		the appropriate value in Hz.
1465c609719bSwdenk
1466c609719bSwdenk- MMC Support:
1467c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1468c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1469c609719bSwdenk		accessed from the boot prompt by mapping the device
1470c609719bSwdenk		to physical memory similar to flash. Command line is
1471602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1472602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1473c609719bSwdenk
1474afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1475afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1476afb35666SYoshihiro Shimoda
1477afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1478afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1479afb35666SYoshihiro Shimoda
1480afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1481afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1482afb35666SYoshihiro Shimoda
1483b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1484b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1485b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1486b3ba6e94STom Rini
1487b3ba6e94STom Rini		CONFIG_CMD_DFU
1488b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1489b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1490b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1491b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1492b3ba6e94STom Rini
1493b3ba6e94STom Rini		CONFIG_DFU_MMC
1494b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1495b3ba6e94STom Rini
1496c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1497c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1498c6631764SPantelis Antoniou
1499a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1500a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1501a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1502a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1503a9479f04SAfzal Mohammed		one that would help mostly the developer.
1504a9479f04SAfzal Mohammed
1505e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1506e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1507e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1508e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1509e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1510e7e75c70SHeiko Schocher
1511ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1512ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1513ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1514ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1515ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1516ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1517ea2453d5SPantelis Antoniou
15186705d81eSwdenk- Journaling Flash filesystem support:
15196705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15206705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15216705d81eSwdenk		Define these for a default partition on a NAND device
15226705d81eSwdenk
15236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15256705d81eSwdenk		Define these for a default partition on a NOR device
15266705d81eSwdenk
15276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15286705d81eSwdenk		Define this to create an own partition. You have to provide a
15296705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15306705d81eSwdenk
15316705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15336705d81eSwdenk		to disable the command chpart. This is the default when you
15346705d81eSwdenk		have not defined a custom partition
15356705d81eSwdenk
1536c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1537c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1538656f4c65SDonggeun Kim
1539656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1540656f4c65SDonggeun Kim		file in FAT formatted partition.
1541656f4c65SDonggeun Kim
1542656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1543656f4c65SDonggeun Kim		user to write files to FAT.
1544c30a15e5SDonggeun Kim
154584cd9327SGabe BlackCBFS (Coreboot Filesystem) support
154684cd9327SGabe Black		CONFIG_CMD_CBFS
154784cd9327SGabe Black
154884cd9327SGabe Black		Define this to enable support for reading from a Coreboot
154984cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
155084cd9327SGabe Black		and cbfsload.
155184cd9327SGabe Black
1552c609719bSwdenk- Keyboard Support:
1553c609719bSwdenk		CONFIG_ISA_KEYBOARD
1554c609719bSwdenk
1555c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1556c609719bSwdenk		support
1557c609719bSwdenk
1558c609719bSwdenk		CONFIG_I8042_KBD
1559c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1560c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1561c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1562c609719bSwdenk		for cfb_console. Supports cursor blinking.
1563c609719bSwdenk
1564713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1565713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1566713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1567713cb680SHung-ying Tyan		which provides key scans on request.
1568713cb680SHung-ying Tyan
1569c609719bSwdenk- Video support:
1570c609719bSwdenk		CONFIG_VIDEO
1571c609719bSwdenk
1572c609719bSwdenk		Define this to enable video support (for output to
1573c609719bSwdenk		video).
1574c609719bSwdenk
1575c609719bSwdenk		CONFIG_VIDEO_CT69000
1576c609719bSwdenk
1577c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1578c609719bSwdenk
1579c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1580eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1581eeb1b77bSwdenk		video output is selected via environment 'videoout'
1582eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1583eeb1b77bSwdenk		assumed.
1584c609719bSwdenk
1585eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
158611ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1587eeb1b77bSwdenk		are possible:
1588eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1589eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1590eeb1b77bSwdenk
1591eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1592eeb1b77bSwdenk		-------------+---------------------------------------------
1593eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1594eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1595eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1596eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1597eeb1b77bSwdenk		-------------+---------------------------------------------
1598c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1599c609719bSwdenk
1600eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16017817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1602eeb1b77bSwdenk
1603eeb1b77bSwdenk
1604a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1605a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1606a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1607a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1608a6c7ad2fSwdenk
16097d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16107d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16117d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16127d3053fbSTimur Tabi		support, and should also define these other macros:
16137d3053fbSTimur Tabi
16147d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16157d3053fbSTimur Tabi			CONFIG_VIDEO
16167d3053fbSTimur Tabi			CONFIG_CMD_BMP
16177d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16187d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16197d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16207d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16217d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16227d3053fbSTimur Tabi
1623ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1624ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1625ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1626ba8e76bdSTimur Tabi		description of this variable.
16277d3053fbSTimur Tabi
1628058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1629058d59b0SSimon Glass
1630058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1631058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1632058d59b0SSimon Glass		driver.
1633058d59b0SSimon Glass
1634058d59b0SSimon Glass
1635682011ffSwdenk- Keyboard Support:
1636682011ffSwdenk		CONFIG_KEYBOARD
1637682011ffSwdenk
1638682011ffSwdenk		Define this to enable a custom keyboard support.
1639682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1640682011ffSwdenk		defined in your board-specific files.
1641682011ffSwdenk		The only board using this so far is RBC823.
1642a6c7ad2fSwdenk
1643c609719bSwdenk- LCD Support:	CONFIG_LCD
1644c609719bSwdenk
1645c609719bSwdenk		Define this to enable LCD support (for output to LCD
1646c609719bSwdenk		display); also select one of the supported displays
1647c609719bSwdenk		by defining one of these:
1648c609719bSwdenk
164939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
165039cf4804SStelian Pop
165139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
165239cf4804SStelian Pop
1653fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1654c609719bSwdenk
1655fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1656c609719bSwdenk
1657fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1658c609719bSwdenk
1659fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1660fd3103bbSwdenk			Active, color, single scan.
1661fd3103bbSwdenk
1662fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1663fd3103bbSwdenk
1664fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1665c609719bSwdenk			Active, color, single scan.
1666c609719bSwdenk
1667c609719bSwdenk		CONFIG_SHARP_16x9
1668c609719bSwdenk
1669c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1670c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1671c609719bSwdenk
1672c609719bSwdenk		CONFIG_SHARP_LQ64D341
1673c609719bSwdenk
1674c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1675c609719bSwdenk			Active, color, single scan.
1676c609719bSwdenk
1677c609719bSwdenk		CONFIG_HLD1045
1678c609719bSwdenk
1679c609719bSwdenk			HLD1045 display, 640x480.
1680c609719bSwdenk			Active, color, single scan.
1681c609719bSwdenk
1682c609719bSwdenk		CONFIG_OPTREX_BW
1683c609719bSwdenk
1684c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1685c609719bSwdenk			or
1686c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1687c609719bSwdenk			or
1688c609719bSwdenk			Hitachi	 SP14Q002
1689c609719bSwdenk
1690c609719bSwdenk			320x240. Black & white.
1691c609719bSwdenk
1692c609719bSwdenk		Normally display is black on white background; define
16936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1694c609719bSwdenk
1695676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1696676d319eSSimon Glass
1697676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1698676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1699676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1700676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1701676d319eSSimon Glass		a per-section basis.
1702676d319eSSimon Glass
17030d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17040d89efefSSimon Glass
17050d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17060d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17070d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17080d89efefSSimon Glass		is slow.
1709676d319eSSimon Glass
171045d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
171145d7f525STom Wai-Hong Tam
171245d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
171345d7f525STom Wai-Hong Tam
1714735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1715735987c5STom Wai-Hong Tam
1716735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1717735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1718735987c5STom Wai-Hong Tam
17197152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1720d791b1dcSwdenk
1721d791b1dcSwdenk		If this option is set, the environment is checked for
1722d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1723d791b1dcSwdenk		of logo, copyright and system information on the LCD
1724e94d2cd9Swdenk		is suppressed and the BMP image at the address
1725d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1726d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1727d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1728d791b1dcSwdenk		loaded very quickly after power-on.
1729d791b1dcSwdenk
1730c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1731c0880485SNikita Kiryanov
1732c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1733c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1734c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1735c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1736c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1737c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1738c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1739c0880485SNikita Kiryanov		there is no need to set this option.
1740c0880485SNikita Kiryanov
17411ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17421ca298ceSMatthias Weisser
17431ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17441ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17451ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17461ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17471ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17481ca298ceSMatthias Weisser		specify 'm' for centering the image.
17491ca298ceSMatthias Weisser
17501ca298ceSMatthias Weisser		Example:
17511ca298ceSMatthias Weisser		setenv splashpos m,m
17521ca298ceSMatthias Weisser			=> image at center of screen
17531ca298ceSMatthias Weisser
17541ca298ceSMatthias Weisser		setenv splashpos 30,20
17551ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17561ca298ceSMatthias Weisser
17571ca298ceSMatthias Weisser		setenv splashpos -10,m
17581ca298ceSMatthias Weisser			=> vertically centered image
17591ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17601ca298ceSMatthias Weisser
176198f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
176298f4a3dfSStefan Roese
176398f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
176498f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
176598f4a3dfSStefan Roese		splashscreen support or the bmp command.
176698f4a3dfSStefan Roese
1767d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1768d5011762SAnatolij Gustschin
1769d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1770d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1771d5011762SAnatolij Gustschin		bmp command.
1772d5011762SAnatolij Gustschin
1773f2b96dfbSLei Wen- Do compresssing for memory range:
1774f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1775f2b96dfbSLei Wen
1776f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1777f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1778f2b96dfbSLei Wen
1779c29fdfc1Swdenk- Compression support:
17808ef70478SKees Cook		CONFIG_GZIP
17818ef70478SKees Cook
17828ef70478SKees Cook		Enabled by default to support gzip compressed images.
17838ef70478SKees Cook
1784c29fdfc1Swdenk		CONFIG_BZIP2
1785c29fdfc1Swdenk
1786c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1787c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1788c29fdfc1Swdenk		compressed images are supported.
1789c29fdfc1Swdenk
1790c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
17916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1792c29fdfc1Swdenk		be at least 4MB.
1793d791b1dcSwdenk
1794fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1795fc9c1727SLuigi 'Comio' Mantellini
1796fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1797fc9c1727SLuigi 'Comio' Mantellini		images is included.
1798fc9c1727SLuigi 'Comio' Mantellini
1799fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1800fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1801fc9c1727SLuigi 'Comio' Mantellini		formula:
1802fc9c1727SLuigi 'Comio' Mantellini
1803fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1804fc9c1727SLuigi 'Comio' Mantellini
1805fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1806fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1807fc9c1727SLuigi 'Comio' Mantellini
1808fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1809fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1810fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1811fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1812fc9c1727SLuigi 'Comio' Mantellini
1813fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1814fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1816fc9c1727SLuigi 'Comio' Mantellini
18178ef70478SKees Cook		CONFIG_LZO
18188ef70478SKees Cook
18198ef70478SKees Cook		If this option is set, support for LZO compressed images
18208ef70478SKees Cook		is included.
18218ef70478SKees Cook
182217ea1177Swdenk- MII/PHY support:
182317ea1177Swdenk		CONFIG_PHY_ADDR
182417ea1177Swdenk
182517ea1177Swdenk		The address of PHY on MII bus.
182617ea1177Swdenk
182717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
182817ea1177Swdenk
182917ea1177Swdenk		The clock frequency of the MII bus
183017ea1177Swdenk
183117ea1177Swdenk		CONFIG_PHY_GIGE
183217ea1177Swdenk
183317ea1177Swdenk		If this option is set, support for speed/duplex
183411ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
183517ea1177Swdenk
183617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
183717ea1177Swdenk
183817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
183917ea1177Swdenk		reset before any MII register access is possible.
184017ea1177Swdenk		For such PHY, set this option to the usec delay
184117ea1177Swdenk		required. (minimum 300usec for LXT971A)
184217ea1177Swdenk
184317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
184417ea1177Swdenk
184517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
184617ea1177Swdenk		command issued before MII status register can be read
184717ea1177Swdenk
1848c609719bSwdenk- Ethernet address:
1849c609719bSwdenk		CONFIG_ETHADDR
1850c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1851c609719bSwdenk		CONFIG_ETH2ADDR
1852c609719bSwdenk		CONFIG_ETH3ADDR
1853c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1854c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1855c609719bSwdenk
185611ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
185711ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1858c609719bSwdenk		is not determined automatically.
1859c609719bSwdenk
1860c609719bSwdenk- IP address:
1861c609719bSwdenk		CONFIG_IPADDR
1862c609719bSwdenk
1863c609719bSwdenk		Define a default value for the IP address to use for
186411ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1865c609719bSwdenk		determined through e.g. bootp.
18661ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1867c609719bSwdenk
1868c609719bSwdenk- Server IP address:
1869c609719bSwdenk		CONFIG_SERVERIP
1870c609719bSwdenk
1871c609719bSwdenk		Defines a default value for the IP address of a TFTP
1872c609719bSwdenk		server to contact when using the "tftboot" command.
18731ebcd654SWolfgang Denk		(Environment variable "serverip")
1874c609719bSwdenk
187597cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
187697cfe861SRobin Getz
187797cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
187897cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
187997cfe861SRobin Getz
18801ebcd654SWolfgang Denk- Gateway IP address:
18811ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18821ebcd654SWolfgang Denk
18831ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18841ebcd654SWolfgang Denk		default router where packets to other networks are
18851ebcd654SWolfgang Denk		sent to.
18861ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18871ebcd654SWolfgang Denk
18881ebcd654SWolfgang Denk- Subnet mask:
18891ebcd654SWolfgang Denk		CONFIG_NETMASK
18901ebcd654SWolfgang Denk
18911ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
18921ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
18931ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
18941ebcd654SWolfgang Denk		forwarded through a router.
18951ebcd654SWolfgang Denk		(Environment variable "netmask")
18961ebcd654SWolfgang Denk
189753a5c424SDavid Updegraff- Multicast TFTP Mode:
189853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
189953a5c424SDavid Updegraff
190053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
190153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
190211ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
190353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
190453a5c424SDavid Updegraff		multicast group.
190553a5c424SDavid Updegraff
1906c609719bSwdenk- BOOTP Recovery Mode:
1907c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1908c609719bSwdenk
1909c609719bSwdenk		If you have many targets in a network that try to
1910c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1911c609719bSwdenk		systems send out BOOTP requests at precisely the same
1912c609719bSwdenk		moment (which would happen for instance at recovery
1913c609719bSwdenk		from a power failure, when all systems will try to
1914c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1915c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1916c609719bSwdenk		inserted before sending out BOOTP requests. The
19176c33c785SWolfgang Denk		following delays are inserted then:
1918c609719bSwdenk
1919c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1920c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1921c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1922c609719bSwdenk		4th and following
1923c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1924c609719bSwdenk
1925fe389a82Sstroese- DHCP Advanced Options:
19261fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19271fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1928fe389a82Sstroese
19291fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19301fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19311fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19321fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19331fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19341fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19351fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19361fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19371fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19381fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19391fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19401fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19412c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1942fe389a82Sstroese
19435d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19445d110f0aSWilson Callan		environment variable, not the BOOTP server.
1945fe389a82Sstroese
19462c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19472c00e099SJoe Hershberger		after the configured retry count, the call will fail
19482c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19492c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19502c00e099SJoe Hershberger		is not available.
19512c00e099SJoe Hershberger
1952fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1953fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1954fe389a82Sstroese		than one DNS serverip is offered to the client.
1955fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1956fe389a82Sstroese		serverip will be stored in the additional environment
1957fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1958fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19591fe80d79SJon Loeliger		is defined.
1960fe389a82Sstroese
1961fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1962fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1963fe389a82Sstroese		need the hostname of the DHCP requester.
19645d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
19651fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
19661fe80d79SJon Loeliger		option 12 to the DHCP server.
1967fe389a82Sstroese
1968d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1969d9a2f416SAras Vaichas
1970d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1971d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1972d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1973d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1974d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1975d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1976d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1977d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1978d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1979d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1980d9a2f416SAras Vaichas		this delay.
1981d9a2f416SAras Vaichas
1982d22c338eSJoe Hershberger - Link-local IP address negotiation:
1983d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1984d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1985d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1986d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1987d22c338eSJoe Hershberger
1988d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1989d22c338eSJoe Hershberger
1990a3d991bdSwdenk - CDP Options:
1991a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1992a3d991bdSwdenk
1993a3d991bdSwdenk		The device id used in CDP trigger frames.
1994a3d991bdSwdenk
1995a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1996a3d991bdSwdenk
1997a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1998a3d991bdSwdenk		of the device.
1999a3d991bdSwdenk
2000a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2001a3d991bdSwdenk
2002a3d991bdSwdenk		A printf format string which contains the ascii name of
2003a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
200411ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2005a3d991bdSwdenk
2006a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2007a3d991bdSwdenk
2008a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2009a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2010a3d991bdSwdenk
2011a3d991bdSwdenk		CONFIG_CDP_VERSION
2012a3d991bdSwdenk
2013a3d991bdSwdenk		An ascii string containing the version of the software.
2014a3d991bdSwdenk
2015a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2016a3d991bdSwdenk
2017a3d991bdSwdenk		An ascii string containing the name of the platform.
2018a3d991bdSwdenk
2019a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2020a3d991bdSwdenk
2021a3d991bdSwdenk		A 32bit integer sent on the trigger.
2022a3d991bdSwdenk
2023a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2024a3d991bdSwdenk
2025a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2026a3d991bdSwdenk		device in .1 of milliwatts.
2027a3d991bdSwdenk
2028a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2029a3d991bdSwdenk
2030a3d991bdSwdenk		A byte containing the id of the VLAN.
2031a3d991bdSwdenk
2032c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2033c609719bSwdenk
2034c609719bSwdenk		Several configurations allow to display the current
2035c609719bSwdenk		status using a LED. For instance, the LED will blink
2036c609719bSwdenk		fast while running U-Boot code, stop blinking as
2037c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2038c609719bSwdenk		start blinking slow once the Linux kernel is running
2039c609719bSwdenk		(supported by a status LED driver in the Linux
2040c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2041c609719bSwdenk		feature in U-Boot.
2042c609719bSwdenk
20431df7bbbaSIgor Grinberg		Additional options:
20441df7bbbaSIgor Grinberg
20451df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20461df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20471df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20481df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20491df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20501df7bbbaSIgor Grinberg
20519dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20529dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20539dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20549dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20559dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20569dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20579dfdcdfeSIgor Grinberg
2058c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2059c609719bSwdenk
2060c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2061c609719bSwdenk		on those systems that support this (optional)
2062c609719bSwdenk		feature, like the TQM8xxL modules.
2063c609719bSwdenk
20643f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2065c609719bSwdenk
20663f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
20673f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
20683f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
20693f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
20703f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
20713f4978c7SHeiko Schocher		interface.
20723f4978c7SHeiko Schocher
20733f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2074ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2075ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2076ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2077ea818dbbSHeiko Schocher		    for defining speed and slave address
2078ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2079ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2080ea818dbbSHeiko Schocher		    for defining speed and slave address
2081ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2082ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2083ea818dbbSHeiko Schocher		    for defining speed and slave address
2084ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2085ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2086ea818dbbSHeiko Schocher		    for defining speed and slave address
20873f4978c7SHeiko Schocher
208800f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
208900f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
209000f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
209100f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
209200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
209300f792e0SHeiko Schocher		    bus.
209400f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
209500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
209600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
209700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
209800f792e0SHeiko Schocher		    second bus.
209900f792e0SHeiko Schocher
21001f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21011f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21021f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21031f2ba722SSimon Glass		    100000 and the slave addr 0!
21041f2ba722SSimon Glass
2105880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2106880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2107880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2108880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2109880540deSDirk Eibach
2110fac96408Strem		- drivers/i2c/i2c_mxc.c
2111fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2112fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2113fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2114fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2115fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2116fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2117fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2118fac96408Strem		If thoses defines are not set, default value is 100000
2119fac96408Strem		for speed, and 0 for slave.
2120fac96408Strem
21211086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21221086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21231086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21241086bfa9SNobuhiro Iwamatsu
21251086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21261086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21271086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21281086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21291086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21301086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21311086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21321086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21331086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21341086bfa9SNobuhiro Iwamatsu
21352035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21362035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21372035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21382035d77dSNobuhiro Iwamatsu
21392035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21402035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21412035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21422035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21432035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21442035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21452035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21462035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21472035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21482035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21492035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21502035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21512035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21522035d77dSNobuhiro Iwamatsu
21536789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21546789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21556789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21566789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21576789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21586789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21596789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21606789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21616789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
21626789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
21636789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
21646789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
21656789e84eSHeiko Schocher
21660bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
21670bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
21680bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
21690bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
21700bdffe71SHeiko Schocher
2171e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2172e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2173e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2174e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2175e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2176e717fc6dSNaveen Krishna Ch
21773f4978c7SHeiko Schocher		additional defines:
21783f4978c7SHeiko Schocher
21793f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
21803f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
21813f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
21823f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
21833f4978c7SHeiko Schocher		omit this define.
21843f4978c7SHeiko Schocher
21853f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
21863f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
21873f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
21883f4978c7SHeiko Schocher		omit this define.
21893f4978c7SHeiko Schocher
21903f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
21913f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
21923f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
21933f4978c7SHeiko Schocher		define.
21943f4978c7SHeiko Schocher
21953f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
21963f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
21973f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
21983f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
21993f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22003f4978c7SHeiko Schocher
22013f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22023f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22033f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22043f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22053f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22063f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22073f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22083f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22093f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22103f4978c7SHeiko Schocher					}
22113f4978c7SHeiko Schocher
22123f4978c7SHeiko Schocher		which defines
22133f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2214ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2215ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2216ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2217ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2218ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22193f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2220ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2221ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22223f4978c7SHeiko Schocher
22233f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22243f4978c7SHeiko Schocher
2225ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22263f4978c7SHeiko Schocher
22273f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22283f4978c7SHeiko Schocher		provides the following compelling advantages:
22293f4978c7SHeiko Schocher
22303f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22313f4978c7SHeiko Schocher		- approved multibus support
22323f4978c7SHeiko Schocher		- better i2c mux support
22333f4978c7SHeiko Schocher
22343f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22353f4978c7SHeiko Schocher
2236ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2237ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2238ea818dbbSHeiko Schocher		for the selected CPU.
2239c609719bSwdenk
2240b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2241602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2242b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2243b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2244c609719bSwdenk		command line interface.
2245c609719bSwdenk
2246bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2247c609719bSwdenk
2248b37c7e5eSwdenk		There are several other quantities that must also be
2249ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2250c609719bSwdenk
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2252b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
225411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2255c609719bSwdenk
22568d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2257a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22588d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22598d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22608d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2261b37c7e5eSwdenk
22625da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
22635da71efaSEric Millbrandt
22645da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
22655da71efaSEric Millbrandt		chips might think that the current transfer is still
22665da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
22675da71efaSEric Millbrandt		commands until the slave device responds.
22685da71efaSEric Millbrandt
2269b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2270b37c7e5eSwdenk
2271ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2272b37c7e5eSwdenk		then the following macros need to be defined (examples are
2273b37c7e5eSwdenk		from include/configs/lwmon.h):
2274c609719bSwdenk
2275c609719bSwdenk		I2C_INIT
2276c609719bSwdenk
2277b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2278c609719bSwdenk		controller or configure ports.
2279c609719bSwdenk
2280b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2281b37c7e5eSwdenk
2282c609719bSwdenk		I2C_PORT
2283c609719bSwdenk
2284c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2285c609719bSwdenk		assumes both bits are on the same port). Valid values
2286c609719bSwdenk		are 0..3 for ports A..D.
2287c609719bSwdenk
2288c609719bSwdenk		I2C_ACTIVE
2289c609719bSwdenk
2290c609719bSwdenk		The code necessary to make the I2C data line active
2291c609719bSwdenk		(driven).  If the data line is open collector, this
2292c609719bSwdenk		define can be null.
2293c609719bSwdenk
2294b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2295b37c7e5eSwdenk
2296c609719bSwdenk		I2C_TRISTATE
2297c609719bSwdenk
2298c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2299c609719bSwdenk		(inactive).  If the data line is open collector, this
2300c609719bSwdenk		define can be null.
2301c609719bSwdenk
2302b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2303b37c7e5eSwdenk
2304c609719bSwdenk		I2C_READ
2305c609719bSwdenk
2306472d5460SYork Sun		Code that returns true if the I2C data line is high,
2307472d5460SYork Sun		false if it is low.
2308c609719bSwdenk
2309b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2310b37c7e5eSwdenk
2311c609719bSwdenk		I2C_SDA(bit)
2312c609719bSwdenk
2313472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2314472d5460SYork Sun		is false, it clears it (low).
2315c609719bSwdenk
2316b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2317b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2318b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2319b37c7e5eSwdenk
2320c609719bSwdenk		I2C_SCL(bit)
2321c609719bSwdenk
2322472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2323472d5460SYork Sun		is false, it clears it (low).
2324c609719bSwdenk
2325b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2326b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2327b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2328b37c7e5eSwdenk
2329c609719bSwdenk		I2C_DELAY
2330c609719bSwdenk
2331c609719bSwdenk		This delay is invoked four times per clock cycle so this
2332c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2333b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2334b37c7e5eSwdenk		like:
2335b37c7e5eSwdenk
2336b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2337c609719bSwdenk
2338793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2339793b5726SMike Frysinger
2340793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2341793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2342793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2343793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2344793b5726SMike Frysinger
2345793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2346793b5726SMike Frysinger		the generic GPIO functions.
2347793b5726SMike Frysinger
23486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
234947cd00faSwdenk
235047cd00faSwdenk		When a board is reset during an i2c bus transfer
235147cd00faSwdenk		chips might think that the current transfer is still
235247cd00faSwdenk		in progress. On some boards it is possible to access
235347cd00faSwdenk		the i2c SCLK line directly, either by using the
235447cd00faSwdenk		processor pin as a GPIO or by having a second pin
235547cd00faSwdenk		connected to the bus. If this option is defined a
235647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
235747cd00faSwdenk		is run early in the boot sequence.
235847cd00faSwdenk
235926a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
236026a33504SRichard Retanubun
236126a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
236226a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
236326a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
236426a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
236526a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
236626a33504SRichard Retanubun		controller provide such a method. It is called at the end of
236726a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
236826a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
236926a33504SRichard Retanubun
237017ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
237117ea1177Swdenk
237217ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
237317ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
237417ea1177Swdenk		variable "i2cfast". (see also i2cfast)
237517ea1177Swdenk
2376bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2377bb99ad6dSBen Warren
2378bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2379bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2380bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2381bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2382bb99ad6dSBen Warren
23836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2384bb99ad6dSBen Warren
2385bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
23860f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
23870f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
23880f89c54bSPeter Tyser		a 1D array of device addresses
2389bb99ad6dSBen Warren
2390bb99ad6dSBen Warren		e.g.
2391bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
23926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2393bb99ad6dSBen Warren
2394bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2395bb99ad6dSBen Warren
2396bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2398bb99ad6dSBen Warren
2399bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2400bb99ad6dSBen Warren
24016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2402be5e6181STimur Tabi
2403be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2404be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2405be5e6181STimur Tabi
24066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24070dc018ecSStefan Roese
24080dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24090dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24100dc018ecSStefan Roese
24116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24120dc018ecSStefan Roese
24130dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24140dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24150dc018ecSStefan Roese
24166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24179ebbb54fSVictor Gallardo
24189ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24199ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24209ebbb54fSVictor Gallardo		specified DTT device.
24219ebbb54fSVictor Gallardo
24222ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24232ac6985aSAndrew Dyer
24242ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24252ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24262ac6985aSAndrew Dyer		between writing the address pointer and reading the
24272ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24282ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24292ac6985aSAndrew Dyer		devices can use either method, but some require one or
24302ac6985aSAndrew Dyer		the other.
2431be5e6181STimur Tabi
2432c609719bSwdenk- SPI Support:	CONFIG_SPI
2433c609719bSwdenk
2434c609719bSwdenk		Enables SPI driver (so far only tested with
2435c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2436c609719bSwdenk		D/As on the SACSng board)
2437c609719bSwdenk
24386639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24396639562eSYoshihiro Shimoda
24406639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24416639562eSYoshihiro Shimoda		only SH7757 is supported.
24426639562eSYoshihiro Shimoda
2443c609719bSwdenk		CONFIG_SPI_X
2444c609719bSwdenk
2445c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2446c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2447c609719bSwdenk
2448c609719bSwdenk		CONFIG_SOFT_SPI
2449c609719bSwdenk
2450c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2451c609719bSwdenk		using hardware support. This is a general purpose
2452c609719bSwdenk		driver that only requires three general I/O port pins
2453c609719bSwdenk		(two outputs, one input) to function. If this is
2454c609719bSwdenk		defined, the board configuration must define several
2455c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2456c609719bSwdenk		an example, see include/configs/sacsng.h.
2457c609719bSwdenk
245804a9e118SBen Warren		CONFIG_HARD_SPI
245904a9e118SBen Warren
246004a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
246104a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
246204a9e118SBen Warren		must define a list of chip-select function pointers.
246304a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
246404a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
246504a9e118SBen Warren
246638254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
246738254f45SGuennadi Liakhovetski
246838254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
24692e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
247038254f45SGuennadi Liakhovetski
24710133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
24720133502eSMatthias Fuchs
24730133502eSMatthias Fuchs		Enables FPGA subsystem.
24740133502eSMatthias Fuchs
24750133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
24760133502eSMatthias Fuchs
24770133502eSMatthias Fuchs		Enables support for specific chip vendors.
24780133502eSMatthias Fuchs		(ALTERA, XILINX)
24790133502eSMatthias Fuchs
24800133502eSMatthias Fuchs		CONFIG_FPGA_<family>
24810133502eSMatthias Fuchs
24820133502eSMatthias Fuchs		Enables support for FPGA family.
24830133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
24840133502eSMatthias Fuchs
24850133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2486c609719bSwdenk
2487c609719bSwdenk		Specify the number of FPGA devices to support.
2488c609719bSwdenk
24896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2490c609719bSwdenk
2491c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2492c609719bSwdenk
24936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2494c609719bSwdenk
2495c609719bSwdenk		Enable checks on FPGA configuration interface busy
2496c609719bSwdenk		status by the configuration function. This option
2497c609719bSwdenk		will require a board or device specific function to
2498c609719bSwdenk		be written.
2499c609719bSwdenk
2500c609719bSwdenk		CONFIG_FPGA_DELAY
2501c609719bSwdenk
2502c609719bSwdenk		If defined, a function that provides delays in the FPGA
2503c609719bSwdenk		configuration driver.
2504c609719bSwdenk
25056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2506c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2507c609719bSwdenk
25086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2509c609719bSwdenk
2510c609719bSwdenk		Check for configuration errors during FPGA bitfile
2511c609719bSwdenk		loading. For example, abort during Virtex II
2512c609719bSwdenk		configuration if the INIT_B line goes low (which
2513c609719bSwdenk		indicated a CRC error).
2514c609719bSwdenk
25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2516c609719bSwdenk
2517c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2518c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2519c609719bSwdenk		FPGA configuration sequence. The default time is 500
252011ccc33fSMarcel Ziswiler		ms.
2521c609719bSwdenk
25226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2523c609719bSwdenk
2524c609719bSwdenk		Maximum time to wait for BUSY to deassert during
252511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2526c609719bSwdenk
25276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2528c609719bSwdenk
2529c609719bSwdenk		Time to wait after FPGA configuration. The default is
253011ccc33fSMarcel Ziswiler		200 ms.
2531c609719bSwdenk
2532c609719bSwdenk- Configuration Management:
2533c609719bSwdenk		CONFIG_IDENT_STRING
2534c609719bSwdenk
2535c609719bSwdenk		If defined, this string will be added to the U-Boot
2536c609719bSwdenk		version information (U_BOOT_VERSION)
2537c609719bSwdenk
2538c609719bSwdenk- Vendor Parameter Protection:
2539c609719bSwdenk
2540c609719bSwdenk		U-Boot considers the values of the environment
2541c609719bSwdenk		variables "serial#" (Board Serial Number) and
25427152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2543c609719bSwdenk		are set once by the board vendor / manufacturer, and
2544c609719bSwdenk		protects these variables from casual modification by
2545c609719bSwdenk		the user. Once set, these variables are read-only,
2546c609719bSwdenk		and write or delete attempts are rejected. You can
254711ccc33fSMarcel Ziswiler		change this behaviour:
2548c609719bSwdenk
2549c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2550c609719bSwdenk		file, the write protection for vendor parameters is
255147cd00faSwdenk		completely disabled. Anybody can change or delete
2552c609719bSwdenk		these parameters.
2553c609719bSwdenk
2554c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2555c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
255611ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2557c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2558c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2559c609719bSwdenk		read-only.]
2560c609719bSwdenk
25612598090bSJoe Hershberger		The same can be accomplished in a more flexible way
25622598090bSJoe Hershberger		for any variable by configuring the type of access
25632598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
25642598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
25652598090bSJoe Hershberger
2566c609719bSwdenk- Protected RAM:
2567c609719bSwdenk		CONFIG_PRAM
2568c609719bSwdenk
2569c609719bSwdenk		Define this variable to enable the reservation of
2570c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2571c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2572c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2573c609719bSwdenk		this default value by defining an environment
2574c609719bSwdenk		variable "pram" to the number of kB you want to
2575c609719bSwdenk		reserve. Note that the board info structure will
2576c609719bSwdenk		still show the full amount of RAM. If pRAM is
2577c609719bSwdenk		reserved, a new environment variable "mem" will
2578c609719bSwdenk		automatically be defined to hold the amount of
2579c609719bSwdenk		remaining RAM in a form that can be passed as boot
2580c609719bSwdenk		argument to Linux, for instance like that:
2581c609719bSwdenk
2582fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2583c609719bSwdenk			saveenv
2584c609719bSwdenk
2585c609719bSwdenk		This way you can tell Linux not to use this memory,
2586c609719bSwdenk		either, which results in a memory region that will
2587c609719bSwdenk		not be affected by reboots.
2588c609719bSwdenk
2589c609719bSwdenk		*WARNING* If your board configuration uses automatic
2590c609719bSwdenk		detection of the RAM size, you must make sure that
2591c609719bSwdenk		this memory test is non-destructive. So far, the
2592c609719bSwdenk		following board configurations are known to be
2593c609719bSwdenk		"pRAM-clean":
2594c609719bSwdenk
25951b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
25961b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2597544d97e9SWolfgang Denk			FLAGADM, TQM8260
2598c609719bSwdenk
259940fef049SGabe Black- Access to physical memory region (> 4GB)
260040fef049SGabe Black		Some basic support is provided for operations on memory not
260140fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
260240fef049SGabe Black		support access to more than 4GB of memory on 32-bit
260340fef049SGabe Black		machines using physical address extension or similar.
260440fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
260540fef049SGabe Black		currently only supports clearing the memory.
260640fef049SGabe Black
2607c609719bSwdenk- Error Recovery:
2608c609719bSwdenk		CONFIG_PANIC_HANG
2609c609719bSwdenk
2610c609719bSwdenk		Define this variable to stop the system in case of a
2611c609719bSwdenk		fatal error, so that you have to reset it manually.
2612c609719bSwdenk		This is probably NOT a good idea for an embedded
261311ccc33fSMarcel Ziswiler		system where you want the system to reboot
2614c609719bSwdenk		automatically as fast as possible, but it may be
2615c609719bSwdenk		useful during development since you can try to debug
2616c609719bSwdenk		the conditions that lead to the situation.
2617c609719bSwdenk
2618c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2619c609719bSwdenk
2620c609719bSwdenk		This variable defines the number of retries for
2621c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2622c609719bSwdenk		before giving up the operation. If not defined, a
2623c609719bSwdenk		default value of 5 is used.
2624c609719bSwdenk
262540cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
262640cb90eeSGuennadi Liakhovetski
262740cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
262840cb90eeSGuennadi Liakhovetski
262948a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
263048a3e999STetsuyuki Kobayashi
263148a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
263248a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
263348a3e999STetsuyuki Kobayashi		try longer timeout such as
263448a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
263548a3e999STetsuyuki Kobayashi
2636c609719bSwdenk- Command Interpreter:
26378078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
263804a85b3bSwdenk
263904a85b3bSwdenk		Enable auto completion of commands using TAB.
264004a85b3bSwdenk
26418078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26428078f1a5SWolfgang Denk		for the "hush" shell.
26438078f1a5SWolfgang Denk
26448078f1a5SWolfgang Denk
26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2646c609719bSwdenk
2647c609719bSwdenk		Define this variable to enable the "hush" shell (from
2648c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2649c609719bSwdenk		powerful command line syntax like
2650c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2651c609719bSwdenk		constructs ("shell scripts").
2652c609719bSwdenk
2653c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2654c609719bSwdenk		with a somewhat smaller memory footprint.
2655c609719bSwdenk
2656c609719bSwdenk
26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2658c609719bSwdenk
2659c609719bSwdenk		This defines the secondary prompt string, which is
2660c609719bSwdenk		printed when the command interpreter needs more input
2661c609719bSwdenk		to complete a command. Usually "> ".
2662c609719bSwdenk
2663c609719bSwdenk	Note:
2664c609719bSwdenk
2665c609719bSwdenk		In the current implementation, the local variables
2666c609719bSwdenk		space and global environment variables space are
2667c609719bSwdenk		separated. Local variables are those you define by
26683b57fe0aSwdenk		simply typing `name=value'. To access a local
2669c609719bSwdenk		variable later on, you have write `$name' or
26703b57fe0aSwdenk		`${name}'; to execute the contents of a variable
26713b57fe0aSwdenk		directly type `$name' at the command prompt.
2672c609719bSwdenk
2673c609719bSwdenk		Global environment variables are those you use
2674c609719bSwdenk		setenv/printenv to work with. To run a command stored
2675c609719bSwdenk		in such a variable, you need to use the run command,
2676c609719bSwdenk		and you must not use the '$' sign to access them.
2677c609719bSwdenk
2678c609719bSwdenk		To store commands and special characters in a
2679c609719bSwdenk		variable, please use double quotation marks
2680c609719bSwdenk		surrounding the whole text of the variable, instead
2681c609719bSwdenk		of the backslashes before semicolons and special
2682c609719bSwdenk		symbols.
2683c609719bSwdenk
2684aa0c71acSWolfgang Denk- Commandline Editing and History:
2685aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2686aa0c71acSWolfgang Denk
268711ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2688aa0c71acSWolfgang Denk		commandline input operations
2689aa0c71acSWolfgang Denk
2690a8c7c708Swdenk- Default Environment:
2691c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2692c609719bSwdenk
2693c609719bSwdenk		Define this to contain any number of null terminated
2694c609719bSwdenk		strings (variable = value pairs) that will be part of
26957152b1d0Swdenk		the default environment compiled into the boot image.
26962262cfeeSwdenk
2697c609719bSwdenk		For example, place something like this in your
2698c609719bSwdenk		board's config file:
2699c609719bSwdenk
2700c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2701c609719bSwdenk			"myvar1=value1\0" \
2702c609719bSwdenk			"myvar2=value2\0"
2703c609719bSwdenk
2704c609719bSwdenk		Warning: This method is based on knowledge about the
2705c609719bSwdenk		internal format how the environment is stored by the
27062262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2707c609719bSwdenk		interface! Although it is unlikely that this format
27087152b1d0Swdenk		will change soon, there is no guarantee either.
2709c609719bSwdenk		You better know what you are doing here.
2710c609719bSwdenk
2711c609719bSwdenk		Note: overly (ab)use of the default environment is
2712c609719bSwdenk		discouraged. Make sure to check other ways to preset
271374de7aefSWolfgang Denk		the environment like the "source" command or the
2714c609719bSwdenk		boot command first.
2715c609719bSwdenk
27165e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27175e724ca2SStephen Warren
27185e724ca2SStephen Warren		Define this in order to add variables describing the
27195e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27205e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27215e724ca2SStephen Warren
27225e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27235e724ca2SStephen Warren
27245e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27255e724ca2SStephen Warren		- CONFIG_SYS_CPU
27265e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27275e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27285e724ca2SStephen Warren		- CONFIG_SYS_SOC
27295e724ca2SStephen Warren
27307e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27317e27f89fSTom Rini
27327e27f89fSTom Rini		Define this in order to add variables describing certain
27337e27f89fSTom Rini		run-time determined information about the hardware to the
27347e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27357e27f89fSTom Rini
273606fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
273706fd8538SSimon Glass
273806fd8538SSimon Glass		Normally the environment is loaded when the board is
273906fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
274006fd8538SSimon Glass		that so that the environment is not available until
274106fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
274206fd8538SSimon Glass		this is instead controlled by the value of
274306fd8538SSimon Glass		/config/load-environment.
274406fd8538SSimon Glass
2745a8c7c708Swdenk- DataFlash Support:
27462abbe075Swdenk		CONFIG_HAS_DATAFLASH
27472abbe075Swdenk
27482abbe075Swdenk		Defining this option enables DataFlash features and
27492abbe075Swdenk		allows to read/write in Dataflash via the standard
27502abbe075Swdenk		commands cp, md...
27512abbe075Swdenk
2752f61ec45eSEric Nelson- Serial Flash support
2753f61ec45eSEric Nelson		CONFIG_CMD_SF
2754f61ec45eSEric Nelson
2755f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2756f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2757f61ec45eSEric Nelson
2758f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2759f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2760f61ec45eSEric Nelson		commands.
2761f61ec45eSEric Nelson
2762f61ec45eSEric Nelson		The following defaults may be provided by the platform
2763f61ec45eSEric Nelson		to handle the common case when only a single serial
2764f61ec45eSEric Nelson		flash is present on the system.
2765f61ec45eSEric Nelson
2766f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2767f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2768f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2769f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2770f61ec45eSEric Nelson
277124007273SSimon Glass		CONFIG_CMD_SF_TEST
277224007273SSimon Glass
277324007273SSimon Glass		Define this option to include a destructive SPI flash
277424007273SSimon Glass		test ('sf test').
277524007273SSimon Glass
27761dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
27771dcd6d03SJagannadha Sutradharudu Teki
27781dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
27791dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
27801dcd6d03SJagannadha Sutradharudu Teki
2781b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2782b902e07cSJagannadha Sutradharudu Teki
2783b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2784b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2785b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2786b902e07cSJagannadha Sutradharudu Teki
27873f85ce27Swdenk- SystemACE Support:
27883f85ce27Swdenk		CONFIG_SYSTEMACE
27893f85ce27Swdenk
27903f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
27913f85ce27Swdenk		chips attached via some sort of local bus. The address
279211ccc33fSMarcel Ziswiler		of the chip must also be defined in the
27936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
27943f85ce27Swdenk
27953f85ce27Swdenk		#define CONFIG_SYSTEMACE
27966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
27973f85ce27Swdenk
27983f85ce27Swdenk		When SystemACE support is added, the "ace" device type
27993f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28003f85ce27Swdenk
2801ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2802ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2803ecb0ccd9SWolfgang Denk
280428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2805ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
280628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2807ecb0ccd9SWolfgang Denk		number generator is used.
2808ecb0ccd9SWolfgang Denk
280928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
281028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
281128cb9375SWolfgang Denk		defined, the normal port 69 is used.
281228cb9375SWolfgang Denk
281328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2814ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2815ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2816ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2817ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2818ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2819ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2820ecb0ccd9SWolfgang Denk
2821bf36c5d5SSimon Glass- Hashing support:
2822bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2823bf36c5d5SSimon Glass
2824bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2825bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2826bf36c5d5SSimon Glass
2827bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2828bf36c5d5SSimon Glass
2829bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2830bf36c5d5SSimon Glass		size a little.
2831bf36c5d5SSimon Glass
2832bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2833bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2834bf36c5d5SSimon Glass
2835bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2836bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2837bf36c5d5SSimon Glass
2838a11f1873SRobert Winkler- Freescale i.MX specific commands:
2839a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2840a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2841a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2842a11f1873SRobert Winkler
2843a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2844a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2845a11f1873SRobert Winkler		a boot from specific media.
2846a11f1873SRobert Winkler
2847a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2848a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2849a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2850a11f1873SRobert Winkler		will set it back to normal.  This command currently
2851a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2852a11f1873SRobert Winkler
285319c402afSSimon Glass- Signing support:
285419c402afSSimon Glass		CONFIG_RSA
285519c402afSSimon Glass
285619c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
28578bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
285819c402afSSimon Glass
285919c402afSSimon Glass		The signing part is build into mkimage regardless of this
286019c402afSSimon Glass		option.
286119c402afSSimon Glass
28629e50c406SHeiko Schocher- bootcount support:
28639e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
28649e50c406SHeiko Schocher
28659e50c406SHeiko Schocher		This enables the bootcounter support, see:
28669e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
28679e50c406SHeiko Schocher
28689e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
28699e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
28709e50c406SHeiko Schocher		CONFIG_BLACKFIN
28719e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
28729e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
28739e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
28749e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
28759e50c406SHeiko Schocher		enable support for the bootcounter in RAM
28769e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
28779e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
28789e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
28799e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
28809e50c406SHeiko Schocher						    the bootcounter.
28819e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
288219c402afSSimon Glass
2883a8c7c708Swdenk- Show boot progress:
2884c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2885c609719bSwdenk
2886c609719bSwdenk		Defining this option allows to add some board-
2887c609719bSwdenk		specific code (calling a user-provided function
2888c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2889c609719bSwdenk		the system's boot progress on some display (for
2890c609719bSwdenk		example, some LED's) on your board. At the moment,
2891c609719bSwdenk		the following checkpoints are implemented:
2892c609719bSwdenk
28933a608ca0SSimon Glass- Detailed boot stage timing
28943a608ca0SSimon Glass		CONFIG_BOOTSTAGE
28953a608ca0SSimon Glass		Define this option to get detailed timing of each stage
28963a608ca0SSimon Glass		of the boot process.
28973a608ca0SSimon Glass
28983a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
28993a608ca0SSimon Glass		This is the number of available user bootstage records.
29003a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29013a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29023a608ca0SSimon Glass		the limit, recording will stop.
29033a608ca0SSimon Glass
29043a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29053a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29063a608ca0SSimon Glass
29073a608ca0SSimon Glass		Timer summary in microseconds:
29083a608ca0SSimon Glass		       Mark    Elapsed  Stage
29093a608ca0SSimon Glass			  0          0  reset
29103a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29113a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29123a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29133a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29143a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29153a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29163a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29173a608ca0SSimon Glass
29182eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29192eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29202eba38cfSSimon Glass		and un/stashing of bootstage data.
29212eba38cfSSimon Glass
292294fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
292394fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
292494fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
292594fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
292694fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
292794fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
292894fd1316SSimon Glass		For example:
292994fd1316SSimon Glass
293094fd1316SSimon Glass		bootstage {
293194fd1316SSimon Glass			154 {
293294fd1316SSimon Glass				name = "board_init_f";
293394fd1316SSimon Glass				mark = <3575678>;
293494fd1316SSimon Glass			};
293594fd1316SSimon Glass			170 {
293694fd1316SSimon Glass				name = "lcd";
293794fd1316SSimon Glass				accum = <33482>;
293894fd1316SSimon Glass			};
293994fd1316SSimon Glass		};
294094fd1316SSimon Glass
294194fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
294294fd1316SSimon Glass
29431372cce2SMarian BalakowiczLegacy uImage format:
29441372cce2SMarian Balakowicz
2945c609719bSwdenk  Arg	Where			When
2946c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2947c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2948c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2949c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2950c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2951c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2952c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2953c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2954c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29551372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2956c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2957c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2958c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2959c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29601372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2961c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
29621372cce2SMarian Balakowicz
29631372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
29641372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
29651372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
29661372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
29671372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
29681372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
29691372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
297011ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
29711372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
29721372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
29731372cce2SMarian Balakowicz
2974ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2975c609719bSwdenk
2976a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
297763e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
297863e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
297963e73c9aSwdenk
2980566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2981566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2982566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2983566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2984566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2985566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2986566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2987566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2988566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2989566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2990566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2991566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2992566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2993566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2994566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2995566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2996566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2997566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2998566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2999566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3000566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3001566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3002566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3003566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3004566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3005566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3006566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3007566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3008566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3009566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3010566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3011566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3012566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3013566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3014566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3015566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3016566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3017566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3018566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3019566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3020566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3021566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3022566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3023566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3024566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3025566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3026566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3027c609719bSwdenk
3028566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3029c609719bSwdenk
3030566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3031566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3032566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3033206c60cbSwdenk
3034566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3035566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
303611ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3037566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3038566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3039566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
304074de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
304174de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3042566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3043c609719bSwdenk
30441372cce2SMarian BalakowiczFIT uImage format:
30451372cce2SMarian Balakowicz
30461372cce2SMarian Balakowicz  Arg	Where			When
30471372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30481372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30491372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30501372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30511372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30521372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3053f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30541372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30551372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30561372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30571372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30581372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
305911ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
306011ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30611372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
30621372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
30631372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
30641372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
30651372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
30661372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
30671372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
30681372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
30691372cce2SMarian Balakowicz
30701372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
30711372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
30721372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
307311ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
30741372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
30751372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
30761372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
30771372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
30781372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
30791372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
30801372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
30811372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
30821372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
30831372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
30841372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
30851372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
30861372cce2SMarian Balakowicz
308711ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
30881372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
30891372cce2SMarian Balakowicz
309011ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
30911372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
30921372cce2SMarian Balakowicz
309311ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
30941372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
30951372cce2SMarian Balakowicz
3096d95f6ec7SGabe Black- FIT image support:
3097d95f6ec7SGabe Black		CONFIG_FIT
3098d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3099d95f6ec7SGabe Black
3100d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3101d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3102d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3103d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3104d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3105d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3106d95f6ec7SGabe Black
31073e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31083e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31093e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31103e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31113e569a6bSSimon Glass
31124cf2609bSWolfgang Denk- Standalone program support:
31134cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31144cf2609bSWolfgang Denk
31156feff899SWolfgang Denk		This option defines a board specific value for the
31166feff899SWolfgang Denk		address where standalone program gets loaded, thus
31176feff899SWolfgang Denk		overwriting the architecture dependent default
31184cf2609bSWolfgang Denk		settings.
31194cf2609bSWolfgang Denk
31204cf2609bSWolfgang Denk- Frame Buffer Address:
31214cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31224cf2609bSWolfgang Denk
31234cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
312444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
312544a53b57SWolfgang Denk		when using a graphics controller has separate video
312644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
312744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
312844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
312944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
313044a53b57SWolfgang Denk		configured panel size.
31314cf2609bSWolfgang Denk
31324cf2609bSWolfgang Denk		Please see board_init_f function.
31334cf2609bSWolfgang Denk
3134cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3135cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3136cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3137cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3138cccfc2abSDetlev Zundel
3139cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3140cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3141cccfc2abSDetlev Zundel
3142cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3143cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3144cccfc2abSDetlev Zundel
3145cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3146cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3147cccfc2abSDetlev Zundel
3148cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3149cccfc2abSDetlev Zundel
3150cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3151cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3152cccfc2abSDetlev Zundel
315370c219cdSJoe Hershberger- UBI support
315470c219cdSJoe Hershberger		CONFIG_CMD_UBI
315570c219cdSJoe Hershberger
315670c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
315770c219cdSJoe Hershberger		with the UBI flash translation layer
315870c219cdSJoe Hershberger
315970c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
316070c219cdSJoe Hershberger
3161147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3162147162daSJoe Hershberger
3163147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3164147162daSJoe Hershberger		warnings and errors enabled.
3165147162daSJoe Hershberger
316670c219cdSJoe Hershberger- UBIFS support
316770c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
316870c219cdSJoe Hershberger
316970c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
317070c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
317170c219cdSJoe Hershberger
317270c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
317370c219cdSJoe Hershberger
3174147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3175147162daSJoe Hershberger
3176147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3177147162daSJoe Hershberger		warnings and errors enabled.
3178147162daSJoe Hershberger
31796a11cf48SDaniel Schwierzeck- SPL framework
31806a11cf48SDaniel Schwierzeck		CONFIG_SPL
31816a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
31826a11cf48SDaniel Schwierzeck
318395579793STom Rini		CONFIG_SPL_LDSCRIPT
318495579793STom Rini		LDSCRIPT for linking the SPL binary.
318595579793STom Rini
31866ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
31876ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
31886ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
31896ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
31908960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
31916ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
31926ebc3461SAlbert ARIBAUD
319395579793STom Rini		CONFIG_SPL_MAX_SIZE
31946ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
31956ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
31966ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
31976ebc3461SAlbert ARIBAUD		not exceed it.
319895579793STom Rini
31996a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32006a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32016a11cf48SDaniel Schwierzeck
320294a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
320394a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
320494a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
320594a45bb1SScott Wood
320695579793STom Rini		CONFIG_SPL_BSS_START_ADDR
320795579793STom Rini		Link address for the BSS within the SPL binary.
320895579793STom Rini
320995579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32106ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32116ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32126ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32138960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32146ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
321595579793STom Rini
321695579793STom Rini		CONFIG_SPL_STACK
321795579793STom Rini		Adress of the start of the stack SPL will use
321895579793STom Rini
321994a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
322094a45bb1SScott Wood		Adress of the start of the stack SPL will use after
322194a45bb1SScott Wood		relocation.  If unspecified, this is equal to
322294a45bb1SScott Wood		CONFIG_SPL_STACK.
322394a45bb1SScott Wood
322495579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
322595579793STom Rini		Starting address of the malloc pool used in SPL.
322695579793STom Rini
322795579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
322895579793STom Rini		The size of the malloc pool used in SPL.
32296a11cf48SDaniel Schwierzeck
323047f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
323147f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
323247f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
323347f7bcaeSTom Rini		NAND loading of the Linux Kernel.
323447f7bcaeSTom Rini
3235861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3236861a86f4STom Rini		For ARM, enable an optional function to print more information
3237861a86f4STom Rini		about the running system.
3238861a86f4STom Rini
32394b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
32404b919725SScott Wood		Arch init code should be built for a very small image
32414b919725SScott Wood
32426a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
32436a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
32446a11cf48SDaniel Schwierzeck
32456a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
32466a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
32476a11cf48SDaniel Schwierzeck
32486a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
32496a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
32506a11cf48SDaniel Schwierzeck
32516a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
32526a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32536a11cf48SDaniel Schwierzeck
32546a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
32556a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
32566a11cf48SDaniel Schwierzeck
325795579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
325895579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
325995579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
326095579793STom Rini		Address, size and partition on the MMC to load U-Boot from
326195579793STom Rini		when the MMC is being used in raw mode.
326295579793STom Rini
32632b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
32642b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
32652b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
32662b75b0adSPeter Korsgaard
32672b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
32682b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
32692b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
32702b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
32712b75b0adSPeter Korsgaard		(for falcon mode)
32722b75b0adSPeter Korsgaard
327395579793STom Rini		CONFIG_SPL_FAT_SUPPORT
327495579793STom Rini		Support for fs/fat/libfat.o in SPL binary
327595579793STom Rini
327695579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
327795579793STom Rini		Filename to read to load U-Boot when reading from FAT
327895579793STom Rini
32797ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
32807ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
32817ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
32827ad2cc79SPeter Korsgaard
32837ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
32847ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
32857ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
32867ad2cc79SPeter Korsgaard
328706f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
328806f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
328906f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
329006f60ae3SScott Wood		continuing (the hardware starts execution after just
329106f60ae3SScott Wood		loading the first page rather than the full 4K).
329206f60ae3SScott Wood
32936f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
32946f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
32956f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
32966f2f01b9SScott Wood
32976f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
32986f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
32996f2f01b9SScott Wood
33006f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33016f2f01b9SScott Wood		Include standard software ECC in the SPL
33026f2f01b9SScott Wood
330395579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33047d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33057d4b7955SScott Wood		expose the cmd_ctrl() interface.
330695579793STom Rini
3307bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3308bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33095614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3310bb0dc108SYing Zhang
33117c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
33127c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
33137c8eea59SYing Zhang		SPL binary.
33147c8eea59SYing Zhang
331595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
331695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
331795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
331895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
331995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
332095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
33217d4b7955SScott Wood		to read U-Boot
332295579793STom Rini
3323fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3324fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3325fbe76ae4SPrabhakar Kushwaha
332695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33277d4b7955SScott Wood		Location in NAND to read U-Boot from
33287d4b7955SScott Wood
33297d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33307d4b7955SScott Wood		Location in memory to load U-Boot to
33317d4b7955SScott Wood
33327d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
33337d4b7955SScott Wood		Size of image to load
333495579793STom Rini
333595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
33367d4b7955SScott Wood		Entry point in loaded image to jump to
333795579793STom Rini
333895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
333995579793STom Rini		Define this if you need to first read the OOB and then the
334095579793STom Rini		data. This is used for example on davinci plattforms.
334195579793STom Rini
334295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
334395579793STom Rini		Support for an OMAP3-specific set of functions to return the
334495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
334595579793STom Rini
33466a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
33476a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
33486a11cf48SDaniel Schwierzeck
33496a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
33506a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
33516a11cf48SDaniel Schwierzeck
33526a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
33536a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
33546a11cf48SDaniel Schwierzeck
3355c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3356c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3357c57b953dSPavel Machek
33586a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
33596a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
33601372cce2SMarian Balakowicz
3361ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3362ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3363ba1bee43SYing Zhang
3364ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3365ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3366ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3367ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3368ba1bee43SYing Zhang
336974752baaSScott Wood		CONFIG_SPL_PAD_TO
33706113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
33716113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
33726113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33736113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33746113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
337574752baaSScott Wood
3376ca2fca22SScott Wood		CONFIG_SPL_TARGET
3377ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3378ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3379ca2fca22SScott Wood		example if more than one image needs to be produced.
3380ca2fca22SScott Wood
338187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
338287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
338387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
338487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
338587ebee39SSimon Glass		bootm command when booting a FIT image.
338687ebee39SSimon Glass
33873aa29de0SYing Zhang- TPL framework
33883aa29de0SYing Zhang		CONFIG_TPL
33893aa29de0SYing Zhang		Enable building of TPL globally.
33903aa29de0SYing Zhang
33913aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
33923aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
33933aa29de0SYing Zhang		the TPL payload. By default, this is defined as
33943aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33953aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33963aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
33973aa29de0SYing Zhang
3398c609719bSwdenkModem Support:
3399c609719bSwdenk--------------
3400c609719bSwdenk
3401566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3402c609719bSwdenk
340311ccc33fSMarcel Ziswiler- Modem support enable:
3404c609719bSwdenk		CONFIG_MODEM_SUPPORT
3405c609719bSwdenk
3406c609719bSwdenk- RTS/CTS Flow control enable:
3407c609719bSwdenk		CONFIG_HWFLOW
3408c609719bSwdenk
3409c609719bSwdenk- Modem debug support:
3410c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3411c609719bSwdenk
3412c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3413c609719bSwdenk		for modem support. Useful only with BDI2000.
3414c609719bSwdenk
3415a8c7c708Swdenk- Interrupt support (PPC):
3416a8c7c708Swdenk
3417a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3418a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
341911ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3420a8c7c708Swdenk		should set decrementer_count to appropriate value. If
342111ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3422a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
342311ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3424a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3425a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3426a8c7c708Swdenk		general timer_interrupt().
3427a8c7c708Swdenk
3428c609719bSwdenk- General:
3429c609719bSwdenk
3430c609719bSwdenk		In the target system modem support is enabled when a
3431c609719bSwdenk		specific key (key combination) is pressed during
3432c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
343311ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3434c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3435c609719bSwdenk		function, returning 1 and thus enabling modem
3436c609719bSwdenk		initialization.
3437c609719bSwdenk
3438c609719bSwdenk		If there are no modem init strings in the
3439c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3440c609719bSwdenk		previous output (banner, info printfs) will be
344111ccc33fSMarcel Ziswiler		suppressed, though.
3442c609719bSwdenk
3443c609719bSwdenk		See also: doc/README.Modem
3444c609719bSwdenk
34459660e442SHelmut RaigerBoard initialization settings:
34469660e442SHelmut Raiger------------------------------
34479660e442SHelmut Raiger
34489660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34499660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34509660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
34519660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
34529660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
34539660e442SHelmut Raigertypically in board_init_f() and board_init_r().
34549660e442SHelmut Raiger
34559660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34569660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34579660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34589660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3459c609719bSwdenk
3460c609719bSwdenkConfiguration Settings:
3461c609719bSwdenk-----------------------
3462c609719bSwdenk
34636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3464c609719bSwdenk		undefine this when you're short of memory.
3465c609719bSwdenk
34662fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
34672fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
34682fb2604dSPeter Tyser
34696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3470c609719bSwdenk		prompt for user input.
3471c609719bSwdenk
34726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3473c609719bSwdenk
34746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3475c609719bSwdenk
34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3477c609719bSwdenk
34786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3479c609719bSwdenk		the application (usually a Linux kernel) when it is
3480c609719bSwdenk		booted
3481c609719bSwdenk
34826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3483c609719bSwdenk		List of legal baudrate settings for this board.
3484c609719bSwdenk
34856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3486c609719bSwdenk		Suppress display of console information at boot.
3487c609719bSwdenk
34886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3489c609719bSwdenk		If the board specific function
3490c609719bSwdenk			extern int overwrite_console (void);
3491c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3492c609719bSwdenk		serial port, else the settings in the environment are used.
3493c609719bSwdenk
34946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3495c609719bSwdenk		Enable the call to overwrite_console().
3496c609719bSwdenk
34976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3498c609719bSwdenk		Enable overwrite of previous console environment settings.
3499c609719bSwdenk
35006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3501c609719bSwdenk		Begin and End addresses of the area used by the
3502c609719bSwdenk		simple memory test.
3503c609719bSwdenk
35046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3505c609719bSwdenk		Enable an alternate, more extensive memory test.
3506c609719bSwdenk
35076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35085f535fe1Swdenk		Scratch address used by the alternate memory test
35095f535fe1Swdenk		You only need to set this if address zero isn't writeable
35105f535fe1Swdenk
35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
35126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
351314f73ca6SStefan Roese		this specified memory area will get subtracted from the top
351411ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
351514f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
351614f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
351714f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35185e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
351914f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35205e12e75dSStefan Roese		will have to get fixed in Linux additionally.
352114f73ca6SStefan Roese
352214f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
352314f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
352414f73ca6SStefan Roese		be touched.
352514f73ca6SStefan Roese
352614f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
352714f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
352814f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
352914f73ca6SStefan Roese		non page size aligned address and this could cause major
353014f73ca6SStefan Roese		problems.
353114f73ca6SStefan Roese
35326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3533c609719bSwdenk		Enable temporary baudrate change while serial download
3534c609719bSwdenk
35356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3536c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3537c609719bSwdenk
35386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3539c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3540c609719bSwdenk		Cogent motherboard)
3541c609719bSwdenk
35426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3543c609719bSwdenk		Physical start address of Flash memory.
3544c609719bSwdenk
35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3546c609719bSwdenk		Physical start address of boot monitor code (set by
3547c609719bSwdenk		make config files to be same as the text base address
354814d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
35496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3550c609719bSwdenk
35516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
35523b57fe0aSwdenk		Size of memory reserved for monitor code, used to
35533b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
35543b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
35553b57fe0aSwdenk		flash sector.
3556c609719bSwdenk
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3558c609719bSwdenk		Size of DRAM reserved for malloc() use.
3559c609719bSwdenk
35606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
356115940c9aSStefan Roese		Normally compressed uImages are limited to an
356215940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
356415940c9aSStefan Roese		to adjust this setting to your needs.
3565c609719bSwdenk
35666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3567c609719bSwdenk		Maximum size of memory mapped by the startup code of
3568c609719bSwdenk		the Linux kernel; all data that must be processed by
35697d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
35707d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
35711bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
35727d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3573c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3574c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3575c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3576c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3577c609719bSwdenk
3578fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3579fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3580fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3581fca43cc8SJohn Rigby		is enabled.
3582fca43cc8SJohn Rigby
3583fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3584fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3585fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3586fca43cc8SJohn Rigby
3587fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3588fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3589fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3590fca43cc8SJohn Rigby
35916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3592c609719bSwdenk		Max number of Flash memory banks
3593c609719bSwdenk
35946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3595c609719bSwdenk		Max number of sectors on a Flash chip
3596c609719bSwdenk
35976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3598c609719bSwdenk		Timeout for Flash erase operations (in ms)
3599c609719bSwdenk
36006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3601c609719bSwdenk		Timeout for Flash write operations (in ms)
3602c609719bSwdenk
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36048564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36058564acf9Swdenk
36066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36078564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36088564acf9Swdenk
36096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36108564acf9Swdenk		If defined, hardware flash sectors protection is used
36118564acf9Swdenk		instead of U-Boot software protection.
36128564acf9Swdenk
36136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3614c609719bSwdenk
3615c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3616c609719bSwdenk		without this option such a download has to be
3617c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3618c609719bSwdenk		copy from RAM to flash.
3619c609719bSwdenk
3620c609719bSwdenk		The two-step approach is usually more reliable, since
3621c609719bSwdenk		you can check if the download worked before you erase
362211ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
362311ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3624c609719bSwdenk		downloaded image) this option may be very useful.
3625c609719bSwdenk
36266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3627c609719bSwdenk		Define if the flash driver uses extra elements in the
36285653fc33Swdenk		common flash structure for storing flash geometry.
36295653fc33Swdenk
363000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36315653fc33Swdenk		This option also enables the building of the cfi_flash driver
36325653fc33Swdenk		in the drivers directory
363353cf9435Sstroese
363491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
363591809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
363691809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
363791809ed5SPiotr Ziecik		to the MTD layer.
363891809ed5SPiotr Ziecik
36396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
364096ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
364196ef831fSGuennadi Liakhovetski
364296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
364396ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
364496ef831fSGuennadi Liakhovetski		write commands.
364596ef831fSGuennadi Liakhovetski
36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
36475568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
36485568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
36495568e613SStefan Roese		is useful, if some of the configured banks are only
36505568e613SStefan Roese		optionally available.
36515568e613SStefan Roese
36529a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
36539a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
36549a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
36559a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
36569a042e9cSJerry Van Baren
3657352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3658352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3659352ef3f1SStefan Roese		against the source after the write operation. An error message
3660352ef3f1SStefan Roese		will be printed when the contents are not identical.
3661352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3662352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3663352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3664352ef3f1SStefan Roese		this option if you really know what you are doing.
3665352ef3f1SStefan Roese
36666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
366711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
366811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
366953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
367053cf9435Sstroese		buffers can be full shortly after enabling the interface
367111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
367253cf9435Sstroese		Defaults to 4 if not defined.
3673c609719bSwdenk
3674ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3675ea882bafSWolfgang Denk
3676ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3677ea882bafSWolfgang Denk	internally to store the environment settings. The default
3678ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3679ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3680ea882bafSWolfgang Denk	lib/hashtable.c for details.
3681ea882bafSWolfgang Denk
36822598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
36832598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
36841bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
36852598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
36862598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
36872598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
36882598090bSJoe Hershberger
36892598090bSJoe Hershberger	The format of the list is:
36902598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3691267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3692267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
36932598090bSJoe Hershberger		entry = variable_name[:attributes]
36942598090bSJoe Hershberger		list = entry[,list]
36952598090bSJoe Hershberger
36962598090bSJoe Hershberger	The type attributes are:
36972598090bSJoe Hershberger		s - String (default)
36982598090bSJoe Hershberger		d - Decimal
36992598090bSJoe Hershberger		x - Hexadecimal
37002598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37012598090bSJoe Hershberger		i - IP address
37022598090bSJoe Hershberger		m - MAC address
37032598090bSJoe Hershberger
3704267541f7SJoe Hershberger	The access attributes are:
3705267541f7SJoe Hershberger		a - Any (default)
3706267541f7SJoe Hershberger		r - Read-only
3707267541f7SJoe Hershberger		o - Write-once
3708267541f7SJoe Hershberger		c - Change-default
3709267541f7SJoe Hershberger
37102598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37112598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
37122598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
37132598090bSJoe Hershberger
37142598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37152598090bSJoe Hershberger		Define this to a list (string) to define validation that
37162598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37172598090bSJoe Hershberger		environment variable.  To override a setting in the static
37182598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37192598090bSJoe Hershberger		".flags" variable.
37202598090bSJoe Hershberger
3721267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3722267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3723267541f7SJoe Hershberger	access flags.
3724267541f7SJoe Hershberger
37255c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
37265c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37275c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37285c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
37295c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
37305c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
37315c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
37325c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
37335c1a7ea6SSimon Glass	your board please report the problem and send patches!
37345c1a7ea6SSimon Glass
3735632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3736632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3737632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3738632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3739632efa74SSimon Glass	directly. You should not need to touch this setting.
3740632efa74SSimon Glass
37410b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37420b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37430b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
37440b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3745632efa74SSimon Glass
3746c609719bSwdenkThe following definitions that deal with the placement and management
3747c609719bSwdenkof environment data (variable area); in general, we support the
3748c609719bSwdenkfollowing configurations:
3749c609719bSwdenk
3750c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3751c3eb3fe4SMike Frysinger
3752c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3753c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3754c3eb3fe4SMike Frysinger
37555a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3756c609719bSwdenk
3757c609719bSwdenk	Define this if the environment is in flash memory.
3758c609719bSwdenk
3759c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3760c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3761c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3762c609719bSwdenk	   sector" type flash chips, which have several smaller
3763c609719bSwdenk	   sectors at the start or the end. For instance, such a
3764c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3765c609719bSwdenk	   such a case you would place the environment in one of the
3766c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3767c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3768c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3769c609719bSwdenk	   between U-Boot and the environment.
3770c609719bSwdenk
37710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3772c609719bSwdenk
3773c609719bSwdenk	   Offset of environment data (variable area) to the
3774c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3775c609719bSwdenk	   type flash chips the second sector can be used: the offset
3776c609719bSwdenk	   for this sector is given here.
3777c609719bSwdenk
37786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3779c609719bSwdenk
37800e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3781c609719bSwdenk
3782c609719bSwdenk	   This is just another way to specify the start address of
3783c609719bSwdenk	   the flash sector containing the environment (instead of
37840e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3785c609719bSwdenk
37860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3787c609719bSwdenk
3788c609719bSwdenk	   Size of the sector containing the environment.
3789c609719bSwdenk
3790c609719bSwdenk
3791c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3792c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3793c609719bSwdenk	   the environment.
3794c609719bSwdenk
37950e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3796c609719bSwdenk
37975a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
37980e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3799c609719bSwdenk	   of this flash sector for the environment. This saves
3800c609719bSwdenk	   memory for the RAM copy of the environment.
3801c609719bSwdenk
3802c609719bSwdenk	   It may also save flash memory if you decide to use this
3803c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3804c609719bSwdenk	   since then the remainder of the flash sector could be used
3805c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3806c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3807c609719bSwdenk	   updating the environment in flash makes it always
3808c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3809c609719bSwdenk	   wrong before the contents has been restored from a copy in
3810c609719bSwdenk	   RAM, your target system will be dead.
3811c609719bSwdenk
38120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38130e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3814c609719bSwdenk
3815c609719bSwdenk	   These settings describe a second storage area used to hold
381611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38173e38691eSwdenk	   a valid backup copy in case there is a power failure during
3818c609719bSwdenk	   a "saveenv" operation.
3819c609719bSwdenk
3820c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3821c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3822c609719bSwdenkaccordingly!
3823c609719bSwdenk
3824c609719bSwdenk
38259314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3826c609719bSwdenk
3827c609719bSwdenk	Define this if you have some non-volatile memory device
3828c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3829c609719bSwdenk	environment.
3830c609719bSwdenk
38310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38320e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3833c609719bSwdenk
383411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3835c609719bSwdenk	  want to use for environment. It is assumed that this memory
3836c609719bSwdenk	  can just be read and written to, without any special
3837c609719bSwdenk	  provision.
3838c609719bSwdenk
3839c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3840c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
384111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3842c609719bSwdenkU-Boot will hang.
3843c609719bSwdenk
3844c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3845c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3846c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3847c609719bSwdenkto save the current settings.
3848c609719bSwdenk
3849c609719bSwdenk
3850bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3851c609719bSwdenk
3852c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3853c609719bSwdenk	device and a driver for it.
3854c609719bSwdenk
38550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3857c609719bSwdenk
3858c609719bSwdenk	  These two #defines specify the offset and size of the
3859c609719bSwdenk	  environment area within the total memory of your EEPROM.
3860c609719bSwdenk
38616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3862c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3863c609719bSwdenk	  The default address is zero.
3864c609719bSwdenk
38656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3866c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3867c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3868c609719bSwdenk	  would require six bits.
3869c609719bSwdenk
38706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3871c609719bSwdenk	  If defined, the number of milliseconds to delay between
3872c609719bSwdenk	  page writes.	The default is zero milliseconds.
3873c609719bSwdenk
38746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3875c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3876c609719bSwdenk	  that this is NOT the chip address length!
3877c609719bSwdenk
38786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
38795cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
38805cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
38815cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
38825cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
38835cf91d6bSwdenk	  byte chips.
38845cf91d6bSwdenk
38855cf91d6bSwdenk	  Note that we consider the length of the address field to
38865cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
38875cf91d6bSwdenk	  in the chip address.
38885cf91d6bSwdenk
38896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3890c609719bSwdenk	  The size in bytes of the EEPROM device.
3891c609719bSwdenk
3892548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3893548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3894548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3895548738b4SHeiko Schocher
3896548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3897548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3898548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3899548738b4SHeiko Schocher	  EEPROM. For example:
3900548738b4SHeiko Schocher
3901ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3902548738b4SHeiko Schocher
3903548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3904548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3905c609719bSwdenk
3906057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39075779d8d9Swdenk
39085779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39095779d8d9Swdenk	want to use for the environment.
39105779d8d9Swdenk
39110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39130e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39145779d8d9Swdenk
39155779d8d9Swdenk	  These three #defines specify the offset and size of the
39165779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39175779d8d9Swdenk	  at the specified address.
39185779d8d9Swdenk
39190a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
39200a85a9e7SLiu Gang
39210a85a9e7SLiu Gang	Define this if you have a remote memory space which you
39220a85a9e7SLiu Gang	want to use for the local device's environment.
39230a85a9e7SLiu Gang
39240a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
39250a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
39260a85a9e7SLiu Gang
39270a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39280a85a9e7SLiu Gang	  environment area within the remote memory space. The
39290a85a9e7SLiu Gang	  local device can get the environment from remote memory
3930fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39310a85a9e7SLiu Gang
39320a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39330a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3934fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3935fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
39360a85a9e7SLiu Gang
393751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
393813a5695bSwdenk
393913a5695bSwdenk	Define this if you have a NAND device which you want to use
394013a5695bSwdenk	for the environment.
394113a5695bSwdenk
39420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
394413a5695bSwdenk
394513a5695bSwdenk	  These two #defines specify the offset and size of the environment
3946fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3947fdd813deSScott Wood	  aligned to an erase block boundary.
39485779d8d9Swdenk
3949fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3950e443c944SMarkus Klotzbuecher
39510e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3952fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3953fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3954fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3955fdd813deSScott Wood	  aligned to an erase block boundary.
3956e443c944SMarkus Klotzbuecher
3957fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3958fdd813deSScott Wood
3959fdd813deSScott Wood	  Specifies the length of the region in which the environment
3960fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3961fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3962fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3963fdd813deSScott Wood	  the range to be avoided.
3964fdd813deSScott Wood
3965fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3966fdd813deSScott Wood
3967fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3968fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3969fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3970fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3971fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3972e443c944SMarkus Klotzbuecher
3973b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3974b74ab737SGuennadi Liakhovetski
3975b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3976b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3977b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3978b74ab737SGuennadi Liakhovetski
39792b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
39802b74433fSJoe Hershberger
39812b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
39822b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
39832b74433fSJoe Hershberger	accesses, which is important on NAND.
39842b74433fSJoe Hershberger
39852b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
39862b74433fSJoe Hershberger
39872b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
39882b74433fSJoe Hershberger
39892b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
39902b74433fSJoe Hershberger
39912b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
39922b74433fSJoe Hershberger	  environment in.
39932b74433fSJoe Hershberger
3994785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3995785881f7SJoe Hershberger
3996785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3997785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3998785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3999785881f7SJoe Hershberger
40002b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40012b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40022b74433fSJoe Hershberger
40032b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40042b74433fSJoe Hershberger	  when storing the env in UBI.
40052b74433fSJoe Hershberger
400606e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
400706e4ae5fSStephen Warren
400806e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
400906e4ae5fSStephen Warren	environment.
401006e4ae5fSStephen Warren
401106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
401206e4ae5fSStephen Warren
401306e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
401406e4ae5fSStephen Warren
401506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
401606e4ae5fSStephen Warren
401706e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
401806e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
401906e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
402006e4ae5fSStephen Warren
402106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
402206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
402306e4ae5fSStephen Warren
402406e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
402506e4ae5fSStephen Warren	  area within the specified MMC device.
402606e4ae5fSStephen Warren
40275c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40285c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40295c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40305c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40315c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40325c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40335c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40345c088ee8SStephen Warren
403506e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
403606e4ae5fSStephen Warren	  MMC sector boundary.
403706e4ae5fSStephen Warren
403806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
403906e4ae5fSStephen Warren
404006e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
404106e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
404206e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
404306e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
404406e4ae5fSStephen Warren
40455c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
40465c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
40475c088ee8SStephen Warren
404806e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
404906e4ae5fSStephen Warren	  an MMC sector boundary.
405006e4ae5fSStephen Warren
405106e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
405206e4ae5fSStephen Warren
405306e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
405406e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
405506e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
405606e4ae5fSStephen Warren
40576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4058c609719bSwdenk
4059c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4060c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4061c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4062c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4063c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4064c609719bSwdenk	to be a good choice since it makes it far enough from the
4065c609719bSwdenk	start of the data area as well as from the stack pointer.
4066c609719bSwdenk
4067e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4068c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4069cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4070c609719bSwdenkuntil then to read environment variables.
4071c609719bSwdenk
407285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
407385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
407485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
407585ec0bccSwdenknecessary, because the first environment variable we need is the
407685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
407785ec0bccSwdenkhave any device yet where we could complain.]
4078c609719bSwdenk
4079c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4080c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
408185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4082c609719bSwdenk
40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4084fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4085fc3e2165Swdenk
40866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4087fc3e2165Swdenk		      also needs to be defined.
4088fc3e2165Swdenk
40896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4090fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4091c609719bSwdenk
4092f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4093f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4094f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4095f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4096f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4097f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4098f5675aa5SRon Madrid
4099b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4100b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4101b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4102b2b92f53SSimon Glass		to do this.
4103b2b92f53SSimon Glass
4104e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4105e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4106e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4107e2e3e2b1SSimon Glass		present.
4108e2e3e2b1SSimon Glass
4109c609719bSwdenkLow Level (hardware related) configuration options:
4110dc7c9a1aSwdenk---------------------------------------------------
4111c609719bSwdenk
41126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4113c609719bSwdenk		Cache Line Size of the CPU.
4114c609719bSwdenk
41156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4116c609719bSwdenk		Default address of the IMMR after system reset.
41172535d602Swdenk
41182535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
41192535d602Swdenk		and RPXsuper) to be able to adjust the position of
41202535d602Swdenk		the IMMR register after a reset.
4121c609719bSwdenk
4122e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4123e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4124e46fedfeSTimur Tabi		PowerPC SOCs.
4125e46fedfeSTimur Tabi
4126e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4127e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4128e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4129e46fedfeSTimur Tabi
4130e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4131e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4132e46fedfeSTimur Tabi
4133e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4134e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4135e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4136e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4137e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4138e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4139e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4140e46fedfeSTimur Tabi
4141e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4142e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4143e46fedfeSTimur Tabi
4144e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4145e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4146e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4147e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4148e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4149e46fedfeSTimur Tabi
4150e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4151e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4152e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4153e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4154e46fedfeSTimur Tabi
4155e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4156e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4157e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4158e46fedfeSTimur Tabi
41597f6c2cbcSwdenk- Floppy Disk Support:
41606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
41617f6c2cbcSwdenk
41627f6c2cbcSwdenk		the default drive number (default value 0)
41637f6c2cbcSwdenk
41646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
41657f6c2cbcSwdenk
416611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
41677f6c2cbcSwdenk		(default value 1)
41687f6c2cbcSwdenk
41696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
41707f6c2cbcSwdenk
41717f6c2cbcSwdenk		defines the offset of register from address. It
41727f6c2cbcSwdenk		depends on which part of the data bus is connected to
417311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
41747f6c2cbcSwdenk
41756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
41766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
41777f6c2cbcSwdenk		default value.
41787f6c2cbcSwdenk
41796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
41807f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
41817f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
41827f6c2cbcSwdenk		source code. It is used to make hardware dependant
41837f6c2cbcSwdenk		initializations.
41847f6c2cbcSwdenk
41850abddf82SMacpaul Lin- CONFIG_IDE_AHB:
41860abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
41870abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
41880abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
41890abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
41900abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
41910abddf82SMacpaul Lin		is requierd.
41920abddf82SMacpaul Lin
41936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
419425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
419525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4196c609719bSwdenk
41976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4198c609719bSwdenk
41997152b1d0Swdenk		Start address of memory area that can be used for
4200c609719bSwdenk		initial data and stack; please note that this must be
4201c609719bSwdenk		writable memory that is working WITHOUT special
4202c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4203c609719bSwdenk		will become available only after programming the
4204c609719bSwdenk		memory controller and running certain initialization
4205c609719bSwdenk		sequences.
4206c609719bSwdenk
4207c609719bSwdenk		U-Boot uses the following memory types:
4208c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4209c609719bSwdenk		- MPC824X: data cache
4210c609719bSwdenk		- PPC4xx:  data cache
4211c609719bSwdenk
42126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4213c609719bSwdenk
4214c609719bSwdenk		Offset of the initial data structure in the memory
42156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
42166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4217c609719bSwdenk		data is located at the end of the available space
4218553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
42196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
42216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4222c609719bSwdenk
4223c609719bSwdenk	Note:
4224c609719bSwdenk		On the MPC824X (or other systems that use the data
4225c609719bSwdenk		cache for initial memory) the address chosen for
42266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4227c609719bSwdenk		point to an otherwise UNUSED address space between
4228c609719bSwdenk		the top of RAM and the start of the PCI space.
4229c609719bSwdenk
42306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4231c609719bSwdenk
42326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4233c609719bSwdenk
42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4235c609719bSwdenk
42366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4237c609719bSwdenk
42386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4239c609719bSwdenk
42406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4241c609719bSwdenk
42426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4243c609719bSwdenk		SDRAM timing
4244c609719bSwdenk
42456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4246c609719bSwdenk		periodic timer for refresh
4247c609719bSwdenk
42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4249c609719bSwdenk
42506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
42516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
42526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
42536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4254c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4255c609719bSwdenk
4256c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
42576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4259c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4260c609719bSwdenk
42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4263c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4264c609719bSwdenk		Prescaler definitions (SDRAM timing)
4265c609719bSwdenk
42666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4267c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4268c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4269c609719bSwdenk
42706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4271b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4272b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4273b423d055SHeiko Schocher
42746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4275c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4276c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4277c609719bSwdenk
42786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4279c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4280c609719bSwdenk		wrong setting might damage your board. Read
4281c609719bSwdenk		doc/README.MBX before setting this variable!
4282c609719bSwdenk
42836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4284ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4285ea909b76Swdenk		(Power On Self Tests). This definition overrides
4286ea909b76Swdenk		#define'd default value in commproc.h resp.
4287ea909b76Swdenk		cpm_8260.h.
4288ea909b76Swdenk
42896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
42906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
42916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
42926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
42936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
42946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
42956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
42966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4297a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
42985d232d0eSwdenk
42999cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43009cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43019cacf4fcSDirk Eibach		required.
43029cacf4fcSDirk Eibach
430369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
430469fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
430569fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
430669fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
430769fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
430869fd2d3bSAndrew Sharp		by coreboot or similar.
430969fd2d3bSAndrew Sharp
4310842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4311842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4312842033e6SGabor Juhos
4313a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4314a09b9b68SKumar Gala		Chip has SRIO or not
4315a09b9b68SKumar Gala
4316a09b9b68SKumar Gala- CONFIG_SRIO1:
4317a09b9b68SKumar Gala		Board has SRIO 1 port available
4318a09b9b68SKumar Gala
4319a09b9b68SKumar Gala- CONFIG_SRIO2:
4320a09b9b68SKumar Gala		Board has SRIO 2 port available
4321a09b9b68SKumar Gala
4322c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4323c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4324c8b28152SLiu Gang
4325a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4326a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4327a09b9b68SKumar Gala
4328a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4329a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4330a09b9b68SKumar Gala
4331a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4332a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4333a09b9b68SKumar Gala
433466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
433566bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
433666bd1846SFabio Estevam		a 16 bit bus.
433766bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4338a430e916SFabio Estevam		Example of drivers that use it:
433966bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4340a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4341eced4626SAlex Waterman
4342eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4343eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4344eced4626SAlex Waterman		a default value will be used.
4345eced4626SAlex Waterman
4346bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4347218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4348218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4349218ca724SWolfgang Denk
4350bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4351bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4352bb99ad6dSBen Warren
43536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4354218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4355218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4356218ca724SWolfgang Denk		to something your driver can deal with.
4357bb99ad6dSBen Warren
43581b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
43591b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
43601b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
43611b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
43621b3e3c4fSYork Sun		header files or board specific files.
43631b3e3c4fSYork Sun
43646f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
43656f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
43666f5e1dc5SYork Sun
43676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4368218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4369218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
43702ad6b513STimur Tabi
4371c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4372c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4373c26e454dSwdenk
4374c26e454dSwdenk- CONFIG_FEC[12]_PHY
4375c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
43766e592385Swdenk		to the given FEC; i. e.
4377c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4378c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4379c26e454dSwdenk
4380c26e454dSwdenk		When set to -1, means to probe for first available.
4381c26e454dSwdenk
4382c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4383c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4384c26e454dSwdenk		(so program the FEC to ignore it).
4385c26e454dSwdenk
4386c26e454dSwdenk- CONFIG_RMII
4387c26e454dSwdenk		Enable RMII mode for all FECs.
4388c26e454dSwdenk		Note that this is a global option, we can't
4389c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4390c26e454dSwdenk
43915cf91d6bSwdenk- CONFIG_CRC32_VERIFY
43925cf91d6bSwdenk		Add a verify option to the crc32 command.
43935cf91d6bSwdenk		The syntax is:
43945cf91d6bSwdenk
43955cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
43965cf91d6bSwdenk
43975cf91d6bSwdenk		Where address/count indicate a memory area
43985cf91d6bSwdenk		and crc32 is the correct crc32 which the
43995cf91d6bSwdenk		area should have.
44005cf91d6bSwdenk
440156523f12Swdenk- CONFIG_LOOPW
440256523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4403602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
440456523f12Swdenk
44057b466641Sstroese- CONFIG_MX_CYCLIC
44067b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44077b466641Sstroese		"md/mw" commands.
44087b466641Sstroese		Examples:
44097b466641Sstroese
44107b466641Sstroese		=> mdc.b 10 4 500
44117b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44127b466641Sstroese
44137b466641Sstroese		=> mwc.l 100 12345678 10
44147b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
44157b466641Sstroese
44167b466641Sstroese		This only takes effect if the memory commands are activated
4417602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
44187b466641Sstroese
44198aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4420afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4421e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4422e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4423e03f3169SWolfgang Denk		relocate itself into RAM.
44248aa1a2d1Swdenk
4425e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4426e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4427e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4428e03f3169SWolfgang Denk		these initializations itself.
44298aa1a2d1Swdenk
4430401bb30bSAneesh V- CONFIG_SPL_BUILD
4431df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4432df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4433df81238bSMagnus Lilja		compiling a NAND SPL.
4434400558b5Swdenk
44353aa29de0SYing Zhang- CONFIG_TPL_BUILD
44363aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
44373aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
44383aa29de0SYing Zhang		It is loaded by the SPL.
44393aa29de0SYing Zhang
44405df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
44415df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
44425df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
44435df572f0SYing Zhang		previous 4k of the .text section.
44445df572f0SYing Zhang
44454213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
44464213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
44474213fc29SSimon Glass		effective address. It is therefore not necessary to regard
44484213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
44494213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
44504213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
44514213fc29SSimon Glass		addressable memory. This option causes some memory accesses
44524213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
44534213fc29SSimon Glass
4454d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4455d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4456d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4457d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4458d8834a13SMatthias Weisser		conditions but may increase the binary size.
4459d8834a13SMatthias Weisser
4460588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4461588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4462588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4463b16f521aSGabe Black
4464fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4465fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4466fc33705eSMark Jackson
4467fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
44685b5ece9eSGabe Black
446916678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
447016678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
447116678eb4SHeiko Schocher
4472f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4473f2717b47STimur Tabi-----------------------------------
4474f2717b47STimur Tabi
4475f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4476f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4477f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4478f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4479f2717b47STimur Tabiwithin that device.
4480f2717b47STimur Tabi
4481f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4482f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4483f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4484f2717b47STimur Tabi	is also specified.
4485f2717b47STimur Tabi
4486f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4487f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4488f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4489f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4490f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4491f2717b47STimur Tabi
4492f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4493f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4494f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4495f2717b47STimur Tabi	virtual address in NOR flash.
4496f2717b47STimur Tabi
4497f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4498f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4499f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4500f2717b47STimur Tabi
4501f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4502f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4503f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4504f2717b47STimur Tabi
4505f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4506f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4507f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4508f2717b47STimur Tabi
4509292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4510292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4511292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4512fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4513fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4514fc54c7faSLiu Gang	master's memory space.
4515f2717b47STimur Tabi
4516c609719bSwdenkBuilding the Software:
4517c609719bSwdenk======================
4518c609719bSwdenk
4519218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4520218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4521218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4522218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4523218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4524218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4525c609719bSwdenk
4526218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4527218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4528218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4529218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4530218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4531c609719bSwdenk
4532218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4533218ca724SWolfgang Denk	$ export CROSS_COMPILE
4534c609719bSwdenk
45352f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
45362f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
45372f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
45382f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
45392f8d396bSPeter Tyser
45402f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
45412f8d396bSPeter Tyser
45422f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
45432f8d396bSPeter Tyser      be executed on computers running Windows.
45442f8d396bSPeter Tyser
4545c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4546c609719bSwdenksources you must configure U-Boot for one specific board type. This
4547c609719bSwdenkis done by typing:
4548c609719bSwdenk
4549c609719bSwdenk	make NAME_config
4550c609719bSwdenk
4551218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
45524d675ae6SMichael Jonesrations; see boards.cfg for supported names.
455354387ac9Swdenk
4554c609719bSwdenkNote: for some board special configuration names may exist; check if
4555c609719bSwdenk      additional information is available from the board vendor; for
45562729af9dSwdenk      instance, the TQM823L systems are available without (standard)
45572729af9dSwdenk      or with LCD support. You can select such additional "features"
455811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4559c609719bSwdenk
45602729af9dSwdenk      make TQM823L_config
45612729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4562c609719bSwdenk
4563c609719bSwdenk      make TQM823L_LCD_config
4564c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4565c609719bSwdenk
4566c609719bSwdenk      etc.
4567c609719bSwdenk
4568c609719bSwdenk
4569c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
45707152b1d0Swdenkimages ready for download to / installation on your system:
4571c609719bSwdenk
4572c609719bSwdenk- "u-boot.bin" is a raw binary image
4573c609719bSwdenk- "u-boot" is an image in ELF binary format
4574c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4575c609719bSwdenk
4576baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4577baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4578baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4579baf31249SMarian Balakowicz
4580baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4581baf31249SMarian Balakowicz
4582baf31249SMarian Balakowicz	make O=/tmp/build distclean
4583baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4584baf31249SMarian Balakowicz	make O=/tmp/build all
4585baf31249SMarian Balakowicz
4586baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4587baf31249SMarian Balakowicz
4588baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4589baf31249SMarian Balakowicz	make distclean
4590baf31249SMarian Balakowicz	make NAME_config
4591baf31249SMarian Balakowicz	make all
4592baf31249SMarian Balakowicz
4593baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4594baf31249SMarian Balakowiczvariable.
4595baf31249SMarian Balakowicz
4596c609719bSwdenk
4597c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4598c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4599c609719bSwdenknative "make".
4600c609719bSwdenk
4601c609719bSwdenk
4602c609719bSwdenkIf the system board that you have is not listed, then you will need
4603c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4604c609719bSwdenksteps:
4605c609719bSwdenk
4606c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
46074d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
46084d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4609c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
461085ec0bccSwdenk    files you need. In your board directory, you will need at least
461185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
461285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
461385ec0bccSwdenk    your board
4614c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4615c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
461685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4617c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4618c609719bSwdenk    to be installed on your target system.
461985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4620c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4621c609719bSwdenk
4622c609719bSwdenk
4623c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4624c609719bSwdenk==============================================================
4625c609719bSwdenk
4626c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4627c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4628c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4629c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4630218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4631c609719bSwdenk
4632c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4633c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4634c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4635c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4636c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
46377152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4638218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4639218ca724SWolfgang Denkyou can type
4640c609719bSwdenk
4641c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4642c609719bSwdenk
4643c609719bSwdenkor to build on a native PowerPC system you can type
4644c609719bSwdenk
4645c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4646c609719bSwdenk
4647218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4648218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4649218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4650218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4651218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4652218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4653218ca724SWolfgang Denkvariable. For example:
4654baf31249SMarian Balakowicz
4655baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4656baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4657baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4658baf31249SMarian Balakowicz
4659218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4660218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4661218ca724SWolfgang Denkduring the whole build process.
4662baf31249SMarian Balakowicz
4663baf31249SMarian Balakowicz
4664c609719bSwdenkSee also "U-Boot Porting Guide" below.
4665c609719bSwdenk
4666c609719bSwdenk
4667c609719bSwdenkMonitor Commands - Overview:
4668c609719bSwdenk============================
4669c609719bSwdenk
4670c609719bSwdenkgo	- start application at address 'addr'
4671c609719bSwdenkrun	- run commands in an environment variable
4672c609719bSwdenkbootm	- boot application image from memory
4673c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
467444f074c7SMarek Vasutbootz   - boot zImage from memory
4675c609719bSwdenktftpboot- boot image via network using TFTP protocol
4676c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4677c609719bSwdenk	       (and eventually "gatewayip")
46781fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4679c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4680c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4681c609719bSwdenkloads	- load S-Record file over serial line
4682c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4683c609719bSwdenkmd	- memory display
4684c609719bSwdenkmm	- memory modify (auto-incrementing)
4685c609719bSwdenknm	- memory modify (constant address)
4686c609719bSwdenkmw	- memory write (fill)
4687c609719bSwdenkcp	- memory copy
4688c609719bSwdenkcmp	- memory compare
4689c609719bSwdenkcrc32	- checksum calculation
46900f89c54bSPeter Tyseri2c	- I2C sub-system
4691c609719bSwdenksspi	- SPI utility commands
4692c609719bSwdenkbase	- print or set address offset
4693c609719bSwdenkprintenv- print environment variables
4694c609719bSwdenksetenv	- set environment variables
4695c609719bSwdenksaveenv - save environment variables to persistent storage
4696c609719bSwdenkprotect - enable or disable FLASH write protection
4697c609719bSwdenkerase	- erase FLASH memory
4698c609719bSwdenkflinfo	- print FLASH memory information
469910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4700c609719bSwdenkbdinfo	- print Board Info structure
4701c609719bSwdenkiminfo	- print header information for application image
4702c609719bSwdenkconinfo - print console devices and informations
4703c609719bSwdenkide	- IDE sub-system
4704c609719bSwdenkloop	- infinite loop on address range
470556523f12Swdenkloopw	- infinite write loop on address range
4706c609719bSwdenkmtest	- simple RAM test
4707c609719bSwdenkicache	- enable or disable instruction cache
4708c609719bSwdenkdcache	- enable or disable data cache
4709c609719bSwdenkreset	- Perform RESET of the CPU
4710c609719bSwdenkecho	- echo args to console
4711c609719bSwdenkversion - print monitor version
4712c609719bSwdenkhelp	- print online help
4713c609719bSwdenk?	- alias for 'help'
4714c609719bSwdenk
4715c609719bSwdenk
4716c609719bSwdenkMonitor Commands - Detailed Description:
4717c609719bSwdenk========================================
4718c609719bSwdenk
4719c609719bSwdenkTODO.
4720c609719bSwdenk
4721c609719bSwdenkFor now: just type "help <command>".
4722c609719bSwdenk
4723c609719bSwdenk
4724c609719bSwdenkEnvironment Variables:
4725c609719bSwdenk======================
4726c609719bSwdenk
4727c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4728c609719bSwdenkcan be made persistent by saving to Flash memory.
4729c609719bSwdenk
4730c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4731c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4732c609719bSwdenkwithout a value can be used to delete a variable from the
4733c609719bSwdenkenvironment. As long as you don't save the environment you are
4734c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4735c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4736c609719bSwdenk
4737c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4738c96f86eeSWolfgang Denk
4739c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4740c609719bSwdenk
4741c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4742c609719bSwdenk
4743c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4744c609719bSwdenk
4745c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4746c609719bSwdenk
4747c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4748c609719bSwdenk
4749c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4750c609719bSwdenk
47517d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
47527d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47537d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
47547d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
47557d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
47567d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4757c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4758c3624e6eSGrant Likely		  bootm_mapsize.
4759c3624e6eSGrant Likely
4760c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4761c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4762c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4763c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4764c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4765c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4766c3624e6eSGrant Likely		  used otherwise.
47677d721e34SBartlomiej Sieka
47687d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
47697d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47707d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
47717d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
47727d721e34SBartlomiej Sieka		  environment variable.
47737d721e34SBartlomiej Sieka
47744bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
47754bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
47764bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
47774bae9090SBartlomiej Sieka
4778c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4779c609719bSwdenk		  "bootp" will just load perform a lookup of the
4780c609719bSwdenk		  configuration from the BOOTP server, but not try to
4781c609719bSwdenk		  load any image using TFTP
4782c609719bSwdenk
4783c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4784c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4785c609719bSwdenk		  be automatically started (by internally calling
4786c609719bSwdenk		  "bootm")
4787c609719bSwdenk
47884a6fd34bSwdenk		  If set to "no", a standalone image passed to the
47894a6fd34bSwdenk		  "bootm" command will be copied to the load address
47904a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
47914a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
47924a6fd34bSwdenk		  data.
47934a6fd34bSwdenk
4794a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4795a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4796fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4797fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4798fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4799fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4800fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4801fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4802fa34f6b2SShawn Guo		  access it during the boot procedure.
4803fa34f6b2SShawn Guo
4804a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4805a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4806a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4807a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4808a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4809a28afca5SDavid A. Long		  must be accessible by the kernel.
4810a28afca5SDavid A. Long
4811eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4812eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4813eea63e05SSimon Glass		  defined.
4814eea63e05SSimon Glass
481517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
481617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
481717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
481817ea1177Swdenk		  initialization code. So, for changes to be effective
481917ea1177Swdenk		  it must be saved and board must be reset.
482017ea1177Swdenk
4821c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4822c609719bSwdenk		  If this variable is not set, initrd images will be
4823c609719bSwdenk		  copied to the highest possible address in RAM; this
4824c609719bSwdenk		  is usually what you want since it allows for
4825c609719bSwdenk		  maximum initrd size. If for some reason you want to
4826c609719bSwdenk		  make sure that the initrd image is loaded below the
48276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4828c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4829c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4830c609719bSwdenk		  address to use (U-Boot will still check that it
4831c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4832c609719bSwdenk
4833c609719bSwdenk		  For instance, when you have a system with 16 MB
48347152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4835c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4836c609719bSwdenk		  the "bootargs" variable. However, now you must make
48377152b1d0Swdenk		  sure that the initrd image is placed in the first
4838c609719bSwdenk		  12 MB as well - this can be done with
4839c609719bSwdenk
4840c609719bSwdenk		  setenv initrd_high 00c00000
4841c609719bSwdenk
484238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
484338b99261Swdenk		  indication to U-Boot that all addresses are legal
484438b99261Swdenk		  for the Linux kernel, including addresses in flash
484538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
484638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
484738b99261Swdenk		  boot time on your system, but requires that this
484838b99261Swdenk		  feature is supported by your Linux kernel.
484938b99261Swdenk
4850c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4851c609719bSwdenk
4852c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4853dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4854c609719bSwdenk
4855c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4856c609719bSwdenk
4857c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4858c609719bSwdenk
4859c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4860c609719bSwdenk
4861c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4862c609719bSwdenk
4863c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4864c609719bSwdenk
4865e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4866a3d991bdSwdenk
4867e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4868e2a53458SMike Frysinger		  For example you can do the following
4869a3d991bdSwdenk
487048690d80SHeiko Schocher		  => setenv ethact FEC
487148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
487248690d80SHeiko Schocher		  => setenv ethact SCC
487348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4874a3d991bdSwdenk
4875e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4876e1692577SMatthias Fuchs		  available network interfaces.
4877e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4878e1692577SMatthias Fuchs
4879a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4880a3d991bdSwdenk		  either succeed or fail without retrying.
48816e592385Swdenk		  When set to "once" the network operation will
48826e592385Swdenk		  fail when all the available network interfaces
48836e592385Swdenk		  are tried once without success.
4884a3d991bdSwdenk		  Useful on scripts which control the retry operation
4885a3d991bdSwdenk		  themselves.
4886a3d991bdSwdenk
4887b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4888a1cf027aSJean-Christophe PLAGNIOL-VILLARD
48898d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
48908d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
48918d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
48928d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
48938d51aacdSSimon Glass		  is silent.
48948d51aacdSSimon Glass
489528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4896ecb0ccd9SWolfgang Denk		  UDP source port.
4897ecb0ccd9SWolfgang Denk
489828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
489928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
490028cb9375SWolfgang Denk
4901c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4902c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4903c96f86eeSWolfgang Denk
4904c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4905c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4906c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4907c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4908c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4909c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4910c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4911c96f86eeSWolfgang Denk
4912a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
491311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4914a3d991bdSwdenk		  VLAN tagged frames.
4915c609719bSwdenk
4916dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4917dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4918dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4919dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4920dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4921dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4922dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4923dc0b7b0eSJason Hobbs
4924dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4925dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4926dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4927dc0b7b0eSJason Hobbs
4928dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4929dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4930dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4931dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4932dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4933dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4934dc0b7b0eSJason Hobbs
4935c609719bSwdenkThe following environment variables may be used and automatically
4936c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4937c609719bSwdenkdepending the information provided by your boot server:
4938c609719bSwdenk
4939c609719bSwdenk  bootfile	- see above
4940c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4941fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4942c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4943c609719bSwdenk  hostname	- Target hostname
4944c609719bSwdenk  ipaddr	- see above
4945c609719bSwdenk  netmask	- Subnet Mask
4946c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4947c609719bSwdenk  serverip	- see above
4948c609719bSwdenk
4949c609719bSwdenk
4950c609719bSwdenkThere are two special Environment Variables:
4951c609719bSwdenk
4952c609719bSwdenk  serial#	- contains hardware identification information such
4953c609719bSwdenk		  as type string and/or serial number
4954c609719bSwdenk  ethaddr	- Ethernet address
4955c609719bSwdenk
4956c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4957c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4958c609719bSwdenkonce they have been set once.
4959c609719bSwdenk
4960c609719bSwdenk
4961c1551ea8SstroeseFurther special Environment Variables:
4962c1551ea8Sstroese
4963c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4964c1551ea8Sstroese		  with the "version" command. This variable is
4965c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4966c1551ea8Sstroese
4967c1551ea8Sstroese
4968c609719bSwdenkPlease note that changes to some configuration parameters may take
4969c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4970c609719bSwdenk
4971c609719bSwdenk
4972170ab110SJoe HershbergerCallback functions for environment variables:
4973170ab110SJoe Hershberger---------------------------------------------
4974170ab110SJoe Hershberger
4975170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4976170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4977170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4978170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4979170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4980170ab110SJoe Hershberger
4981170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4982170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4983170ab110SJoe Hershberger
4984170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4985170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4986170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4987170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4988170ab110SJoe Hershberger
4989170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4990170ab110SJoe Hershberger	list = entry[,list]
4991170ab110SJoe Hershberger
4992170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4993170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4994170ab110SJoe Hershberger
4995170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4996170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4997170ab110SJoe Hershbergeroverride any association in the static list. You can define
4998170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4999170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5000170ab110SJoe Hershberger
5001170ab110SJoe Hershberger
5002f07771ccSwdenkCommand Line Parsing:
5003f07771ccSwdenk=====================
5004f07771ccSwdenk
5005f07771ccSwdenkThere are two different command line parsers available with U-Boot:
50067152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5007f07771ccSwdenk
5008f07771ccSwdenkOld, simple command line parser:
5009f07771ccSwdenk--------------------------------
5010f07771ccSwdenk
5011f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5012f07771ccSwdenk- several commands on one line, separated by ';'
5013fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5014f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5015f07771ccSwdenk  for example:
5016fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5017f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5018f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5019f07771ccSwdenk
5020f07771ccSwdenkHush shell:
5021f07771ccSwdenk-----------
5022f07771ccSwdenk
5023f07771ccSwdenk- similar to Bourne shell, with control structures like
5024f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5025f07771ccSwdenk  until...do...done, ...
5026f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5027f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5028f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5029f07771ccSwdenk  command
5030f07771ccSwdenk
5031f07771ccSwdenkGeneral rules:
5032f07771ccSwdenk--------------
5033f07771ccSwdenk
5034f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5035f07771ccSwdenk    command) contains several commands separated by semicolon, and
5036f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5037f07771ccSwdenk    executed anyway.
5038f07771ccSwdenk
5039f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
504011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5041f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5042f07771ccSwdenk    variables are not executed.
5043f07771ccSwdenk
5044c609719bSwdenkNote for Redundant Ethernet Interfaces:
5045c609719bSwdenk=======================================
5046c609719bSwdenk
504711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5048c609719bSwdenksuch configurations and is capable of automatic selection of a
50497152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5050c609719bSwdenk
5051c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5052c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5053c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5054c609719bSwdenk
5055c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5056c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5057c609719bSwdenkding setting in the environment; if the corresponding environment
5058c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5059c609719bSwdenk
5060c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5061c609719bSwdenk  environment, the SROM's address is used.
5062c609719bSwdenk
5063c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5064c609719bSwdenk  environment exists, then the value from the environment variable is
5065c609719bSwdenk  used.
5066c609719bSwdenk
5067c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5068c609719bSwdenk  both addresses are the same, this MAC address is used.
5069c609719bSwdenk
5070c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5071c609719bSwdenk  addresses differ, the value from the environment is used and a
5072c609719bSwdenk  warning is printed.
5073c609719bSwdenk
5074c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5075c609719bSwdenk  is raised.
5076c609719bSwdenk
5077ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5078ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5079ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5080ecee9324SBen WarrenThe naming convention is as follows:
5081ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5082c609719bSwdenk
5083c609719bSwdenkImage Formats:
5084c609719bSwdenk==============
5085c609719bSwdenk
50863310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
50873310c549SMarian Balakowiczimages in two formats:
50883310c549SMarian Balakowicz
50893310c549SMarian BalakowiczNew uImage format (FIT)
50903310c549SMarian Balakowicz-----------------------
50913310c549SMarian Balakowicz
50923310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
50933310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
50943310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
50953310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
50963310c549SMarian Balakowicz
50973310c549SMarian Balakowicz
50983310c549SMarian BalakowiczOld uImage format
50993310c549SMarian Balakowicz-----------------
51003310c549SMarian Balakowicz
51013310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51023310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51033310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5104c609719bSwdenk
5105c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5106c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5107f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5108f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5109f5ed9e39SPeter Tyser  INTEGRITY).
51107b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5111afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5112afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5113c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5114c609719bSwdenk* Load Address
5115c609719bSwdenk* Entry Point
5116c609719bSwdenk* Image Name
5117c609719bSwdenk* Image Timestamp
5118c609719bSwdenk
5119c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5120c609719bSwdenkand the data portions of the image are secured against corruption by
5121c609719bSwdenkCRC32 checksums.
5122c609719bSwdenk
5123c609719bSwdenk
5124c609719bSwdenkLinux Support:
5125c609719bSwdenk==============
5126c609719bSwdenk
5127c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51287152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5129c609719bSwdenkU-Boot.
5130c609719bSwdenk
5131c609719bSwdenkU-Boot includes many features that so far have been part of some
5132c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5133c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5134c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
51357152b1d0Swdenkserves several purposes:
5136c609719bSwdenk
5137c609719bSwdenk- the same features can be used for other OS or standalone
5138c609719bSwdenk  applications (for instance: using compressed images to reduce the
5139c609719bSwdenk  Flash memory footprint)
5140c609719bSwdenk
5141c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
51427152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5143c609719bSwdenk
5144c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5145c609719bSwdenk  images; of course this also means that different kernel images can
5146c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5147c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5148c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5149c609719bSwdenk  software is easier now.
5150c609719bSwdenk
5151c609719bSwdenk
5152c609719bSwdenkLinux HOWTO:
5153c609719bSwdenk============
5154c609719bSwdenk
5155c609719bSwdenkPorting Linux to U-Boot based systems:
5156c609719bSwdenk---------------------------------------
5157c609719bSwdenk
5158c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5159c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5160c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5161c609719bSwdenkLinux :-).
5162c609719bSwdenk
5163a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5164c609719bSwdenk
5165c609719bSwdenkJust make sure your machine specific header file (for instance
5166c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
51671dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
51681dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
51696d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5170c609719bSwdenk
5171c609719bSwdenk
5172c609719bSwdenkConfiguring the Linux kernel:
5173c609719bSwdenk-----------------------------
5174c609719bSwdenk
5175c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5176c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5177c609719bSwdenk
5178c609719bSwdenk
5179c609719bSwdenkBuilding a Linux Image:
5180c609719bSwdenk-----------------------
5181c609719bSwdenk
518224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
518324ee89b9Swdenknot used. If you use recent kernel source, a new build target
518424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
518524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
518624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
518724ee89b9Swdenk100% compatible format.
5188c609719bSwdenk
5189c609719bSwdenkExample:
5190c609719bSwdenk
5191c609719bSwdenk	make TQM850L_config
5192c609719bSwdenk	make oldconfig
5193c609719bSwdenk	make dep
519424ee89b9Swdenk	make uImage
5195c609719bSwdenk
519624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
519724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
519824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5199c609719bSwdenk
520024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
520124ee89b9Swdenk
520224ee89b9Swdenk* convert the kernel into a raw binary image:
520324ee89b9Swdenk
520424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
520524ee89b9Swdenk				 -R .note -R .comment \
520624ee89b9Swdenk				 -S vmlinux linux.bin
520724ee89b9Swdenk
520824ee89b9Swdenk* compress the binary image:
520924ee89b9Swdenk
521024ee89b9Swdenk	gzip -9 linux.bin
521124ee89b9Swdenk
521224ee89b9Swdenk* package compressed binary image for U-Boot:
521324ee89b9Swdenk
521424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
521524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
521624ee89b9Swdenk		-d linux.bin.gz uImage
521724ee89b9Swdenk
521824ee89b9Swdenk
521924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
522024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
522124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
522224ee89b9Swdenkbyte header containing information about target architecture,
522324ee89b9Swdenkoperating system, image type, compression method, entry points, time
522424ee89b9Swdenkstamp, CRC32 checksums, etc.
522524ee89b9Swdenk
522624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
522724ee89b9Swdenkprint the header information, or to build new images.
5228c609719bSwdenk
5229c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5230c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5231c609719bSwdenkchecksum verification:
5232c609719bSwdenk
5233c609719bSwdenk	tools/mkimage -l image
5234c609719bSwdenk	  -l ==> list image header information
5235c609719bSwdenk
5236c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5237c609719bSwdenkfrom a "data file" which is used as image payload:
5238c609719bSwdenk
5239c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5240c609719bSwdenk		      -n name -d data_file image
5241c609719bSwdenk	  -A ==> set architecture to 'arch'
5242c609719bSwdenk	  -O ==> set operating system to 'os'
5243c609719bSwdenk	  -T ==> set image type to 'type'
5244c609719bSwdenk	  -C ==> set compression type 'comp'
5245c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5246c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5247c609719bSwdenk	  -n ==> set image name to 'name'
5248c609719bSwdenk	  -d ==> use image data from 'datafile'
5249c609719bSwdenk
525069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
525169459791Swdenkaddress (0x00000000), but the entry point address depends on the
525269459791Swdenkkernel version:
5253c609719bSwdenk
5254c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
525524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5256c609719bSwdenk
5257c609719bSwdenkSo a typical call to build a U-Boot image would read:
5258c609719bSwdenk
525924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
526024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5261a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
526224ee89b9Swdenk	> examples/uImage.TQM850L
526324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5264c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5265c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5266c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5267c609719bSwdenk	Load Address: 0x00000000
526824ee89b9Swdenk	Entry Point:  0x00000000
5269c609719bSwdenk
5270c609719bSwdenkTo verify the contents of the image (or check for corruption):
5271c609719bSwdenk
527224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
527324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5274c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5275c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5276c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5277c609719bSwdenk	Load Address: 0x00000000
527824ee89b9Swdenk	Entry Point:  0x00000000
5279c609719bSwdenk
5280c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5281c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5282c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5283c609719bSwdenkneed to be uncompressed:
5284c609719bSwdenk
5285a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
528624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
528724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5288a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
528924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
529024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5291c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5292c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5293c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5294c609719bSwdenk	Load Address: 0x00000000
529524ee89b9Swdenk	Entry Point:  0x00000000
5296c609719bSwdenk
5297c609719bSwdenk
5298c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5299c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5300c609719bSwdenk
5301c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5302c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5303c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5304c609719bSwdenk	Image Name:   Simple Ramdisk Image
5305c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5306c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5307c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5308c609719bSwdenk	Load Address: 0x00000000
5309c609719bSwdenk	Entry Point:  0x00000000
5310c609719bSwdenk
5311a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5312a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5313a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5314a804b5ceSGuilherme Maciel Ferreirafrom the image:
5315a804b5ceSGuilherme Maciel Ferreira
5316a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5317a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5318a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5319a804b5ceSGuilherme Maciel Ferreira
5320c609719bSwdenk
5321c609719bSwdenkInstalling a Linux Image:
5322c609719bSwdenk-------------------------
5323c609719bSwdenk
5324c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5325c609719bSwdenkyou must convert the image to S-Record format:
5326c609719bSwdenk
5327c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5328c609719bSwdenk
5329c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5330c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5331c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5332c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5333c609719bSwdenkcommand.
5334c609719bSwdenk
5335c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5336c609719bSwdenkTQM8xxL is in the first Flash bank):
5337c609719bSwdenk
5338c609719bSwdenk	=> erase 40100000 401FFFFF
5339c609719bSwdenk
5340c609719bSwdenk	.......... done
5341c609719bSwdenk	Erased 8 sectors
5342c609719bSwdenk
5343c609719bSwdenk	=> loads 40100000
5344c609719bSwdenk	## Ready for S-Record download ...
5345c609719bSwdenk	~>examples/image.srec
5346c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5347c609719bSwdenk	...
5348c609719bSwdenk	15989 15990 15991 15992
5349c609719bSwdenk	[file transfer complete]
5350c609719bSwdenk	[connected]
5351c609719bSwdenk	## Start Addr = 0x00000000
5352c609719bSwdenk
5353c609719bSwdenk
5354c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5355c609719bSwdenkthis includes a checksum verification so you can be sure no data
5356c609719bSwdenkcorruption happened:
5357c609719bSwdenk
5358c609719bSwdenk	=> imi 40100000
5359c609719bSwdenk
5360c609719bSwdenk	## Checking Image at 40100000 ...
5361c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5362c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5363c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5364c609719bSwdenk	   Load Address: 00000000
5365c609719bSwdenk	   Entry Point:	 0000000c
5366c609719bSwdenk	   Verifying Checksum ... OK
5367c609719bSwdenk
5368c609719bSwdenk
5369c609719bSwdenkBoot Linux:
5370c609719bSwdenk-----------
5371c609719bSwdenk
5372c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5373c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5374c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5375c609719bSwdenkparameters. You can check and modify this variable using the
5376c609719bSwdenk"printenv" and "setenv" commands:
5377c609719bSwdenk
5378c609719bSwdenk
5379c609719bSwdenk	=> printenv bootargs
5380c609719bSwdenk	bootargs=root=/dev/ram
5381c609719bSwdenk
5382c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5383c609719bSwdenk
5384c609719bSwdenk	=> printenv bootargs
5385c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5386c609719bSwdenk
5387c609719bSwdenk	=> bootm 40020000
5388c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5389c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5390c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5391c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5392c609719bSwdenk	   Load Address: 00000000
5393c609719bSwdenk	   Entry Point:	 0000000c
5394c609719bSwdenk	   Verifying Checksum ... OK
5395c609719bSwdenk	   Uncompressing Kernel Image ... OK
5396c609719bSwdenk	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
5397c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5398c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5399c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5400c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5401c609719bSwdenk	...
5402c609719bSwdenk
540311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54047152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5405c609719bSwdenkformat!) to the "bootm" command:
5406c609719bSwdenk
5407c609719bSwdenk	=> imi 40100000 40200000
5408c609719bSwdenk
5409c609719bSwdenk	## Checking Image at 40100000 ...
5410c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5411c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5412c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5413c609719bSwdenk	   Load Address: 00000000
5414c609719bSwdenk	   Entry Point:	 0000000c
5415c609719bSwdenk	   Verifying Checksum ... OK
5416c609719bSwdenk
5417c609719bSwdenk	## Checking Image at 40200000 ...
5418c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5419c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5420c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5421c609719bSwdenk	   Load Address: 00000000
5422c609719bSwdenk	   Entry Point:	 00000000
5423c609719bSwdenk	   Verifying Checksum ... OK
5424c609719bSwdenk
5425c609719bSwdenk	=> bootm 40100000 40200000
5426c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5427c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5428c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5429c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5430c609719bSwdenk	   Load Address: 00000000
5431c609719bSwdenk	   Entry Point:	 0000000c
5432c609719bSwdenk	   Verifying Checksum ... OK
5433c609719bSwdenk	   Uncompressing Kernel Image ... OK
5434c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5435c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5436c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5437c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5438c609719bSwdenk	   Load Address: 00000000
5439c609719bSwdenk	   Entry Point:	 00000000
5440c609719bSwdenk	   Verifying Checksum ... OK
5441c609719bSwdenk	   Loading Ramdisk ... OK
5442c609719bSwdenk	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
5443c609719bSwdenk	Boot arguments: root=/dev/ram
5444c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5445c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5446c609719bSwdenk	...
5447c609719bSwdenk	RAMDISK: Compressed image found at block 0
5448c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5449c609719bSwdenk
5450c609719bSwdenk	bash#
5451c609719bSwdenk
54520267768eSMatthew McClintockBoot Linux and pass a flat device tree:
54530267768eSMatthew McClintock-----------
54540267768eSMatthew McClintock
54550267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
54560267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
54570267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
54580267768eSMatthew McClintockflat device tree:
54590267768eSMatthew McClintock
54600267768eSMatthew McClintock=> print oftaddr
54610267768eSMatthew McClintockoftaddr=0x300000
54620267768eSMatthew McClintock=> print oft
54630267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
54640267768eSMatthew McClintock=> tftp $oftaddr $oft
54650267768eSMatthew McClintockSpeed: 1000, full duplex
54660267768eSMatthew McClintockUsing TSEC0 device
54670267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
54680267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
54690267768eSMatthew McClintockLoad address: 0x300000
54700267768eSMatthew McClintockLoading: #
54710267768eSMatthew McClintockdone
54720267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
54730267768eSMatthew McClintock=> tftp $loadaddr $bootfile
54740267768eSMatthew McClintockSpeed: 1000, full duplex
54750267768eSMatthew McClintockUsing TSEC0 device
54760267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
54770267768eSMatthew McClintockFilename 'uImage'.
54780267768eSMatthew McClintockLoad address: 0x200000
54790267768eSMatthew McClintockLoading:############
54800267768eSMatthew McClintockdone
54810267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
54820267768eSMatthew McClintock=> print loadaddr
54830267768eSMatthew McClintockloadaddr=200000
54840267768eSMatthew McClintock=> print oftaddr
54850267768eSMatthew McClintockoftaddr=0x300000
54860267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
54870267768eSMatthew McClintock## Booting image at 00200000 ...
54880267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
54890267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
54900267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
54910267768eSMatthew McClintock   Load Address: 00000000
54920267768eSMatthew McClintock   Entry Point:	 00000000
54930267768eSMatthew McClintock   Verifying Checksum ... OK
54940267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
54950267768eSMatthew McClintockBooting using flat device tree at 0x300000
54960267768eSMatthew McClintockUsing MPC85xx ADS machine description
54970267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
54980267768eSMatthew McClintock[snip]
54990267768eSMatthew McClintock
55000267768eSMatthew McClintock
55016069ff26SwdenkMore About U-Boot Image Types:
55026069ff26Swdenk------------------------------
55036069ff26Swdenk
55046069ff26SwdenkU-Boot supports the following image types:
55056069ff26Swdenk
55066069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
55076069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
55086069ff26Swdenk	well) you can continue to work in U-Boot after return from
55096069ff26Swdenk	the Standalone Program.
55106069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
55116069ff26Swdenk	will take over control completely. Usually these programs
55126069ff26Swdenk	will install their own set of exception handlers, device
55136069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
55146069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
55156069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
55166069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
55176069ff26Swdenk	being started.
55186069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
55196069ff26Swdenk	(Linux) kernel image and one or more data images like
55206069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
55216069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
55226069ff26Swdenk	server provides just a single image file, but you want to get
55236069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
55246069ff26Swdenk
55256069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
55266069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55276069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55286069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55296069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
55306069ff26Swdenk	a multiple of 4 bytes).
55316069ff26Swdenk
55326069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
55336069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
55346069ff26Swdenk	flash memory.
55356069ff26Swdenk
55366069ff26Swdenk   "Script files" are command sequences that will be executed by
55376069ff26Swdenk	U-Boot's command interpreter; this feature is especially
55386069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
55396069ff26Swdenk	as command interpreter.
55406069ff26Swdenk
554144f074c7SMarek VasutBooting the Linux zImage:
554244f074c7SMarek Vasut-------------------------
554344f074c7SMarek Vasut
554444f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
554544f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
554644f074c7SMarek Vasutas the syntax of "bootm" command.
554744f074c7SMarek Vasut
55488ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5549017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5550017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5551017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5552017e1f3fSMarek Vasut
5553c609719bSwdenk
5554c609719bSwdenkStandalone HOWTO:
5555c609719bSwdenk=================
5556c609719bSwdenk
5557c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5558c609719bSwdenkrun "standalone" applications, which can use some resources of
5559c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5560c609719bSwdenk
5561c609719bSwdenkTwo simple examples are included with the sources:
5562c609719bSwdenk
5563c609719bSwdenk"Hello World" Demo:
5564c609719bSwdenk-------------------
5565c609719bSwdenk
5566c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5567c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5568c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5569c609719bSwdenklike that:
5570c609719bSwdenk
5571c609719bSwdenk	=> loads
5572c609719bSwdenk	## Ready for S-Record download ...
5573c609719bSwdenk	~>examples/hello_world.srec
5574c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5575c609719bSwdenk	[file transfer complete]
5576c609719bSwdenk	[connected]
5577c609719bSwdenk	## Start Addr = 0x00040004
5578c609719bSwdenk
5579c609719bSwdenk	=> go 40004 Hello World! This is a test.
5580c609719bSwdenk	## Starting application at 0x00040004 ...
5581c609719bSwdenk	Hello World
5582c609719bSwdenk	argc = 7
5583c609719bSwdenk	argv[0] = "40004"
5584c609719bSwdenk	argv[1] = "Hello"
5585c609719bSwdenk	argv[2] = "World!"
5586c609719bSwdenk	argv[3] = "This"
5587c609719bSwdenk	argv[4] = "is"
5588c609719bSwdenk	argv[5] = "a"
5589c609719bSwdenk	argv[6] = "test."
5590c609719bSwdenk	argv[7] = "<NULL>"
5591c609719bSwdenk	Hit any key to exit ...
5592c609719bSwdenk
5593c609719bSwdenk	## Application terminated, rc = 0x0
5594c609719bSwdenk
5595c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5596c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5597c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5598c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5599c609719bSwdenkcharacter, but this is just a demo program. The application can be
5600c609719bSwdenkcontrolled by the following keys:
5601c609719bSwdenk
5602c609719bSwdenk	? - print current values og the CPM Timer registers
5603c609719bSwdenk	b - enable interrupts and start timer
5604c609719bSwdenk	e - stop timer and disable interrupts
5605c609719bSwdenk	q - quit application
5606c609719bSwdenk
5607c609719bSwdenk	=> loads
5608c609719bSwdenk	## Ready for S-Record download ...
5609c609719bSwdenk	~>examples/timer.srec
5610c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5611c609719bSwdenk	[file transfer complete]
5612c609719bSwdenk	[connected]
5613c609719bSwdenk	## Start Addr = 0x00040004
5614c609719bSwdenk
5615c609719bSwdenk	=> go 40004
5616c609719bSwdenk	## Starting application at 0x00040004 ...
5617c609719bSwdenk	TIMERS=0xfff00980
5618c609719bSwdenk	Using timer 1
5619c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5620c609719bSwdenk
5621c609719bSwdenkHit 'b':
5622c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5623c609719bSwdenk	Enabling timer
5624c609719bSwdenkHit '?':
5625c609719bSwdenk	[q, b, e, ?] ........
5626c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5627c609719bSwdenkHit '?':
5628c609719bSwdenk	[q, b, e, ?] .
5629c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5630c609719bSwdenkHit '?':
5631c609719bSwdenk	[q, b, e, ?] .
5632c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5633c609719bSwdenkHit '?':
5634c609719bSwdenk	[q, b, e, ?] .
5635c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5636c609719bSwdenkHit 'e':
5637c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5638c609719bSwdenkHit 'q':
5639c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5640c609719bSwdenk
5641c609719bSwdenk
564285ec0bccSwdenkMinicom warning:
564385ec0bccSwdenk================
564485ec0bccSwdenk
56457152b1d0SwdenkOver time, many people have reported problems when trying to use the
564685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
564785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5648f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
564985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5650e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5651e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5652e53515a2SKarl O. Pincfor help with kermit.
5653e53515a2SKarl O. Pinc
565485ec0bccSwdenk
565552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
565652f52c14Swdenkconfiguration to your "File transfer protocols" section:
565752f52c14Swdenk
565852f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
565952f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
566052f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
566152f52c14Swdenk
566252f52c14Swdenk
5663c609719bSwdenkNetBSD Notes:
5664c609719bSwdenk=============
5665c609719bSwdenk
5666c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5667c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5668c609719bSwdenk
5669c609719bSwdenkBuilding requires a cross environment; it is known to work on
5670c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5671c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5672c609719bSwdenkNote that the cross-powerpc package does not install include files;
5673c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5674c609719bSwdenkmissing.  This file has to be installed and patched manually:
5675c609719bSwdenk
5676c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5677c609719bSwdenk	# mkdir powerpc
5678c609719bSwdenk	# ln -s powerpc machine
5679c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5680c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5681c609719bSwdenk
5682c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5683c609719bSwdenkand U-Boot include files.
5684c609719bSwdenk
5685c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5686c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5687c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5688c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
56892a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5690c609719bSwdenk
5691c609719bSwdenk
5692c609719bSwdenkImplementation Internals:
5693c609719bSwdenk=========================
5694c609719bSwdenk
5695c609719bSwdenkThe following is not intended to be a complete description of every
5696c609719bSwdenkimplementation detail. However, it should help to understand the
5697c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5698c609719bSwdenkhardware.
5699c609719bSwdenk
5700c609719bSwdenk
5701c609719bSwdenkInitial Stack, Global Data:
5702c609719bSwdenk---------------------------
5703c609719bSwdenk
5704c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5705c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5706c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5707c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5708c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5709c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5710c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5711c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5712c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5713c609719bSwdenklocked as (mis-) used as memory, etc.
5714c609719bSwdenk
57157152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
57160668236bSWolfgang Denk	U-Boot mailing list:
571743d9616cSwdenk
571843d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
571943d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
572043d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
572143d9616cSwdenk	...
572243d9616cSwdenk
572343d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
572443d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
572543d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
572643d9616cSwdenk	is that the cache is being used as a temporary supply of
572743d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
572811ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
572943d9616cSwdenk	can see how this works by studying the cache architecture and
573043d9616cSwdenk	operation in the architecture and processor-specific manuals.
573143d9616cSwdenk
573243d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
573343d9616cSwdenk	is another option for the system designer to use as an
573411ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
573543d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
573643d9616cSwdenk	board designers haven't used it for something that would
573743d9616cSwdenk	cause you grief during the initial boot! It is frequently not
573843d9616cSwdenk	used.
573943d9616cSwdenk
57406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
574143d9616cSwdenk	with your processor/board/system design. The default value
574243d9616cSwdenk	you will find in any recent u-boot distribution in
57438a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
574443d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
574543d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
574643d9616cSwdenk	that are supposed to respond to that address! That code in
574743d9616cSwdenk	start.S has been around a while and should work as is when
574843d9616cSwdenk	you get the config right.
574943d9616cSwdenk
575043d9616cSwdenk	-Chris Hallinan
575143d9616cSwdenk	DS4.COM, Inc.
575243d9616cSwdenk
5753c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5754c609719bSwdenkcode for the initialization procedures:
5755c609719bSwdenk
5756c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5757c609719bSwdenk  to write it.
5758c609719bSwdenk
575911ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5760c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
57617152b1d0Swdenk  zation is performed later (when relocating to RAM).
5762c609719bSwdenk
5763c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5764c609719bSwdenk  that.
5765c609719bSwdenk
5766c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5767c609719bSwdenknormal global data to share information beween the code. But it
5768c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5769c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5770c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5771c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5772c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5773c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5774c609719bSwdenkreserve for this purpose.
5775c609719bSwdenk
57767152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5777c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5778c609719bSwdenkGCC's implementation.
5779c609719bSwdenk
5780c609719bSwdenkFor PowerPC, the following registers have specific use:
5781c609719bSwdenk	R1:	stack pointer
5782e7670f6cSWolfgang Denk	R2:	reserved for system use
5783c609719bSwdenk	R3-R4:	parameter passing and return values
5784c609719bSwdenk	R5-R10: parameter passing
5785c609719bSwdenk	R13:	small data area pointer
5786c609719bSwdenk	R30:	GOT pointer
5787c609719bSwdenk	R31:	frame pointer
5788c609719bSwdenk
5789e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5790e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5791e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5792c609719bSwdenk
5793e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5794c609719bSwdenk
5795c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5796c609719bSwdenk    address of the global data structure is known at compile time),
5797c609719bSwdenk    but it turned out that reserving a register results in somewhat
5798c609719bSwdenk    smaller code - although the code savings are not that big (on
5799c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5800c609719bSwdenk    624 text + 127 data).
5801c609719bSwdenk
5802c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58034c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58044c58eb55SMike Frysinger
5805c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
58064c58eb55SMike Frysinger
5807c609719bSwdenkOn ARM, the following registers are used:
5808c609719bSwdenk
5809c609719bSwdenk	R0:	function argument word/integer result
5810c609719bSwdenk	R1-R3:	function argument word
581112eba1b4SJeroen Hofstee	R9:	platform specific
581212eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5813c609719bSwdenk	R11:	argument (frame) pointer
5814c609719bSwdenk	R12:	temporary workspace
5815c609719bSwdenk	R13:	stack pointer
5816c609719bSwdenk	R14:	link register
5817c609719bSwdenk	R15:	program counter
5818c609719bSwdenk
581912eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
582012eba1b4SJeroen Hofstee
582112eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5822c609719bSwdenk
58230df01fd3SThomas ChouOn Nios II, the ABI is documented here:
58240df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
58250df01fd3SThomas Chou
58260df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58270df01fd3SThomas Chou
58280df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58290df01fd3SThomas Chou    to access small data sections, so gp is free.
58300df01fd3SThomas Chou
5831afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5832afc1ce82SMacpaul Lin
5833afc1ce82SMacpaul Lin	R0-R1:	argument/return
5834afc1ce82SMacpaul Lin	R2-R5:	argument
5835afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5836afc1ce82SMacpaul Lin	R16:	trampoline register
5837afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5838afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5839afc1ce82SMacpaul Lin	R30:	link register (LP)
5840afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5841afc1ce82SMacpaul Lin	PC:	program counter (PC)
5842afc1ce82SMacpaul Lin
5843afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5844afc1ce82SMacpaul Lin
5845d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5846d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5847c609719bSwdenk
5848c609719bSwdenkMemory Management:
5849c609719bSwdenk------------------
5850c609719bSwdenk
5851c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5852c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5853c609719bSwdenk
5854c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5855c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5856c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5857c609719bSwdenkphysical memory banks.
5858c609719bSwdenk
5859c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5860c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5861c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5862c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
58636d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5864c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5865c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5866c609719bSwdenk
5867c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5868c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5869c609719bSwdenk
5870c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5871c609719bSwdenkthis:
5872c609719bSwdenk
5873c609719bSwdenk	0x0000 0000	Exception Vector code
5874c609719bSwdenk	      :
5875c609719bSwdenk	0x0000 1FFF
5876c609719bSwdenk	0x0000 2000	Free for Application Use
5877c609719bSwdenk	      :
5878c609719bSwdenk	      :
5879c609719bSwdenk
5880c609719bSwdenk	      :
5881c609719bSwdenk	      :
5882c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5883c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5884c609719bSwdenk	0x00FC 0000	Malloc Arena
5885c609719bSwdenk	      :
5886c609719bSwdenk	0x00FD FFFF
5887c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5888c609719bSwdenk	...		eventually: LCD or video framebuffer
5889c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5890c609719bSwdenk	0x00FF FFFF	[End of RAM]
5891c609719bSwdenk
5892c609719bSwdenk
5893c609719bSwdenkSystem Initialization:
5894c609719bSwdenk----------------------
5895c609719bSwdenk
5896c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
589711ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5898c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
58997152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5900c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5901c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5902c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5903c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5904c609719bSwdenkthe caches and the SIU.
5905c609719bSwdenk
5906c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5907c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5908c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5909c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5910c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5911c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5912c609719bSwdenkbanks.
5913c609719bSwdenk
5914c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
59157152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5916c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5917c609719bSwdenk0x00000000, with any additional banks following immediately to create
5918c609719bSwdenkcontiguous memory starting from 0.
5919c609719bSwdenk
5920c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5921c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5922c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5923c609719bSwdenkpages, and the final stack is set up.
5924c609719bSwdenk
5925c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5926c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5927c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5928c609719bSwdenknew address in RAM.
5929c609719bSwdenk
5930c609719bSwdenk
5931c609719bSwdenkU-Boot Porting Guide:
5932c609719bSwdenk----------------------
5933c609719bSwdenk
5934c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
59356aff3115Swdenklist, October 2002]
5936c609719bSwdenk
5937c609719bSwdenk
5938c609719bSwdenkint main(int argc, char *argv[])
5939c609719bSwdenk{
5940c609719bSwdenk	sighandler_t no_more_time;
5941c609719bSwdenk
5942c609719bSwdenk	signal(SIGALRM, no_more_time);
5943c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5944c609719bSwdenk
5945c609719bSwdenk	if (available_money > available_manpower) {
59466c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5947c609719bSwdenk		return 0;
5948c609719bSwdenk	}
5949c609719bSwdenk
5950c609719bSwdenk	Download latest U-Boot source;
5951c609719bSwdenk
59520668236bSWolfgang Denk	Subscribe to u-boot mailing list;
59536aff3115Swdenk
59546c3fef28SJerry Van Baren	if (clueless)
5955c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5956c609719bSwdenk
5957c609719bSwdenk	while (learning) {
5958c609719bSwdenk		Read the README file in the top level directory;
59597cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
59606c3fef28SJerry Van Baren		Read applicable doc/*.README;
5961c609719bSwdenk		Read the source, Luke;
59626c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5963c609719bSwdenk	}
5964c609719bSwdenk
59656c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
59666c3fef28SJerry Van Baren		Buy a BDI3000;
59676c3fef28SJerry Van Baren	else
5968c609719bSwdenk		Add a lot of aggravation and time;
5969c609719bSwdenk
59706c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
59716c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
59726c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
59736c3fef28SJerry Van Baren	} else {
5974c609719bSwdenk		Create your own board support subdirectory;
59756c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
59766c3fef28SJerry Van Baren	}
59776c3fef28SJerry Van Baren	Edit new board/<myboard> files
59786c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5979c609719bSwdenk
59806c3fef28SJerry Van Baren	while (!accepted) {
5981c609719bSwdenk		while (!running) {
5982c609719bSwdenk			do {
5983c609719bSwdenk				Add / modify source code;
5984c609719bSwdenk			} until (compiles);
5985c609719bSwdenk			Debug;
5986c609719bSwdenk			if (clueless)
5987c609719bSwdenk				email("Hi, I am having problems...");
5988c609719bSwdenk		}
59896c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
59906c3fef28SJerry Van Baren		if (reasonable critiques)
59916c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
59926c3fef28SJerry Van Baren		else
59936c3fef28SJerry Van Baren			Defend code as written;
59946c3fef28SJerry Van Baren	}
5995c609719bSwdenk
5996c609719bSwdenk	return 0;
5997c609719bSwdenk}
5998c609719bSwdenk
5999c609719bSwdenkvoid no_more_time (int sig)
6000c609719bSwdenk{
6001c609719bSwdenk      hire_a_guru();
6002c609719bSwdenk}
6003c609719bSwdenk
6004c609719bSwdenk
6005c609719bSwdenkCoding Standards:
6006c609719bSwdenk-----------------
6007c609719bSwdenk
6008c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
60092c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
60107ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6011c609719bSwdenk
60122c051651SDetlev ZundelSource files originating from a different project (for example the
60132c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
60142c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
60152c051651SDetlev Zundelsources.
60162c051651SDetlev Zundel
60172c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
60182c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
60192c051651SDetlev Zundelin your code.
6020c609719bSwdenk
6021c178d3daSwdenkPlease also stick to the following formatting rules:
6022180d3f74Swdenk- remove any trailing white space
60237ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6024180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
60257ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6026180d3f74Swdenk- do not add trailing empty lines to source files
6027180d3f74Swdenk
6028c609719bSwdenkSubmissions which do not conform to the standards may be returned
6029c609719bSwdenkwith a request to reformat the changes.
6030c609719bSwdenk
6031c609719bSwdenk
6032c609719bSwdenkSubmitting Patches:
6033c609719bSwdenk-------------------
6034c609719bSwdenk
6035c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6036c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6037c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6038c609719bSwdenk
60390d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6040218ca724SWolfgang Denk
60410668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
60420668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
60430668236bSWolfgang Denk
6044c609719bSwdenkWhen you send a patch, please include the following information with
6045c609719bSwdenkit:
6046c609719bSwdenk
6047c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6048c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6049c609719bSwdenk  patch actually fixes something.
6050c609719bSwdenk
6051c609719bSwdenk* For new features: a description of the feature and your
6052c609719bSwdenk  implementation.
6053c609719bSwdenk
6054c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6055c609719bSwdenk
6056c609719bSwdenk* For major contributions, your entry to the CREDITS file
6057c609719bSwdenk
605827af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
605927af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6060c609719bSwdenk
6061c609719bSwdenk* If your patch adds new configuration options, don't forget to
6062c609719bSwdenk  document these in the README file.
6063c609719bSwdenk
6064218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6065218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
60667ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6067218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6068218ca724SWolfgang Denk  with some other mail clients.
6069c609719bSwdenk
6070218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6071218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6072218ca724SWolfgang Denk  GNU diff.
60736dff5529Swdenk
6074218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6075218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6076218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6077218ca724SWolfgang Denk  affected files).
6078218ca724SWolfgang Denk
6079218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6080218ca724SWolfgang Denk  and compressed attachments must not be used.
6081c609719bSwdenk
608252f52c14Swdenk* If one logical set of modifications affects or creates several
608352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
608452f52c14Swdenk
608552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
608652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
608752f52c14Swdenk
608852f52c14Swdenk
6089c609719bSwdenkNotes:
6090c609719bSwdenk
6091c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6092c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6093c609719bSwdenk  for any of the boards.
6094c609719bSwdenk
6095c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6096c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6097c609719bSwdenk  returned with a request to re-formatting / split it.
6098c609719bSwdenk
6099c609719bSwdenk* If you modify existing code, make sure that your new code does not
6100c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6101c609719bSwdenk  When adding new features, these should compile conditionally only
6102c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6103c609719bSwdenk  disabled must not need more memory than the old code without your
6104c609719bSwdenk  modification.
610590dc6704Swdenk
61060668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
61070668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
61080668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
61090668236bSWolfgang Denk  bigger than the size limit should be avoided.
6110