xref: /openbmc/u-boot/README (revision 89ad7be8e713f33ec677cf4576e0c9b0ed83f7c6)
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
430fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
431fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
432fb4a2409SAneesh Bansal		time of U-boot entry and is required to be re-initialized.
433fb4a2409SAneesh Bansal
434aade2004STang Yuantian		CONFIG_DEEP_SLEEP
435aade2004STang Yuantian		Inidcates this SoC supports deep sleep feature. If deep sleep is
436aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
437aade2004STang Yuantian
4386cb461b4SDaniel Schwierzeck- Generic CPU options:
4396cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4406cb461b4SDaniel Schwierzeck
4416cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4426cb461b4SDaniel Schwierzeck		values is arch specific.
4436cb461b4SDaniel Schwierzeck
4445614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4455614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4465614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4475614e71bSYork Sun		SoCs.
4485614e71bSYork Sun
4495614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4505614e71bSYork Sun		Freescale DDR memory-mapped register base.
4515614e71bSYork Sun
4525614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4535614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4545614e71bSYork Sun		deskew training are not available.
4555614e71bSYork Sun
4565614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4575614e71bSYork Sun		Freescale DDR1 controller.
4585614e71bSYork Sun
4595614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4605614e71bSYork Sun		Freescale DDR2 controller.
4615614e71bSYork Sun
4625614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4635614e71bSYork Sun		Freescale DDR3 controller.
4645614e71bSYork Sun
46534e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
46634e026f9SYork Sun		Freescale DDR4 controller.
46734e026f9SYork Sun
4689ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4699ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4709ac4ffbdSYork Sun
4715614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4725614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4735614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4745614e71bSYork Sun		implemetation.
4755614e71bSYork Sun
4765614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4775614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4785614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4795614e71bSYork Sun		implementation.
4805614e71bSYork Sun
4815614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4825614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
48334e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
48434e026f9SYork Sun
48534e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
48634e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
48734e026f9SYork Sun		DDR3L controllers.
48834e026f9SYork Sun
48934e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
49034e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
49134e026f9SYork Sun		DDR4 controllers.
4925614e71bSYork Sun
4931b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4941b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4951b4175d6SPrabhakar Kushwaha
4961b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4971b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4981b4175d6SPrabhakar Kushwaha
499690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
500690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
501690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
502690e4258SPrabhakar Kushwaha
503690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
504690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
505690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
506690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
507690e4258SPrabhakar Kushwaha
508*89ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
509*89ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
510*89ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
511*89ad7be8SPrabhakar Kushwaha
5124e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
5134e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
5144e5b1bd0SYork Sun
5154e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5164e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5174e5b1bd0SYork Sun
5186b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5196b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5206b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5216b9e309aSYork Sun		it could be different for ARM SoCs.
5226b9e309aSYork Sun
5236b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5246b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5256b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5266b1e1254SYork Sun		SoCs with ARM core.
5276b1e1254SYork Sun
5280b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5300b953ffcSMarkus Klotzbuecher
5310b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5320b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5330b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5340b953ffcSMarkus Klotzbuecher
5356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5360b953ffcSMarkus Klotzbuecher
5370b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5380b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5390b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5400b953ffcSMarkus Klotzbuecher		by this value.
5410b953ffcSMarkus Klotzbuecher
54292bbd64eSDaniel Schwierzeck- MIPS CPU options:
54392bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
54492bbd64eSDaniel Schwierzeck
54592bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
54692bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
54792bbd64eSDaniel Schwierzeck		relocation.
54892bbd64eSDaniel Schwierzeck
54992bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
55092bbd64eSDaniel Schwierzeck
55192bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
55292bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
55392bbd64eSDaniel Schwierzeck		Possible values are:
55492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
55592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
55692bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
55792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
55892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
55992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
56092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
56192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
56292bbd64eSDaniel Schwierzeck
56392bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
56492bbd64eSDaniel Schwierzeck
56592bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
56692bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
56792bbd64eSDaniel Schwierzeck
56892bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
56992bbd64eSDaniel Schwierzeck
57092bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
57192bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
57292bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
57392bbd64eSDaniel Schwierzeck
574b67d8816SChristian Riesch- ARM options:
575b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
576b67d8816SChristian Riesch
577b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
578b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
579b67d8816SChristian Riesch
5805356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5815356f545SAneesh V
5825356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5835356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5845356f545SAneesh V		better code density. For ARM architectures that support
5855356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5865356f545SAneesh V		GCC.
5875356f545SAneesh V
588c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5890678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5900678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5910678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
592f71cbfe3SNitin Garg		CONFIG_ARM_ERRATA_794072
593b7588e3bSNitin Garg		CONFIG_ARM_ERRATA_761320
5940678587fSStephen Warren
5950678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5960678587fSStephen Warren		during U-Boot startup. Note that these options force the
5970678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5980678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5990678587fSStephen Warren		set these options unless they apply!
6000678587fSStephen Warren
601795659dcSStephen Warren- CPU timer options:
602795659dcSStephen Warren		CONFIG_SYS_HZ
603795659dcSStephen Warren
604795659dcSStephen Warren		The frequency of the timer returned by get_timer().
605795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
606795659dcSStephen Warren		option must be set to 1000.
607795659dcSStephen Warren
6085da627a4Swdenk- Linux Kernel Interface:
609c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
610c609719bSwdenk
611c609719bSwdenk		U-Boot stores all clock information in Hz
612c609719bSwdenk		internally. For binary compatibility with older Linux
613c609719bSwdenk		kernels (which expect the clocks passed in the
614c609719bSwdenk		bd_info data to be in MHz) the environment variable
615c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
616c609719bSwdenk		converts clock data to MHZ before passing it to the
617c609719bSwdenk		Linux kernel.
618c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
619c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
620c609719bSwdenk		default environment.
621c609719bSwdenk
6225da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
6235da627a4Swdenk
62411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6255da627a4Swdenk		expect it to be in bytes, others in MB.
6265da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6275da627a4Swdenk
628fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
629f57f70aaSWolfgang Denk
630f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
631213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
632213bf8c8SGerald Van Baren		concepts).
633213bf8c8SGerald Van Baren
634213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
635213bf8c8SGerald Van Baren		 * New libfdt-based support
636213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6373bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
638213bf8c8SGerald Van Baren
639b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
640b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
641b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
642b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
643f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
644c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
645f57f70aaSWolfgang Denk
64611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
64711ccc33fSMarcel Ziswiler		addresses
6483bb342fcSKim Phillips
6494e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6504e253137SKumar Gala
6514e253137SKumar Gala		Board code has addition modification that it wants to make
6524e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6536705d81eSwdenk
6540267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6550267768eSMatthew McClintock
65611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6570267768eSMatthew McClintock		param header, the default value is zero if undefined.
6580267768eSMatthew McClintock
6593887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6603887c3fbSHeiko Schocher
6613887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6623887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6633887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6643887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6653887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6663887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6673887c3fbSHeiko Schocher
6687eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6697eb29398SIgor Grinberg
6707eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6717eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6727eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6737eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6747eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6757eb29398SIgor Grinberg		in a single configuration file and the machine type is
6767eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6777eb29398SIgor Grinberg
6780b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6790b2f4ecaSNiklaus Giger
6800b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6810b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6820b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6830b2f4ecaSNiklaus Giger
6840b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6850b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6860b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6870b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6880b2f4ecaSNiklaus Giger
6890b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6900b2f4ecaSNiklaus Giger
6910b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6920b2f4ecaSNiklaus Giger
6930b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6940b2f4ecaSNiklaus Giger		the defaults discussed just above.
6950b2f4ecaSNiklaus Giger
6962c451f78SAneesh V- Cache Configuration:
6972c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6982c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6992c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
7002c451f78SAneesh V
70193bc2193SAneesh V- Cache Configuration for ARM:
70293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
70393bc2193SAneesh V				      controller
70493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
70593bc2193SAneesh V					controller register space
70693bc2193SAneesh V
7076705d81eSwdenk- Serial Ports:
70848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
7096705d81eSwdenk
7106705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
7116705d81eSwdenk
71248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
7136705d81eSwdenk
7146705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
7156705d81eSwdenk
7166705d81eSwdenk		CONFIG_PL011_CLOCK
7176705d81eSwdenk
7186705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
7196705d81eSwdenk		the clock speed of the UARTs.
7206705d81eSwdenk
7216705d81eSwdenk		CONFIG_PL01x_PORTS
7226705d81eSwdenk
7236705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
7246705d81eSwdenk		define this to a list of base addresses for each (supported)
7256705d81eSwdenk		port. See e.g. include/configs/versatile.h
7266705d81eSwdenk
727910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
728910f1ae3SJohn Rigby
729910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
730910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
731910f1ae3SJohn Rigby		this variable to initialize the extra register.
732910f1ae3SJohn Rigby
733910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
734910f1ae3SJohn Rigby
735910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
736910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
737910f1ae3SJohn Rigby		variable to flush the UART at init time.
738910f1ae3SJohn Rigby
7396705d81eSwdenk
740c609719bSwdenk- Console Interface:
741c609719bSwdenk		Depending on board, define exactly one serial port
742c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
743c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
744c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
745c609719bSwdenk
746c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
747c609719bSwdenk		port routines must be defined elsewhere
748c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
749c609719bSwdenk
750c609719bSwdenk		CONFIG_CFB_CONSOLE
751c609719bSwdenk		Enables console device for a color framebuffer. Needs following
752c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
753c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
754c609719bSwdenk						(default big endian)
755c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
756c609719bSwdenk						rectangle fill
757c609719bSwdenk						(cf. smiLynxEM)
758c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
759c609719bSwdenk						bit-blit (cf. smiLynxEM)
760c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
761c609719bSwdenk						(cols=pitch)
762c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
763c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
764c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
765c609719bSwdenk						(0-5, cf. cfb_console.c)
766c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
767c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
768c609719bSwdenk						(i.e. i8042_kbd_init())
769c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
770c609719bSwdenk						(i.e. i8042_tstc)
771c609719bSwdenk			VIDEO_GETC_FCT		get char fct
772c609719bSwdenk						(i.e. i8042_getc)
773c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
774c609719bSwdenk						(requires blink timer
775c609719bSwdenk						cf. i8042.c)
7766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
777c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
778c609719bSwdenk						upper right corner
779602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
780c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
781c609719bSwdenk						upper left corner
782a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
783a6c7ad2fSwdenk						linux_logo.h for logo.
784a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
785c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
78611ccc33fSMarcel Ziswiler						additional board info beside
787c609719bSwdenk						the logo
788c609719bSwdenk
78933a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
79033a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
79133a35bbbSPali Rohár		erase functions and limited graphics rendition control).
79233a35bbbSPali Rohár
793c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
794c609719bSwdenk		default i/o. Serial console can be forced with
795c609719bSwdenk		environment 'console=serial'.
796c609719bSwdenk
797a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
798a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
799a3ad8e26Swdenk		the "silent" environment variable. See
800a3ad8e26Swdenk		doc/README.silent for more information.
801a3ad8e26Swdenk
80245ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
80345ae2546SHeiko Schocher			is 0x00.
80445ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
80545ae2546SHeiko Schocher			is 0xa0.
80645ae2546SHeiko Schocher
807c609719bSwdenk- Console Baudrate:
808c609719bSwdenk		CONFIG_BAUDRATE - in bps
809c609719bSwdenk		Select one of the baudrates listed in
8106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
8116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
812c609719bSwdenk
813c92fac91SHeiko Schocher- Console Rx buffer length
814c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
815c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
8162b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
817c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
818c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
819c92fac91SHeiko Schocher		the SMC.
820c92fac91SHeiko Schocher
8219558b48aSGraeme Russ- Pre-Console Buffer:
8229558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
8239558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
8249558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8259558b48aSGraeme Russ		buffer any console messages prior to the console being
8269558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8279558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8289558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8299558b48aSGraeme Russ		bytes are output before the console is initialised, the
8309558b48aSGraeme Russ		earlier bytes are discarded.
8319558b48aSGraeme Russ
8329558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8339558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8349558b48aSGraeme Russ
835046a37bdSSonny Rao- Safe printf() functions
836046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
837046a37bdSSonny Rao		the printf() functions. These are defined in
838046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
839046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
840046a37bdSSonny Rao		If this option is not given then these functions will
841046a37bdSSonny Rao		silently discard their buffer size argument - this means
842046a37bdSSonny Rao		you are not getting any overflow checking in this case.
843046a37bdSSonny Rao
844c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
845c609719bSwdenk		Delay before automatically booting the default image;
846c609719bSwdenk		set to -1 to disable autoboot.
84793d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
84893d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
849c609719bSwdenk
850c609719bSwdenk		See doc/README.autoboot for these options that
851c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
852c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
853c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
854c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
855c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
856c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
857c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
858c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
859c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
860c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
861c609719bSwdenk		CONFIG_RESET_TO_RETRY
862c609719bSwdenk
863c609719bSwdenk- Autoboot Command:
864c609719bSwdenk		CONFIG_BOOTCOMMAND
865c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
866c609719bSwdenk		define a command string that is automatically executed
867c609719bSwdenk		when no character is read on the console interface
868c609719bSwdenk		within "Boot Delay" after reset.
869c609719bSwdenk
870c609719bSwdenk		CONFIG_BOOTARGS
871c609719bSwdenk		This can be used to pass arguments to the bootm
872c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
873c609719bSwdenk		environment value "bootargs".
874c609719bSwdenk
875c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
876c609719bSwdenk		The value of these goes into the environment as
877c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
878c609719bSwdenk		as a convenience, when switching between booting from
87911ccc33fSMarcel Ziswiler		RAM and NFS.
880c609719bSwdenk
881eda0ba38SHeiko Schocher- Bootcount:
882eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
883eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
884eda0ba38SHeiko Schocher		cycle, see:
885eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
886eda0ba38SHeiko Schocher
887eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
888eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
889eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
890eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
891eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
892eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
893eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
894eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
895eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
896eda0ba38SHeiko Schocher
897c609719bSwdenk- Pre-Boot Commands:
898c609719bSwdenk		CONFIG_PREBOOT
899c609719bSwdenk
900c609719bSwdenk		When this option is #defined, the existence of the
901c609719bSwdenk		environment variable "preboot" will be checked
902c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
903c609719bSwdenk		countdown and/or running the auto-boot command resp.
904c609719bSwdenk		entering interactive mode.
905c609719bSwdenk
906c609719bSwdenk		This feature is especially useful when "preboot" is
907c609719bSwdenk		automatically generated or modified. For an example
908c609719bSwdenk		see the LWMON board specific code: here "preboot" is
909c609719bSwdenk		modified when the user holds down a certain
910c609719bSwdenk		combination of keys on the (special) keyboard when
911c609719bSwdenk		booting the systems
912c609719bSwdenk
913c609719bSwdenk- Serial Download Echo Mode:
914c609719bSwdenk		CONFIG_LOADS_ECHO
915c609719bSwdenk		If defined to 1, all characters received during a
916c609719bSwdenk		serial download (using the "loads" command) are
917c609719bSwdenk		echoed back. This might be needed by some terminal
918c609719bSwdenk		emulations (like "cu"), but may as well just take
919c609719bSwdenk		time on others. This setting #define's the initial
920c609719bSwdenk		value of the "loads_echo" environment variable.
921c609719bSwdenk
922602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
923c609719bSwdenk		CONFIG_KGDB_BAUDRATE
924c609719bSwdenk		Select one of the baudrates listed in
9256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
926c609719bSwdenk
927c609719bSwdenk- Monitor Functions:
928602ad3b3SJon Loeliger		Monitor commands can be included or excluded
929602ad3b3SJon Loeliger		from the build by using the #include files
930c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
931c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
932602ad3b3SJon Loeliger		and augmenting with additional #define's
933602ad3b3SJon Loeliger		for wanted commands.
934c609719bSwdenk
935602ad3b3SJon Loeliger		The default command configuration includes all commands
936602ad3b3SJon Loeliger		except those marked below with a "*".
937602ad3b3SJon Loeliger
938b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
939602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
940602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
941602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
942602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
943602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
944602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
945602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
94608d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
947602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
948710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
949602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
950602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
951602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
952a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
953a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
954a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
955a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
956602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
957602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
958246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
959602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
960602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9615e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
962fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
96388733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9640c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
96503e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
96603e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
96716f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
96816f4d933SStephen Warren					  that work for multiple fs types
969bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
970602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
97103e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
972602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
973602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9744d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
97553fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
976a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
977a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
978bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
979602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
980602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
981602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
982602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9838fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9844d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
985602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9860c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
987c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
988602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
989602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
990602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
991602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9924d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
993d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
994d22c338eSJoe Hershberger					  (169.254.*.*)
995602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
996602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9974d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
99802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
99915a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
1000602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1001a2681707SWolfgang Denk					  loop, loopw
10024d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
1003602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
1004602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
1005602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
100668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
1007602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
1008602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
10094d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
1010e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1011e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1012602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
1013602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
1014602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
1015602ad3b3SJon Loeliger					  host
1016602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
1017ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
1018602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
1019602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
1020d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1021602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
1022602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
1023602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
1024602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1025602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1026602ad3b3SJon Loeliger					  (4xx only)
1027f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10284d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
102902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10307d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
103174de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1032602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10337a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10341fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1035da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1036da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1037602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1038602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1039c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10404d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
104189c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
1042c609719bSwdenk
1043c609719bSwdenk		EXAMPLE: If you want all functions except of network
1044c609719bSwdenk		support you can write:
1045c609719bSwdenk
1046602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1047602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1048c609719bSwdenk
1049213bf8c8SGerald Van Baren	Other Commands:
1050213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1051c609719bSwdenk
1052c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1053602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1054c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1055c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1056c609719bSwdenk		8260 (where accesses to the IMMR region must be
1057c609719bSwdenk		uncached), and it cannot be disabled on all other
1058c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1059c609719bSwdenk		initial stack and some data.
1060c609719bSwdenk
1061c609719bSwdenk
1062c609719bSwdenk		XXX - this list needs to get updated!
1063c609719bSwdenk
1064a5ecbe62SWolfgang Denk- Regular expression support:
1065a5ecbe62SWolfgang Denk		CONFIG_REGEX
1066a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1067a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1068a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1069a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1070a5ecbe62SWolfgang Denk
107145ba8077SSimon Glass- Device tree:
107245ba8077SSimon Glass		CONFIG_OF_CONTROL
107345ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
107445ba8077SSimon Glass		to configure its devices, instead of relying on statically
107545ba8077SSimon Glass		compiled #defines in the board file. This option is
107645ba8077SSimon Glass		experimental and only available on a few boards. The device
107745ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
107845ba8077SSimon Glass
10792c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10802c0f79e4SSimon Glass		be done using one of the two options below:
1081bbb0b128SSimon Glass
1082bbb0b128SSimon Glass		CONFIG_OF_EMBED
1083bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1084bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1085bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1086bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1087bbb0b128SSimon Glass		the global data structure as gd->blob.
108845ba8077SSimon Glass
10892c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10902c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10912c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10922c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10932c0f79e4SSimon Glass
10942c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10952c0f79e4SSimon Glass
10962c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10972c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10982c0f79e4SSimon Glass		still use the individual files if you need something more
10992c0f79e4SSimon Glass		exotic.
11002c0f79e4SSimon Glass
1101c609719bSwdenk- Watchdog:
1102c609719bSwdenk		CONFIG_WATCHDOG
1103c609719bSwdenk		If this variable is defined, it enables watchdog
11046abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
11056abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
11066abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
11076abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
11086abe6fb6SDetlev Zundel		available, then no further board specific code should
11096abe6fb6SDetlev Zundel		be needed to use it.
11106abe6fb6SDetlev Zundel
11116abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
11126abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
11136abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
11146abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1115c609719bSwdenk
1116c1551ea8Sstroese- U-Boot Version:
1117c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1118c1551ea8Sstroese		If this variable is defined, an environment variable
1119c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1120c1551ea8Sstroese		version as printed by the "version" command.
1121a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1122a1ea8e51SBenoît Thébaudeau		next reset.
1123c1551ea8Sstroese
1124c609719bSwdenk- Real-Time Clock:
1125c609719bSwdenk
1126602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1127c609719bSwdenk		has to be selected, too. Define exactly one of the
1128c609719bSwdenk		following options:
1129c609719bSwdenk
1130c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1131c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11324e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1133c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11341cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1135c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11367f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11373bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11389536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11394c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
114171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
114271d19f30SHeiko Schocher					  RV3029 RTC.
1143c609719bSwdenk
1144b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1145b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1146b37c7e5eSwdenk
1147e92739d3SPeter Tyser- GPIO Support:
1148e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1149e92739d3SPeter Tyser
11505dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11515dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11525dec49caSChris Packham		pins supported by a particular chip.
11535dec49caSChris Packham
1154e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1155e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1156e92739d3SPeter Tyser
1157c609719bSwdenk- Timestamp Support:
1158c609719bSwdenk
1159c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1160c609719bSwdenk		(date and time) of an image is printed by image
1161c609719bSwdenk		commands like bootm or iminfo. This option is
1162602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1163c609719bSwdenk
1164923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1165923c46f9SKarl O. Pinc		Zero or more of the following:
1166923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1167923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1168923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1169923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1170923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1171923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1172923c46f9SKarl O. Pinc				       disk/part_efi.c
1173923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1174c609719bSwdenk
1175602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1176218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1177923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1178c609719bSwdenk
1179c609719bSwdenk- IDE Reset method:
11804d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11814d13cbadSwdenk		board configurations files but used nowhere!
1182c609719bSwdenk
11834d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11844d13cbadSwdenk		be performed by calling the function
11854d13cbadSwdenk			ide_set_reset(int reset)
11864d13cbadSwdenk		which has to be defined in a board specific file
1187c609719bSwdenk
1188c609719bSwdenk- ATAPI Support:
1189c609719bSwdenk		CONFIG_ATAPI
1190c609719bSwdenk
1191c609719bSwdenk		Set this to enable ATAPI support.
1192c609719bSwdenk
1193c40b2956Swdenk- LBA48 Support
1194c40b2956Swdenk		CONFIG_LBA48
1195c40b2956Swdenk
1196c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11974b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1198c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1199c40b2956Swdenk		support disks up to 2.1TB.
1200c40b2956Swdenk
12016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1202c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1203c40b2956Swdenk			Default is 32bit.
1204c40b2956Swdenk
1205c609719bSwdenk- SCSI Support:
1206c609719bSwdenk		At the moment only there is only support for the
1207c609719bSwdenk		SYM53C8XX SCSI controller; define
1208c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1209c609719bSwdenk
12106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
12116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
12126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1213c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1214c609719bSwdenk		devices.
12156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1216c609719bSwdenk
1217447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1218447c031bSStefan Reinauer		SCSI devices found during the last scan.
1219447c031bSStefan Reinauer
1220c609719bSwdenk- NETWORK Support (PCI):
1221682011ffSwdenk		CONFIG_E1000
1222ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1223ce5207e1SKyle Moffett
1224ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1225ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1226ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1227ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1228ce5207e1SKyle Moffett
1229ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1230ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1231ce5207e1SKyle Moffett		example with the "sspi" command.
1232ce5207e1SKyle Moffett
1233ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1234ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1235ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1236682011ffSwdenk
1237ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
123811ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1239ac3315c2SAndre Schwarz
1240c609719bSwdenk		CONFIG_EEPRO100
1241c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
124211ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1243c609719bSwdenk		write routine for first time initialisation.
1244c609719bSwdenk
1245c609719bSwdenk		CONFIG_TULIP
1246c609719bSwdenk		Support for Digital 2114x chips.
1247c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1248c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1249c609719bSwdenk
1250c609719bSwdenk		CONFIG_NATSEMI
1251c609719bSwdenk		Support for National dp83815 chips.
1252c609719bSwdenk
1253c609719bSwdenk		CONFIG_NS8382X
1254c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1255c609719bSwdenk
125645219c46Swdenk- NETWORK Support (other):
125745219c46Swdenk
1258c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1259c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1260c041e9d2SJens Scharsig
1261c041e9d2SJens Scharsig			CONFIG_RMII
1262c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1263c041e9d2SJens Scharsig
1264c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1265c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1266c041e9d2SJens Scharsig			The driver doen't show link status messages.
1267c041e9d2SJens Scharsig
1268efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1269efdd7319SRob Herring		Support for the Calxeda XGMAC device
1270efdd7319SRob Herring
12713bb46d23SAshok		CONFIG_LAN91C96
127245219c46Swdenk		Support for SMSC's LAN91C96 chips.
127345219c46Swdenk
127445219c46Swdenk			CONFIG_LAN91C96_BASE
127545219c46Swdenk			Define this to hold the physical address
127645219c46Swdenk			of the LAN91C96's I/O space
127745219c46Swdenk
127845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
127945219c46Swdenk			Define this to enable 32 bit addressing
128045219c46Swdenk
12813bb46d23SAshok		CONFIG_SMC91111
1282f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1283f39748aeSwdenk
1284f39748aeSwdenk			CONFIG_SMC91111_BASE
1285f39748aeSwdenk			Define this to hold the physical address
1286f39748aeSwdenk			of the device (I/O space)
1287f39748aeSwdenk
1288f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1289f39748aeSwdenk			Define this if data bus is 32 bits
1290f39748aeSwdenk
1291f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1292f39748aeSwdenk			Define this to use i/o functions instead of macros
1293f39748aeSwdenk			(some hardware wont work with macros)
1294f39748aeSwdenk
1295dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1296dc02badaSHeiko Schocher		Support for davinci emac
1297dc02badaSHeiko Schocher
1298dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1299dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1300dc02badaSHeiko Schocher
1301b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1302b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1303b3dbf4a5SMacpaul Lin
1304b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1305b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1306b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1307b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1308b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1309b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1310b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1311b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1312b3dbf4a5SMacpaul Lin
1313c2fff331SMike Rapoport		CONFIG_SMC911X
1314557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1315557b377dSJens Gehrlein
1316c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1317557b377dSJens Gehrlein			Define this to hold the physical address
1318557b377dSJens Gehrlein			of the device (I/O space)
1319557b377dSJens Gehrlein
1320c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1321557b377dSJens Gehrlein			Define this if data bus is 32 bits
1322557b377dSJens Gehrlein
1323c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1324557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1325557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1326c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1327557b377dSJens Gehrlein
13283d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13293d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13303d0075faSYoshihiro Shimoda
13313d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13323d0075faSYoshihiro Shimoda			Define the number of ports to be used
13333d0075faSYoshihiro Shimoda
13343d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13353d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13363d0075faSYoshihiro Shimoda
133768260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
133868260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
133968260aabSYoshihiro Shimoda
13405e124724SVadim Bendebury- TPM Support:
134190899cc0SChe-liang Chiou		CONFIG_TPM
134290899cc0SChe-liang Chiou		Support TPM devices.
134390899cc0SChe-liang Chiou
13441b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13451b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13461b393db5STom Wai-Hong Tam		per system is supported at this time.
13471b393db5STom Wai-Hong Tam
13481b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13491b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13501b393db5STom Wai-Hong Tam
13511b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13521b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13531b393db5STom Wai-Hong Tam
13541b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13551b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13561b393db5STom Wai-Hong Tam
1357c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1358c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1359c01939c7SDirk Eibach
136090899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13615e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13625e124724SVadim Bendebury		per system is supported at this time.
13635e124724SVadim Bendebury
13645e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13655e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13665e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13675e124724SVadim Bendebury			0xfed40000.
13685e124724SVadim Bendebury
1369be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1370be6c1529SReinhard Pfau		Add tpm monitor functions.
1371be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1372be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1373be6c1529SReinhard Pfau
1374be6c1529SReinhard Pfau		CONFIG_TPM
1375be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1376be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1377be6c1529SReinhard Pfau		Requires support for a TPM device.
1378be6c1529SReinhard Pfau
1379be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1380be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1381be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1382be6c1529SReinhard Pfau
1383c609719bSwdenk- USB Support:
1384c609719bSwdenk		At the moment only the UHCI host controller is
13854d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1386c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1387c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
138830d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1389c609719bSwdenk		storage devices.
1390c609719bSwdenk		Note:
1391c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1392c609719bSwdenk		(TEAC FD-05PUB).
13934d13cbadSwdenk		MPC5200 USB requires additional defines:
13944d13cbadSwdenk			CONFIG_USB_CLOCK
13954d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1396307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1397307ecb6dSEric Millbrandt				for USB on PSC3
13984d13cbadSwdenk			CONFIG_USB_CONFIG
13994d13cbadSwdenk				for differential drivers: 0x00001000
14004d13cbadSwdenk				for single ended drivers: 0x00005000
1401307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1402307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
14036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1404fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1405fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
14064d13cbadSwdenk
14079ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
14089ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
14099ab4ce22SSimon Glass
1410aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1411aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1412aa155058SKuo-Jung Su
141316c8d5e7SWolfgang Denk- USB Device:
141416c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
141516c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
141616c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
141711ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
141816c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
141916c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
142016c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
142116c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
142216c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
142316c8d5e7SWolfgang Denk		a Linux host by
142416c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
142516c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
142616c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
142716c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
142816c8d5e7SWolfgang Denk
142916c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
143016c8d5e7SWolfgang Denk			Define this to build a UDC device
143116c8d5e7SWolfgang Denk
143216c8d5e7SWolfgang Denk			CONFIG_USB_TTY
143316c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
143416c8d5e7SWolfgang Denk			talk to the UDC device
143516c8d5e7SWolfgang Denk
1436f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1437f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1438f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1439f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1440f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1441f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1442f9da0f89SVipin KUMAR			speed.
1443f9da0f89SVipin KUMAR
14446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
144516c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
144616c8d5e7SWolfgang Denk			be set to usbtty.
144716c8d5e7SWolfgang Denk
144816c8d5e7SWolfgang Denk			mpc8xx:
14496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
145016c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
145216c8d5e7SWolfgang Denk
14536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
145416c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
145616c8d5e7SWolfgang Denk
145716c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
145816c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
145916c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
146016c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
146116c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
146216c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
146316c8d5e7SWolfgang Denk
146416c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
146516c8d5e7SWolfgang Denk			Define this string as the name of your company for
146616c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
146716c8d5e7SWolfgang Denk
146816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
146916c8d5e7SWolfgang Denk			Define this string as the name of your product
147016c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
147116c8d5e7SWolfgang Denk
147216c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
147316c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
147416c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
147516c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
147616c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
147716c8d5e7SWolfgang Denk
147816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
147916c8d5e7SWolfgang Denk			Define this as the unique Product ID
148016c8d5e7SWolfgang Denk			for your device
148116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1482c609719bSwdenk
1483351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1484351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1485351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1486351e9b20SPrzemyslaw Marczak			This enables function definition:
1487351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1488351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1489351e9b20SPrzemyslaw Marczak
1490d70a560fSIgor Grinberg- ULPI Layer Support:
1491d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1492d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1493d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1494d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1495d70a560fSIgor Grinberg		viewport is supported.
1496d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1497d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14986d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14996d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
15006d365ea0SLucas Stach		the appropriate value in Hz.
1501c609719bSwdenk
1502c609719bSwdenk- MMC Support:
1503c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1504c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1505c609719bSwdenk		accessed from the boot prompt by mapping the device
1506c609719bSwdenk		to physical memory similar to flash. Command line is
1507602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1508602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1509c609719bSwdenk
1510afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1511afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1512afb35666SYoshihiro Shimoda
1513afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1514afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1515afb35666SYoshihiro Shimoda
1516afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1517afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1518afb35666SYoshihiro Shimoda
1519b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1520b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1521b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1522b3ba6e94STom Rini
1523b3ba6e94STom Rini		CONFIG_CMD_DFU
1524b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1525b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1526b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1527b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1528b3ba6e94STom Rini
1529b3ba6e94STom Rini		CONFIG_DFU_MMC
1530b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1531b3ba6e94STom Rini
1532c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1533c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1534c6631764SPantelis Antoniou
1535a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1536a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1537a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1538a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1539a9479f04SAfzal Mohammed		one that would help mostly the developer.
1540a9479f04SAfzal Mohammed
1541e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1542e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1543e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1544e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1545e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1546e7e75c70SHeiko Schocher
1547ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1548ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1549ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1550ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1551ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1552ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1553ea2453d5SPantelis Antoniou
1554001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1555001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1556001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1557001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1558001a8319SHeiko Schocher
1559001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1560001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1561001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1562001a8319SHeiko Schocher		sending again an USB request to the device.
1563001a8319SHeiko Schocher
15646705d81eSwdenk- Journaling Flash filesystem support:
15656705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15666705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15676705d81eSwdenk		Define these for a default partition on a NAND device
15686705d81eSwdenk
15696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15716705d81eSwdenk		Define these for a default partition on a NOR device
15726705d81eSwdenk
15736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15746705d81eSwdenk		Define this to create an own partition. You have to provide a
15756705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15766705d81eSwdenk
15776705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15796705d81eSwdenk		to disable the command chpart. This is the default when you
15806705d81eSwdenk		have not defined a custom partition
15816705d81eSwdenk
1582c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1583c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1584656f4c65SDonggeun Kim
1585656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1586656f4c65SDonggeun Kim		file in FAT formatted partition.
1587656f4c65SDonggeun Kim
1588656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1589656f4c65SDonggeun Kim		user to write files to FAT.
1590c30a15e5SDonggeun Kim
159184cd9327SGabe BlackCBFS (Coreboot Filesystem) support
159284cd9327SGabe Black		CONFIG_CMD_CBFS
159384cd9327SGabe Black
159484cd9327SGabe Black		Define this to enable support for reading from a Coreboot
159584cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
159684cd9327SGabe Black		and cbfsload.
159784cd9327SGabe Black
1598c609719bSwdenk- Keyboard Support:
1599c609719bSwdenk		CONFIG_ISA_KEYBOARD
1600c609719bSwdenk
1601c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1602c609719bSwdenk		support
1603c609719bSwdenk
1604c609719bSwdenk		CONFIG_I8042_KBD
1605c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1606c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1607c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1608c609719bSwdenk		for cfb_console. Supports cursor blinking.
1609c609719bSwdenk
1610713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1611713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1612713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1613713cb680SHung-ying Tyan		which provides key scans on request.
1614713cb680SHung-ying Tyan
1615c609719bSwdenk- Video support:
1616c609719bSwdenk		CONFIG_VIDEO
1617c609719bSwdenk
1618c609719bSwdenk		Define this to enable video support (for output to
1619c609719bSwdenk		video).
1620c609719bSwdenk
1621c609719bSwdenk		CONFIG_VIDEO_CT69000
1622c609719bSwdenk
1623c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1624c609719bSwdenk
1625c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1626eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1627eeb1b77bSwdenk		video output is selected via environment 'videoout'
1628eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1629eeb1b77bSwdenk		assumed.
1630c609719bSwdenk
1631eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
163211ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1633eeb1b77bSwdenk		are possible:
1634eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1635eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1636eeb1b77bSwdenk
1637eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1638eeb1b77bSwdenk		-------------+---------------------------------------------
1639eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1640eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1641eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1642eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1643eeb1b77bSwdenk		-------------+---------------------------------------------
1644c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1645c609719bSwdenk
1646eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16477817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1648eeb1b77bSwdenk
1649eeb1b77bSwdenk
1650a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1651a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1652a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1653a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1654a6c7ad2fSwdenk
16557d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16567d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16577d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16587d3053fbSTimur Tabi		support, and should also define these other macros:
16597d3053fbSTimur Tabi
16607d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16617d3053fbSTimur Tabi			CONFIG_VIDEO
16627d3053fbSTimur Tabi			CONFIG_CMD_BMP
16637d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16647d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16657d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16667d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16677d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16687d3053fbSTimur Tabi
1669ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1670ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1671ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1672ba8e76bdSTimur Tabi		description of this variable.
16737d3053fbSTimur Tabi
1674058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1675058d59b0SSimon Glass
1676058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1677058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1678058d59b0SSimon Glass		driver.
1679058d59b0SSimon Glass
1680058d59b0SSimon Glass
1681682011ffSwdenk- Keyboard Support:
1682682011ffSwdenk		CONFIG_KEYBOARD
1683682011ffSwdenk
1684682011ffSwdenk		Define this to enable a custom keyboard support.
1685682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1686682011ffSwdenk		defined in your board-specific files.
1687682011ffSwdenk		The only board using this so far is RBC823.
1688a6c7ad2fSwdenk
1689c609719bSwdenk- LCD Support:	CONFIG_LCD
1690c609719bSwdenk
1691c609719bSwdenk		Define this to enable LCD support (for output to LCD
1692c609719bSwdenk		display); also select one of the supported displays
1693c609719bSwdenk		by defining one of these:
1694c609719bSwdenk
169539cf4804SStelian Pop		CONFIG_ATMEL_LCD:
169639cf4804SStelian Pop
169739cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
169839cf4804SStelian Pop
1699fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1700c609719bSwdenk
1701fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1702c609719bSwdenk
1703fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1704c609719bSwdenk
1705fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1706fd3103bbSwdenk			Active, color, single scan.
1707fd3103bbSwdenk
1708fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1709fd3103bbSwdenk
1710fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1711c609719bSwdenk			Active, color, single scan.
1712c609719bSwdenk
1713c609719bSwdenk		CONFIG_SHARP_16x9
1714c609719bSwdenk
1715c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1716c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1717c609719bSwdenk
1718c609719bSwdenk		CONFIG_SHARP_LQ64D341
1719c609719bSwdenk
1720c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1721c609719bSwdenk			Active, color, single scan.
1722c609719bSwdenk
1723c609719bSwdenk		CONFIG_HLD1045
1724c609719bSwdenk
1725c609719bSwdenk			HLD1045 display, 640x480.
1726c609719bSwdenk			Active, color, single scan.
1727c609719bSwdenk
1728c609719bSwdenk		CONFIG_OPTREX_BW
1729c609719bSwdenk
1730c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1731c609719bSwdenk			or
1732c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1733c609719bSwdenk			or
1734c609719bSwdenk			Hitachi	 SP14Q002
1735c609719bSwdenk
1736c609719bSwdenk			320x240. Black & white.
1737c609719bSwdenk
1738c609719bSwdenk		Normally display is black on white background; define
17396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1740c609719bSwdenk
1741676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1742676d319eSSimon Glass
1743676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1744676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1745676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1746676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1747676d319eSSimon Glass		a per-section basis.
1748676d319eSSimon Glass
17490d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17500d89efefSSimon Glass
17510d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17520d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17530d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17540d89efefSSimon Glass		is slow.
1755676d319eSSimon Glass
175645d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
175745d7f525STom Wai-Hong Tam
175845d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
175945d7f525STom Wai-Hong Tam
1760735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1761735987c5STom Wai-Hong Tam
1762735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1763735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1764735987c5STom Wai-Hong Tam
17657152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1766d791b1dcSwdenk
1767d791b1dcSwdenk		If this option is set, the environment is checked for
1768d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1769d791b1dcSwdenk		of logo, copyright and system information on the LCD
1770e94d2cd9Swdenk		is suppressed and the BMP image at the address
1771d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1772d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1773d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1774d791b1dcSwdenk		loaded very quickly after power-on.
1775d791b1dcSwdenk
1776c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1777c0880485SNikita Kiryanov
1778c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1779c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
17801551df35STom Rini		(see README.displaying-bmps).
1781c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1782c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1783c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1784c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1785c0880485SNikita Kiryanov		there is no need to set this option.
1786c0880485SNikita Kiryanov
17871ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17881ca298ceSMatthias Weisser
17891ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17901ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17911ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17921ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17931ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17941ca298ceSMatthias Weisser		specify 'm' for centering the image.
17951ca298ceSMatthias Weisser
17961ca298ceSMatthias Weisser		Example:
17971ca298ceSMatthias Weisser		setenv splashpos m,m
17981ca298ceSMatthias Weisser			=> image at center of screen
17991ca298ceSMatthias Weisser
18001ca298ceSMatthias Weisser		setenv splashpos 30,20
18011ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
18021ca298ceSMatthias Weisser
18031ca298ceSMatthias Weisser		setenv splashpos -10,m
18041ca298ceSMatthias Weisser			=> vertically centered image
18051ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
18061ca298ceSMatthias Weisser
180798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
180898f4a3dfSStefan Roese
180998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
181098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
181198f4a3dfSStefan Roese		splashscreen support or the bmp command.
181298f4a3dfSStefan Roese
1813d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1814d5011762SAnatolij Gustschin
1815d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1816d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1817d5011762SAnatolij Gustschin		bmp command.
1818d5011762SAnatolij Gustschin
1819f2b96dfbSLei Wen- Do compresssing for memory range:
1820f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1821f2b96dfbSLei Wen
1822f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1823f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1824f2b96dfbSLei Wen
1825c29fdfc1Swdenk- Compression support:
18268ef70478SKees Cook		CONFIG_GZIP
18278ef70478SKees Cook
18288ef70478SKees Cook		Enabled by default to support gzip compressed images.
18298ef70478SKees Cook
1830c29fdfc1Swdenk		CONFIG_BZIP2
1831c29fdfc1Swdenk
1832c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1833c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1834c29fdfc1Swdenk		compressed images are supported.
1835c29fdfc1Swdenk
1836c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1838c29fdfc1Swdenk		be at least 4MB.
1839d791b1dcSwdenk
1840fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1841fc9c1727SLuigi 'Comio' Mantellini
1842fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1843fc9c1727SLuigi 'Comio' Mantellini		images is included.
1844fc9c1727SLuigi 'Comio' Mantellini
1845fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1846fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1847fc9c1727SLuigi 'Comio' Mantellini		formula:
1848fc9c1727SLuigi 'Comio' Mantellini
1849fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1850fc9c1727SLuigi 'Comio' Mantellini
1851fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1852fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1853fc9c1727SLuigi 'Comio' Mantellini
1854fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1855fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1856fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1857fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1858fc9c1727SLuigi 'Comio' Mantellini
1859fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1860fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1862fc9c1727SLuigi 'Comio' Mantellini
18638ef70478SKees Cook		CONFIG_LZO
18648ef70478SKees Cook
18658ef70478SKees Cook		If this option is set, support for LZO compressed images
18668ef70478SKees Cook		is included.
18678ef70478SKees Cook
186817ea1177Swdenk- MII/PHY support:
186917ea1177Swdenk		CONFIG_PHY_ADDR
187017ea1177Swdenk
187117ea1177Swdenk		The address of PHY on MII bus.
187217ea1177Swdenk
187317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
187417ea1177Swdenk
187517ea1177Swdenk		The clock frequency of the MII bus
187617ea1177Swdenk
187717ea1177Swdenk		CONFIG_PHY_GIGE
187817ea1177Swdenk
187917ea1177Swdenk		If this option is set, support for speed/duplex
188011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
188117ea1177Swdenk
188217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
188317ea1177Swdenk
188417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
188517ea1177Swdenk		reset before any MII register access is possible.
188617ea1177Swdenk		For such PHY, set this option to the usec delay
188717ea1177Swdenk		required. (minimum 300usec for LXT971A)
188817ea1177Swdenk
188917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
189017ea1177Swdenk
189117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
189217ea1177Swdenk		command issued before MII status register can be read
189317ea1177Swdenk
1894c609719bSwdenk- Ethernet address:
1895c609719bSwdenk		CONFIG_ETHADDR
1896c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1897c609719bSwdenk		CONFIG_ETH2ADDR
1898c609719bSwdenk		CONFIG_ETH3ADDR
1899c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1900c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1901c609719bSwdenk
190211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
190311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1904c609719bSwdenk		is not determined automatically.
1905c609719bSwdenk
1906c609719bSwdenk- IP address:
1907c609719bSwdenk		CONFIG_IPADDR
1908c609719bSwdenk
1909c609719bSwdenk		Define a default value for the IP address to use for
191011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1911c609719bSwdenk		determined through e.g. bootp.
19121ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1913c609719bSwdenk
1914c609719bSwdenk- Server IP address:
1915c609719bSwdenk		CONFIG_SERVERIP
1916c609719bSwdenk
1917c609719bSwdenk		Defines a default value for the IP address of a TFTP
1918c609719bSwdenk		server to contact when using the "tftboot" command.
19191ebcd654SWolfgang Denk		(Environment variable "serverip")
1920c609719bSwdenk
192197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
192297cfe861SRobin Getz
192397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
192497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
192597cfe861SRobin Getz
19261ebcd654SWolfgang Denk- Gateway IP address:
19271ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
19281ebcd654SWolfgang Denk
19291ebcd654SWolfgang Denk		Defines a default value for the IP address of the
19301ebcd654SWolfgang Denk		default router where packets to other networks are
19311ebcd654SWolfgang Denk		sent to.
19321ebcd654SWolfgang Denk		(Environment variable "gatewayip")
19331ebcd654SWolfgang Denk
19341ebcd654SWolfgang Denk- Subnet mask:
19351ebcd654SWolfgang Denk		CONFIG_NETMASK
19361ebcd654SWolfgang Denk
19371ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19381ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19391ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19401ebcd654SWolfgang Denk		forwarded through a router.
19411ebcd654SWolfgang Denk		(Environment variable "netmask")
19421ebcd654SWolfgang Denk
194353a5c424SDavid Updegraff- Multicast TFTP Mode:
194453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
194553a5c424SDavid Updegraff
194653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
194753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
194811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
194953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
195053a5c424SDavid Updegraff		multicast group.
195153a5c424SDavid Updegraff
1952c609719bSwdenk- BOOTP Recovery Mode:
1953c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1954c609719bSwdenk
1955c609719bSwdenk		If you have many targets in a network that try to
1956c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1957c609719bSwdenk		systems send out BOOTP requests at precisely the same
1958c609719bSwdenk		moment (which would happen for instance at recovery
1959c609719bSwdenk		from a power failure, when all systems will try to
1960c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1961c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1962c609719bSwdenk		inserted before sending out BOOTP requests. The
19636c33c785SWolfgang Denk		following delays are inserted then:
1964c609719bSwdenk
1965c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1966c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1967c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1968c609719bSwdenk		4th and following
1969c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1970c609719bSwdenk
1971fe389a82Sstroese- DHCP Advanced Options:
19721fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19731fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1974fe389a82Sstroese
19751fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19761fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19771fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19781fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19791fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19801fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19811fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19821fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19831fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19841fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19851fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19861fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19872c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1988fe389a82Sstroese
19895d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19905d110f0aSWilson Callan		environment variable, not the BOOTP server.
1991fe389a82Sstroese
19922c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19932c00e099SJoe Hershberger		after the configured retry count, the call will fail
19942c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19952c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19962c00e099SJoe Hershberger		is not available.
19972c00e099SJoe Hershberger
1998fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1999fe389a82Sstroese		serverip from a DHCP server, it is possible that more
2000fe389a82Sstroese		than one DNS serverip is offered to the client.
2001fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2002fe389a82Sstroese		serverip will be stored in the additional environment
2003fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
2004fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
20051fe80d79SJon Loeliger		is defined.
2006fe389a82Sstroese
2007fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2008fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
2009fe389a82Sstroese		need the hostname of the DHCP requester.
20105d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
20111fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
20121fe80d79SJon Loeliger		option 12 to the DHCP server.
2013fe389a82Sstroese
2014d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
2015d9a2f416SAras Vaichas
2016d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
2017d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
2018d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
2019d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
2020d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
2021d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
2022d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
2023d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
2024d9a2f416SAras Vaichas		that one of the retries will be successful but note that
2025d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
2026d9a2f416SAras Vaichas		this delay.
2027d9a2f416SAras Vaichas
2028d22c338eSJoe Hershberger - Link-local IP address negotiation:
2029d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
2030d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
2031d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
2032d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
2033d22c338eSJoe Hershberger
2034d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2035d22c338eSJoe Hershberger
2036a3d991bdSwdenk - CDP Options:
2037a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2038a3d991bdSwdenk
2039a3d991bdSwdenk		The device id used in CDP trigger frames.
2040a3d991bdSwdenk
2041a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2042a3d991bdSwdenk
2043a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2044a3d991bdSwdenk		of the device.
2045a3d991bdSwdenk
2046a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2047a3d991bdSwdenk
2048a3d991bdSwdenk		A printf format string which contains the ascii name of
2049a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
205011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2051a3d991bdSwdenk
2052a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2053a3d991bdSwdenk
2054a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2055a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2056a3d991bdSwdenk
2057a3d991bdSwdenk		CONFIG_CDP_VERSION
2058a3d991bdSwdenk
2059a3d991bdSwdenk		An ascii string containing the version of the software.
2060a3d991bdSwdenk
2061a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2062a3d991bdSwdenk
2063a3d991bdSwdenk		An ascii string containing the name of the platform.
2064a3d991bdSwdenk
2065a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2066a3d991bdSwdenk
2067a3d991bdSwdenk		A 32bit integer sent on the trigger.
2068a3d991bdSwdenk
2069a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2070a3d991bdSwdenk
2071a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2072a3d991bdSwdenk		device in .1 of milliwatts.
2073a3d991bdSwdenk
2074a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2075a3d991bdSwdenk
2076a3d991bdSwdenk		A byte containing the id of the VLAN.
2077a3d991bdSwdenk
2078c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2079c609719bSwdenk
2080c609719bSwdenk		Several configurations allow to display the current
2081c609719bSwdenk		status using a LED. For instance, the LED will blink
2082c609719bSwdenk		fast while running U-Boot code, stop blinking as
2083c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2084c609719bSwdenk		start blinking slow once the Linux kernel is running
2085c609719bSwdenk		(supported by a status LED driver in the Linux
2086c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2087c609719bSwdenk		feature in U-Boot.
2088c609719bSwdenk
20891df7bbbaSIgor Grinberg		Additional options:
20901df7bbbaSIgor Grinberg
20911df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20921df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20931df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20941df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20951df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20961df7bbbaSIgor Grinberg
20979dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20989dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20999dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
21009dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
21019dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
21029dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
21039dfdcdfeSIgor Grinberg
2104c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2105c609719bSwdenk
2106c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2107c609719bSwdenk		on those systems that support this (optional)
2108c609719bSwdenk		feature, like the TQM8xxL modules.
2109c609719bSwdenk
21103f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2111c609719bSwdenk
21123f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
21133f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
21143f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
21153f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
21163f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
21173f4978c7SHeiko Schocher		interface.
21183f4978c7SHeiko Schocher
21193f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2120ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2121ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2122ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2123ea818dbbSHeiko Schocher		    for defining speed and slave address
2124ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2125ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2126ea818dbbSHeiko Schocher		    for defining speed and slave address
2127ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2128ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2129ea818dbbSHeiko Schocher		    for defining speed and slave address
2130ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2131ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2132ea818dbbSHeiko Schocher		    for defining speed and slave address
21333f4978c7SHeiko Schocher
213400f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
213500f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
213600f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
213700f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
213800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
213900f792e0SHeiko Schocher		    bus.
214000f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
214100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
214200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
214300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
214400f792e0SHeiko Schocher		    second bus.
214500f792e0SHeiko Schocher
21461f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21471f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21481f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21491f2ba722SSimon Glass		    100000 and the slave addr 0!
21501f2ba722SSimon Glass
2151880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2152880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2153880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2154880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2155880540deSDirk Eibach
2156fac96408Strem		- drivers/i2c/i2c_mxc.c
2157fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2158fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2159fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2160fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2161fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2162fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2163fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2164fac96408Strem		If thoses defines are not set, default value is 100000
2165fac96408Strem		for speed, and 0 for slave.
2166fac96408Strem
21671086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21681086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21691086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21701086bfa9SNobuhiro Iwamatsu
21711086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21721086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21731086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21741086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21751086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21761086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21771086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21781086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21791086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21801086bfa9SNobuhiro Iwamatsu
21812035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21822035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21832035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21842035d77dSNobuhiro Iwamatsu
21852035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21862035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21872035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21882035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21892035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21902035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21912035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21922035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21932035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21942035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21952035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21962035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21972035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21982035d77dSNobuhiro Iwamatsu
21996789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
22006789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
22016789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
22026789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
22036789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
22046789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
22056789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
22066789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
22076789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
22086789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
22096789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
22106789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
22116789e84eSHeiko Schocher
22120bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
22130bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
22140bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
22150bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
22160bdffe71SHeiko Schocher
2217e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2218e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2219e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2220e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2221e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2222e717fc6dSNaveen Krishna Ch
22233f4978c7SHeiko Schocher		additional defines:
22243f4978c7SHeiko Schocher
22253f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
22263f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
22273f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
22283f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
22293f4978c7SHeiko Schocher		omit this define.
22303f4978c7SHeiko Schocher
22313f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
22323f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
22333f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
22343f4978c7SHeiko Schocher		omit this define.
22353f4978c7SHeiko Schocher
22363f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22373f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22383f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22393f4978c7SHeiko Schocher		define.
22403f4978c7SHeiko Schocher
22413f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22423f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22433f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22443f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22453f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22463f4978c7SHeiko Schocher
22473f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22483f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22493f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22503f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22513f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22523f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22533f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22543f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22553f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22563f4978c7SHeiko Schocher					}
22573f4978c7SHeiko Schocher
22583f4978c7SHeiko Schocher		which defines
22593f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2260ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2261ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2262ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2263ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2264ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22653f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2266ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2267ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22683f4978c7SHeiko Schocher
22693f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22703f4978c7SHeiko Schocher
2271ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22723f4978c7SHeiko Schocher
22733f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22743f4978c7SHeiko Schocher		provides the following compelling advantages:
22753f4978c7SHeiko Schocher
22763f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22773f4978c7SHeiko Schocher		- approved multibus support
22783f4978c7SHeiko Schocher		- better i2c mux support
22793f4978c7SHeiko Schocher
22803f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22813f4978c7SHeiko Schocher
2282ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2283ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2284ea818dbbSHeiko Schocher		for the selected CPU.
2285c609719bSwdenk
2286b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2287602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2288b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2289b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2290c609719bSwdenk		command line interface.
2291c609719bSwdenk
2292bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2293c609719bSwdenk
2294b37c7e5eSwdenk		There are several other quantities that must also be
2295ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2296c609719bSwdenk
22976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2298b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
230011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2301c609719bSwdenk
23028d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2303a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
23048d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
23058d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
23068d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2307b37c7e5eSwdenk
23085da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
23095da71efaSEric Millbrandt
23105da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
23115da71efaSEric Millbrandt		chips might think that the current transfer is still
23125da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
23135da71efaSEric Millbrandt		commands until the slave device responds.
23145da71efaSEric Millbrandt
2315b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2316b37c7e5eSwdenk
2317ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2318b37c7e5eSwdenk		then the following macros need to be defined (examples are
2319b37c7e5eSwdenk		from include/configs/lwmon.h):
2320c609719bSwdenk
2321c609719bSwdenk		I2C_INIT
2322c609719bSwdenk
2323b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2324c609719bSwdenk		controller or configure ports.
2325c609719bSwdenk
2326b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2327b37c7e5eSwdenk
2328c609719bSwdenk		I2C_PORT
2329c609719bSwdenk
2330c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2331c609719bSwdenk		assumes both bits are on the same port). Valid values
2332c609719bSwdenk		are 0..3 for ports A..D.
2333c609719bSwdenk
2334c609719bSwdenk		I2C_ACTIVE
2335c609719bSwdenk
2336c609719bSwdenk		The code necessary to make the I2C data line active
2337c609719bSwdenk		(driven).  If the data line is open collector, this
2338c609719bSwdenk		define can be null.
2339c609719bSwdenk
2340b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2341b37c7e5eSwdenk
2342c609719bSwdenk		I2C_TRISTATE
2343c609719bSwdenk
2344c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2345c609719bSwdenk		(inactive).  If the data line is open collector, this
2346c609719bSwdenk		define can be null.
2347c609719bSwdenk
2348b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2349b37c7e5eSwdenk
2350c609719bSwdenk		I2C_READ
2351c609719bSwdenk
2352472d5460SYork Sun		Code that returns true if the I2C data line is high,
2353472d5460SYork Sun		false if it is low.
2354c609719bSwdenk
2355b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2356b37c7e5eSwdenk
2357c609719bSwdenk		I2C_SDA(bit)
2358c609719bSwdenk
2359472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2360472d5460SYork Sun		is false, it clears it (low).
2361c609719bSwdenk
2362b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2363b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2364b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2365b37c7e5eSwdenk
2366c609719bSwdenk		I2C_SCL(bit)
2367c609719bSwdenk
2368472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2369472d5460SYork Sun		is false, it clears it (low).
2370c609719bSwdenk
2371b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2372b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2373b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2374b37c7e5eSwdenk
2375c609719bSwdenk		I2C_DELAY
2376c609719bSwdenk
2377c609719bSwdenk		This delay is invoked four times per clock cycle so this
2378c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2379b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2380b37c7e5eSwdenk		like:
2381b37c7e5eSwdenk
2382b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2383c609719bSwdenk
2384793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2385793b5726SMike Frysinger
2386793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2387793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2388793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2389793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2390793b5726SMike Frysinger
2391793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2392793b5726SMike Frysinger		the generic GPIO functions.
2393793b5726SMike Frysinger
23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
239547cd00faSwdenk
239647cd00faSwdenk		When a board is reset during an i2c bus transfer
239747cd00faSwdenk		chips might think that the current transfer is still
239847cd00faSwdenk		in progress. On some boards it is possible to access
239947cd00faSwdenk		the i2c SCLK line directly, either by using the
240047cd00faSwdenk		processor pin as a GPIO or by having a second pin
240147cd00faSwdenk		connected to the bus. If this option is defined a
240247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
240347cd00faSwdenk		is run early in the boot sequence.
240447cd00faSwdenk
240526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
240626a33504SRichard Retanubun
240726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
240826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
240926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
241026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
241126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
241226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
241326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
241426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
241526a33504SRichard Retanubun
241617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
241717ea1177Swdenk
241817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
241917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
242017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
242117ea1177Swdenk
2422bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2423bb99ad6dSBen Warren
2424bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2425bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2426bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2427bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2428bb99ad6dSBen Warren
24296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2430bb99ad6dSBen Warren
2431bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
24320f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
24330f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
24340f89c54bSPeter Tyser		a 1D array of device addresses
2435bb99ad6dSBen Warren
2436bb99ad6dSBen Warren		e.g.
2437bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2439bb99ad6dSBen Warren
2440bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2441bb99ad6dSBen Warren
2442bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2444bb99ad6dSBen Warren
2445bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2446bb99ad6dSBen Warren
24476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2448be5e6181STimur Tabi
2449be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2450be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2451be5e6181STimur Tabi
24526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24530dc018ecSStefan Roese
24540dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24550dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24560dc018ecSStefan Roese
24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24580dc018ecSStefan Roese
24590dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24600dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24610dc018ecSStefan Roese
24626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24639ebbb54fSVictor Gallardo
24649ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24659ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24669ebbb54fSVictor Gallardo		specified DTT device.
24679ebbb54fSVictor Gallardo
24682ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24692ac6985aSAndrew Dyer
24702ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24712ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24722ac6985aSAndrew Dyer		between writing the address pointer and reading the
24732ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24742ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24752ac6985aSAndrew Dyer		devices can use either method, but some require one or
24762ac6985aSAndrew Dyer		the other.
2477be5e6181STimur Tabi
2478c609719bSwdenk- SPI Support:	CONFIG_SPI
2479c609719bSwdenk
2480c609719bSwdenk		Enables SPI driver (so far only tested with
2481c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2482c609719bSwdenk		D/As on the SACSng board)
2483c609719bSwdenk
24846639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24856639562eSYoshihiro Shimoda
24866639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24876639562eSYoshihiro Shimoda		only SH7757 is supported.
24886639562eSYoshihiro Shimoda
2489c609719bSwdenk		CONFIG_SPI_X
2490c609719bSwdenk
2491c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2492c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2493c609719bSwdenk
2494c609719bSwdenk		CONFIG_SOFT_SPI
2495c609719bSwdenk
2496c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2497c609719bSwdenk		using hardware support. This is a general purpose
2498c609719bSwdenk		driver that only requires three general I/O port pins
2499c609719bSwdenk		(two outputs, one input) to function. If this is
2500c609719bSwdenk		defined, the board configuration must define several
2501c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2502c609719bSwdenk		an example, see include/configs/sacsng.h.
2503c609719bSwdenk
250404a9e118SBen Warren		CONFIG_HARD_SPI
250504a9e118SBen Warren
250604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
250704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
250804a9e118SBen Warren		must define a list of chip-select function pointers.
250904a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
251004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
251104a9e118SBen Warren
251238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
251338254f45SGuennadi Liakhovetski
251438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
25152e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
251638254f45SGuennadi Liakhovetski
25170133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
25180133502eSMatthias Fuchs
25190133502eSMatthias Fuchs		Enables FPGA subsystem.
25200133502eSMatthias Fuchs
25210133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
25220133502eSMatthias Fuchs
25230133502eSMatthias Fuchs		Enables support for specific chip vendors.
25240133502eSMatthias Fuchs		(ALTERA, XILINX)
25250133502eSMatthias Fuchs
25260133502eSMatthias Fuchs		CONFIG_FPGA_<family>
25270133502eSMatthias Fuchs
25280133502eSMatthias Fuchs		Enables support for FPGA family.
25290133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
25300133502eSMatthias Fuchs
25310133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2532c609719bSwdenk
2533c609719bSwdenk		Specify the number of FPGA devices to support.
2534c609719bSwdenk
25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2536c609719bSwdenk
2537c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2538c609719bSwdenk
25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2540c609719bSwdenk
2541c609719bSwdenk		Enable checks on FPGA configuration interface busy
2542c609719bSwdenk		status by the configuration function. This option
2543c609719bSwdenk		will require a board or device specific function to
2544c609719bSwdenk		be written.
2545c609719bSwdenk
2546c609719bSwdenk		CONFIG_FPGA_DELAY
2547c609719bSwdenk
2548c609719bSwdenk		If defined, a function that provides delays in the FPGA
2549c609719bSwdenk		configuration driver.
2550c609719bSwdenk
25516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2552c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2553c609719bSwdenk
25546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2555c609719bSwdenk
2556c609719bSwdenk		Check for configuration errors during FPGA bitfile
2557c609719bSwdenk		loading. For example, abort during Virtex II
2558c609719bSwdenk		configuration if the INIT_B line goes low (which
2559c609719bSwdenk		indicated a CRC error).
2560c609719bSwdenk
25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2562c609719bSwdenk
2563c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2564c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2565c609719bSwdenk		FPGA configuration sequence. The default time is 500
256611ccc33fSMarcel Ziswiler		ms.
2567c609719bSwdenk
25686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2569c609719bSwdenk
2570c609719bSwdenk		Maximum time to wait for BUSY to deassert during
257111ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2572c609719bSwdenk
25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2574c609719bSwdenk
2575c609719bSwdenk		Time to wait after FPGA configuration. The default is
257611ccc33fSMarcel Ziswiler		200 ms.
2577c609719bSwdenk
2578c609719bSwdenk- Configuration Management:
2579c609719bSwdenk		CONFIG_IDENT_STRING
2580c609719bSwdenk
2581c609719bSwdenk		If defined, this string will be added to the U-Boot
2582c609719bSwdenk		version information (U_BOOT_VERSION)
2583c609719bSwdenk
2584c609719bSwdenk- Vendor Parameter Protection:
2585c609719bSwdenk
2586c609719bSwdenk		U-Boot considers the values of the environment
2587c609719bSwdenk		variables "serial#" (Board Serial Number) and
25887152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2589c609719bSwdenk		are set once by the board vendor / manufacturer, and
2590c609719bSwdenk		protects these variables from casual modification by
2591c609719bSwdenk		the user. Once set, these variables are read-only,
2592c609719bSwdenk		and write or delete attempts are rejected. You can
259311ccc33fSMarcel Ziswiler		change this behaviour:
2594c609719bSwdenk
2595c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2596c609719bSwdenk		file, the write protection for vendor parameters is
259747cd00faSwdenk		completely disabled. Anybody can change or delete
2598c609719bSwdenk		these parameters.
2599c609719bSwdenk
2600c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2601c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
260211ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2603c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2604c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2605c609719bSwdenk		read-only.]
2606c609719bSwdenk
26072598090bSJoe Hershberger		The same can be accomplished in a more flexible way
26082598090bSJoe Hershberger		for any variable by configuring the type of access
26092598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
26102598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
26112598090bSJoe Hershberger
2612c609719bSwdenk- Protected RAM:
2613c609719bSwdenk		CONFIG_PRAM
2614c609719bSwdenk
2615c609719bSwdenk		Define this variable to enable the reservation of
2616c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2617c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2618c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2619c609719bSwdenk		this default value by defining an environment
2620c609719bSwdenk		variable "pram" to the number of kB you want to
2621c609719bSwdenk		reserve. Note that the board info structure will
2622c609719bSwdenk		still show the full amount of RAM. If pRAM is
2623c609719bSwdenk		reserved, a new environment variable "mem" will
2624c609719bSwdenk		automatically be defined to hold the amount of
2625c609719bSwdenk		remaining RAM in a form that can be passed as boot
2626c609719bSwdenk		argument to Linux, for instance like that:
2627c609719bSwdenk
2628fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2629c609719bSwdenk			saveenv
2630c609719bSwdenk
2631c609719bSwdenk		This way you can tell Linux not to use this memory,
2632c609719bSwdenk		either, which results in a memory region that will
2633c609719bSwdenk		not be affected by reboots.
2634c609719bSwdenk
2635c609719bSwdenk		*WARNING* If your board configuration uses automatic
2636c609719bSwdenk		detection of the RAM size, you must make sure that
2637c609719bSwdenk		this memory test is non-destructive. So far, the
2638c609719bSwdenk		following board configurations are known to be
2639c609719bSwdenk		"pRAM-clean":
2640c609719bSwdenk
26411b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26421b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2643544d97e9SWolfgang Denk			FLAGADM, TQM8260
2644c609719bSwdenk
264540fef049SGabe Black- Access to physical memory region (> 4GB)
264640fef049SGabe Black		Some basic support is provided for operations on memory not
264740fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
264840fef049SGabe Black		support access to more than 4GB of memory on 32-bit
264940fef049SGabe Black		machines using physical address extension or similar.
265040fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
265140fef049SGabe Black		currently only supports clearing the memory.
265240fef049SGabe Black
2653c609719bSwdenk- Error Recovery:
2654c609719bSwdenk		CONFIG_PANIC_HANG
2655c609719bSwdenk
2656c609719bSwdenk		Define this variable to stop the system in case of a
2657c609719bSwdenk		fatal error, so that you have to reset it manually.
2658c609719bSwdenk		This is probably NOT a good idea for an embedded
265911ccc33fSMarcel Ziswiler		system where you want the system to reboot
2660c609719bSwdenk		automatically as fast as possible, but it may be
2661c609719bSwdenk		useful during development since you can try to debug
2662c609719bSwdenk		the conditions that lead to the situation.
2663c609719bSwdenk
2664c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2665c609719bSwdenk
2666c609719bSwdenk		This variable defines the number of retries for
2667c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2668c609719bSwdenk		before giving up the operation. If not defined, a
2669c609719bSwdenk		default value of 5 is used.
2670c609719bSwdenk
267140cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
267240cb90eeSGuennadi Liakhovetski
267340cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
267440cb90eeSGuennadi Liakhovetski
267548a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
267648a3e999STetsuyuki Kobayashi
267748a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
267848a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
267948a3e999STetsuyuki Kobayashi		try longer timeout such as
268048a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
268148a3e999STetsuyuki Kobayashi
2682c609719bSwdenk- Command Interpreter:
26838078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
268404a85b3bSwdenk
268504a85b3bSwdenk		Enable auto completion of commands using TAB.
268604a85b3bSwdenk
26878078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26888078f1a5SWolfgang Denk		for the "hush" shell.
26898078f1a5SWolfgang Denk
26908078f1a5SWolfgang Denk
26916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2692c609719bSwdenk
2693c609719bSwdenk		Define this variable to enable the "hush" shell (from
2694c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2695c609719bSwdenk		powerful command line syntax like
2696c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2697c609719bSwdenk		constructs ("shell scripts").
2698c609719bSwdenk
2699c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2700c609719bSwdenk		with a somewhat smaller memory footprint.
2701c609719bSwdenk
2702c609719bSwdenk
27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2704c609719bSwdenk
2705c609719bSwdenk		This defines the secondary prompt string, which is
2706c609719bSwdenk		printed when the command interpreter needs more input
2707c609719bSwdenk		to complete a command. Usually "> ".
2708c609719bSwdenk
2709c609719bSwdenk	Note:
2710c609719bSwdenk
2711c609719bSwdenk		In the current implementation, the local variables
2712c609719bSwdenk		space and global environment variables space are
2713c609719bSwdenk		separated. Local variables are those you define by
27143b57fe0aSwdenk		simply typing `name=value'. To access a local
2715c609719bSwdenk		variable later on, you have write `$name' or
27163b57fe0aSwdenk		`${name}'; to execute the contents of a variable
27173b57fe0aSwdenk		directly type `$name' at the command prompt.
2718c609719bSwdenk
2719c609719bSwdenk		Global environment variables are those you use
2720c609719bSwdenk		setenv/printenv to work with. To run a command stored
2721c609719bSwdenk		in such a variable, you need to use the run command,
2722c609719bSwdenk		and you must not use the '$' sign to access them.
2723c609719bSwdenk
2724c609719bSwdenk		To store commands and special characters in a
2725c609719bSwdenk		variable, please use double quotation marks
2726c609719bSwdenk		surrounding the whole text of the variable, instead
2727c609719bSwdenk		of the backslashes before semicolons and special
2728c609719bSwdenk		symbols.
2729c609719bSwdenk
2730aa0c71acSWolfgang Denk- Commandline Editing and History:
2731aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2732aa0c71acSWolfgang Denk
273311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2734aa0c71acSWolfgang Denk		commandline input operations
2735aa0c71acSWolfgang Denk
2736a8c7c708Swdenk- Default Environment:
2737c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2738c609719bSwdenk
2739c609719bSwdenk		Define this to contain any number of null terminated
2740c609719bSwdenk		strings (variable = value pairs) that will be part of
27417152b1d0Swdenk		the default environment compiled into the boot image.
27422262cfeeSwdenk
2743c609719bSwdenk		For example, place something like this in your
2744c609719bSwdenk		board's config file:
2745c609719bSwdenk
2746c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2747c609719bSwdenk			"myvar1=value1\0" \
2748c609719bSwdenk			"myvar2=value2\0"
2749c609719bSwdenk
2750c609719bSwdenk		Warning: This method is based on knowledge about the
2751c609719bSwdenk		internal format how the environment is stored by the
27522262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2753c609719bSwdenk		interface! Although it is unlikely that this format
27547152b1d0Swdenk		will change soon, there is no guarantee either.
2755c609719bSwdenk		You better know what you are doing here.
2756c609719bSwdenk
2757c609719bSwdenk		Note: overly (ab)use of the default environment is
2758c609719bSwdenk		discouraged. Make sure to check other ways to preset
275974de7aefSWolfgang Denk		the environment like the "source" command or the
2760c609719bSwdenk		boot command first.
2761c609719bSwdenk
27625e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27635e724ca2SStephen Warren
27645e724ca2SStephen Warren		Define this in order to add variables describing the
27655e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27665e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27675e724ca2SStephen Warren
27685e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27695e724ca2SStephen Warren
27705e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27715e724ca2SStephen Warren		- CONFIG_SYS_CPU
27725e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27735e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27745e724ca2SStephen Warren		- CONFIG_SYS_SOC
27755e724ca2SStephen Warren
27767e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27777e27f89fSTom Rini
27787e27f89fSTom Rini		Define this in order to add variables describing certain
27797e27f89fSTom Rini		run-time determined information about the hardware to the
27807e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27817e27f89fSTom Rini
278206fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
278306fd8538SSimon Glass
278406fd8538SSimon Glass		Normally the environment is loaded when the board is
278506fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
278606fd8538SSimon Glass		that so that the environment is not available until
278706fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
278806fd8538SSimon Glass		this is instead controlled by the value of
278906fd8538SSimon Glass		/config/load-environment.
279006fd8538SSimon Glass
2791a8c7c708Swdenk- DataFlash Support:
27922abbe075Swdenk		CONFIG_HAS_DATAFLASH
27932abbe075Swdenk
27942abbe075Swdenk		Defining this option enables DataFlash features and
27952abbe075Swdenk		allows to read/write in Dataflash via the standard
27962abbe075Swdenk		commands cp, md...
27972abbe075Swdenk
2798f61ec45eSEric Nelson- Serial Flash support
2799f61ec45eSEric Nelson		CONFIG_CMD_SF
2800f61ec45eSEric Nelson
2801f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2802f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2803f61ec45eSEric Nelson
2804f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2805f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2806f61ec45eSEric Nelson		commands.
2807f61ec45eSEric Nelson
2808f61ec45eSEric Nelson		The following defaults may be provided by the platform
2809f61ec45eSEric Nelson		to handle the common case when only a single serial
2810f61ec45eSEric Nelson		flash is present on the system.
2811f61ec45eSEric Nelson
2812f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2813f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2814f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2815f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2816f61ec45eSEric Nelson
281724007273SSimon Glass		CONFIG_CMD_SF_TEST
281824007273SSimon Glass
281924007273SSimon Glass		Define this option to include a destructive SPI flash
282024007273SSimon Glass		test ('sf test').
282124007273SSimon Glass
28221dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
28231dcd6d03SJagannadha Sutradharudu Teki
28241dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
28251dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
28261dcd6d03SJagannadha Sutradharudu Teki
2827b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2828b902e07cSJagannadha Sutradharudu Teki
2829b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2830b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2831b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2832b902e07cSJagannadha Sutradharudu Teki
28333f85ce27Swdenk- SystemACE Support:
28343f85ce27Swdenk		CONFIG_SYSTEMACE
28353f85ce27Swdenk
28363f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28373f85ce27Swdenk		chips attached via some sort of local bus. The address
283811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28403f85ce27Swdenk
28413f85ce27Swdenk		#define CONFIG_SYSTEMACE
28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28433f85ce27Swdenk
28443f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28453f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28463f85ce27Swdenk
2847ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2848ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2849ecb0ccd9SWolfgang Denk
285028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2851ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
285228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2853ecb0ccd9SWolfgang Denk		number generator is used.
2854ecb0ccd9SWolfgang Denk
285528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
285628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
285728cb9375SWolfgang Denk		defined, the normal port 69 is used.
285828cb9375SWolfgang Denk
285928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2860ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2861ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2862ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2863ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2864ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2865ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2866ecb0ccd9SWolfgang Denk
2867bf36c5d5SSimon Glass- Hashing support:
2868bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2869bf36c5d5SSimon Glass
2870bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2871bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2872bf36c5d5SSimon Glass
2873bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2874bf36c5d5SSimon Glass
2875bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2876bf36c5d5SSimon Glass		size a little.
2877bf36c5d5SSimon Glass
2878bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2879bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2880bf36c5d5SSimon Glass
2881bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2882bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2883bf36c5d5SSimon Glass
2884a11f1873SRobert Winkler- Freescale i.MX specific commands:
2885a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2886a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2887a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2888a11f1873SRobert Winkler
2889a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2890a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2891a11f1873SRobert Winkler		a boot from specific media.
2892a11f1873SRobert Winkler
2893a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2894a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2895a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2896a11f1873SRobert Winkler		will set it back to normal.  This command currently
2897a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2898a11f1873SRobert Winkler
289919c402afSSimon Glass- Signing support:
290019c402afSSimon Glass		CONFIG_RSA
290119c402afSSimon Glass
290219c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
29038bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
290419c402afSSimon Glass
290519c402afSSimon Glass		The signing part is build into mkimage regardless of this
290619c402afSSimon Glass		option.
290719c402afSSimon Glass
29089e50c406SHeiko Schocher- bootcount support:
29099e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
29109e50c406SHeiko Schocher
29119e50c406SHeiko Schocher		This enables the bootcounter support, see:
29129e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
29139e50c406SHeiko Schocher
29149e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
29159e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
29169e50c406SHeiko Schocher		CONFIG_BLACKFIN
29179e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
29189e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
29199e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
29209e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
29219e50c406SHeiko Schocher		enable support for the bootcounter in RAM
29229e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
29239e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
29249e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
29259e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
29269e50c406SHeiko Schocher						    the bootcounter.
29279e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
292819c402afSSimon Glass
2929a8c7c708Swdenk- Show boot progress:
2930c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2931c609719bSwdenk
2932c609719bSwdenk		Defining this option allows to add some board-
2933c609719bSwdenk		specific code (calling a user-provided function
2934c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2935c609719bSwdenk		the system's boot progress on some display (for
2936c609719bSwdenk		example, some LED's) on your board. At the moment,
2937c609719bSwdenk		the following checkpoints are implemented:
2938c609719bSwdenk
29393a608ca0SSimon Glass- Detailed boot stage timing
29403a608ca0SSimon Glass		CONFIG_BOOTSTAGE
29413a608ca0SSimon Glass		Define this option to get detailed timing of each stage
29423a608ca0SSimon Glass		of the boot process.
29433a608ca0SSimon Glass
29443a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
29453a608ca0SSimon Glass		This is the number of available user bootstage records.
29463a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29473a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29483a608ca0SSimon Glass		the limit, recording will stop.
29493a608ca0SSimon Glass
29503a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29513a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29523a608ca0SSimon Glass
29533a608ca0SSimon Glass		Timer summary in microseconds:
29543a608ca0SSimon Glass		       Mark    Elapsed  Stage
29553a608ca0SSimon Glass			  0          0  reset
29563a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29573a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29583a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29593a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29603a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29613a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29623a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29633a608ca0SSimon Glass
29642eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29652eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29662eba38cfSSimon Glass		and un/stashing of bootstage data.
29672eba38cfSSimon Glass
296894fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
296994fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
297094fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
297194fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
297294fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
297394fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
297494fd1316SSimon Glass		For example:
297594fd1316SSimon Glass
297694fd1316SSimon Glass		bootstage {
297794fd1316SSimon Glass			154 {
297894fd1316SSimon Glass				name = "board_init_f";
297994fd1316SSimon Glass				mark = <3575678>;
298094fd1316SSimon Glass			};
298194fd1316SSimon Glass			170 {
298294fd1316SSimon Glass				name = "lcd";
298394fd1316SSimon Glass				accum = <33482>;
298494fd1316SSimon Glass			};
298594fd1316SSimon Glass		};
298694fd1316SSimon Glass
298794fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
298894fd1316SSimon Glass
29891372cce2SMarian BalakowiczLegacy uImage format:
29901372cce2SMarian Balakowicz
2991c609719bSwdenk  Arg	Where			When
2992c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2993c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2994c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2995c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2996c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2997c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2998c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2999c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
3000c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
30011372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
3002c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
3003c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
3004c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
3005c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
30061372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
3007c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
30081372cce2SMarian Balakowicz
30091372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
30101372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
30111372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
30121372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
30131372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
30141372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
30151372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
301611ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
30171372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
30181372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
30191372cce2SMarian Balakowicz
3020ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
3021c609719bSwdenk
3022a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
302363e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
302463e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
302563e73c9aSwdenk
3026566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
3027566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
3028566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
3029566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
3030566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
3031566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
3032566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
3033566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
3034566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3035566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3036566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3037566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3038566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3039566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3040566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3041566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3042566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3043566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3044566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3045566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3046566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3047566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3048566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3049566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3050566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3051566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3052566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3053566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3054566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3055566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3056566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3057566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3058566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3059566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3060566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3061566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3062566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3063566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3064566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3065566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3066566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3067566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3068566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3069566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3070566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3071566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3072566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3073c609719bSwdenk
3074566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3075c609719bSwdenk
3076566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3077566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3078566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3079206c60cbSwdenk
3080566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3081566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
308211ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3083566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3084566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3085566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
308674de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
308774de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3088566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3089c609719bSwdenk
30901372cce2SMarian BalakowiczFIT uImage format:
30911372cce2SMarian Balakowicz
30921372cce2SMarian Balakowicz  Arg	Where			When
30931372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30941372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30951372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30961372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30971372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30981372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3099f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
31001372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
31011372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
31021372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
31031372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
31041372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
310511ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
310611ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
31071372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
31081372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
31091372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
31101372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
31111372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
31121372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
31131372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
31141372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
31151372cce2SMarian Balakowicz
31161372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
31171372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
31181372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
311911ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
31201372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
31211372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
31221372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
31231372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
31241372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
31251372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
31261372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
31271372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
31281372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
31291372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
31301372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
31311372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
31321372cce2SMarian Balakowicz
313311ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
31341372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31351372cce2SMarian Balakowicz
313611ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31371372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31381372cce2SMarian Balakowicz
313911ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31401372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31411372cce2SMarian Balakowicz
3142d95f6ec7SGabe Black- FIT image support:
3143d95f6ec7SGabe Black		CONFIG_FIT
3144d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3145d95f6ec7SGabe Black
3146d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3147d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3148d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3149d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3150d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3151d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3152d95f6ec7SGabe Black
31533e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31543e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31553e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31563e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31573e569a6bSSimon Glass
31584cf2609bSWolfgang Denk- Standalone program support:
31594cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31604cf2609bSWolfgang Denk
31616feff899SWolfgang Denk		This option defines a board specific value for the
31626feff899SWolfgang Denk		address where standalone program gets loaded, thus
31636feff899SWolfgang Denk		overwriting the architecture dependent default
31644cf2609bSWolfgang Denk		settings.
31654cf2609bSWolfgang Denk
31664cf2609bSWolfgang Denk- Frame Buffer Address:
31674cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31684cf2609bSWolfgang Denk
31694cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
317044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
317144a53b57SWolfgang Denk		when using a graphics controller has separate video
317244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
317344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
317444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
317544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
317644a53b57SWolfgang Denk		configured panel size.
31774cf2609bSWolfgang Denk
31784cf2609bSWolfgang Denk		Please see board_init_f function.
31794cf2609bSWolfgang Denk
3180cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3181cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3182cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3183cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3184cccfc2abSDetlev Zundel
3185cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3186cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3187cccfc2abSDetlev Zundel
3188cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3189cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3190cccfc2abSDetlev Zundel
3191cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3192cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3193cccfc2abSDetlev Zundel
3194cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3195cccfc2abSDetlev Zundel
3196cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3197cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3198cccfc2abSDetlev Zundel
319970c219cdSJoe Hershberger- UBI support
320070c219cdSJoe Hershberger		CONFIG_CMD_UBI
320170c219cdSJoe Hershberger
320270c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
320370c219cdSJoe Hershberger		with the UBI flash translation layer
320470c219cdSJoe Hershberger
320570c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
320670c219cdSJoe Hershberger
3207147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3208147162daSJoe Hershberger
3209147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3210147162daSJoe Hershberger		warnings and errors enabled.
3211147162daSJoe Hershberger
321270c219cdSJoe Hershberger- UBIFS support
321370c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
321470c219cdSJoe Hershberger
321570c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
321670c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
321770c219cdSJoe Hershberger
321870c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
321970c219cdSJoe Hershberger
3220147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3221147162daSJoe Hershberger
3222147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3223147162daSJoe Hershberger		warnings and errors enabled.
3224147162daSJoe Hershberger
32256a11cf48SDaniel Schwierzeck- SPL framework
32266a11cf48SDaniel Schwierzeck		CONFIG_SPL
32276a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
32286a11cf48SDaniel Schwierzeck
322995579793STom Rini		CONFIG_SPL_LDSCRIPT
323095579793STom Rini		LDSCRIPT for linking the SPL binary.
323195579793STom Rini
32326ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
32336ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
32346ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32356ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32368960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32376ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32386ebc3461SAlbert ARIBAUD
323995579793STom Rini		CONFIG_SPL_MAX_SIZE
32406ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32416ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32426ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32436ebc3461SAlbert ARIBAUD		not exceed it.
324495579793STom Rini
32456a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32466a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32476a11cf48SDaniel Schwierzeck
324894a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
324994a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
325094a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
325194a45bb1SScott Wood
325295579793STom Rini		CONFIG_SPL_BSS_START_ADDR
325395579793STom Rini		Link address for the BSS within the SPL binary.
325495579793STom Rini
325595579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32566ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32576ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32586ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32598960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32606ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
326195579793STom Rini
326295579793STom Rini		CONFIG_SPL_STACK
326395579793STom Rini		Adress of the start of the stack SPL will use
326495579793STom Rini
326594a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
326694a45bb1SScott Wood		Adress of the start of the stack SPL will use after
326794a45bb1SScott Wood		relocation.  If unspecified, this is equal to
326894a45bb1SScott Wood		CONFIG_SPL_STACK.
326994a45bb1SScott Wood
327095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
327195579793STom Rini		Starting address of the malloc pool used in SPL.
327295579793STom Rini
327395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
327495579793STom Rini		The size of the malloc pool used in SPL.
32756a11cf48SDaniel Schwierzeck
327647f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
327747f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
327847f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
327947f7bcaeSTom Rini		NAND loading of the Linux Kernel.
328047f7bcaeSTom Rini
3281861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3282861a86f4STom Rini		For ARM, enable an optional function to print more information
3283861a86f4STom Rini		about the running system.
3284861a86f4STom Rini
32854b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
32864b919725SScott Wood		Arch init code should be built for a very small image
32874b919725SScott Wood
32886a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
32896a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
32906a11cf48SDaniel Schwierzeck
32916a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
32926a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
32936a11cf48SDaniel Schwierzeck
32946a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
32956a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
32966a11cf48SDaniel Schwierzeck
32976a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
32986a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32996a11cf48SDaniel Schwierzeck
33006a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
33016a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
33026a11cf48SDaniel Schwierzeck
330395579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
330495579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
330595579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
330695579793STom Rini		Address, size and partition on the MMC to load U-Boot from
330795579793STom Rini		when the MMC is being used in raw mode.
330895579793STom Rini
33092b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
33102b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
33112b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
33122b75b0adSPeter Korsgaard
33132b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
33142b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
33152b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
33162b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
33172b75b0adSPeter Korsgaard		(for falcon mode)
33182b75b0adSPeter Korsgaard
331995579793STom Rini		CONFIG_SPL_FAT_SUPPORT
332095579793STom Rini		Support for fs/fat/libfat.o in SPL binary
332195579793STom Rini
332295579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
332395579793STom Rini		Filename to read to load U-Boot when reading from FAT
332495579793STom Rini
33257ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
33267ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
33277ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
33287ad2cc79SPeter Korsgaard
33297ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
33307ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
33317ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
33327ad2cc79SPeter Korsgaard
333306f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
333406f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
333506f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
333606f60ae3SScott Wood		continuing (the hardware starts execution after just
333706f60ae3SScott Wood		loading the first page rather than the full 4K).
333806f60ae3SScott Wood
3339651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3340651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3341651fcf60SPrabhakar Kushwaha
33426f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33436f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33446f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33456f2f01b9SScott Wood
33466f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33476f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33486f2f01b9SScott Wood
33496f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33506f2f01b9SScott Wood		Include standard software ECC in the SPL
33516f2f01b9SScott Wood
335295579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33537d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33547d4b7955SScott Wood		expose the cmd_ctrl() interface.
335595579793STom Rini
3356bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3357bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33585614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3359bb0dc108SYing Zhang
33607c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
33617c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
33627c8eea59SYing Zhang		SPL binary.
33637c8eea59SYing Zhang
336495579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
336595579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
336695579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
336795579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
336895579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
336995579793STom Rini		Defines the size and behavior of the NAND that SPL uses
33707d4b7955SScott Wood		to read U-Boot
337195579793STom Rini
3372fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3373fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3374fbe76ae4SPrabhakar Kushwaha
337595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33767d4b7955SScott Wood		Location in NAND to read U-Boot from
33777d4b7955SScott Wood
33787d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33797d4b7955SScott Wood		Location in memory to load U-Boot to
33807d4b7955SScott Wood
33817d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
33827d4b7955SScott Wood		Size of image to load
338395579793STom Rini
338495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
33857d4b7955SScott Wood		Entry point in loaded image to jump to
338695579793STom Rini
338795579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
338895579793STom Rini		Define this if you need to first read the OOB and then the
338995579793STom Rini		data. This is used for example on davinci plattforms.
339095579793STom Rini
339195579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
339295579793STom Rini		Support for an OMAP3-specific set of functions to return the
339395579793STom Rini		ID and MFR of the first attached NAND chip, if present.
339495579793STom Rini
33956a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
33966a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
33976a11cf48SDaniel Schwierzeck
33986a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
33996a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
34006a11cf48SDaniel Schwierzeck
34016a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
34026a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
34036a11cf48SDaniel Schwierzeck
3404c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3405c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3406c57b953dSPavel Machek
34076a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
34086a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
34091372cce2SMarian Balakowicz
3410ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3411ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3412ba1bee43SYing Zhang
3413ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3414ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3415ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3416ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3417ba1bee43SYing Zhang
341874752baaSScott Wood		CONFIG_SPL_PAD_TO
34196113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
34206113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
34216113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34226113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34236113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
342474752baaSScott Wood
3425ca2fca22SScott Wood		CONFIG_SPL_TARGET
3426ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3427ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3428ca2fca22SScott Wood		example if more than one image needs to be produced.
3429ca2fca22SScott Wood
343087ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
343187ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
343287ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
343387ebee39SSimon Glass		option to re-enable it. This will affect the output of the
343487ebee39SSimon Glass		bootm command when booting a FIT image.
343587ebee39SSimon Glass
34363aa29de0SYing Zhang- TPL framework
34373aa29de0SYing Zhang		CONFIG_TPL
34383aa29de0SYing Zhang		Enable building of TPL globally.
34393aa29de0SYing Zhang
34403aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34413aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34423aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34433aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34443aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34453aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34463aa29de0SYing Zhang
3447c609719bSwdenkModem Support:
3448c609719bSwdenk--------------
3449c609719bSwdenk
3450566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3451c609719bSwdenk
345211ccc33fSMarcel Ziswiler- Modem support enable:
3453c609719bSwdenk		CONFIG_MODEM_SUPPORT
3454c609719bSwdenk
3455c609719bSwdenk- RTS/CTS Flow control enable:
3456c609719bSwdenk		CONFIG_HWFLOW
3457c609719bSwdenk
3458c609719bSwdenk- Modem debug support:
3459c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3460c609719bSwdenk
3461c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3462c609719bSwdenk		for modem support. Useful only with BDI2000.
3463c609719bSwdenk
3464a8c7c708Swdenk- Interrupt support (PPC):
3465a8c7c708Swdenk
3466a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3467a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
346811ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3469a8c7c708Swdenk		should set decrementer_count to appropriate value. If
347011ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3471a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
347211ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3473a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3474a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3475a8c7c708Swdenk		general timer_interrupt().
3476a8c7c708Swdenk
3477c609719bSwdenk- General:
3478c609719bSwdenk
3479c609719bSwdenk		In the target system modem support is enabled when a
3480c609719bSwdenk		specific key (key combination) is pressed during
3481c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
348211ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3483c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3484c609719bSwdenk		function, returning 1 and thus enabling modem
3485c609719bSwdenk		initialization.
3486c609719bSwdenk
3487c609719bSwdenk		If there are no modem init strings in the
3488c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3489c609719bSwdenk		previous output (banner, info printfs) will be
349011ccc33fSMarcel Ziswiler		suppressed, though.
3491c609719bSwdenk
3492c609719bSwdenk		See also: doc/README.Modem
3493c609719bSwdenk
34949660e442SHelmut RaigerBoard initialization settings:
34959660e442SHelmut Raiger------------------------------
34969660e442SHelmut Raiger
34979660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34989660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34999660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
35009660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
35019660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
35029660e442SHelmut Raigertypically in board_init_f() and board_init_r().
35039660e442SHelmut Raiger
35049660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
35059660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
35069660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
35079660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3508c609719bSwdenk
3509c609719bSwdenkConfiguration Settings:
3510c609719bSwdenk-----------------------
3511c609719bSwdenk
35124d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
35134d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
35144d1fd7f1SYork Sun
35156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3516c609719bSwdenk		undefine this when you're short of memory.
3517c609719bSwdenk
35182fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
35192fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
35202fb2604dSPeter Tyser
35216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3522c609719bSwdenk		prompt for user input.
3523c609719bSwdenk
35246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3525c609719bSwdenk
35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3527c609719bSwdenk
35286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3529c609719bSwdenk
35306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3531c609719bSwdenk		the application (usually a Linux kernel) when it is
3532c609719bSwdenk		booted
3533c609719bSwdenk
35346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3535c609719bSwdenk		List of legal baudrate settings for this board.
3536c609719bSwdenk
35376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3538c609719bSwdenk		Suppress display of console information at boot.
3539c609719bSwdenk
35406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3541c609719bSwdenk		If the board specific function
3542c609719bSwdenk			extern int overwrite_console (void);
3543c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3544c609719bSwdenk		serial port, else the settings in the environment are used.
3545c609719bSwdenk
35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3547c609719bSwdenk		Enable the call to overwrite_console().
3548c609719bSwdenk
35496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3550c609719bSwdenk		Enable overwrite of previous console environment settings.
3551c609719bSwdenk
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3553c609719bSwdenk		Begin and End addresses of the area used by the
3554c609719bSwdenk		simple memory test.
3555c609719bSwdenk
35566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3557c609719bSwdenk		Enable an alternate, more extensive memory test.
3558c609719bSwdenk
35596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35605f535fe1Swdenk		Scratch address used by the alternate memory test
35615f535fe1Swdenk		You only need to set this if address zero isn't writeable
35625f535fe1Swdenk
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
35646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
356514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
356611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
356714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
356814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
356914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35705e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
357114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35725e12e75dSStefan Roese		will have to get fixed in Linux additionally.
357314f73ca6SStefan Roese
357414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
357514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
357614f73ca6SStefan Roese		be touched.
357714f73ca6SStefan Roese
357814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
357914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
358014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
358114f73ca6SStefan Roese		non page size aligned address and this could cause major
358214f73ca6SStefan Roese		problems.
358314f73ca6SStefan Roese
35846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3585c609719bSwdenk		Enable temporary baudrate change while serial download
3586c609719bSwdenk
35876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3588c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3589c609719bSwdenk
35906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3591c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3592c609719bSwdenk		Cogent motherboard)
3593c609719bSwdenk
35946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3595c609719bSwdenk		Physical start address of Flash memory.
3596c609719bSwdenk
35976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3598c609719bSwdenk		Physical start address of boot monitor code (set by
3599c609719bSwdenk		make config files to be same as the text base address
360014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
36016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3602c609719bSwdenk
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
36043b57fe0aSwdenk		Size of memory reserved for monitor code, used to
36053b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
36063b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
36073b57fe0aSwdenk		flash sector.
3608c609719bSwdenk
36096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3610c609719bSwdenk		Size of DRAM reserved for malloc() use.
3611c609719bSwdenk
36126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
361315940c9aSStefan Roese		Normally compressed uImages are limited to an
361415940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
36156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
361615940c9aSStefan Roese		to adjust this setting to your needs.
3617c609719bSwdenk
36186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3619c609719bSwdenk		Maximum size of memory mapped by the startup code of
3620c609719bSwdenk		the Linux kernel; all data that must be processed by
36217d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
36227d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
36231bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
36247d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3625c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3626c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3627c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3628c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3629c609719bSwdenk
3630fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3631fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3632fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3633fca43cc8SJohn Rigby		is enabled.
3634fca43cc8SJohn Rigby
3635fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3636fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3637fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3638fca43cc8SJohn Rigby
3639fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3640fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3641fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3642fca43cc8SJohn Rigby
36436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3644c609719bSwdenk		Max number of Flash memory banks
3645c609719bSwdenk
36466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3647c609719bSwdenk		Max number of sectors on a Flash chip
3648c609719bSwdenk
36496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3650c609719bSwdenk		Timeout for Flash erase operations (in ms)
3651c609719bSwdenk
36526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3653c609719bSwdenk		Timeout for Flash write operations (in ms)
3654c609719bSwdenk
36556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36568564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36578564acf9Swdenk
36586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36598564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36608564acf9Swdenk
36616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36628564acf9Swdenk		If defined, hardware flash sectors protection is used
36638564acf9Swdenk		instead of U-Boot software protection.
36648564acf9Swdenk
36656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3666c609719bSwdenk
3667c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3668c609719bSwdenk		without this option such a download has to be
3669c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3670c609719bSwdenk		copy from RAM to flash.
3671c609719bSwdenk
3672c609719bSwdenk		The two-step approach is usually more reliable, since
3673c609719bSwdenk		you can check if the download worked before you erase
367411ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
367511ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3676c609719bSwdenk		downloaded image) this option may be very useful.
3677c609719bSwdenk
36786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3679c609719bSwdenk		Define if the flash driver uses extra elements in the
36805653fc33Swdenk		common flash structure for storing flash geometry.
36815653fc33Swdenk
368200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36835653fc33Swdenk		This option also enables the building of the cfi_flash driver
36845653fc33Swdenk		in the drivers directory
368553cf9435Sstroese
368691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
368791809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
368891809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
368991809ed5SPiotr Ziecik		to the MTD layer.
369091809ed5SPiotr Ziecik
36916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
369296ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
369396ef831fSGuennadi Liakhovetski
369496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
369596ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
369696ef831fSGuennadi Liakhovetski		write commands.
369796ef831fSGuennadi Liakhovetski
36986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
36995568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
37005568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
37015568e613SStefan Roese		is useful, if some of the configured banks are only
37025568e613SStefan Roese		optionally available.
37035568e613SStefan Roese
37049a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
37059a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
37069a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
37079a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
37089a042e9cSJerry Van Baren
3709352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3710352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3711352ef3f1SStefan Roese		against the source after the write operation. An error message
3712352ef3f1SStefan Roese		will be printed when the contents are not identical.
3713352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3714352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3715352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3716352ef3f1SStefan Roese		this option if you really know what you are doing.
3717352ef3f1SStefan Roese
37186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
371911ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
372011ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
372153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
372253cf9435Sstroese		buffers can be full shortly after enabling the interface
372311ccc33fSMarcel Ziswiler		on high Ethernet traffic.
372453cf9435Sstroese		Defaults to 4 if not defined.
3725c609719bSwdenk
3726ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3727ea882bafSWolfgang Denk
3728ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3729ea882bafSWolfgang Denk	internally to store the environment settings. The default
3730ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3731ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3732ea882bafSWolfgang Denk	lib/hashtable.c for details.
3733ea882bafSWolfgang Denk
37342598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
37352598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
37361bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
37372598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37382598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37392598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37402598090bSJoe Hershberger
37412598090bSJoe Hershberger	The format of the list is:
37422598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3743267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3744267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
37452598090bSJoe Hershberger		entry = variable_name[:attributes]
37462598090bSJoe Hershberger		list = entry[,list]
37472598090bSJoe Hershberger
37482598090bSJoe Hershberger	The type attributes are:
37492598090bSJoe Hershberger		s - String (default)
37502598090bSJoe Hershberger		d - Decimal
37512598090bSJoe Hershberger		x - Hexadecimal
37522598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37532598090bSJoe Hershberger		i - IP address
37542598090bSJoe Hershberger		m - MAC address
37552598090bSJoe Hershberger
3756267541f7SJoe Hershberger	The access attributes are:
3757267541f7SJoe Hershberger		a - Any (default)
3758267541f7SJoe Hershberger		r - Read-only
3759267541f7SJoe Hershberger		o - Write-once
3760267541f7SJoe Hershberger		c - Change-default
3761267541f7SJoe Hershberger
37622598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37632598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
37642598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
37652598090bSJoe Hershberger
37662598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37672598090bSJoe Hershberger		Define this to a list (string) to define validation that
37682598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37692598090bSJoe Hershberger		environment variable.  To override a setting in the static
37702598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37712598090bSJoe Hershberger		".flags" variable.
37722598090bSJoe Hershberger
3773267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3774267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3775267541f7SJoe Hershberger	access flags.
3776267541f7SJoe Hershberger
37775c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
37785c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37795c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37805c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
37815c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
37825c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
37835c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
37845c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
37855c1a7ea6SSimon Glass	your board please report the problem and send patches!
37865c1a7ea6SSimon Glass
37870b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37880b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37890b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
37900b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3791632efa74SSimon Glass
3792c609719bSwdenkThe following definitions that deal with the placement and management
3793c609719bSwdenkof environment data (variable area); in general, we support the
3794c609719bSwdenkfollowing configurations:
3795c609719bSwdenk
3796c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3797c3eb3fe4SMike Frysinger
3798c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3799c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3800c3eb3fe4SMike Frysinger
38015a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3802c609719bSwdenk
3803c609719bSwdenk	Define this if the environment is in flash memory.
3804c609719bSwdenk
3805c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3806c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3807c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3808c609719bSwdenk	   sector" type flash chips, which have several smaller
3809c609719bSwdenk	   sectors at the start or the end. For instance, such a
3810c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3811c609719bSwdenk	   such a case you would place the environment in one of the
3812c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3813c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3814c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3815c609719bSwdenk	   between U-Boot and the environment.
3816c609719bSwdenk
38170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3818c609719bSwdenk
3819c609719bSwdenk	   Offset of environment data (variable area) to the
3820c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3821c609719bSwdenk	   type flash chips the second sector can be used: the offset
3822c609719bSwdenk	   for this sector is given here.
3823c609719bSwdenk
38246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3825c609719bSwdenk
38260e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3827c609719bSwdenk
3828c609719bSwdenk	   This is just another way to specify the start address of
3829c609719bSwdenk	   the flash sector containing the environment (instead of
38300e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3831c609719bSwdenk
38320e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3833c609719bSwdenk
3834c609719bSwdenk	   Size of the sector containing the environment.
3835c609719bSwdenk
3836c609719bSwdenk
3837c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3838c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3839c609719bSwdenk	   the environment.
3840c609719bSwdenk
38410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3842c609719bSwdenk
38435a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38440e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3845c609719bSwdenk	   of this flash sector for the environment. This saves
3846c609719bSwdenk	   memory for the RAM copy of the environment.
3847c609719bSwdenk
3848c609719bSwdenk	   It may also save flash memory if you decide to use this
3849c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3850c609719bSwdenk	   since then the remainder of the flash sector could be used
3851c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3852c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3853c609719bSwdenk	   updating the environment in flash makes it always
3854c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3855c609719bSwdenk	   wrong before the contents has been restored from a copy in
3856c609719bSwdenk	   RAM, your target system will be dead.
3857c609719bSwdenk
38580e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38590e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3860c609719bSwdenk
3861c609719bSwdenk	   These settings describe a second storage area used to hold
386211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38633e38691eSwdenk	   a valid backup copy in case there is a power failure during
3864c609719bSwdenk	   a "saveenv" operation.
3865c609719bSwdenk
3866c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3867c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3868c609719bSwdenkaccordingly!
3869c609719bSwdenk
3870c609719bSwdenk
38719314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3872c609719bSwdenk
3873c609719bSwdenk	Define this if you have some non-volatile memory device
3874c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3875c609719bSwdenk	environment.
3876c609719bSwdenk
38770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3879c609719bSwdenk
388011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3881c609719bSwdenk	  want to use for environment. It is assumed that this memory
3882c609719bSwdenk	  can just be read and written to, without any special
3883c609719bSwdenk	  provision.
3884c609719bSwdenk
3885c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3886c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
388711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3888c609719bSwdenkU-Boot will hang.
3889c609719bSwdenk
3890c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3891c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3892c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3893c609719bSwdenkto save the current settings.
3894c609719bSwdenk
3895c609719bSwdenk
3896bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3897c609719bSwdenk
3898c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3899c609719bSwdenk	device and a driver for it.
3900c609719bSwdenk
39010e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39020e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3903c609719bSwdenk
3904c609719bSwdenk	  These two #defines specify the offset and size of the
3905c609719bSwdenk	  environment area within the total memory of your EEPROM.
3906c609719bSwdenk
39076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3908c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3909c609719bSwdenk	  The default address is zero.
3910c609719bSwdenk
39116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3912c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3913c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3914c609719bSwdenk	  would require six bits.
3915c609719bSwdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3917c609719bSwdenk	  If defined, the number of milliseconds to delay between
3918c609719bSwdenk	  page writes.	The default is zero milliseconds.
3919c609719bSwdenk
39206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3921c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3922c609719bSwdenk	  that this is NOT the chip address length!
3923c609719bSwdenk
39246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
39255cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
39265cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
39275cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
39285cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
39295cf91d6bSwdenk	  byte chips.
39305cf91d6bSwdenk
39315cf91d6bSwdenk	  Note that we consider the length of the address field to
39325cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
39335cf91d6bSwdenk	  in the chip address.
39345cf91d6bSwdenk
39356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3936c609719bSwdenk	  The size in bytes of the EEPROM device.
3937c609719bSwdenk
3938548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3939548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3940548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3941548738b4SHeiko Schocher
3942548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3943548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3944548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3945548738b4SHeiko Schocher	  EEPROM. For example:
3946548738b4SHeiko Schocher
3947ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3948548738b4SHeiko Schocher
3949548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3950548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3951c609719bSwdenk
3952057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39535779d8d9Swdenk
39545779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39555779d8d9Swdenk	want to use for the environment.
39565779d8d9Swdenk
39570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39580e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39590e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39605779d8d9Swdenk
39615779d8d9Swdenk	  These three #defines specify the offset and size of the
39625779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39635779d8d9Swdenk	  at the specified address.
39645779d8d9Swdenk
39650a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
39660a85a9e7SLiu Gang
39670a85a9e7SLiu Gang	Define this if you have a remote memory space which you
39680a85a9e7SLiu Gang	want to use for the local device's environment.
39690a85a9e7SLiu Gang
39700a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
39710a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
39720a85a9e7SLiu Gang
39730a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39740a85a9e7SLiu Gang	  environment area within the remote memory space. The
39750a85a9e7SLiu Gang	  local device can get the environment from remote memory
3976fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39770a85a9e7SLiu Gang
39780a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39790a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3980fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3981fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
39820a85a9e7SLiu Gang
398351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
398413a5695bSwdenk
398513a5695bSwdenk	Define this if you have a NAND device which you want to use
398613a5695bSwdenk	for the environment.
398713a5695bSwdenk
39880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39890e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
399013a5695bSwdenk
399113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3992fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3993fdd813deSScott Wood	  aligned to an erase block boundary.
39945779d8d9Swdenk
3995fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3996e443c944SMarkus Klotzbuecher
39970e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3998fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3999fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
4000fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
4001fdd813deSScott Wood	  aligned to an erase block boundary.
4002e443c944SMarkus Klotzbuecher
4003fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
4004fdd813deSScott Wood
4005fdd813deSScott Wood	  Specifies the length of the region in which the environment
4006fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
4007fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
4008fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4009fdd813deSScott Wood	  the range to be avoided.
4010fdd813deSScott Wood
4011fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
4012fdd813deSScott Wood
4013fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
4014fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
4015fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
4016fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4017fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
4018e443c944SMarkus Klotzbuecher
4019b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
4020b74ab737SGuennadi Liakhovetski
4021b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
4022b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
4023b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4024b74ab737SGuennadi Liakhovetski
40252b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
40262b74433fSJoe Hershberger
40272b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
40282b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
40292b74433fSJoe Hershberger	accesses, which is important on NAND.
40302b74433fSJoe Hershberger
40312b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
40322b74433fSJoe Hershberger
40332b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
40342b74433fSJoe Hershberger
40352b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
40362b74433fSJoe Hershberger
40372b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40382b74433fSJoe Hershberger	  environment in.
40392b74433fSJoe Hershberger
4040785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4041785881f7SJoe Hershberger
4042785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4043785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4044785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4045785881f7SJoe Hershberger
40462b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40472b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40482b74433fSJoe Hershberger
40492b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40502b74433fSJoe Hershberger	  when storing the env in UBI.
40512b74433fSJoe Hershberger
405206e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
405306e4ae5fSStephen Warren
405406e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
405506e4ae5fSStephen Warren	environment.
405606e4ae5fSStephen Warren
405706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
405806e4ae5fSStephen Warren
405906e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
406006e4ae5fSStephen Warren
406106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
406206e4ae5fSStephen Warren
406306e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
406406e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
406506e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
406606e4ae5fSStephen Warren
406706e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
406806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
406906e4ae5fSStephen Warren
407006e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
407106e4ae5fSStephen Warren	  area within the specified MMC device.
407206e4ae5fSStephen Warren
40735c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40745c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40755c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40765c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40775c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40785c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40795c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40805c088ee8SStephen Warren
408106e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
408206e4ae5fSStephen Warren	  MMC sector boundary.
408306e4ae5fSStephen Warren
408406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
408506e4ae5fSStephen Warren
408606e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
408706e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
408806e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
408906e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
409006e4ae5fSStephen Warren
40915c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
40925c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
40935c088ee8SStephen Warren
409406e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
409506e4ae5fSStephen Warren	  an MMC sector boundary.
409606e4ae5fSStephen Warren
409706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
409806e4ae5fSStephen Warren
409906e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
410006e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
410106e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
410206e4ae5fSStephen Warren
41036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4104c609719bSwdenk
4105c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4106c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4107c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4108c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4109c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4110c609719bSwdenk	to be a good choice since it makes it far enough from the
4111c609719bSwdenk	start of the data area as well as from the stack pointer.
4112c609719bSwdenk
4113e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4114c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4115cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4116c609719bSwdenkuntil then to read environment variables.
4117c609719bSwdenk
411885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
411985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
412085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
412185ec0bccSwdenknecessary, because the first environment variable we need is the
412285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
412385ec0bccSwdenkhave any device yet where we could complain.]
4124c609719bSwdenk
4125c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4126c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
412785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4128c609719bSwdenk
41296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4130fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4131fc3e2165Swdenk
41326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4133fc3e2165Swdenk		      also needs to be defined.
4134fc3e2165Swdenk
41356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4136fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4137c609719bSwdenk
4138f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4139f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4140f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4141f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4142f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4143f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4144f5675aa5SRon Madrid
4145b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4146b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4147b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4148b2b92f53SSimon Glass		to do this.
4149b2b92f53SSimon Glass
4150e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4151e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4152e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4153e2e3e2b1SSimon Glass		present.
4154e2e3e2b1SSimon Glass
4155c609719bSwdenkLow Level (hardware related) configuration options:
4156dc7c9a1aSwdenk---------------------------------------------------
4157c609719bSwdenk
41586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4159c609719bSwdenk		Cache Line Size of the CPU.
4160c609719bSwdenk
41616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4162c609719bSwdenk		Default address of the IMMR after system reset.
41632535d602Swdenk
41642535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
41652535d602Swdenk		and RPXsuper) to be able to adjust the position of
41662535d602Swdenk		the IMMR register after a reset.
4167c609719bSwdenk
4168e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4169e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4170e46fedfeSTimur Tabi		PowerPC SOCs.
4171e46fedfeSTimur Tabi
4172e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4173e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4174e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4175e46fedfeSTimur Tabi
4176e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4177e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4178e46fedfeSTimur Tabi
4179e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4180e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4181e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4182e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4183e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4184e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4185e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4186e46fedfeSTimur Tabi
4187e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4188e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4189e46fedfeSTimur Tabi
4190e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4191e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4192e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4193e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4194e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4195e46fedfeSTimur Tabi
4196e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4197e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4198e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4199e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4200e46fedfeSTimur Tabi
4201e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4202e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4203e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4204e46fedfeSTimur Tabi
42057f6c2cbcSwdenk- Floppy Disk Support:
42066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
42077f6c2cbcSwdenk
42087f6c2cbcSwdenk		the default drive number (default value 0)
42097f6c2cbcSwdenk
42106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
42117f6c2cbcSwdenk
421211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
42137f6c2cbcSwdenk		(default value 1)
42147f6c2cbcSwdenk
42156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
42167f6c2cbcSwdenk
42177f6c2cbcSwdenk		defines the offset of register from address. It
42187f6c2cbcSwdenk		depends on which part of the data bus is connected to
421911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
42207f6c2cbcSwdenk
42216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
42226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
42237f6c2cbcSwdenk		default value.
42247f6c2cbcSwdenk
42256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
42267f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
42277f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
42287f6c2cbcSwdenk		source code. It is used to make hardware dependant
42297f6c2cbcSwdenk		initializations.
42307f6c2cbcSwdenk
42310abddf82SMacpaul Lin- CONFIG_IDE_AHB:
42320abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
42330abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
42340abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
42350abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
42360abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
42370abddf82SMacpaul Lin		is requierd.
42380abddf82SMacpaul Lin
42396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
424025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
424125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4242c609719bSwdenk
42436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4244c609719bSwdenk
42457152b1d0Swdenk		Start address of memory area that can be used for
4246c609719bSwdenk		initial data and stack; please note that this must be
4247c609719bSwdenk		writable memory that is working WITHOUT special
4248c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4249c609719bSwdenk		will become available only after programming the
4250c609719bSwdenk		memory controller and running certain initialization
4251c609719bSwdenk		sequences.
4252c609719bSwdenk
4253c609719bSwdenk		U-Boot uses the following memory types:
4254c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4255c609719bSwdenk		- MPC824X: data cache
4256c609719bSwdenk		- PPC4xx:  data cache
4257c609719bSwdenk
42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4259c609719bSwdenk
4260c609719bSwdenk		Offset of the initial data structure in the memory
42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
42626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4263c609719bSwdenk		data is located at the end of the available space
4264553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
42656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
42666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
42676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4268c609719bSwdenk
4269c609719bSwdenk	Note:
4270c609719bSwdenk		On the MPC824X (or other systems that use the data
4271c609719bSwdenk		cache for initial memory) the address chosen for
42726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4273c609719bSwdenk		point to an otherwise UNUSED address space between
4274c609719bSwdenk		the top of RAM and the start of the PCI space.
4275c609719bSwdenk
42766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4277c609719bSwdenk
42786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4279c609719bSwdenk
42806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4281c609719bSwdenk
42826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4283c609719bSwdenk
42846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4285c609719bSwdenk
42866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4287c609719bSwdenk
42886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4289c609719bSwdenk		SDRAM timing
4290c609719bSwdenk
42916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4292c609719bSwdenk		periodic timer for refresh
4293c609719bSwdenk
42946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4295c609719bSwdenk
42966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
42986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
42996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4300c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4301c609719bSwdenk
4302c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
43036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
43046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4305c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4306c609719bSwdenk
43076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
43086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4309c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4310c609719bSwdenk		Prescaler definitions (SDRAM timing)
4311c609719bSwdenk
43126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4313c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4314c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4315c609719bSwdenk
43166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4317b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4318b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4319b423d055SHeiko Schocher
43206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4321c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4322c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4323c609719bSwdenk
43246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4325c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4326c609719bSwdenk		wrong setting might damage your board. Read
4327c609719bSwdenk		doc/README.MBX before setting this variable!
4328c609719bSwdenk
43296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4330ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4331ea909b76Swdenk		(Power On Self Tests). This definition overrides
4332ea909b76Swdenk		#define'd default value in commproc.h resp.
4333ea909b76Swdenk		cpm_8260.h.
4334ea909b76Swdenk
43356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
43366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
43376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
43386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
43396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
43406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
43416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
43426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4343a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
43445d232d0eSwdenk
43459cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43469cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43479cacf4fcSDirk Eibach		required.
43489cacf4fcSDirk Eibach
434969fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
435069fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
435169fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
435269fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
435369fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
435469fd2d3bSAndrew Sharp		by coreboot or similar.
435569fd2d3bSAndrew Sharp
4356842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4357842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4358842033e6SGabor Juhos
4359a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4360a09b9b68SKumar Gala		Chip has SRIO or not
4361a09b9b68SKumar Gala
4362a09b9b68SKumar Gala- CONFIG_SRIO1:
4363a09b9b68SKumar Gala		Board has SRIO 1 port available
4364a09b9b68SKumar Gala
4365a09b9b68SKumar Gala- CONFIG_SRIO2:
4366a09b9b68SKumar Gala		Board has SRIO 2 port available
4367a09b9b68SKumar Gala
4368c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4369c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4370c8b28152SLiu Gang
4371a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4372a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4373a09b9b68SKumar Gala
4374a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4375a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4376a09b9b68SKumar Gala
4377a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4378a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4379a09b9b68SKumar Gala
438066bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
438166bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
438266bd1846SFabio Estevam		a 16 bit bus.
438366bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4384a430e916SFabio Estevam		Example of drivers that use it:
438566bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4386a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4387eced4626SAlex Waterman
4388eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4389eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4390eced4626SAlex Waterman		a default value will be used.
4391eced4626SAlex Waterman
4392bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4393218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4394218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4395218ca724SWolfgang Denk
4396bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4397bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4398bb99ad6dSBen Warren
43996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4400218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4401218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4402218ca724SWolfgang Denk		to something your driver can deal with.
4403bb99ad6dSBen Warren
44041b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
44051b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
44061b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
44071b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
44081b3e3c4fSYork Sun		header files or board specific files.
44091b3e3c4fSYork Sun
44106f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
44116f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
44126f5e1dc5SYork Sun
44136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4414218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4415218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
44162ad6b513STimur Tabi
4417c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4418c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4419c26e454dSwdenk
4420c26e454dSwdenk- CONFIG_FEC[12]_PHY
4421c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
44226e592385Swdenk		to the given FEC; i. e.
4423c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4424c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4425c26e454dSwdenk
4426c26e454dSwdenk		When set to -1, means to probe for first available.
4427c26e454dSwdenk
4428c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4429c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4430c26e454dSwdenk		(so program the FEC to ignore it).
4431c26e454dSwdenk
4432c26e454dSwdenk- CONFIG_RMII
4433c26e454dSwdenk		Enable RMII mode for all FECs.
4434c26e454dSwdenk		Note that this is a global option, we can't
4435c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4436c26e454dSwdenk
44375cf91d6bSwdenk- CONFIG_CRC32_VERIFY
44385cf91d6bSwdenk		Add a verify option to the crc32 command.
44395cf91d6bSwdenk		The syntax is:
44405cf91d6bSwdenk
44415cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
44425cf91d6bSwdenk
44435cf91d6bSwdenk		Where address/count indicate a memory area
44445cf91d6bSwdenk		and crc32 is the correct crc32 which the
44455cf91d6bSwdenk		area should have.
44465cf91d6bSwdenk
444756523f12Swdenk- CONFIG_LOOPW
444856523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4449602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
445056523f12Swdenk
44517b466641Sstroese- CONFIG_MX_CYCLIC
44527b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44537b466641Sstroese		"md/mw" commands.
44547b466641Sstroese		Examples:
44557b466641Sstroese
44567b466641Sstroese		=> mdc.b 10 4 500
44577b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44587b466641Sstroese
44597b466641Sstroese		=> mwc.l 100 12345678 10
44607b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
44617b466641Sstroese
44627b466641Sstroese		This only takes effect if the memory commands are activated
4463602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
44647b466641Sstroese
44658aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4466afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4467e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4468e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4469e03f3169SWolfgang Denk		relocate itself into RAM.
44708aa1a2d1Swdenk
4471e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4472e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4473e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4474e03f3169SWolfgang Denk		these initializations itself.
44758aa1a2d1Swdenk
4476401bb30bSAneesh V- CONFIG_SPL_BUILD
4477df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4478df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4479df81238bSMagnus Lilja		compiling a NAND SPL.
4480400558b5Swdenk
44813aa29de0SYing Zhang- CONFIG_TPL_BUILD
44823aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
44833aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
44843aa29de0SYing Zhang		It is loaded by the SPL.
44853aa29de0SYing Zhang
44865df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
44875df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
44885df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
44895df572f0SYing Zhang		previous 4k of the .text section.
44905df572f0SYing Zhang
44914213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
44924213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
44934213fc29SSimon Glass		effective address. It is therefore not necessary to regard
44944213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
44954213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
44964213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
44974213fc29SSimon Glass		addressable memory. This option causes some memory accesses
44984213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
44994213fc29SSimon Glass
4500d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4501d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4502d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4503d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4504d8834a13SMatthias Weisser		conditions but may increase the binary size.
4505d8834a13SMatthias Weisser
4506588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4507588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4508588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4509b16f521aSGabe Black
4510fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4511fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4512fc33705eSMark Jackson
4513fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
45145b5ece9eSGabe Black
451516678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
451616678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
451716678eb4SHeiko Schocher
4518f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4519f2717b47STimur Tabi-----------------------------------
4520f2717b47STimur Tabi
4521f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4522f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4523f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4524f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4525f2717b47STimur Tabiwithin that device.
4526f2717b47STimur Tabi
4527dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4528dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4529dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4530dcf1d774SZhao Qiang	is also specified.
4531dcf1d774SZhao Qiang
4532dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4533dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4534f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4535f2717b47STimur Tabi	is also specified.
4536f2717b47STimur Tabi
4537f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4538f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4539f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4540f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4541f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4542f2717b47STimur Tabi
4543f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4544f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4545f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4546f2717b47STimur Tabi	virtual address in NOR flash.
4547f2717b47STimur Tabi
4548f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4549f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4550f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4551f2717b47STimur Tabi
4552f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4553f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4554f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4555f2717b47STimur Tabi
4556f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4557f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4558f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4559f2717b47STimur Tabi
4560292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4561292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4562292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4563fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4564fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4565fc54c7faSLiu Gang	master's memory space.
4566f2717b47STimur Tabi
4567c609719bSwdenkBuilding the Software:
4568c609719bSwdenk======================
4569c609719bSwdenk
4570218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4571218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4572218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4573218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4574218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4575218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4576c609719bSwdenk
4577218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4578218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4579218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4580218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4581218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4582c609719bSwdenk
4583218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4584218ca724SWolfgang Denk	$ export CROSS_COMPILE
4585c609719bSwdenk
45862f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
45872f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
45882f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
45892f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
45902f8d396bSPeter Tyser
45912f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
45922f8d396bSPeter Tyser
45932f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
45942f8d396bSPeter Tyser      be executed on computers running Windows.
45952f8d396bSPeter Tyser
4596c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4597c609719bSwdenksources you must configure U-Boot for one specific board type. This
4598c609719bSwdenkis done by typing:
4599c609719bSwdenk
4600c609719bSwdenk	make NAME_config
4601c609719bSwdenk
4602218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
46034d675ae6SMichael Jonesrations; see boards.cfg for supported names.
460454387ac9Swdenk
4605c609719bSwdenkNote: for some board special configuration names may exist; check if
4606c609719bSwdenk      additional information is available from the board vendor; for
46072729af9dSwdenk      instance, the TQM823L systems are available without (standard)
46082729af9dSwdenk      or with LCD support. You can select such additional "features"
460911ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4610c609719bSwdenk
46112729af9dSwdenk      make TQM823L_config
46122729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4613c609719bSwdenk
4614c609719bSwdenk      make TQM823L_LCD_config
4615c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4616c609719bSwdenk
4617c609719bSwdenk      etc.
4618c609719bSwdenk
4619c609719bSwdenk
4620c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
46217152b1d0Swdenkimages ready for download to / installation on your system:
4622c609719bSwdenk
4623c609719bSwdenk- "u-boot.bin" is a raw binary image
4624c609719bSwdenk- "u-boot" is an image in ELF binary format
4625c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4626c609719bSwdenk
4627baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4628baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4629baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4630baf31249SMarian Balakowicz
4631baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4632baf31249SMarian Balakowicz
4633baf31249SMarian Balakowicz	make O=/tmp/build distclean
4634baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4635baf31249SMarian Balakowicz	make O=/tmp/build all
4636baf31249SMarian Balakowicz
4637baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4638baf31249SMarian Balakowicz
4639baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4640baf31249SMarian Balakowicz	make distclean
4641baf31249SMarian Balakowicz	make NAME_config
4642baf31249SMarian Balakowicz	make all
4643baf31249SMarian Balakowicz
4644baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4645baf31249SMarian Balakowiczvariable.
4646baf31249SMarian Balakowicz
4647c609719bSwdenk
4648c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4649c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4650c609719bSwdenknative "make".
4651c609719bSwdenk
4652c609719bSwdenk
4653c609719bSwdenkIf the system board that you have is not listed, then you will need
4654c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4655c609719bSwdenksteps:
4656c609719bSwdenk
4657c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
46584d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
46594d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4660c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
466185ec0bccSwdenk    files you need. In your board directory, you will need at least
466285ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
466385ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
466485ec0bccSwdenk    your board
4665c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4666c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
466785ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4668c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4669c609719bSwdenk    to be installed on your target system.
467085ec0bccSwdenk6.  Debug and solve any problems that might arise.
4671c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4672c609719bSwdenk
4673c609719bSwdenk
4674c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4675c609719bSwdenk==============================================================
4676c609719bSwdenk
4677c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4678c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4679c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4680c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4681218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4682c609719bSwdenk
4683c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4684c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4685c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4686c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4687c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
46887152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4689218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4690218ca724SWolfgang Denkyou can type
4691c609719bSwdenk
4692c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4693c609719bSwdenk
4694c609719bSwdenkor to build on a native PowerPC system you can type
4695c609719bSwdenk
4696c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4697c609719bSwdenk
4698218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4699218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4700218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4701218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4702218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4703218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4704218ca724SWolfgang Denkvariable. For example:
4705baf31249SMarian Balakowicz
4706baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4707baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4708baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4709baf31249SMarian Balakowicz
4710218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4711218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4712218ca724SWolfgang Denkduring the whole build process.
4713baf31249SMarian Balakowicz
4714baf31249SMarian Balakowicz
4715c609719bSwdenkSee also "U-Boot Porting Guide" below.
4716c609719bSwdenk
4717c609719bSwdenk
4718c609719bSwdenkMonitor Commands - Overview:
4719c609719bSwdenk============================
4720c609719bSwdenk
4721c609719bSwdenkgo	- start application at address 'addr'
4722c609719bSwdenkrun	- run commands in an environment variable
4723c609719bSwdenkbootm	- boot application image from memory
4724c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
472544f074c7SMarek Vasutbootz   - boot zImage from memory
4726c609719bSwdenktftpboot- boot image via network using TFTP protocol
4727c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4728c609719bSwdenk	       (and eventually "gatewayip")
47291fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4730c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4731c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4732c609719bSwdenkloads	- load S-Record file over serial line
4733c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4734c609719bSwdenkmd	- memory display
4735c609719bSwdenkmm	- memory modify (auto-incrementing)
4736c609719bSwdenknm	- memory modify (constant address)
4737c609719bSwdenkmw	- memory write (fill)
4738c609719bSwdenkcp	- memory copy
4739c609719bSwdenkcmp	- memory compare
4740c609719bSwdenkcrc32	- checksum calculation
47410f89c54bSPeter Tyseri2c	- I2C sub-system
4742c609719bSwdenksspi	- SPI utility commands
4743c609719bSwdenkbase	- print or set address offset
4744c609719bSwdenkprintenv- print environment variables
4745c609719bSwdenksetenv	- set environment variables
4746c609719bSwdenksaveenv - save environment variables to persistent storage
4747c609719bSwdenkprotect - enable or disable FLASH write protection
4748c609719bSwdenkerase	- erase FLASH memory
4749c609719bSwdenkflinfo	- print FLASH memory information
475010635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4751c609719bSwdenkbdinfo	- print Board Info structure
4752c609719bSwdenkiminfo	- print header information for application image
4753c609719bSwdenkconinfo - print console devices and informations
4754c609719bSwdenkide	- IDE sub-system
4755c609719bSwdenkloop	- infinite loop on address range
475656523f12Swdenkloopw	- infinite write loop on address range
4757c609719bSwdenkmtest	- simple RAM test
4758c609719bSwdenkicache	- enable or disable instruction cache
4759c609719bSwdenkdcache	- enable or disable data cache
4760c609719bSwdenkreset	- Perform RESET of the CPU
4761c609719bSwdenkecho	- echo args to console
4762c609719bSwdenkversion - print monitor version
4763c609719bSwdenkhelp	- print online help
4764c609719bSwdenk?	- alias for 'help'
4765c609719bSwdenk
4766c609719bSwdenk
4767c609719bSwdenkMonitor Commands - Detailed Description:
4768c609719bSwdenk========================================
4769c609719bSwdenk
4770c609719bSwdenkTODO.
4771c609719bSwdenk
4772c609719bSwdenkFor now: just type "help <command>".
4773c609719bSwdenk
4774c609719bSwdenk
4775c609719bSwdenkEnvironment Variables:
4776c609719bSwdenk======================
4777c609719bSwdenk
4778c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4779c609719bSwdenkcan be made persistent by saving to Flash memory.
4780c609719bSwdenk
4781c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4782c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4783c609719bSwdenkwithout a value can be used to delete a variable from the
4784c609719bSwdenkenvironment. As long as you don't save the environment you are
4785c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4786c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4787c609719bSwdenk
4788c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4789c96f86eeSWolfgang Denk
4790c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4791c609719bSwdenk
4792c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4793c609719bSwdenk
4794c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4795c609719bSwdenk
4796c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4797c609719bSwdenk
4798c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4799c609719bSwdenk
4800c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4801c609719bSwdenk
48027d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
48037d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48047d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
48057d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
48067d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
48077d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4808c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4809c3624e6eSGrant Likely		  bootm_mapsize.
4810c3624e6eSGrant Likely
4811c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4812c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4813c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4814c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4815c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4816c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4817c3624e6eSGrant Likely		  used otherwise.
48187d721e34SBartlomiej Sieka
48197d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
48207d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
48217d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
48227d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
48237d721e34SBartlomiej Sieka		  environment variable.
48247d721e34SBartlomiej Sieka
48254bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
48264bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
48274bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
48284bae9090SBartlomiej Sieka
4829c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4830c609719bSwdenk		  "bootp" will just load perform a lookup of the
4831c609719bSwdenk		  configuration from the BOOTP server, but not try to
4832c609719bSwdenk		  load any image using TFTP
4833c609719bSwdenk
4834c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4835c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4836c609719bSwdenk		  be automatically started (by internally calling
4837c609719bSwdenk		  "bootm")
4838c609719bSwdenk
48394a6fd34bSwdenk		  If set to "no", a standalone image passed to the
48404a6fd34bSwdenk		  "bootm" command will be copied to the load address
48414a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
48424a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
48434a6fd34bSwdenk		  data.
48444a6fd34bSwdenk
4845a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4846a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4847fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4848fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4849fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4850fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4851fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4852fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4853fa34f6b2SShawn Guo		  access it during the boot procedure.
4854fa34f6b2SShawn Guo
4855a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4856a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4857a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4858a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4859a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4860a28afca5SDavid A. Long		  must be accessible by the kernel.
4861a28afca5SDavid A. Long
4862eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4863eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4864eea63e05SSimon Glass		  defined.
4865eea63e05SSimon Glass
486617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
486717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
486817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
486917ea1177Swdenk		  initialization code. So, for changes to be effective
487017ea1177Swdenk		  it must be saved and board must be reset.
487117ea1177Swdenk
4872c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4873c609719bSwdenk		  If this variable is not set, initrd images will be
4874c609719bSwdenk		  copied to the highest possible address in RAM; this
4875c609719bSwdenk		  is usually what you want since it allows for
4876c609719bSwdenk		  maximum initrd size. If for some reason you want to
4877c609719bSwdenk		  make sure that the initrd image is loaded below the
48786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4879c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4880c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4881c609719bSwdenk		  address to use (U-Boot will still check that it
4882c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4883c609719bSwdenk
4884c609719bSwdenk		  For instance, when you have a system with 16 MB
48857152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4886c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4887c609719bSwdenk		  the "bootargs" variable. However, now you must make
48887152b1d0Swdenk		  sure that the initrd image is placed in the first
4889c609719bSwdenk		  12 MB as well - this can be done with
4890c609719bSwdenk
4891c609719bSwdenk		  setenv initrd_high 00c00000
4892c609719bSwdenk
489338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
489438b99261Swdenk		  indication to U-Boot that all addresses are legal
489538b99261Swdenk		  for the Linux kernel, including addresses in flash
489638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
489738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
489838b99261Swdenk		  boot time on your system, but requires that this
489938b99261Swdenk		  feature is supported by your Linux kernel.
490038b99261Swdenk
4901c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4902c609719bSwdenk
4903c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4904dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4905c609719bSwdenk
4906c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4907c609719bSwdenk
4908c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4909c609719bSwdenk
4910c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4911c609719bSwdenk
4912c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4913c609719bSwdenk
4914c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4915c609719bSwdenk
4916e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4917a3d991bdSwdenk
4918e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4919e2a53458SMike Frysinger		  For example you can do the following
4920a3d991bdSwdenk
492148690d80SHeiko Schocher		  => setenv ethact FEC
492248690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
492348690d80SHeiko Schocher		  => setenv ethact SCC
492448690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4925a3d991bdSwdenk
4926e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4927e1692577SMatthias Fuchs		  available network interfaces.
4928e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4929e1692577SMatthias Fuchs
4930a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4931a3d991bdSwdenk		  either succeed or fail without retrying.
49326e592385Swdenk		  When set to "once" the network operation will
49336e592385Swdenk		  fail when all the available network interfaces
49346e592385Swdenk		  are tried once without success.
4935a3d991bdSwdenk		  Useful on scripts which control the retry operation
4936a3d991bdSwdenk		  themselves.
4937a3d991bdSwdenk
4938b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4939a1cf027aSJean-Christophe PLAGNIOL-VILLARD
49408d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
49418d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
49428d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
49438d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
49448d51aacdSSimon Glass		  is silent.
49458d51aacdSSimon Glass
494628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4947ecb0ccd9SWolfgang Denk		  UDP source port.
4948ecb0ccd9SWolfgang Denk
494928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
495028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
495128cb9375SWolfgang Denk
4952c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4953c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4954c96f86eeSWolfgang Denk
4955c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4956c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4957c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4958c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4959c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4960c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4961c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4962c96f86eeSWolfgang Denk
4963a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
496411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4965a3d991bdSwdenk		  VLAN tagged frames.
4966c609719bSwdenk
4967dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4968dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4969dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4970dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4971dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4972dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4973dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4974dc0b7b0eSJason Hobbs
4975dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4976dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4977dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4978dc0b7b0eSJason Hobbs
4979dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4980dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4981dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4982dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4983dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4984dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4985dc0b7b0eSJason Hobbs
4986c609719bSwdenkThe following environment variables may be used and automatically
4987c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4988c609719bSwdenkdepending the information provided by your boot server:
4989c609719bSwdenk
4990c609719bSwdenk  bootfile	- see above
4991c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4992fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4993c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4994c609719bSwdenk  hostname	- Target hostname
4995c609719bSwdenk  ipaddr	- see above
4996c609719bSwdenk  netmask	- Subnet Mask
4997c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4998c609719bSwdenk  serverip	- see above
4999c609719bSwdenk
5000c609719bSwdenk
5001c609719bSwdenkThere are two special Environment Variables:
5002c609719bSwdenk
5003c609719bSwdenk  serial#	- contains hardware identification information such
5004c609719bSwdenk		  as type string and/or serial number
5005c609719bSwdenk  ethaddr	- Ethernet address
5006c609719bSwdenk
5007c609719bSwdenkThese variables can be set only once (usually during manufacturing of
5008c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
5009c609719bSwdenkonce they have been set once.
5010c609719bSwdenk
5011c609719bSwdenk
5012c1551ea8SstroeseFurther special Environment Variables:
5013c1551ea8Sstroese
5014c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
5015c1551ea8Sstroese		  with the "version" command. This variable is
5016c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
5017c1551ea8Sstroese
5018c1551ea8Sstroese
5019c609719bSwdenkPlease note that changes to some configuration parameters may take
5020c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
5021c609719bSwdenk
5022c609719bSwdenk
5023170ab110SJoe HershbergerCallback functions for environment variables:
5024170ab110SJoe Hershberger---------------------------------------------
5025170ab110SJoe Hershberger
5026170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
5027170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
5028170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
5029170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
5030170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
5031170ab110SJoe Hershberger
5032170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
5033170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
5034170ab110SJoe Hershberger
5035170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
5036170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5037170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
5038170ab110SJoe Hershbergerassociations.  The list must be in the following format:
5039170ab110SJoe Hershberger
5040170ab110SJoe Hershberger	entry = variable_name[:callback_name]
5041170ab110SJoe Hershberger	list = entry[,list]
5042170ab110SJoe Hershberger
5043170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5044170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5045170ab110SJoe Hershberger
5046170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5047170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5048170ab110SJoe Hershbergeroverride any association in the static list. You can define
5049170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5050170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5051170ab110SJoe Hershberger
5052170ab110SJoe Hershberger
5053f07771ccSwdenkCommand Line Parsing:
5054f07771ccSwdenk=====================
5055f07771ccSwdenk
5056f07771ccSwdenkThere are two different command line parsers available with U-Boot:
50577152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5058f07771ccSwdenk
5059f07771ccSwdenkOld, simple command line parser:
5060f07771ccSwdenk--------------------------------
5061f07771ccSwdenk
5062f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5063f07771ccSwdenk- several commands on one line, separated by ';'
5064fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5065f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5066f07771ccSwdenk  for example:
5067fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5068f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5069f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5070f07771ccSwdenk
5071f07771ccSwdenkHush shell:
5072f07771ccSwdenk-----------
5073f07771ccSwdenk
5074f07771ccSwdenk- similar to Bourne shell, with control structures like
5075f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5076f07771ccSwdenk  until...do...done, ...
5077f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5078f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5079f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5080f07771ccSwdenk  command
5081f07771ccSwdenk
5082f07771ccSwdenkGeneral rules:
5083f07771ccSwdenk--------------
5084f07771ccSwdenk
5085f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5086f07771ccSwdenk    command) contains several commands separated by semicolon, and
5087f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5088f07771ccSwdenk    executed anyway.
5089f07771ccSwdenk
5090f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
509111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5092f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5093f07771ccSwdenk    variables are not executed.
5094f07771ccSwdenk
5095c609719bSwdenkNote for Redundant Ethernet Interfaces:
5096c609719bSwdenk=======================================
5097c609719bSwdenk
509811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5099c609719bSwdenksuch configurations and is capable of automatic selection of a
51007152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5101c609719bSwdenk
5102c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5103c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5104c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5105c609719bSwdenk
5106c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5107c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5108c609719bSwdenkding setting in the environment; if the corresponding environment
5109c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5110c609719bSwdenk
5111c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5112c609719bSwdenk  environment, the SROM's address is used.
5113c609719bSwdenk
5114c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5115c609719bSwdenk  environment exists, then the value from the environment variable is
5116c609719bSwdenk  used.
5117c609719bSwdenk
5118c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5119c609719bSwdenk  both addresses are the same, this MAC address is used.
5120c609719bSwdenk
5121c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5122c609719bSwdenk  addresses differ, the value from the environment is used and a
5123c609719bSwdenk  warning is printed.
5124c609719bSwdenk
5125c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5126c609719bSwdenk  is raised.
5127c609719bSwdenk
5128ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5129ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5130ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5131ecee9324SBen WarrenThe naming convention is as follows:
5132ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5133c609719bSwdenk
5134c609719bSwdenkImage Formats:
5135c609719bSwdenk==============
5136c609719bSwdenk
51373310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
51383310c549SMarian Balakowiczimages in two formats:
51393310c549SMarian Balakowicz
51403310c549SMarian BalakowiczNew uImage format (FIT)
51413310c549SMarian Balakowicz-----------------------
51423310c549SMarian Balakowicz
51433310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
51443310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
51453310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
51463310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
51473310c549SMarian Balakowicz
51483310c549SMarian Balakowicz
51493310c549SMarian BalakowiczOld uImage format
51503310c549SMarian Balakowicz-----------------
51513310c549SMarian Balakowicz
51523310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51533310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51543310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5155c609719bSwdenk
5156c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5157c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5158f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5159f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5160f5ed9e39SPeter Tyser  INTEGRITY).
51617b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5162afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5163afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5164c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5165c609719bSwdenk* Load Address
5166c609719bSwdenk* Entry Point
5167c609719bSwdenk* Image Name
5168c609719bSwdenk* Image Timestamp
5169c609719bSwdenk
5170c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5171c609719bSwdenkand the data portions of the image are secured against corruption by
5172c609719bSwdenkCRC32 checksums.
5173c609719bSwdenk
5174c609719bSwdenk
5175c609719bSwdenkLinux Support:
5176c609719bSwdenk==============
5177c609719bSwdenk
5178c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51797152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5180c609719bSwdenkU-Boot.
5181c609719bSwdenk
5182c609719bSwdenkU-Boot includes many features that so far have been part of some
5183c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5184c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5185c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
51867152b1d0Swdenkserves several purposes:
5187c609719bSwdenk
5188c609719bSwdenk- the same features can be used for other OS or standalone
5189c609719bSwdenk  applications (for instance: using compressed images to reduce the
5190c609719bSwdenk  Flash memory footprint)
5191c609719bSwdenk
5192c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
51937152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5194c609719bSwdenk
5195c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5196c609719bSwdenk  images; of course this also means that different kernel images can
5197c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5198c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5199c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5200c609719bSwdenk  software is easier now.
5201c609719bSwdenk
5202c609719bSwdenk
5203c609719bSwdenkLinux HOWTO:
5204c609719bSwdenk============
5205c609719bSwdenk
5206c609719bSwdenkPorting Linux to U-Boot based systems:
5207c609719bSwdenk---------------------------------------
5208c609719bSwdenk
5209c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5210c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5211c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5212c609719bSwdenkLinux :-).
5213c609719bSwdenk
5214a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5215c609719bSwdenk
5216c609719bSwdenkJust make sure your machine specific header file (for instance
5217c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
52181dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
52191dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
52206d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5221c609719bSwdenk
5222c609719bSwdenk
5223c609719bSwdenkConfiguring the Linux kernel:
5224c609719bSwdenk-----------------------------
5225c609719bSwdenk
5226c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5227c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5228c609719bSwdenk
5229c609719bSwdenk
5230c609719bSwdenkBuilding a Linux Image:
5231c609719bSwdenk-----------------------
5232c609719bSwdenk
523324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
523424ee89b9Swdenknot used. If you use recent kernel source, a new build target
523524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
523624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
523724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
523824ee89b9Swdenk100% compatible format.
5239c609719bSwdenk
5240c609719bSwdenkExample:
5241c609719bSwdenk
5242c609719bSwdenk	make TQM850L_config
5243c609719bSwdenk	make oldconfig
5244c609719bSwdenk	make dep
524524ee89b9Swdenk	make uImage
5246c609719bSwdenk
524724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
524824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
524924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5250c609719bSwdenk
525124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
525224ee89b9Swdenk
525324ee89b9Swdenk* convert the kernel into a raw binary image:
525424ee89b9Swdenk
525524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
525624ee89b9Swdenk				 -R .note -R .comment \
525724ee89b9Swdenk				 -S vmlinux linux.bin
525824ee89b9Swdenk
525924ee89b9Swdenk* compress the binary image:
526024ee89b9Swdenk
526124ee89b9Swdenk	gzip -9 linux.bin
526224ee89b9Swdenk
526324ee89b9Swdenk* package compressed binary image for U-Boot:
526424ee89b9Swdenk
526524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
526624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
526724ee89b9Swdenk		-d linux.bin.gz uImage
526824ee89b9Swdenk
526924ee89b9Swdenk
527024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
527124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
527224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
527324ee89b9Swdenkbyte header containing information about target architecture,
527424ee89b9Swdenkoperating system, image type, compression method, entry points, time
527524ee89b9Swdenkstamp, CRC32 checksums, etc.
527624ee89b9Swdenk
527724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
527824ee89b9Swdenkprint the header information, or to build new images.
5279c609719bSwdenk
5280c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5281c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5282c609719bSwdenkchecksum verification:
5283c609719bSwdenk
5284c609719bSwdenk	tools/mkimage -l image
5285c609719bSwdenk	  -l ==> list image header information
5286c609719bSwdenk
5287c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5288c609719bSwdenkfrom a "data file" which is used as image payload:
5289c609719bSwdenk
5290c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5291c609719bSwdenk		      -n name -d data_file image
5292c609719bSwdenk	  -A ==> set architecture to 'arch'
5293c609719bSwdenk	  -O ==> set operating system to 'os'
5294c609719bSwdenk	  -T ==> set image type to 'type'
5295c609719bSwdenk	  -C ==> set compression type 'comp'
5296c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5297c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5298c609719bSwdenk	  -n ==> set image name to 'name'
5299c609719bSwdenk	  -d ==> use image data from 'datafile'
5300c609719bSwdenk
530169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
530269459791Swdenkaddress (0x00000000), but the entry point address depends on the
530369459791Swdenkkernel version:
5304c609719bSwdenk
5305c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
530624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5307c609719bSwdenk
5308c609719bSwdenkSo a typical call to build a U-Boot image would read:
5309c609719bSwdenk
531024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
531124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5312a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
531324ee89b9Swdenk	> examples/uImage.TQM850L
531424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5315c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5316c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5317c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5318c609719bSwdenk	Load Address: 0x00000000
531924ee89b9Swdenk	Entry Point:  0x00000000
5320c609719bSwdenk
5321c609719bSwdenkTo verify the contents of the image (or check for corruption):
5322c609719bSwdenk
532324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
532424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5325c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5326c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5327c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5328c609719bSwdenk	Load Address: 0x00000000
532924ee89b9Swdenk	Entry Point:  0x00000000
5330c609719bSwdenk
5331c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5332c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5333c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5334c609719bSwdenkneed to be uncompressed:
5335c609719bSwdenk
5336a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
533724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
533824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5339a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
534024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
534124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5342c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5343c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5344c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5345c609719bSwdenk	Load Address: 0x00000000
534624ee89b9Swdenk	Entry Point:  0x00000000
5347c609719bSwdenk
5348c609719bSwdenk
5349c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5350c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5351c609719bSwdenk
5352c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5353c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5354c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5355c609719bSwdenk	Image Name:   Simple Ramdisk Image
5356c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5357c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5358c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5359c609719bSwdenk	Load Address: 0x00000000
5360c609719bSwdenk	Entry Point:  0x00000000
5361c609719bSwdenk
5362a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5363a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5364a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5365a804b5ceSGuilherme Maciel Ferreirafrom the image:
5366a804b5ceSGuilherme Maciel Ferreira
5367a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5368a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5369a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5370a804b5ceSGuilherme Maciel Ferreira
5371c609719bSwdenk
5372c609719bSwdenkInstalling a Linux Image:
5373c609719bSwdenk-------------------------
5374c609719bSwdenk
5375c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5376c609719bSwdenkyou must convert the image to S-Record format:
5377c609719bSwdenk
5378c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5379c609719bSwdenk
5380c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5381c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5382c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5383c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5384c609719bSwdenkcommand.
5385c609719bSwdenk
5386c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5387c609719bSwdenkTQM8xxL is in the first Flash bank):
5388c609719bSwdenk
5389c609719bSwdenk	=> erase 40100000 401FFFFF
5390c609719bSwdenk
5391c609719bSwdenk	.......... done
5392c609719bSwdenk	Erased 8 sectors
5393c609719bSwdenk
5394c609719bSwdenk	=> loads 40100000
5395c609719bSwdenk	## Ready for S-Record download ...
5396c609719bSwdenk	~>examples/image.srec
5397c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5398c609719bSwdenk	...
5399c609719bSwdenk	15989 15990 15991 15992
5400c609719bSwdenk	[file transfer complete]
5401c609719bSwdenk	[connected]
5402c609719bSwdenk	## Start Addr = 0x00000000
5403c609719bSwdenk
5404c609719bSwdenk
5405c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5406c609719bSwdenkthis includes a checksum verification so you can be sure no data
5407c609719bSwdenkcorruption happened:
5408c609719bSwdenk
5409c609719bSwdenk	=> imi 40100000
5410c609719bSwdenk
5411c609719bSwdenk	## Checking Image at 40100000 ...
5412c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5413c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5414c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5415c609719bSwdenk	   Load Address: 00000000
5416c609719bSwdenk	   Entry Point:	 0000000c
5417c609719bSwdenk	   Verifying Checksum ... OK
5418c609719bSwdenk
5419c609719bSwdenk
5420c609719bSwdenkBoot Linux:
5421c609719bSwdenk-----------
5422c609719bSwdenk
5423c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5424c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5425c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5426c609719bSwdenkparameters. You can check and modify this variable using the
5427c609719bSwdenk"printenv" and "setenv" commands:
5428c609719bSwdenk
5429c609719bSwdenk
5430c609719bSwdenk	=> printenv bootargs
5431c609719bSwdenk	bootargs=root=/dev/ram
5432c609719bSwdenk
5433c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5434c609719bSwdenk
5435c609719bSwdenk	=> printenv bootargs
5436c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5437c609719bSwdenk
5438c609719bSwdenk	=> bootm 40020000
5439c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5440c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5441c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5442c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5443c609719bSwdenk	   Load Address: 00000000
5444c609719bSwdenk	   Entry Point:	 0000000c
5445c609719bSwdenk	   Verifying Checksum ... OK
5446c609719bSwdenk	   Uncompressing Kernel Image ... OK
5447c609719bSwdenk	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
5448c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5449c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5450c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5451c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5452c609719bSwdenk	...
5453c609719bSwdenk
545411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54557152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5456c609719bSwdenkformat!) to the "bootm" command:
5457c609719bSwdenk
5458c609719bSwdenk	=> imi 40100000 40200000
5459c609719bSwdenk
5460c609719bSwdenk	## Checking Image at 40100000 ...
5461c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5462c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5463c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5464c609719bSwdenk	   Load Address: 00000000
5465c609719bSwdenk	   Entry Point:	 0000000c
5466c609719bSwdenk	   Verifying Checksum ... OK
5467c609719bSwdenk
5468c609719bSwdenk	## Checking Image at 40200000 ...
5469c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5470c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5471c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5472c609719bSwdenk	   Load Address: 00000000
5473c609719bSwdenk	   Entry Point:	 00000000
5474c609719bSwdenk	   Verifying Checksum ... OK
5475c609719bSwdenk
5476c609719bSwdenk	=> bootm 40100000 40200000
5477c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5478c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5479c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5480c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5481c609719bSwdenk	   Load Address: 00000000
5482c609719bSwdenk	   Entry Point:	 0000000c
5483c609719bSwdenk	   Verifying Checksum ... OK
5484c609719bSwdenk	   Uncompressing Kernel Image ... OK
5485c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5486c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5487c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5488c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5489c609719bSwdenk	   Load Address: 00000000
5490c609719bSwdenk	   Entry Point:	 00000000
5491c609719bSwdenk	   Verifying Checksum ... OK
5492c609719bSwdenk	   Loading Ramdisk ... OK
5493c609719bSwdenk	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
5494c609719bSwdenk	Boot arguments: root=/dev/ram
5495c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5496c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5497c609719bSwdenk	...
5498c609719bSwdenk	RAMDISK: Compressed image found at block 0
5499c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5500c609719bSwdenk
5501c609719bSwdenk	bash#
5502c609719bSwdenk
55030267768eSMatthew McClintockBoot Linux and pass a flat device tree:
55040267768eSMatthew McClintock-----------
55050267768eSMatthew McClintock
55060267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
55070267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
55080267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
55090267768eSMatthew McClintockflat device tree:
55100267768eSMatthew McClintock
55110267768eSMatthew McClintock=> print oftaddr
55120267768eSMatthew McClintockoftaddr=0x300000
55130267768eSMatthew McClintock=> print oft
55140267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
55150267768eSMatthew McClintock=> tftp $oftaddr $oft
55160267768eSMatthew McClintockSpeed: 1000, full duplex
55170267768eSMatthew McClintockUsing TSEC0 device
55180267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
55190267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
55200267768eSMatthew McClintockLoad address: 0x300000
55210267768eSMatthew McClintockLoading: #
55220267768eSMatthew McClintockdone
55230267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
55240267768eSMatthew McClintock=> tftp $loadaddr $bootfile
55250267768eSMatthew McClintockSpeed: 1000, full duplex
55260267768eSMatthew McClintockUsing TSEC0 device
55270267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
55280267768eSMatthew McClintockFilename 'uImage'.
55290267768eSMatthew McClintockLoad address: 0x200000
55300267768eSMatthew McClintockLoading:############
55310267768eSMatthew McClintockdone
55320267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
55330267768eSMatthew McClintock=> print loadaddr
55340267768eSMatthew McClintockloadaddr=200000
55350267768eSMatthew McClintock=> print oftaddr
55360267768eSMatthew McClintockoftaddr=0x300000
55370267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
55380267768eSMatthew McClintock## Booting image at 00200000 ...
55390267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
55400267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
55410267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
55420267768eSMatthew McClintock   Load Address: 00000000
55430267768eSMatthew McClintock   Entry Point:	 00000000
55440267768eSMatthew McClintock   Verifying Checksum ... OK
55450267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
55460267768eSMatthew McClintockBooting using flat device tree at 0x300000
55470267768eSMatthew McClintockUsing MPC85xx ADS machine description
55480267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
55490267768eSMatthew McClintock[snip]
55500267768eSMatthew McClintock
55510267768eSMatthew McClintock
55526069ff26SwdenkMore About U-Boot Image Types:
55536069ff26Swdenk------------------------------
55546069ff26Swdenk
55556069ff26SwdenkU-Boot supports the following image types:
55566069ff26Swdenk
55576069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
55586069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
55596069ff26Swdenk	well) you can continue to work in U-Boot after return from
55606069ff26Swdenk	the Standalone Program.
55616069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
55626069ff26Swdenk	will take over control completely. Usually these programs
55636069ff26Swdenk	will install their own set of exception handlers, device
55646069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
55656069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
55666069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
55676069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
55686069ff26Swdenk	being started.
55696069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
55706069ff26Swdenk	(Linux) kernel image and one or more data images like
55716069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
55726069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
55736069ff26Swdenk	server provides just a single image file, but you want to get
55746069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
55756069ff26Swdenk
55766069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
55776069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55786069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55796069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55806069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
55816069ff26Swdenk	a multiple of 4 bytes).
55826069ff26Swdenk
55836069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
55846069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
55856069ff26Swdenk	flash memory.
55866069ff26Swdenk
55876069ff26Swdenk   "Script files" are command sequences that will be executed by
55886069ff26Swdenk	U-Boot's command interpreter; this feature is especially
55896069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
55906069ff26Swdenk	as command interpreter.
55916069ff26Swdenk
559244f074c7SMarek VasutBooting the Linux zImage:
559344f074c7SMarek Vasut-------------------------
559444f074c7SMarek Vasut
559544f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
559644f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
559744f074c7SMarek Vasutas the syntax of "bootm" command.
559844f074c7SMarek Vasut
55998ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5600017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5601017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5602017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5603017e1f3fSMarek Vasut
5604c609719bSwdenk
5605c609719bSwdenkStandalone HOWTO:
5606c609719bSwdenk=================
5607c609719bSwdenk
5608c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5609c609719bSwdenkrun "standalone" applications, which can use some resources of
5610c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5611c609719bSwdenk
5612c609719bSwdenkTwo simple examples are included with the sources:
5613c609719bSwdenk
5614c609719bSwdenk"Hello World" Demo:
5615c609719bSwdenk-------------------
5616c609719bSwdenk
5617c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5618c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5619c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5620c609719bSwdenklike that:
5621c609719bSwdenk
5622c609719bSwdenk	=> loads
5623c609719bSwdenk	## Ready for S-Record download ...
5624c609719bSwdenk	~>examples/hello_world.srec
5625c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5626c609719bSwdenk	[file transfer complete]
5627c609719bSwdenk	[connected]
5628c609719bSwdenk	## Start Addr = 0x00040004
5629c609719bSwdenk
5630c609719bSwdenk	=> go 40004 Hello World! This is a test.
5631c609719bSwdenk	## Starting application at 0x00040004 ...
5632c609719bSwdenk	Hello World
5633c609719bSwdenk	argc = 7
5634c609719bSwdenk	argv[0] = "40004"
5635c609719bSwdenk	argv[1] = "Hello"
5636c609719bSwdenk	argv[2] = "World!"
5637c609719bSwdenk	argv[3] = "This"
5638c609719bSwdenk	argv[4] = "is"
5639c609719bSwdenk	argv[5] = "a"
5640c609719bSwdenk	argv[6] = "test."
5641c609719bSwdenk	argv[7] = "<NULL>"
5642c609719bSwdenk	Hit any key to exit ...
5643c609719bSwdenk
5644c609719bSwdenk	## Application terminated, rc = 0x0
5645c609719bSwdenk
5646c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5647c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5648c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5649c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5650c609719bSwdenkcharacter, but this is just a demo program. The application can be
5651c609719bSwdenkcontrolled by the following keys:
5652c609719bSwdenk
5653c609719bSwdenk	? - print current values og the CPM Timer registers
5654c609719bSwdenk	b - enable interrupts and start timer
5655c609719bSwdenk	e - stop timer and disable interrupts
5656c609719bSwdenk	q - quit application
5657c609719bSwdenk
5658c609719bSwdenk	=> loads
5659c609719bSwdenk	## Ready for S-Record download ...
5660c609719bSwdenk	~>examples/timer.srec
5661c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5662c609719bSwdenk	[file transfer complete]
5663c609719bSwdenk	[connected]
5664c609719bSwdenk	## Start Addr = 0x00040004
5665c609719bSwdenk
5666c609719bSwdenk	=> go 40004
5667c609719bSwdenk	## Starting application at 0x00040004 ...
5668c609719bSwdenk	TIMERS=0xfff00980
5669c609719bSwdenk	Using timer 1
5670c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5671c609719bSwdenk
5672c609719bSwdenkHit 'b':
5673c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5674c609719bSwdenk	Enabling timer
5675c609719bSwdenkHit '?':
5676c609719bSwdenk	[q, b, e, ?] ........
5677c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5678c609719bSwdenkHit '?':
5679c609719bSwdenk	[q, b, e, ?] .
5680c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5681c609719bSwdenkHit '?':
5682c609719bSwdenk	[q, b, e, ?] .
5683c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5684c609719bSwdenkHit '?':
5685c609719bSwdenk	[q, b, e, ?] .
5686c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5687c609719bSwdenkHit 'e':
5688c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5689c609719bSwdenkHit 'q':
5690c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5691c609719bSwdenk
5692c609719bSwdenk
569385ec0bccSwdenkMinicom warning:
569485ec0bccSwdenk================
569585ec0bccSwdenk
56967152b1d0SwdenkOver time, many people have reported problems when trying to use the
569785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
569885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5699f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
570085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5701e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5702e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5703e53515a2SKarl O. Pincfor help with kermit.
5704e53515a2SKarl O. Pinc
570585ec0bccSwdenk
570652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
570752f52c14Swdenkconfiguration to your "File transfer protocols" section:
570852f52c14Swdenk
570952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
571052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
571152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
571252f52c14Swdenk
571352f52c14Swdenk
5714c609719bSwdenkNetBSD Notes:
5715c609719bSwdenk=============
5716c609719bSwdenk
5717c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5718c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5719c609719bSwdenk
5720c609719bSwdenkBuilding requires a cross environment; it is known to work on
5721c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5722c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5723c609719bSwdenkNote that the cross-powerpc package does not install include files;
5724c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5725c609719bSwdenkmissing.  This file has to be installed and patched manually:
5726c609719bSwdenk
5727c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5728c609719bSwdenk	# mkdir powerpc
5729c609719bSwdenk	# ln -s powerpc machine
5730c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5731c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5732c609719bSwdenk
5733c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5734c609719bSwdenkand U-Boot include files.
5735c609719bSwdenk
5736c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5737c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5738c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5739c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
57402a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5741c609719bSwdenk
5742c609719bSwdenk
5743c609719bSwdenkImplementation Internals:
5744c609719bSwdenk=========================
5745c609719bSwdenk
5746c609719bSwdenkThe following is not intended to be a complete description of every
5747c609719bSwdenkimplementation detail. However, it should help to understand the
5748c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5749c609719bSwdenkhardware.
5750c609719bSwdenk
5751c609719bSwdenk
5752c609719bSwdenkInitial Stack, Global Data:
5753c609719bSwdenk---------------------------
5754c609719bSwdenk
5755c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5756c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5757c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5758c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5759c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5760c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5761c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5762c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5763c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5764c609719bSwdenklocked as (mis-) used as memory, etc.
5765c609719bSwdenk
57667152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
57670668236bSWolfgang Denk	U-Boot mailing list:
576843d9616cSwdenk
576943d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
577043d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
577143d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
577243d9616cSwdenk	...
577343d9616cSwdenk
577443d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
577543d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
577643d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
577743d9616cSwdenk	is that the cache is being used as a temporary supply of
577843d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
577911ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
578043d9616cSwdenk	can see how this works by studying the cache architecture and
578143d9616cSwdenk	operation in the architecture and processor-specific manuals.
578243d9616cSwdenk
578343d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
578443d9616cSwdenk	is another option for the system designer to use as an
578511ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
578643d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
578743d9616cSwdenk	board designers haven't used it for something that would
578843d9616cSwdenk	cause you grief during the initial boot! It is frequently not
578943d9616cSwdenk	used.
579043d9616cSwdenk
57916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
579243d9616cSwdenk	with your processor/board/system design. The default value
579343d9616cSwdenk	you will find in any recent u-boot distribution in
57948a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
579543d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
579643d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
579743d9616cSwdenk	that are supposed to respond to that address! That code in
579843d9616cSwdenk	start.S has been around a while and should work as is when
579943d9616cSwdenk	you get the config right.
580043d9616cSwdenk
580143d9616cSwdenk	-Chris Hallinan
580243d9616cSwdenk	DS4.COM, Inc.
580343d9616cSwdenk
5804c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5805c609719bSwdenkcode for the initialization procedures:
5806c609719bSwdenk
5807c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5808c609719bSwdenk  to write it.
5809c609719bSwdenk
581011ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5811c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
58127152b1d0Swdenk  zation is performed later (when relocating to RAM).
5813c609719bSwdenk
5814c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5815c609719bSwdenk  that.
5816c609719bSwdenk
5817c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5818c609719bSwdenknormal global data to share information beween the code. But it
5819c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5820c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5821c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5822c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5823c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5824c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5825c609719bSwdenkreserve for this purpose.
5826c609719bSwdenk
58277152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5828c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5829c609719bSwdenkGCC's implementation.
5830c609719bSwdenk
5831c609719bSwdenkFor PowerPC, the following registers have specific use:
5832c609719bSwdenk	R1:	stack pointer
5833e7670f6cSWolfgang Denk	R2:	reserved for system use
5834c609719bSwdenk	R3-R4:	parameter passing and return values
5835c609719bSwdenk	R5-R10: parameter passing
5836c609719bSwdenk	R13:	small data area pointer
5837c609719bSwdenk	R30:	GOT pointer
5838c609719bSwdenk	R31:	frame pointer
5839c609719bSwdenk
5840e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5841e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5842e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5843c609719bSwdenk
5844e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5845c609719bSwdenk
5846c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5847c609719bSwdenk    address of the global data structure is known at compile time),
5848c609719bSwdenk    but it turned out that reserving a register results in somewhat
5849c609719bSwdenk    smaller code - although the code savings are not that big (on
5850c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5851c609719bSwdenk    624 text + 127 data).
5852c609719bSwdenk
5853c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58544c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58554c58eb55SMike Frysinger
5856c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
58574c58eb55SMike Frysinger
5858c609719bSwdenkOn ARM, the following registers are used:
5859c609719bSwdenk
5860c609719bSwdenk	R0:	function argument word/integer result
5861c609719bSwdenk	R1-R3:	function argument word
586212eba1b4SJeroen Hofstee	R9:	platform specific
586312eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5864c609719bSwdenk	R11:	argument (frame) pointer
5865c609719bSwdenk	R12:	temporary workspace
5866c609719bSwdenk	R13:	stack pointer
5867c609719bSwdenk	R14:	link register
5868c609719bSwdenk	R15:	program counter
5869c609719bSwdenk
587012eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
587112eba1b4SJeroen Hofstee
587212eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5873c609719bSwdenk
58740df01fd3SThomas ChouOn Nios II, the ABI is documented here:
58750df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
58760df01fd3SThomas Chou
58770df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58780df01fd3SThomas Chou
58790df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58800df01fd3SThomas Chou    to access small data sections, so gp is free.
58810df01fd3SThomas Chou
5882afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5883afc1ce82SMacpaul Lin
5884afc1ce82SMacpaul Lin	R0-R1:	argument/return
5885afc1ce82SMacpaul Lin	R2-R5:	argument
5886afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5887afc1ce82SMacpaul Lin	R16:	trampoline register
5888afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5889afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5890afc1ce82SMacpaul Lin	R30:	link register (LP)
5891afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5892afc1ce82SMacpaul Lin	PC:	program counter (PC)
5893afc1ce82SMacpaul Lin
5894afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5895afc1ce82SMacpaul Lin
5896d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5897d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5898c609719bSwdenk
5899c609719bSwdenkMemory Management:
5900c609719bSwdenk------------------
5901c609719bSwdenk
5902c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5903c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5904c609719bSwdenk
5905c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5906c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5907c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5908c609719bSwdenkphysical memory banks.
5909c609719bSwdenk
5910c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5911c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5912c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5913c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
59146d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5915c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5916c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5917c609719bSwdenk
5918c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5919c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5920c609719bSwdenk
5921c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5922c609719bSwdenkthis:
5923c609719bSwdenk
5924c609719bSwdenk	0x0000 0000	Exception Vector code
5925c609719bSwdenk	      :
5926c609719bSwdenk	0x0000 1FFF
5927c609719bSwdenk	0x0000 2000	Free for Application Use
5928c609719bSwdenk	      :
5929c609719bSwdenk	      :
5930c609719bSwdenk
5931c609719bSwdenk	      :
5932c609719bSwdenk	      :
5933c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5934c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5935c609719bSwdenk	0x00FC 0000	Malloc Arena
5936c609719bSwdenk	      :
5937c609719bSwdenk	0x00FD FFFF
5938c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5939c609719bSwdenk	...		eventually: LCD or video framebuffer
5940c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5941c609719bSwdenk	0x00FF FFFF	[End of RAM]
5942c609719bSwdenk
5943c609719bSwdenk
5944c609719bSwdenkSystem Initialization:
5945c609719bSwdenk----------------------
5946c609719bSwdenk
5947c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
594811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5949c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
59507152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5951c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5952c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5953c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5954c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5955c609719bSwdenkthe caches and the SIU.
5956c609719bSwdenk
5957c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5958c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5959c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5960c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5961c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5962c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5963c609719bSwdenkbanks.
5964c609719bSwdenk
5965c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
59667152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5967c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5968c609719bSwdenk0x00000000, with any additional banks following immediately to create
5969c609719bSwdenkcontiguous memory starting from 0.
5970c609719bSwdenk
5971c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5972c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5973c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5974c609719bSwdenkpages, and the final stack is set up.
5975c609719bSwdenk
5976c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5977c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5978c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5979c609719bSwdenknew address in RAM.
5980c609719bSwdenk
5981c609719bSwdenk
5982c609719bSwdenkU-Boot Porting Guide:
5983c609719bSwdenk----------------------
5984c609719bSwdenk
5985c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
59866aff3115Swdenklist, October 2002]
5987c609719bSwdenk
5988c609719bSwdenk
5989c609719bSwdenkint main(int argc, char *argv[])
5990c609719bSwdenk{
5991c609719bSwdenk	sighandler_t no_more_time;
5992c609719bSwdenk
5993c609719bSwdenk	signal(SIGALRM, no_more_time);
5994c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5995c609719bSwdenk
5996c609719bSwdenk	if (available_money > available_manpower) {
59976c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5998c609719bSwdenk		return 0;
5999c609719bSwdenk	}
6000c609719bSwdenk
6001c609719bSwdenk	Download latest U-Boot source;
6002c609719bSwdenk
60030668236bSWolfgang Denk	Subscribe to u-boot mailing list;
60046aff3115Swdenk
60056c3fef28SJerry Van Baren	if (clueless)
6006c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
6007c609719bSwdenk
6008c609719bSwdenk	while (learning) {
6009c609719bSwdenk		Read the README file in the top level directory;
60107cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
60116c3fef28SJerry Van Baren		Read applicable doc/*.README;
6012c609719bSwdenk		Read the source, Luke;
60136c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
6014c609719bSwdenk	}
6015c609719bSwdenk
60166c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
60176c3fef28SJerry Van Baren		Buy a BDI3000;
60186c3fef28SJerry Van Baren	else
6019c609719bSwdenk		Add a lot of aggravation and time;
6020c609719bSwdenk
60216c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
60226c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
60236c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
60246c3fef28SJerry Van Baren	} else {
6025c609719bSwdenk		Create your own board support subdirectory;
60266c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
60276c3fef28SJerry Van Baren	}
60286c3fef28SJerry Van Baren	Edit new board/<myboard> files
60296c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
6030c609719bSwdenk
60316c3fef28SJerry Van Baren	while (!accepted) {
6032c609719bSwdenk		while (!running) {
6033c609719bSwdenk			do {
6034c609719bSwdenk				Add / modify source code;
6035c609719bSwdenk			} until (compiles);
6036c609719bSwdenk			Debug;
6037c609719bSwdenk			if (clueless)
6038c609719bSwdenk				email("Hi, I am having problems...");
6039c609719bSwdenk		}
60406c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
60416c3fef28SJerry Van Baren		if (reasonable critiques)
60426c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
60436c3fef28SJerry Van Baren		else
60446c3fef28SJerry Van Baren			Defend code as written;
60456c3fef28SJerry Van Baren	}
6046c609719bSwdenk
6047c609719bSwdenk	return 0;
6048c609719bSwdenk}
6049c609719bSwdenk
6050c609719bSwdenkvoid no_more_time (int sig)
6051c609719bSwdenk{
6052c609719bSwdenk      hire_a_guru();
6053c609719bSwdenk}
6054c609719bSwdenk
6055c609719bSwdenk
6056c609719bSwdenkCoding Standards:
6057c609719bSwdenk-----------------
6058c609719bSwdenk
6059c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
60602c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
60617ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6062c609719bSwdenk
60632c051651SDetlev ZundelSource files originating from a different project (for example the
60642c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
60652c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
60662c051651SDetlev Zundelsources.
60672c051651SDetlev Zundel
60682c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
60692c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
60702c051651SDetlev Zundelin your code.
6071c609719bSwdenk
6072c178d3daSwdenkPlease also stick to the following formatting rules:
6073180d3f74Swdenk- remove any trailing white space
60747ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6075180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
60767ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6077180d3f74Swdenk- do not add trailing empty lines to source files
6078180d3f74Swdenk
6079c609719bSwdenkSubmissions which do not conform to the standards may be returned
6080c609719bSwdenkwith a request to reformat the changes.
6081c609719bSwdenk
6082c609719bSwdenk
6083c609719bSwdenkSubmitting Patches:
6084c609719bSwdenk-------------------
6085c609719bSwdenk
6086c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6087c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6088c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6089c609719bSwdenk
60900d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6091218ca724SWolfgang Denk
60920668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
60930668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
60940668236bSWolfgang Denk
6095c609719bSwdenkWhen you send a patch, please include the following information with
6096c609719bSwdenkit:
6097c609719bSwdenk
6098c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6099c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6100c609719bSwdenk  patch actually fixes something.
6101c609719bSwdenk
6102c609719bSwdenk* For new features: a description of the feature and your
6103c609719bSwdenk  implementation.
6104c609719bSwdenk
6105c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6106c609719bSwdenk
6107c609719bSwdenk* For major contributions, your entry to the CREDITS file
6108c609719bSwdenk
610927af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
611027af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6111c609719bSwdenk
6112c609719bSwdenk* If your patch adds new configuration options, don't forget to
6113c609719bSwdenk  document these in the README file.
6114c609719bSwdenk
6115218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6116218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
61177ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6118218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6119218ca724SWolfgang Denk  with some other mail clients.
6120c609719bSwdenk
6121218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6122218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6123218ca724SWolfgang Denk  GNU diff.
61246dff5529Swdenk
6125218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6126218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6127218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6128218ca724SWolfgang Denk  affected files).
6129218ca724SWolfgang Denk
6130218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6131218ca724SWolfgang Denk  and compressed attachments must not be used.
6132c609719bSwdenk
613352f52c14Swdenk* If one logical set of modifications affects or creates several
613452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
613552f52c14Swdenk
613652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
613752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
613852f52c14Swdenk
613952f52c14Swdenk
6140c609719bSwdenkNotes:
6141c609719bSwdenk
6142c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6143c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6144c609719bSwdenk  for any of the boards.
6145c609719bSwdenk
6146c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6147c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6148c609719bSwdenk  returned with a request to re-formatting / split it.
6149c609719bSwdenk
6150c609719bSwdenk* If you modify existing code, make sure that your new code does not
6151c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6152c609719bSwdenk  When adding new features, these should compile conditionally only
6153c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6154c609719bSwdenk  disabled must not need more memory than the old code without your
6155c609719bSwdenk  modification.
615690dc6704Swdenk
61570668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
61580668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
61590668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
61600668236bSWolfgang Denk  bigger than the size limit should be avoided.
6161