xref: /openbmc/u-boot/README (revision b401b73d)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
37c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
3827af930eSAlbert ARIBAUDwho contributed the specific port. The boards.cfg file lists board
39218ca724SWolfgang Denkmaintainers.
40c609719bSwdenk
41adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
42adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
43adb9d851SRobert P. J. Day
44adb9d851SRobert P. J. Day	make CHANGELOG
45adb9d851SRobert P. J. Day
46c609719bSwdenk
47c609719bSwdenkWhere to get help:
48c609719bSwdenk==================
49c609719bSwdenk
50c609719bSwdenkIn case you have questions about, problems with or contributions for
51c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
520c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
530c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
540c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
550c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
56c609719bSwdenk
57c609719bSwdenk
58218ca724SWolfgang DenkWhere to get source code:
59218ca724SWolfgang Denk=========================
60218ca724SWolfgang Denk
61218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
62218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
63218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64218ca724SWolfgang Denk
65218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6611ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
67218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68218ca724SWolfgang Denkdirectory.
69218ca724SWolfgang Denk
70d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
71218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
72218ca724SWolfgang Denk
73218ca724SWolfgang Denk
74c609719bSwdenkWhere we come from:
75c609719bSwdenk===================
76c609719bSwdenk
77c609719bSwdenk- start from 8xxrom sources
7824ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
79c609719bSwdenk- clean up code
80c609719bSwdenk- make it easier to add custom boards
81c609719bSwdenk- make it possible to add other [PowerPC] CPUs
82c609719bSwdenk- extend functions, especially:
83c609719bSwdenk  * Provide extended interface to Linux boot loader
84c609719bSwdenk  * S-Record download
85c609719bSwdenk  * network boot
8611ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8724ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
88c609719bSwdenk- add other CPU families (starting with ARM)
8924ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
900d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9124ee89b9Swdenk
9224ee89b9Swdenk
9324ee89b9SwdenkNames and Spelling:
9424ee89b9Swdenk===================
9524ee89b9Swdenk
9624ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9724ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9824ee89b9Swdenkin source files etc.). Example:
9924ee89b9Swdenk
10024ee89b9Swdenk	This is the README file for the U-Boot project.
10124ee89b9Swdenk
10224ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10324ee89b9Swdenk
10424ee89b9Swdenk	include/asm-ppc/u-boot.h
10524ee89b9Swdenk
10624ee89b9Swdenk	#include <asm/u-boot.h>
10724ee89b9Swdenk
10824ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10924ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11224ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
113c609719bSwdenk
114c609719bSwdenk
11593f19cc0SwdenkVersioning:
11693f19cc0Swdenk===========
11793f19cc0Swdenk
118360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
119360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
120360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
121360d883aSThomas Webernames consisting of the calendar year and month of the release date.
122360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
123360d883aSThomas Weberreleases in "stable" maintenance trees.
12493f19cc0Swdenk
125360d883aSThomas WeberExamples:
126360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
127360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
128360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
12993f19cc0Swdenk
13093f19cc0Swdenk
131c609719bSwdenkDirectory Hierarchy:
132c609719bSwdenk====================
133c609719bSwdenk
1348d321b81SPeter Tyser/arch			Architecture specific files
1358d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1368d321b81SPeter Tyser    /cpu		CPU specific files
1378d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1388d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1396eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1408d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1418d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1428d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1438d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1448d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1458d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1468d321b81SPeter Tyser    /lib		Architecture specific library files
1478d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1488d321b81SPeter Tyser    /cpu		CPU specific files
1498d321b81SPeter Tyser    /lib		Architecture specific library files
1508d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1518d321b81SPeter Tyser    /cpu		CPU specific files
1528d321b81SPeter Tyser    /lib		Architecture specific library files
1538d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1548d321b81SPeter Tyser    /cpu		CPU specific files
1558d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1568d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1578d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1588d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1598d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
16692bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
16780421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1688d321b81SPeter Tyser    /lib		Architecture specific library files
169afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
170afc1ce82SMacpaul Lin    /cpu		CPU specific files
171afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
172afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1738d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1748d321b81SPeter Tyser    /cpu		CPU specific files
1758d321b81SPeter Tyser    /lib		Architecture specific library files
17633c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
17733c7731bSRobert P. J. Day    /cpu		CPU specific files
17833c7731bSRobert P. J. Day    /lib		Architecture specific library files
179a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1808d321b81SPeter Tyser    /cpu		CPU specific files
1818d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1828d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1838d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1848d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1858d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1868d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1878d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1888d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1898d321b81SPeter Tyser    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /sh			Files generic to SH architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
1938d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
1948d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
1958d321b81SPeter Tyser    /lib		Architecture specific library files
1968d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
1978d321b81SPeter Tyser    /cpu		CPU specific files
1988d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
1998d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2008d321b81SPeter Tyser    /lib		Architecture specific library files
20133c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
20233c7731bSRobert P. J. Day    /cpu		CPU specific files
20333c7731bSRobert P. J. Day    /lib		Architecture specific library files
2048d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2058d321b81SPeter Tyser/board			Board dependent files
2068d321b81SPeter Tyser/common			Misc architecture independent functions
2078d321b81SPeter Tyser/disk			Code for disk drive partition handling
2088d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2098d321b81SPeter Tyser/drivers		Commonly used device drivers
21033c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
2118d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2128d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2138d321b81SPeter Tyser/include		Header Files
2148d321b81SPeter Tyser/lib			Files generic to all architectures
2158d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2168d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2178d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2188d321b81SPeter Tyser/net			Networking code
2198d321b81SPeter Tyser/post			Power On Self Test
22033c7731bSRobert P. J. Day/spl			Secondary Program Loader framework
2218d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
222c609719bSwdenk
223c609719bSwdenkSoftware Configuration:
224c609719bSwdenk=======================
225c609719bSwdenk
226c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
227c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
228c609719bSwdenk
229c609719bSwdenkThere are two classes of configuration variables:
230c609719bSwdenk
231c609719bSwdenk* Configuration _OPTIONS_:
232c609719bSwdenk  These are selectable by the user and have names beginning with
233c609719bSwdenk  "CONFIG_".
234c609719bSwdenk
235c609719bSwdenk* Configuration _SETTINGS_:
236c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
237c609719bSwdenk  you don't know what you're doing; they have names beginning with
2386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
239c609719bSwdenk
240c609719bSwdenkLater we will add a configuration tool - probably similar to or even
241c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
242c609719bSwdenkdo the configuration by hand, which means creating some symbolic
243c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
244c609719bSwdenkas an example here.
245c609719bSwdenk
246c609719bSwdenk
247c609719bSwdenkSelection of Processor Architecture and Board Type:
248c609719bSwdenk---------------------------------------------------
249c609719bSwdenk
250c609719bSwdenkFor all supported boards there are ready-to-use default
251c609719bSwdenkconfigurations available; just type "make <board_name>_config".
252c609719bSwdenk
253c609719bSwdenkExample: For a TQM823L module type:
254c609719bSwdenk
255c609719bSwdenk	cd u-boot
256c609719bSwdenk	make TQM823L_config
257c609719bSwdenk
25811ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
259c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
260c609719bSwdenkdirectory according to the instructions in cogent/README.
261c609719bSwdenk
262c609719bSwdenk
263c609719bSwdenkConfiguration Options:
264c609719bSwdenk----------------------
265c609719bSwdenk
266c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
267c609719bSwdenksuch information is kept in a configuration file
268c609719bSwdenk"include/configs/<board_name>.h".
269c609719bSwdenk
270c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
271c609719bSwdenk"include/configs/TQM823L.h".
272c609719bSwdenk
273c609719bSwdenk
2747f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2757f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2767f6c2cbcSwdenkbuild a config tool - later.
2777f6c2cbcSwdenk
2787f6c2cbcSwdenk
279c609719bSwdenkThe following options need to be configured:
280c609719bSwdenk
2812628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
282c609719bSwdenk
2832628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2846ccec449SWolfgang Denk
2856ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
28609ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
287c609719bSwdenk
288c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
289c609719bSwdenk		Define exactly one of
290c609719bSwdenk		CONFIG_CMA286_60_OLD
291c609719bSwdenk--- FIXME --- not tested yet:
292c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
293c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
294c609719bSwdenk
295c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
296c609719bSwdenk		Define exactly one of
297c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
298c609719bSwdenk
299c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define one or more of
301c609719bSwdenk		CONFIG_CMA302
302c609719bSwdenk
303c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
304c609719bSwdenk		Define one or more of
305c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
30611ccc33fSMarcel Ziswiler					  the LCD display every second with
307c609719bSwdenk					  a "rotator" |\-/|\-/
308c609719bSwdenk
3092535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3102535d602Swdenk		CONFIG_ADSTYPE
3112535d602Swdenk		Possible values are:
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3162535d602Swdenk
317cf946c6dSLei Wen- Marvell Family Member
318cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
319cf946c6dSLei Wen					  multiple fs option at one time
320cf946c6dSLei Wen					  for marvell soc family
321cf946c6dSLei Wen
322c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
323c609719bSwdenk		Define exactly one of
324c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
325c609719bSwdenk
32611ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
32766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
32866ca92a5Swdenk					  get_gclk_freq() cannot work
3295da627a4Swdenk					  e.g. if there is no 32KHz
3305da627a4Swdenk					  reference PIT/RTC clock
33166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33266ca92a5Swdenk					  or XTAL/EXTAL)
333c609719bSwdenk
33466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
33766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
33875d1ea7fSwdenk			See doc/README.MPC866
33975d1ea7fSwdenk
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34175d1ea7fSwdenk
34275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34375d1ea7fSwdenk		of relying on the correctness of the configured
34475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
34575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
34675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
34875d1ea7fSwdenk
349506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
350506f3918SHeiko Schocher
351506f3918SHeiko Schocher		Define this option if you want to enable the
352506f3918SHeiko Schocher		ICache only when Code runs from RAM.
353506f3918SHeiko Schocher
35466412c63SKumar Gala- 85xx CPU Options:
355ffd06e02SYork Sun		CONFIG_SYS_PPC64
356ffd06e02SYork Sun
357ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
358ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
359ffd06e02SYork Sun		compliance, among other possible reasons.
360ffd06e02SYork Sun
36166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36266412c63SKumar Gala
36366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36666412c63SKumar Gala
3678f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3688f29084aSKumar Gala
3698f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3708f29084aSKumar Gala		tree nodes for the given platform.
3718f29084aSKumar Gala
372afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
373afa6b551SPrabhakar Kushwaha
374afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
375afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
376afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
377afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
378afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
379afa6b551SPrabhakar Kushwaha		purpose.
380afa6b551SPrabhakar Kushwaha
38133eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
38233eee330SScott Wood
38333eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
38433eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
38533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
38633eee330SScott Wood
38733eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
38833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
38933eee330SScott Wood
39033eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
39133eee330SScott Wood		for which the A004510 workaround should be applied.
39233eee330SScott Wood
39333eee330SScott Wood		The rest of SVR is either not relevant to the decision
39433eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
39533eee330SScott Wood		p2041) or is implied by the build target, which controls
39633eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
39733eee330SScott Wood
39833eee330SScott Wood		See Freescale App Note 4493 for more information about
39933eee330SScott Wood		this erratum.
40033eee330SScott Wood
40174fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
40274fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
40374fa22edSPrabhakar Kushwaha		requred during NOR boot.
40474fa22edSPrabhakar Kushwaha
40533eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
40633eee330SScott Wood
40733eee330SScott Wood		This is the value to write into CCSR offset 0x18600
40833eee330SScott Wood		according to the A004510 workaround.
40933eee330SScott Wood
41064501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
41164501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
41264501c66SPriyanka Jain		connected exclusively to the DSP cores.
41364501c66SPriyanka Jain
414765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
416765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
417765b0bdbSPriyanka Jain
41864501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
41964501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
42064501c66SPriyanka Jain		connected to the DSP core.
42164501c66SPriyanka Jain
422765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
424765b0bdbSPriyanka Jain
425b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
427b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
428b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
429b135991aSPriyanka Jain
4306cb461b4SDaniel Schwierzeck- Generic CPU options:
4316cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4326cb461b4SDaniel Schwierzeck
4336cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4346cb461b4SDaniel Schwierzeck		values is arch specific.
4356cb461b4SDaniel Schwierzeck
4365614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4375614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4385614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4395614e71bSYork Sun		SoCs.
4405614e71bSYork Sun
4415614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4425614e71bSYork Sun		Freescale DDR memory-mapped register base.
4435614e71bSYork Sun
4445614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4455614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4465614e71bSYork Sun		deskew training are not available.
4475614e71bSYork Sun
4485614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4495614e71bSYork Sun		Freescale DDR1 controller.
4505614e71bSYork Sun
4515614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4525614e71bSYork Sun		Freescale DDR2 controller.
4535614e71bSYork Sun
4545614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4555614e71bSYork Sun		Freescale DDR3 controller.
4565614e71bSYork Sun
4579ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4589ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4599ac4ffbdSYork Sun
4605614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4615614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4625614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4635614e71bSYork Sun		implemetation.
4645614e71bSYork Sun
4655614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
4665614e71bSYork Sun		Board config to use DDR2. It can be eanbeld for SoCs with
4675614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4685614e71bSYork Sun		implementation.
4695614e71bSYork Sun
4705614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4715614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
4725614e71bSYork Sun		Freescale DDR3 controllers.
4735614e71bSYork Sun
4741b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4751b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4761b4175d6SPrabhakar Kushwaha
4771b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4781b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4791b4175d6SPrabhakar Kushwaha
480690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
481690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
482690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
483690e4258SPrabhakar Kushwaha
484690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
485690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
486690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
487690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
488690e4258SPrabhakar Kushwaha
4894e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
4904e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
4914e5b1bd0SYork Sun
4924e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
4934e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
4944e5b1bd0SYork Sun
4956b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
4966b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
4976b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
4986b9e309aSYork Sun		it could be different for ARM SoCs.
4996b9e309aSYork Sun
5006b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5016b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5026b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5036b1e1254SYork Sun		SoCs with ARM core.
5046b1e1254SYork Sun
5050b953ffcSMarkus Klotzbuecher- Intel Monahans options:
5066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
5070b953ffcSMarkus Klotzbuecher
5080b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
5090b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
5100b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
5110b953ffcSMarkus Klotzbuecher
5126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
5130b953ffcSMarkus Klotzbuecher
5140b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
5150b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
5160b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
5170b953ffcSMarkus Klotzbuecher		by this value.
5180b953ffcSMarkus Klotzbuecher
51992bbd64eSDaniel Schwierzeck- MIPS CPU options:
52092bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
52192bbd64eSDaniel Schwierzeck
52292bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
52392bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
52492bbd64eSDaniel Schwierzeck		relocation.
52592bbd64eSDaniel Schwierzeck
52692bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
52792bbd64eSDaniel Schwierzeck
52892bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
52992bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
53092bbd64eSDaniel Schwierzeck		Possible values are:
53192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
53292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
53392bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
53492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
53592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
53692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
53792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
53892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
53992bbd64eSDaniel Schwierzeck
54092bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
54192bbd64eSDaniel Schwierzeck
54292bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
54392bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
54492bbd64eSDaniel Schwierzeck
54592bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
54692bbd64eSDaniel Schwierzeck
54792bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
54892bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
54992bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
55092bbd64eSDaniel Schwierzeck
551b67d8816SChristian Riesch- ARM options:
552b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
553b67d8816SChristian Riesch
554b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
555b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
556b67d8816SChristian Riesch
5575356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
5585356f545SAneesh V
5595356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
5605356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
5615356f545SAneesh V		better code density. For ARM architectures that support
5625356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
5635356f545SAneesh V		GCC.
5645356f545SAneesh V
565c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
5660678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5670678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5680678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5690678587fSStephen Warren
5700678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5710678587fSStephen Warren		during U-Boot startup. Note that these options force the
5720678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5730678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5740678587fSStephen Warren		set these options unless they apply!
5750678587fSStephen Warren
576795659dcSStephen Warren- CPU timer options:
577795659dcSStephen Warren		CONFIG_SYS_HZ
578795659dcSStephen Warren
579795659dcSStephen Warren		The frequency of the timer returned by get_timer().
580795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
581795659dcSStephen Warren		option must be set to 1000.
582795659dcSStephen Warren
5835da627a4Swdenk- Linux Kernel Interface:
584c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
585c609719bSwdenk
586c609719bSwdenk		U-Boot stores all clock information in Hz
587c609719bSwdenk		internally. For binary compatibility with older Linux
588c609719bSwdenk		kernels (which expect the clocks passed in the
589c609719bSwdenk		bd_info data to be in MHz) the environment variable
590c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
591c609719bSwdenk		converts clock data to MHZ before passing it to the
592c609719bSwdenk		Linux kernel.
593c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
594c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
595c609719bSwdenk		default environment.
596c609719bSwdenk
5975da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5985da627a4Swdenk
59911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
6005da627a4Swdenk		expect it to be in bytes, others in MB.
6015da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
6025da627a4Swdenk
603fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
604f57f70aaSWolfgang Denk
605f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
606213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
607213bf8c8SGerald Van Baren		concepts).
608213bf8c8SGerald Van Baren
609213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
610213bf8c8SGerald Van Baren		 * New libfdt-based support
611213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6123bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
613213bf8c8SGerald Van Baren
614b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
615b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
616b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
617b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
618f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
619c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
620f57f70aaSWolfgang Denk
62111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
62211ccc33fSMarcel Ziswiler		addresses
6233bb342fcSKim Phillips
6244e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6254e253137SKumar Gala
6264e253137SKumar Gala		Board code has addition modification that it wants to make
6274e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6286705d81eSwdenk
6290267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
6300267768eSMatthew McClintock
63111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
6320267768eSMatthew McClintock		param header, the default value is zero if undefined.
6330267768eSMatthew McClintock
6343887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6353887c3fbSHeiko Schocher
6363887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6373887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6383887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6393887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6403887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6413887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6423887c3fbSHeiko Schocher
6437eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6447eb29398SIgor Grinberg
6457eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6467eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6477eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6487eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6497eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6507eb29398SIgor Grinberg		in a single configuration file and the machine type is
6517eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6527eb29398SIgor Grinberg
6530b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6540b2f4ecaSNiklaus Giger
6550b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6560b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
6570b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6580b2f4ecaSNiklaus Giger
6590b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
6600b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
6610b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
6620b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
6630b2f4ecaSNiklaus Giger
6640b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
6650b2f4ecaSNiklaus Giger
6660b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6670b2f4ecaSNiklaus Giger
6680b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6690b2f4ecaSNiklaus Giger		the defaults discussed just above.
6700b2f4ecaSNiklaus Giger
6712c451f78SAneesh V- Cache Configuration:
6722c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6732c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6742c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6752c451f78SAneesh V
67693bc2193SAneesh V- Cache Configuration for ARM:
67793bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
67893bc2193SAneesh V				      controller
67993bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
68093bc2193SAneesh V					controller register space
68193bc2193SAneesh V
6826705d81eSwdenk- Serial Ports:
68348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6846705d81eSwdenk
6856705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6866705d81eSwdenk
68748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6886705d81eSwdenk
6896705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6906705d81eSwdenk
6916705d81eSwdenk		CONFIG_PL011_CLOCK
6926705d81eSwdenk
6936705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6946705d81eSwdenk		the clock speed of the UARTs.
6956705d81eSwdenk
6966705d81eSwdenk		CONFIG_PL01x_PORTS
6976705d81eSwdenk
6986705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6996705d81eSwdenk		define this to a list of base addresses for each (supported)
7006705d81eSwdenk		port. See e.g. include/configs/versatile.h
7016705d81eSwdenk
702910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
703910f1ae3SJohn Rigby
704910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
705910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
706910f1ae3SJohn Rigby		this variable to initialize the extra register.
707910f1ae3SJohn Rigby
708910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
709910f1ae3SJohn Rigby
710910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
711910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
712910f1ae3SJohn Rigby		variable to flush the UART at init time.
713910f1ae3SJohn Rigby
7146705d81eSwdenk
715c609719bSwdenk- Console Interface:
716c609719bSwdenk		Depending on board, define exactly one serial port
717c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
718c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
719c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
720c609719bSwdenk
721c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
722c609719bSwdenk		port routines must be defined elsewhere
723c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
724c609719bSwdenk
725c609719bSwdenk		CONFIG_CFB_CONSOLE
726c609719bSwdenk		Enables console device for a color framebuffer. Needs following
727c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
728c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
729c609719bSwdenk						(default big endian)
730c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
731c609719bSwdenk						rectangle fill
732c609719bSwdenk						(cf. smiLynxEM)
733c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
734c609719bSwdenk						bit-blit (cf. smiLynxEM)
735c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
736c609719bSwdenk						(cols=pitch)
737c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
738c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
739c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
740c609719bSwdenk						(0-5, cf. cfb_console.c)
741c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
742c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
743c609719bSwdenk						(i.e. i8042_kbd_init())
744c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
745c609719bSwdenk						(i.e. i8042_tstc)
746c609719bSwdenk			VIDEO_GETC_FCT		get char fct
747c609719bSwdenk						(i.e. i8042_getc)
748c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
749c609719bSwdenk						(requires blink timer
750c609719bSwdenk						cf. i8042.c)
7516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
752c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
753c609719bSwdenk						upper right corner
754602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
755c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
756c609719bSwdenk						upper left corner
757a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
758a6c7ad2fSwdenk						linux_logo.h for logo.
759a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
760c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
76111ccc33fSMarcel Ziswiler						additional board info beside
762c609719bSwdenk						the logo
763c609719bSwdenk
76433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
76533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
76633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
76733a35bbbSPali Rohár
768c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
769c609719bSwdenk		default i/o. Serial console can be forced with
770c609719bSwdenk		environment 'console=serial'.
771c609719bSwdenk
772a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
773a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
774a3ad8e26Swdenk		the "silent" environment variable. See
775a3ad8e26Swdenk		doc/README.silent for more information.
776a3ad8e26Swdenk
77745ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
77845ae2546SHeiko Schocher			is 0x00.
77945ae2546SHeiko Schocher		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
78045ae2546SHeiko Schocher			is 0xa0.
78145ae2546SHeiko Schocher
782c609719bSwdenk- Console Baudrate:
783c609719bSwdenk		CONFIG_BAUDRATE - in bps
784c609719bSwdenk		Select one of the baudrates listed in
7856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
787c609719bSwdenk
788c92fac91SHeiko Schocher- Console Rx buffer length
789c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
790c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7912b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
792c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
793c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
794c92fac91SHeiko Schocher		the SMC.
795c92fac91SHeiko Schocher
7969558b48aSGraeme Russ- Pre-Console Buffer:
7979558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7989558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7999558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
8009558b48aSGraeme Russ		buffer any console messages prior to the console being
8019558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
8029558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
8039558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
8049558b48aSGraeme Russ		bytes are output before the console is initialised, the
8059558b48aSGraeme Russ		earlier bytes are discarded.
8069558b48aSGraeme Russ
8079558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
8089558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
8099558b48aSGraeme Russ
810046a37bdSSonny Rao- Safe printf() functions
811046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
812046a37bdSSonny Rao		the printf() functions. These are defined in
813046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
814046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
815046a37bdSSonny Rao		If this option is not given then these functions will
816046a37bdSSonny Rao		silently discard their buffer size argument - this means
817046a37bdSSonny Rao		you are not getting any overflow checking in this case.
818046a37bdSSonny Rao
819c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
820c609719bSwdenk		Delay before automatically booting the default image;
821c609719bSwdenk		set to -1 to disable autoboot.
82293d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
82393d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
824c609719bSwdenk
825c609719bSwdenk		See doc/README.autoboot for these options that
826c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
827c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
828c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
829c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
830c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
831c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
832c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
833c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
834c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
835c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
836c609719bSwdenk		CONFIG_RESET_TO_RETRY
837c609719bSwdenk
838c609719bSwdenk- Autoboot Command:
839c609719bSwdenk		CONFIG_BOOTCOMMAND
840c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
841c609719bSwdenk		define a command string that is automatically executed
842c609719bSwdenk		when no character is read on the console interface
843c609719bSwdenk		within "Boot Delay" after reset.
844c609719bSwdenk
845c609719bSwdenk		CONFIG_BOOTARGS
846c609719bSwdenk		This can be used to pass arguments to the bootm
847c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
848c609719bSwdenk		environment value "bootargs".
849c609719bSwdenk
850c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
851c609719bSwdenk		The value of these goes into the environment as
852c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
853c609719bSwdenk		as a convenience, when switching between booting from
85411ccc33fSMarcel Ziswiler		RAM and NFS.
855c609719bSwdenk
856eda0ba38SHeiko Schocher- Bootcount:
857eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
858eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
859eda0ba38SHeiko Schocher		cycle, see:
860eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
861eda0ba38SHeiko Schocher
862eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
863eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
864eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
865eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
866eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
867eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
868eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
869eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
870eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
871eda0ba38SHeiko Schocher
872c609719bSwdenk- Pre-Boot Commands:
873c609719bSwdenk		CONFIG_PREBOOT
874c609719bSwdenk
875c609719bSwdenk		When this option is #defined, the existence of the
876c609719bSwdenk		environment variable "preboot" will be checked
877c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
878c609719bSwdenk		countdown and/or running the auto-boot command resp.
879c609719bSwdenk		entering interactive mode.
880c609719bSwdenk
881c609719bSwdenk		This feature is especially useful when "preboot" is
882c609719bSwdenk		automatically generated or modified. For an example
883c609719bSwdenk		see the LWMON board specific code: here "preboot" is
884c609719bSwdenk		modified when the user holds down a certain
885c609719bSwdenk		combination of keys on the (special) keyboard when
886c609719bSwdenk		booting the systems
887c609719bSwdenk
888c609719bSwdenk- Serial Download Echo Mode:
889c609719bSwdenk		CONFIG_LOADS_ECHO
890c609719bSwdenk		If defined to 1, all characters received during a
891c609719bSwdenk		serial download (using the "loads" command) are
892c609719bSwdenk		echoed back. This might be needed by some terminal
893c609719bSwdenk		emulations (like "cu"), but may as well just take
894c609719bSwdenk		time on others. This setting #define's the initial
895c609719bSwdenk		value of the "loads_echo" environment variable.
896c609719bSwdenk
897602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
898c609719bSwdenk		CONFIG_KGDB_BAUDRATE
899c609719bSwdenk		Select one of the baudrates listed in
9006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
901c609719bSwdenk
902c609719bSwdenk- Monitor Functions:
903602ad3b3SJon Loeliger		Monitor commands can be included or excluded
904602ad3b3SJon Loeliger		from the build by using the #include files
905c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
906c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
907602ad3b3SJon Loeliger		and augmenting with additional #define's
908602ad3b3SJon Loeliger		for wanted commands.
909c609719bSwdenk
910602ad3b3SJon Loeliger		The default command configuration includes all commands
911602ad3b3SJon Loeliger		except those marked below with a "*".
912602ad3b3SJon Loeliger
913*b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
914602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
915602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
916602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
917602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
918602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
919602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
920602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
92108d0d6f3SMichal Simek		CONFIG_CMD_CLK   	* clock command support
922602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
923710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
924602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
925602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
926602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
927a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
928a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
929a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
930a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
931602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
932602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
933246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
934602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
935602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
9365e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
937fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
93888733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
9390c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
94003e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
94103e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
94216f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
94316f4d933SStephen Warren					  that work for multiple fs types
944bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
945602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
94603e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
947602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
948602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
9494d98b5c8SVincent Stehlé		CONFIG_CMD_FUSE		* Device fuse support
95053fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
951a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
952a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
953bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
954602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
955602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
956602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
957602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
9588fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
9594d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
960602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
9610c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
962c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
963602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
964602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
965602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
966602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
9674d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
968d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
969d22c338eSJoe Hershberger					  (169.254.*.*)
970602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
971602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
9724d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
97302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
97415a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
975602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
976a2681707SWolfgang Denk					  loop, loopw
9774d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
978602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
979602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
980602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
98168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
982602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
983602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
9844d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
985e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
986e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
987602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
988602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
989602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
990602ad3b3SJon Loeliger					  host
991602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
992ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
993602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
994602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
995d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
996602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
997602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
998602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
999602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
1000602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
1001602ad3b3SJon Loeliger					  (4xx only)
1002f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
10034d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
100402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
10057d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
100674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
1007602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
10087a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
10091fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1010da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
1011da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
1012602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
1013602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1014c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
10154d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
1016c609719bSwdenk
1017c609719bSwdenk
1018c609719bSwdenk		EXAMPLE: If you want all functions except of network
1019c609719bSwdenk		support you can write:
1020c609719bSwdenk
1021602ad3b3SJon Loeliger		#include "config_cmd_all.h"
1022602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
1023c609719bSwdenk
1024213bf8c8SGerald Van Baren	Other Commands:
1025213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
1026c609719bSwdenk
1027c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
1028602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
1029c609719bSwdenk		what you (and your U-Boot users) are doing. Data
1030c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
1031c609719bSwdenk		8260 (where accesses to the IMMR region must be
1032c609719bSwdenk		uncached), and it cannot be disabled on all other
1033c609719bSwdenk		systems where we (mis-) use the data cache to hold an
1034c609719bSwdenk		initial stack and some data.
1035c609719bSwdenk
1036c609719bSwdenk
1037c609719bSwdenk		XXX - this list needs to get updated!
1038c609719bSwdenk
1039a5ecbe62SWolfgang Denk- Regular expression support:
1040a5ecbe62SWolfgang Denk		CONFIG_REGEX
1041a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
1042a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
1043a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
1044a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
1045a5ecbe62SWolfgang Denk
104645ba8077SSimon Glass- Device tree:
104745ba8077SSimon Glass		CONFIG_OF_CONTROL
104845ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
104945ba8077SSimon Glass		to configure its devices, instead of relying on statically
105045ba8077SSimon Glass		compiled #defines in the board file. This option is
105145ba8077SSimon Glass		experimental and only available on a few boards. The device
105245ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
105345ba8077SSimon Glass
10542c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
10552c0f79e4SSimon Glass		be done using one of the two options below:
1056bbb0b128SSimon Glass
1057bbb0b128SSimon Glass		CONFIG_OF_EMBED
1058bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
1059bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
1060bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
1061bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
1062bbb0b128SSimon Glass		the global data structure as gd->blob.
106345ba8077SSimon Glass
10642c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
10652c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
10662c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
10672c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
10682c0f79e4SSimon Glass
10692c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
10702c0f79e4SSimon Glass
10712c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
10722c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
10732c0f79e4SSimon Glass		still use the individual files if you need something more
10742c0f79e4SSimon Glass		exotic.
10752c0f79e4SSimon Glass
1076c609719bSwdenk- Watchdog:
1077c609719bSwdenk		CONFIG_WATCHDOG
1078c609719bSwdenk		If this variable is defined, it enables watchdog
10796abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
10806abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
10816abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
10826abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
10836abe6fb6SDetlev Zundel		available, then no further board specific code should
10846abe6fb6SDetlev Zundel		be needed to use it.
10856abe6fb6SDetlev Zundel
10866abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
10876abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
10886abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
10896abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
1090c609719bSwdenk
1091c1551ea8Sstroese- U-Boot Version:
1092c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1093c1551ea8Sstroese		If this variable is defined, an environment variable
1094c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1095c1551ea8Sstroese		version as printed by the "version" command.
1096a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1097a1ea8e51SBenoît Thébaudeau		next reset.
1098c1551ea8Sstroese
1099c609719bSwdenk- Real-Time Clock:
1100c609719bSwdenk
1101602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1102c609719bSwdenk		has to be selected, too. Define exactly one of the
1103c609719bSwdenk		following options:
1104c609719bSwdenk
1105c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1106c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
11074e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1108c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
11091cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1110c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
11117f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
11123bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
11139536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
11144c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
11156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
111671d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
111771d19f30SHeiko Schocher					  RV3029 RTC.
1118c609719bSwdenk
1119b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1120b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1121b37c7e5eSwdenk
1122e92739d3SPeter Tyser- GPIO Support:
1123e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1124e92739d3SPeter Tyser
11255dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
11265dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
11275dec49caSChris Packham		pins supported by a particular chip.
11285dec49caSChris Packham
1129e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1130e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1131e92739d3SPeter Tyser
1132c609719bSwdenk- Timestamp Support:
1133c609719bSwdenk
1134c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1135c609719bSwdenk		(date and time) of an image is printed by image
1136c609719bSwdenk		commands like bootm or iminfo. This option is
1137602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1138c609719bSwdenk
1139923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1140923c46f9SKarl O. Pinc		Zero or more of the following:
1141923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1142923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1143923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1144923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1145923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1146923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1147923c46f9SKarl O. Pinc				       disk/part_efi.c
1148923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1149c609719bSwdenk
1150602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1151218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1152923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1153c609719bSwdenk
1154c609719bSwdenk- IDE Reset method:
11554d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
11564d13cbadSwdenk		board configurations files but used nowhere!
1157c609719bSwdenk
11584d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
11594d13cbadSwdenk		be performed by calling the function
11604d13cbadSwdenk			ide_set_reset(int reset)
11614d13cbadSwdenk		which has to be defined in a board specific file
1162c609719bSwdenk
1163c609719bSwdenk- ATAPI Support:
1164c609719bSwdenk		CONFIG_ATAPI
1165c609719bSwdenk
1166c609719bSwdenk		Set this to enable ATAPI support.
1167c609719bSwdenk
1168c40b2956Swdenk- LBA48 Support
1169c40b2956Swdenk		CONFIG_LBA48
1170c40b2956Swdenk
1171c40b2956Swdenk		Set this to enable support for disks larger than 137GB
11724b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1173c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1174c40b2956Swdenk		support disks up to 2.1TB.
1175c40b2956Swdenk
11766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1177c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1178c40b2956Swdenk			Default is 32bit.
1179c40b2956Swdenk
1180c609719bSwdenk- SCSI Support:
1181c609719bSwdenk		At the moment only there is only support for the
1182c609719bSwdenk		SYM53C8XX SCSI controller; define
1183c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1184c609719bSwdenk
11856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
11866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1188c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1189c609719bSwdenk		devices.
11906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1191c609719bSwdenk
1192447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1193447c031bSStefan Reinauer		SCSI devices found during the last scan.
1194447c031bSStefan Reinauer
1195c609719bSwdenk- NETWORK Support (PCI):
1196682011ffSwdenk		CONFIG_E1000
1197ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1198ce5207e1SKyle Moffett
1199ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1200ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1201ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1202ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1203ce5207e1SKyle Moffett
1204ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1205ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1206ce5207e1SKyle Moffett		example with the "sspi" command.
1207ce5207e1SKyle Moffett
1208ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1209ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1210ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1211682011ffSwdenk
1212ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
121311ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1214ac3315c2SAndre Schwarz
1215c609719bSwdenk		CONFIG_EEPRO100
1216c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
121711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1218c609719bSwdenk		write routine for first time initialisation.
1219c609719bSwdenk
1220c609719bSwdenk		CONFIG_TULIP
1221c609719bSwdenk		Support for Digital 2114x chips.
1222c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1223c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1224c609719bSwdenk
1225c609719bSwdenk		CONFIG_NATSEMI
1226c609719bSwdenk		Support for National dp83815 chips.
1227c609719bSwdenk
1228c609719bSwdenk		CONFIG_NS8382X
1229c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1230c609719bSwdenk
123145219c46Swdenk- NETWORK Support (other):
123245219c46Swdenk
1233c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1234c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1235c041e9d2SJens Scharsig
1236c041e9d2SJens Scharsig			CONFIG_RMII
1237c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1238c041e9d2SJens Scharsig
1239c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1240c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1241c041e9d2SJens Scharsig			The driver doen't show link status messages.
1242c041e9d2SJens Scharsig
1243efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1244efdd7319SRob Herring		Support for the Calxeda XGMAC device
1245efdd7319SRob Herring
12463bb46d23SAshok		CONFIG_LAN91C96
124745219c46Swdenk		Support for SMSC's LAN91C96 chips.
124845219c46Swdenk
124945219c46Swdenk			CONFIG_LAN91C96_BASE
125045219c46Swdenk			Define this to hold the physical address
125145219c46Swdenk			of the LAN91C96's I/O space
125245219c46Swdenk
125345219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
125445219c46Swdenk			Define this to enable 32 bit addressing
125545219c46Swdenk
12563bb46d23SAshok		CONFIG_SMC91111
1257f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1258f39748aeSwdenk
1259f39748aeSwdenk			CONFIG_SMC91111_BASE
1260f39748aeSwdenk			Define this to hold the physical address
1261f39748aeSwdenk			of the device (I/O space)
1262f39748aeSwdenk
1263f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1264f39748aeSwdenk			Define this if data bus is 32 bits
1265f39748aeSwdenk
1266f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1267f39748aeSwdenk			Define this to use i/o functions instead of macros
1268f39748aeSwdenk			(some hardware wont work with macros)
1269f39748aeSwdenk
1270dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1271dc02badaSHeiko Schocher		Support for davinci emac
1272dc02badaSHeiko Schocher
1273dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1274dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1275dc02badaSHeiko Schocher
1276b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1277b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1278b3dbf4a5SMacpaul Lin
1279b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1280b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1281b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1282b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1283b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1284b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1285b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1286b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1287b3dbf4a5SMacpaul Lin
1288c2fff331SMike Rapoport		CONFIG_SMC911X
1289557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1290557b377dSJens Gehrlein
1291c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1292557b377dSJens Gehrlein			Define this to hold the physical address
1293557b377dSJens Gehrlein			of the device (I/O space)
1294557b377dSJens Gehrlein
1295c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1296557b377dSJens Gehrlein			Define this if data bus is 32 bits
1297557b377dSJens Gehrlein
1298c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1299557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1300557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1301c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1302557b377dSJens Gehrlein
13033d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
13043d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
13053d0075faSYoshihiro Shimoda
13063d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
13073d0075faSYoshihiro Shimoda			Define the number of ports to be used
13083d0075faSYoshihiro Shimoda
13093d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
13103d0075faSYoshihiro Shimoda			Define the ETH PHY's address
13113d0075faSYoshihiro Shimoda
131268260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
131368260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
131468260aabSYoshihiro Shimoda
13155e124724SVadim Bendebury- TPM Support:
131690899cc0SChe-liang Chiou		CONFIG_TPM
131790899cc0SChe-liang Chiou		Support TPM devices.
131890899cc0SChe-liang Chiou
13191b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
13201b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
13211b393db5STom Wai-Hong Tam		per system is supported at this time.
13221b393db5STom Wai-Hong Tam
13231b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
13241b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
13251b393db5STom Wai-Hong Tam
13261b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
13271b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
13281b393db5STom Wai-Hong Tam
13291b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
13301b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
13311b393db5STom Wai-Hong Tam
1332c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1333c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1334c01939c7SDirk Eibach
133590899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
13365e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
13375e124724SVadim Bendebury		per system is supported at this time.
13385e124724SVadim Bendebury
13395e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
13405e124724SVadim Bendebury			Base address where the generic TPM device is mapped
13415e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
13425e124724SVadim Bendebury			0xfed40000.
13435e124724SVadim Bendebury
1344be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1345be6c1529SReinhard Pfau		Add tpm monitor functions.
1346be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1347be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1348be6c1529SReinhard Pfau
1349be6c1529SReinhard Pfau		CONFIG_TPM
1350be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1351be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1352be6c1529SReinhard Pfau		Requires support for a TPM device.
1353be6c1529SReinhard Pfau
1354be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1355be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1356be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1357be6c1529SReinhard Pfau
1358c609719bSwdenk- USB Support:
1359c609719bSwdenk		At the moment only the UHCI host controller is
13604d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1361c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1362c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
136330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1364c609719bSwdenk		storage devices.
1365c609719bSwdenk		Note:
1366c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1367c609719bSwdenk		(TEAC FD-05PUB).
13684d13cbadSwdenk		MPC5200 USB requires additional defines:
13694d13cbadSwdenk			CONFIG_USB_CLOCK
13704d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1371307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1372307ecb6dSEric Millbrandt				for USB on PSC3
13734d13cbadSwdenk			CONFIG_USB_CONFIG
13744d13cbadSwdenk				for differential drivers: 0x00001000
13754d13cbadSwdenk				for single ended drivers: 0x00005000
1376307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1377307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
13786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1379fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1380fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
13814d13cbadSwdenk
13829ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
13839ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
13849ab4ce22SSimon Glass
1385aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1386aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1387aa155058SKuo-Jung Su
138816c8d5e7SWolfgang Denk- USB Device:
138916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
139016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
139116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
139211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
139316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
139416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
139516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
139616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
139716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
139816c8d5e7SWolfgang Denk		a Linux host by
139916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
140016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
140116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
140216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
140316c8d5e7SWolfgang Denk
140416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
140516c8d5e7SWolfgang Denk			Define this to build a UDC device
140616c8d5e7SWolfgang Denk
140716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
140816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
140916c8d5e7SWolfgang Denk			talk to the UDC device
141016c8d5e7SWolfgang Denk
1411f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1412f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1413f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1414f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1415f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1416f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1417f9da0f89SVipin KUMAR			speed.
1418f9da0f89SVipin KUMAR
14196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
142016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
142116c8d5e7SWolfgang Denk			be set to usbtty.
142216c8d5e7SWolfgang Denk
142316c8d5e7SWolfgang Denk			mpc8xx:
14246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
142516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
14266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
142716c8d5e7SWolfgang Denk
14286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
142916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
14306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
143116c8d5e7SWolfgang Denk
143216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
143316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
143416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
143516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
143616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
143716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
143816c8d5e7SWolfgang Denk
143916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
144016c8d5e7SWolfgang Denk			Define this string as the name of your company for
144116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
144216c8d5e7SWolfgang Denk
144316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
144416c8d5e7SWolfgang Denk			Define this string as the name of your product
144516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
144616c8d5e7SWolfgang Denk
144716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
144816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
144916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
145016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
145116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
145216c8d5e7SWolfgang Denk
145316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
145416c8d5e7SWolfgang Denk			Define this as the unique Product ID
145516c8d5e7SWolfgang Denk			for your device
145616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1457c609719bSwdenk
1458351e9b20SPrzemyslaw Marczak		Some USB device drivers may need to check USB cable attachment.
1459351e9b20SPrzemyslaw Marczak		In this case you can enable following config in BoardName.h:
1460351e9b20SPrzemyslaw Marczak			CONFIG_USB_CABLE_CHECK
1461351e9b20SPrzemyslaw Marczak			This enables function definition:
1462351e9b20SPrzemyslaw Marczak			- usb_cable_connected() in include/usb.h
1463351e9b20SPrzemyslaw Marczak			Implementation of this function is board-specific.
1464351e9b20SPrzemyslaw Marczak
1465d70a560fSIgor Grinberg- ULPI Layer Support:
1466d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1467d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1468d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1469d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1470d70a560fSIgor Grinberg		viewport is supported.
1471d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1472d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
14736d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
14746d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
14756d365ea0SLucas Stach		the appropriate value in Hz.
1476c609719bSwdenk
1477c609719bSwdenk- MMC Support:
1478c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1479c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1480c609719bSwdenk		accessed from the boot prompt by mapping the device
1481c609719bSwdenk		to physical memory similar to flash. Command line is
1482602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1483602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1484c609719bSwdenk
1485afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1486afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1487afb35666SYoshihiro Shimoda
1488afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1489afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1490afb35666SYoshihiro Shimoda
1491afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1492afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1493afb35666SYoshihiro Shimoda
1494b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1495b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1496b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1497b3ba6e94STom Rini
1498b3ba6e94STom Rini		CONFIG_CMD_DFU
1499b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1500b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1501b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1502b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1503b3ba6e94STom Rini
1504b3ba6e94STom Rini		CONFIG_DFU_MMC
1505b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1506b3ba6e94STom Rini
1507c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1508c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1509c6631764SPantelis Antoniou
1510a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1511a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1512a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1513a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1514a9479f04SAfzal Mohammed		one that would help mostly the developer.
1515a9479f04SAfzal Mohammed
1516e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1517e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1518e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1519e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1520e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1521e7e75c70SHeiko Schocher
1522ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1523ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1524ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1525ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1526ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1527ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1528ea2453d5SPantelis Antoniou
15296705d81eSwdenk- Journaling Flash filesystem support:
15306705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
15316705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
15326705d81eSwdenk		Define these for a default partition on a NAND device
15336705d81eSwdenk
15346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
15356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
15366705d81eSwdenk		Define these for a default partition on a NOR device
15376705d81eSwdenk
15386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
15396705d81eSwdenk		Define this to create an own partition. You have to provide a
15406705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
15416705d81eSwdenk
15426705d81eSwdenk		If you define only one JFFS2 partition you may also want to
15436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
15446705d81eSwdenk		to disable the command chpart. This is the default when you
15456705d81eSwdenk		have not defined a custom partition
15466705d81eSwdenk
1547c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1548c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1549656f4c65SDonggeun Kim
1550656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1551656f4c65SDonggeun Kim		file in FAT formatted partition.
1552656f4c65SDonggeun Kim
1553656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1554656f4c65SDonggeun Kim		user to write files to FAT.
1555c30a15e5SDonggeun Kim
155684cd9327SGabe BlackCBFS (Coreboot Filesystem) support
155784cd9327SGabe Black		CONFIG_CMD_CBFS
155884cd9327SGabe Black
155984cd9327SGabe Black		Define this to enable support for reading from a Coreboot
156084cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
156184cd9327SGabe Black		and cbfsload.
156284cd9327SGabe Black
1563c609719bSwdenk- Keyboard Support:
1564c609719bSwdenk		CONFIG_ISA_KEYBOARD
1565c609719bSwdenk
1566c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1567c609719bSwdenk		support
1568c609719bSwdenk
1569c609719bSwdenk		CONFIG_I8042_KBD
1570c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1571c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1572c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1573c609719bSwdenk		for cfb_console. Supports cursor blinking.
1574c609719bSwdenk
1575713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1576713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1577713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1578713cb680SHung-ying Tyan		which provides key scans on request.
1579713cb680SHung-ying Tyan
1580c609719bSwdenk- Video support:
1581c609719bSwdenk		CONFIG_VIDEO
1582c609719bSwdenk
1583c609719bSwdenk		Define this to enable video support (for output to
1584c609719bSwdenk		video).
1585c609719bSwdenk
1586c609719bSwdenk		CONFIG_VIDEO_CT69000
1587c609719bSwdenk
1588c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1589c609719bSwdenk
1590c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1591eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1592eeb1b77bSwdenk		video output is selected via environment 'videoout'
1593eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1594eeb1b77bSwdenk		assumed.
1595c609719bSwdenk
1596eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
159711ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1598eeb1b77bSwdenk		are possible:
1599eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1600eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1601eeb1b77bSwdenk
1602eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1603eeb1b77bSwdenk		-------------+---------------------------------------------
1604eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1605eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1606eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1607eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1608eeb1b77bSwdenk		-------------+---------------------------------------------
1609c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1610c609719bSwdenk
1611eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
16127817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1613eeb1b77bSwdenk
1614eeb1b77bSwdenk
1615a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1616a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1617a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1618a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1619a6c7ad2fSwdenk
16207d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
16217d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
16227d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
16237d3053fbSTimur Tabi		support, and should also define these other macros:
16247d3053fbSTimur Tabi
16257d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
16267d3053fbSTimur Tabi			CONFIG_VIDEO
16277d3053fbSTimur Tabi			CONFIG_CMD_BMP
16287d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
16297d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
16307d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
16317d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
16327d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
16337d3053fbSTimur Tabi
1634ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1635ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1636ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1637ba8e76bdSTimur Tabi		description of this variable.
16387d3053fbSTimur Tabi
1639058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1640058d59b0SSimon Glass
1641058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1642058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1643058d59b0SSimon Glass		driver.
1644058d59b0SSimon Glass
1645058d59b0SSimon Glass
1646682011ffSwdenk- Keyboard Support:
1647682011ffSwdenk		CONFIG_KEYBOARD
1648682011ffSwdenk
1649682011ffSwdenk		Define this to enable a custom keyboard support.
1650682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1651682011ffSwdenk		defined in your board-specific files.
1652682011ffSwdenk		The only board using this so far is RBC823.
1653a6c7ad2fSwdenk
1654c609719bSwdenk- LCD Support:	CONFIG_LCD
1655c609719bSwdenk
1656c609719bSwdenk		Define this to enable LCD support (for output to LCD
1657c609719bSwdenk		display); also select one of the supported displays
1658c609719bSwdenk		by defining one of these:
1659c609719bSwdenk
166039cf4804SStelian Pop		CONFIG_ATMEL_LCD:
166139cf4804SStelian Pop
166239cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
166339cf4804SStelian Pop
1664fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1665c609719bSwdenk
1666fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1667c609719bSwdenk
1668fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1669c609719bSwdenk
1670fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1671fd3103bbSwdenk			Active, color, single scan.
1672fd3103bbSwdenk
1673fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1674fd3103bbSwdenk
1675fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1676c609719bSwdenk			Active, color, single scan.
1677c609719bSwdenk
1678c609719bSwdenk		CONFIG_SHARP_16x9
1679c609719bSwdenk
1680c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1681c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1682c609719bSwdenk
1683c609719bSwdenk		CONFIG_SHARP_LQ64D341
1684c609719bSwdenk
1685c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1686c609719bSwdenk			Active, color, single scan.
1687c609719bSwdenk
1688c609719bSwdenk		CONFIG_HLD1045
1689c609719bSwdenk
1690c609719bSwdenk			HLD1045 display, 640x480.
1691c609719bSwdenk			Active, color, single scan.
1692c609719bSwdenk
1693c609719bSwdenk		CONFIG_OPTREX_BW
1694c609719bSwdenk
1695c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1696c609719bSwdenk			or
1697c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1698c609719bSwdenk			or
1699c609719bSwdenk			Hitachi	 SP14Q002
1700c609719bSwdenk
1701c609719bSwdenk			320x240. Black & white.
1702c609719bSwdenk
1703c609719bSwdenk		Normally display is black on white background; define
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1705c609719bSwdenk
1706676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1707676d319eSSimon Glass
1708676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1709676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1710676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1711676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1712676d319eSSimon Glass		a per-section basis.
1713676d319eSSimon Glass
17140d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
17150d89efefSSimon Glass
17160d89efefSSimon Glass		When the console need to be scrolled, this is the number of
17170d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
17180d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
17190d89efefSSimon Glass		is slow.
1720676d319eSSimon Glass
172145d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
172245d7f525STom Wai-Hong Tam
172345d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
172445d7f525STom Wai-Hong Tam
1725735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1726735987c5STom Wai-Hong Tam
1727735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1728735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1729735987c5STom Wai-Hong Tam
17307152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1731d791b1dcSwdenk
1732d791b1dcSwdenk		If this option is set, the environment is checked for
1733d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1734d791b1dcSwdenk		of logo, copyright and system information on the LCD
1735e94d2cd9Swdenk		is suppressed and the BMP image at the address
1736d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1737d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1738d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1739d791b1dcSwdenk		loaded very quickly after power-on.
1740d791b1dcSwdenk
1741c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1742c0880485SNikita Kiryanov
1743c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1744c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
17451551df35STom Rini		(see README.displaying-bmps).
1746c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1747c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1748c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1749c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1750c0880485SNikita Kiryanov		there is no need to set this option.
1751c0880485SNikita Kiryanov
17521ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
17531ca298ceSMatthias Weisser
17541ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
17551ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
17561ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
17571ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
17581ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
17591ca298ceSMatthias Weisser		specify 'm' for centering the image.
17601ca298ceSMatthias Weisser
17611ca298ceSMatthias Weisser		Example:
17621ca298ceSMatthias Weisser		setenv splashpos m,m
17631ca298ceSMatthias Weisser			=> image at center of screen
17641ca298ceSMatthias Weisser
17651ca298ceSMatthias Weisser		setenv splashpos 30,20
17661ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
17671ca298ceSMatthias Weisser
17681ca298ceSMatthias Weisser		setenv splashpos -10,m
17691ca298ceSMatthias Weisser			=> vertically centered image
17701ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
17711ca298ceSMatthias Weisser
177298f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
177398f4a3dfSStefan Roese
177498f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
177598f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
177698f4a3dfSStefan Roese		splashscreen support or the bmp command.
177798f4a3dfSStefan Roese
1778d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1779d5011762SAnatolij Gustschin
1780d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1781d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1782d5011762SAnatolij Gustschin		bmp command.
1783d5011762SAnatolij Gustschin
1784f2b96dfbSLei Wen- Do compresssing for memory range:
1785f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1786f2b96dfbSLei Wen
1787f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1788f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1789f2b96dfbSLei Wen
1790c29fdfc1Swdenk- Compression support:
17918ef70478SKees Cook		CONFIG_GZIP
17928ef70478SKees Cook
17938ef70478SKees Cook		Enabled by default to support gzip compressed images.
17948ef70478SKees Cook
1795c29fdfc1Swdenk		CONFIG_BZIP2
1796c29fdfc1Swdenk
1797c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1798c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1799c29fdfc1Swdenk		compressed images are supported.
1800c29fdfc1Swdenk
1801c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
18026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1803c29fdfc1Swdenk		be at least 4MB.
1804d791b1dcSwdenk
1805fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1806fc9c1727SLuigi 'Comio' Mantellini
1807fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1808fc9c1727SLuigi 'Comio' Mantellini		images is included.
1809fc9c1727SLuigi 'Comio' Mantellini
1810fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1811fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1812fc9c1727SLuigi 'Comio' Mantellini		formula:
1813fc9c1727SLuigi 'Comio' Mantellini
1814fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1815fc9c1727SLuigi 'Comio' Mantellini
1816fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1817fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1818fc9c1727SLuigi 'Comio' Mantellini
1819fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1820fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1821fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1822fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1823fc9c1727SLuigi 'Comio' Mantellini
1824fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1825fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
18266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1827fc9c1727SLuigi 'Comio' Mantellini
18288ef70478SKees Cook		CONFIG_LZO
18298ef70478SKees Cook
18308ef70478SKees Cook		If this option is set, support for LZO compressed images
18318ef70478SKees Cook		is included.
18328ef70478SKees Cook
183317ea1177Swdenk- MII/PHY support:
183417ea1177Swdenk		CONFIG_PHY_ADDR
183517ea1177Swdenk
183617ea1177Swdenk		The address of PHY on MII bus.
183717ea1177Swdenk
183817ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
183917ea1177Swdenk
184017ea1177Swdenk		The clock frequency of the MII bus
184117ea1177Swdenk
184217ea1177Swdenk		CONFIG_PHY_GIGE
184317ea1177Swdenk
184417ea1177Swdenk		If this option is set, support for speed/duplex
184511ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
184617ea1177Swdenk
184717ea1177Swdenk		CONFIG_PHY_RESET_DELAY
184817ea1177Swdenk
184917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
185017ea1177Swdenk		reset before any MII register access is possible.
185117ea1177Swdenk		For such PHY, set this option to the usec delay
185217ea1177Swdenk		required. (minimum 300usec for LXT971A)
185317ea1177Swdenk
185417ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
185517ea1177Swdenk
185617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
185717ea1177Swdenk		command issued before MII status register can be read
185817ea1177Swdenk
1859c609719bSwdenk- Ethernet address:
1860c609719bSwdenk		CONFIG_ETHADDR
1861c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1862c609719bSwdenk		CONFIG_ETH2ADDR
1863c609719bSwdenk		CONFIG_ETH3ADDR
1864c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1865c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1866c609719bSwdenk
186711ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
186811ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1869c609719bSwdenk		is not determined automatically.
1870c609719bSwdenk
1871c609719bSwdenk- IP address:
1872c609719bSwdenk		CONFIG_IPADDR
1873c609719bSwdenk
1874c609719bSwdenk		Define a default value for the IP address to use for
187511ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1876c609719bSwdenk		determined through e.g. bootp.
18771ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1878c609719bSwdenk
1879c609719bSwdenk- Server IP address:
1880c609719bSwdenk		CONFIG_SERVERIP
1881c609719bSwdenk
1882c609719bSwdenk		Defines a default value for the IP address of a TFTP
1883c609719bSwdenk		server to contact when using the "tftboot" command.
18841ebcd654SWolfgang Denk		(Environment variable "serverip")
1885c609719bSwdenk
188697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
188797cfe861SRobin Getz
188897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
188997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
189097cfe861SRobin Getz
18911ebcd654SWolfgang Denk- Gateway IP address:
18921ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
18931ebcd654SWolfgang Denk
18941ebcd654SWolfgang Denk		Defines a default value for the IP address of the
18951ebcd654SWolfgang Denk		default router where packets to other networks are
18961ebcd654SWolfgang Denk		sent to.
18971ebcd654SWolfgang Denk		(Environment variable "gatewayip")
18981ebcd654SWolfgang Denk
18991ebcd654SWolfgang Denk- Subnet mask:
19001ebcd654SWolfgang Denk		CONFIG_NETMASK
19011ebcd654SWolfgang Denk
19021ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
19031ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
19041ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
19051ebcd654SWolfgang Denk		forwarded through a router.
19061ebcd654SWolfgang Denk		(Environment variable "netmask")
19071ebcd654SWolfgang Denk
190853a5c424SDavid Updegraff- Multicast TFTP Mode:
190953a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
191053a5c424SDavid Updegraff
191153a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
191253a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
191311ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
191453a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
191553a5c424SDavid Updegraff		multicast group.
191653a5c424SDavid Updegraff
1917c609719bSwdenk- BOOTP Recovery Mode:
1918c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1919c609719bSwdenk
1920c609719bSwdenk		If you have many targets in a network that try to
1921c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1922c609719bSwdenk		systems send out BOOTP requests at precisely the same
1923c609719bSwdenk		moment (which would happen for instance at recovery
1924c609719bSwdenk		from a power failure, when all systems will try to
1925c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1926c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1927c609719bSwdenk		inserted before sending out BOOTP requests. The
19286c33c785SWolfgang Denk		following delays are inserted then:
1929c609719bSwdenk
1930c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1931c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1932c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1933c609719bSwdenk		4th and following
1934c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1935c609719bSwdenk
1936fe389a82Sstroese- DHCP Advanced Options:
19371fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
19381fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1939fe389a82Sstroese
19401fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
19411fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
19421fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
19431fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
19441fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
19451fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
19461fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
19471fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
19481fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
19491fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
19501fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
19511fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
19522c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1953fe389a82Sstroese
19545d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
19555d110f0aSWilson Callan		environment variable, not the BOOTP server.
1956fe389a82Sstroese
19572c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
19582c00e099SJoe Hershberger		after the configured retry count, the call will fail
19592c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
19602c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
19612c00e099SJoe Hershberger		is not available.
19622c00e099SJoe Hershberger
1963fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1964fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1965fe389a82Sstroese		than one DNS serverip is offered to the client.
1966fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1967fe389a82Sstroese		serverip will be stored in the additional environment
1968fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1969fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
19701fe80d79SJon Loeliger		is defined.
1971fe389a82Sstroese
1972fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1973fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1974fe389a82Sstroese		need the hostname of the DHCP requester.
19755d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
19761fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
19771fe80d79SJon Loeliger		option 12 to the DHCP server.
1978fe389a82Sstroese
1979d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1980d9a2f416SAras Vaichas
1981d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1982d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1983d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1984d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1985d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1986d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1987d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1988d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1989d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1990d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1991d9a2f416SAras Vaichas		this delay.
1992d9a2f416SAras Vaichas
1993d22c338eSJoe Hershberger - Link-local IP address negotiation:
1994d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1995d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1996d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1997d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1998d22c338eSJoe Hershberger
1999d22c338eSJoe Hershberger		See doc/README.link-local for more information.
2000d22c338eSJoe Hershberger
2001a3d991bdSwdenk - CDP Options:
2002a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
2003a3d991bdSwdenk
2004a3d991bdSwdenk		The device id used in CDP trigger frames.
2005a3d991bdSwdenk
2006a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
2007a3d991bdSwdenk
2008a3d991bdSwdenk		A two character string which is prefixed to the MAC address
2009a3d991bdSwdenk		of the device.
2010a3d991bdSwdenk
2011a3d991bdSwdenk		CONFIG_CDP_PORT_ID
2012a3d991bdSwdenk
2013a3d991bdSwdenk		A printf format string which contains the ascii name of
2014a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
201511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
2016a3d991bdSwdenk
2017a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
2018a3d991bdSwdenk
2019a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
2020a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
2021a3d991bdSwdenk
2022a3d991bdSwdenk		CONFIG_CDP_VERSION
2023a3d991bdSwdenk
2024a3d991bdSwdenk		An ascii string containing the version of the software.
2025a3d991bdSwdenk
2026a3d991bdSwdenk		CONFIG_CDP_PLATFORM
2027a3d991bdSwdenk
2028a3d991bdSwdenk		An ascii string containing the name of the platform.
2029a3d991bdSwdenk
2030a3d991bdSwdenk		CONFIG_CDP_TRIGGER
2031a3d991bdSwdenk
2032a3d991bdSwdenk		A 32bit integer sent on the trigger.
2033a3d991bdSwdenk
2034a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
2035a3d991bdSwdenk
2036a3d991bdSwdenk		A 16bit integer containing the power consumption of the
2037a3d991bdSwdenk		device in .1 of milliwatts.
2038a3d991bdSwdenk
2039a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
2040a3d991bdSwdenk
2041a3d991bdSwdenk		A byte containing the id of the VLAN.
2042a3d991bdSwdenk
2043c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
2044c609719bSwdenk
2045c609719bSwdenk		Several configurations allow to display the current
2046c609719bSwdenk		status using a LED. For instance, the LED will blink
2047c609719bSwdenk		fast while running U-Boot code, stop blinking as
2048c609719bSwdenk		soon as a reply to a BOOTP request was received, and
2049c609719bSwdenk		start blinking slow once the Linux kernel is running
2050c609719bSwdenk		(supported by a status LED driver in the Linux
2051c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
2052c609719bSwdenk		feature in U-Boot.
2053c609719bSwdenk
20541df7bbbaSIgor Grinberg		Additional options:
20551df7bbbaSIgor Grinberg
20561df7bbbaSIgor Grinberg		CONFIG_GPIO_LED
20571df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
20581df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
20591df7bbbaSIgor Grinberg		status LED backend implementation. Define CONFIG_GPIO_LED
20601df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
20611df7bbbaSIgor Grinberg
20629dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
20639dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
20649dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
20659dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
20669dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
20679dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
20689dfdcdfeSIgor Grinberg
2069c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
2070c609719bSwdenk
2071c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
2072c609719bSwdenk		on those systems that support this (optional)
2073c609719bSwdenk		feature, like the TQM8xxL modules.
2074c609719bSwdenk
20753f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
2076c609719bSwdenk
20773f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
20783f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
20793f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
20803f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
20813f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
20823f4978c7SHeiko Schocher		interface.
20833f4978c7SHeiko Schocher
20843f4978c7SHeiko Schocher		ported i2c driver to the new framework:
2085ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
2086ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
2087ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2088ea818dbbSHeiko Schocher		    for defining speed and slave address
2089ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
2090ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2091ea818dbbSHeiko Schocher		    for defining speed and slave address
2092ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
2093ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2094ea818dbbSHeiko Schocher		    for defining speed and slave address
2095ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2096ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2097ea818dbbSHeiko Schocher		    for defining speed and slave address
20983f4978c7SHeiko Schocher
209900f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
210000f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
210100f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
210200f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
210300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
210400f792e0SHeiko Schocher		    bus.
210500f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
210600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
210700f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
210800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
210900f792e0SHeiko Schocher		    second bus.
211000f792e0SHeiko Schocher
21111f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
21121f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
21131f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
21141f2ba722SSimon Glass		    100000 and the slave addr 0!
21151f2ba722SSimon Glass
2116880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
2117880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
2118880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2119880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2120880540deSDirk Eibach
2121fac96408Strem		- drivers/i2c/i2c_mxc.c
2122fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
2123fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2124fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2125fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2126fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2127fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2128fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2129fac96408Strem		If thoses defines are not set, default value is 100000
2130fac96408Strem		for speed, and 0 for slave.
2131fac96408Strem
21321086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
21331086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
21341086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
21351086bfa9SNobuhiro Iwamatsu
21361086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
21371086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
21381086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
21391086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
21401086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
21411086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
21421086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
21431086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
21441086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
21451086bfa9SNobuhiro Iwamatsu
21462035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
21472035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
21482035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
21492035d77dSNobuhiro Iwamatsu
21502035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
21512035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
21522035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
21532035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
21542035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
21552035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
21562035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
21572035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
21582035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
21592035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
21602035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
21612035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
21622035d77dSNobuhiro Iwamatsu		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
21632035d77dSNobuhiro Iwamatsu
21646789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
21656789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
21666789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
21676789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
21686789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
21696789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
21706789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
21716789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
21726789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
21736789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
21746789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
21756789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
21766789e84eSHeiko Schocher
21770bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
21780bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
21790bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
21800bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
21810bdffe71SHeiko Schocher
2182e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2183e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2184e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2185e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2186e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2187e717fc6dSNaveen Krishna Ch
21883f4978c7SHeiko Schocher		additional defines:
21893f4978c7SHeiko Schocher
21903f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
21913f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
21923f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
21933f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
21943f4978c7SHeiko Schocher		omit this define.
21953f4978c7SHeiko Schocher
21963f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
21973f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
21983f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
21993f4978c7SHeiko Schocher		omit this define.
22003f4978c7SHeiko Schocher
22013f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
22023f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
22033f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
22043f4978c7SHeiko Schocher		define.
22053f4978c7SHeiko Schocher
22063f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
22073f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
22083f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
22093f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
22103f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
22113f4978c7SHeiko Schocher
22123f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
22133f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
22143f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
22153f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
22163f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
22173f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
22183f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
22193f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
22203f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
22213f4978c7SHeiko Schocher					}
22223f4978c7SHeiko Schocher
22233f4978c7SHeiko Schocher		which defines
22243f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2225ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2226ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2227ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2228ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2229ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
22303f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2231ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2232ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
22333f4978c7SHeiko Schocher
22343f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
22353f4978c7SHeiko Schocher
2236ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
22373f4978c7SHeiko Schocher
22383f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
22393f4978c7SHeiko Schocher		provides the following compelling advantages:
22403f4978c7SHeiko Schocher
22413f4978c7SHeiko Schocher		- more than one i2c adapter is usable
22423f4978c7SHeiko Schocher		- approved multibus support
22433f4978c7SHeiko Schocher		- better i2c mux support
22443f4978c7SHeiko Schocher
22453f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
22463f4978c7SHeiko Schocher
2247ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2248ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2249ea818dbbSHeiko Schocher		for the selected CPU.
2250c609719bSwdenk
2251b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2252602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2253b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2254b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2255c609719bSwdenk		command line interface.
2256c609719bSwdenk
2257bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2258c609719bSwdenk
2259b37c7e5eSwdenk		There are several other quantities that must also be
2260ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2261c609719bSwdenk
22626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2263b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
22646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
226511ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2266c609719bSwdenk
22678d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2268a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
22698d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
22708d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
22718d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2272b37c7e5eSwdenk
22735da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
22745da71efaSEric Millbrandt
22755da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
22765da71efaSEric Millbrandt		chips might think that the current transfer is still
22775da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
22785da71efaSEric Millbrandt		commands until the slave device responds.
22795da71efaSEric Millbrandt
2280b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2281b37c7e5eSwdenk
2282ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2283b37c7e5eSwdenk		then the following macros need to be defined (examples are
2284b37c7e5eSwdenk		from include/configs/lwmon.h):
2285c609719bSwdenk
2286c609719bSwdenk		I2C_INIT
2287c609719bSwdenk
2288b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2289c609719bSwdenk		controller or configure ports.
2290c609719bSwdenk
2291b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2292b37c7e5eSwdenk
2293c609719bSwdenk		I2C_PORT
2294c609719bSwdenk
2295c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2296c609719bSwdenk		assumes both bits are on the same port). Valid values
2297c609719bSwdenk		are 0..3 for ports A..D.
2298c609719bSwdenk
2299c609719bSwdenk		I2C_ACTIVE
2300c609719bSwdenk
2301c609719bSwdenk		The code necessary to make the I2C data line active
2302c609719bSwdenk		(driven).  If the data line is open collector, this
2303c609719bSwdenk		define can be null.
2304c609719bSwdenk
2305b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2306b37c7e5eSwdenk
2307c609719bSwdenk		I2C_TRISTATE
2308c609719bSwdenk
2309c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2310c609719bSwdenk		(inactive).  If the data line is open collector, this
2311c609719bSwdenk		define can be null.
2312c609719bSwdenk
2313b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2314b37c7e5eSwdenk
2315c609719bSwdenk		I2C_READ
2316c609719bSwdenk
2317472d5460SYork Sun		Code that returns true if the I2C data line is high,
2318472d5460SYork Sun		false if it is low.
2319c609719bSwdenk
2320b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2321b37c7e5eSwdenk
2322c609719bSwdenk		I2C_SDA(bit)
2323c609719bSwdenk
2324472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2325472d5460SYork Sun		is false, it clears it (low).
2326c609719bSwdenk
2327b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2328b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2329b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2330b37c7e5eSwdenk
2331c609719bSwdenk		I2C_SCL(bit)
2332c609719bSwdenk
2333472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2334472d5460SYork Sun		is false, it clears it (low).
2335c609719bSwdenk
2336b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2337b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2338b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2339b37c7e5eSwdenk
2340c609719bSwdenk		I2C_DELAY
2341c609719bSwdenk
2342c609719bSwdenk		This delay is invoked four times per clock cycle so this
2343c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2344b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2345b37c7e5eSwdenk		like:
2346b37c7e5eSwdenk
2347b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2348c609719bSwdenk
2349793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2350793b5726SMike Frysinger
2351793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2352793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2353793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2354793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2355793b5726SMike Frysinger
2356793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2357793b5726SMike Frysinger		the generic GPIO functions.
2358793b5726SMike Frysinger
23596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
236047cd00faSwdenk
236147cd00faSwdenk		When a board is reset during an i2c bus transfer
236247cd00faSwdenk		chips might think that the current transfer is still
236347cd00faSwdenk		in progress. On some boards it is possible to access
236447cd00faSwdenk		the i2c SCLK line directly, either by using the
236547cd00faSwdenk		processor pin as a GPIO or by having a second pin
236647cd00faSwdenk		connected to the bus. If this option is defined a
236747cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
236847cd00faSwdenk		is run early in the boot sequence.
236947cd00faSwdenk
237026a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
237126a33504SRichard Retanubun
237226a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
237326a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
237426a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
237526a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
237626a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
237726a33504SRichard Retanubun		controller provide such a method. It is called at the end of
237826a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
237926a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
238026a33504SRichard Retanubun
238117ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
238217ea1177Swdenk
238317ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
238417ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
238517ea1177Swdenk		variable "i2cfast". (see also i2cfast)
238617ea1177Swdenk
2387bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2388bb99ad6dSBen Warren
2389bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2390bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2391bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2392bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2393bb99ad6dSBen Warren
23946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2395bb99ad6dSBen Warren
2396bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
23970f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
23980f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
23990f89c54bSPeter Tyser		a 1D array of device addresses
2400bb99ad6dSBen Warren
2401bb99ad6dSBen Warren		e.g.
2402bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
24036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2404bb99ad6dSBen Warren
2405bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2406bb99ad6dSBen Warren
2407bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
24086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2409bb99ad6dSBen Warren
2410bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2411bb99ad6dSBen Warren
24126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2413be5e6181STimur Tabi
2414be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2415be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2416be5e6181STimur Tabi
24176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
24180dc018ecSStefan Roese
24190dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
24200dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
24210dc018ecSStefan Roese
24226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
24230dc018ecSStefan Roese
24240dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
24250dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
24260dc018ecSStefan Roese
24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
24289ebbb54fSVictor Gallardo
24299ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
24309ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
24319ebbb54fSVictor Gallardo		specified DTT device.
24329ebbb54fSVictor Gallardo
24332ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
24342ac6985aSAndrew Dyer
24352ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
24362ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
24372ac6985aSAndrew Dyer		between writing the address pointer and reading the
24382ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
24392ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
24402ac6985aSAndrew Dyer		devices can use either method, but some require one or
24412ac6985aSAndrew Dyer		the other.
2442be5e6181STimur Tabi
2443c609719bSwdenk- SPI Support:	CONFIG_SPI
2444c609719bSwdenk
2445c609719bSwdenk		Enables SPI driver (so far only tested with
2446c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2447c609719bSwdenk		D/As on the SACSng board)
2448c609719bSwdenk
24496639562eSYoshihiro Shimoda		CONFIG_SH_SPI
24506639562eSYoshihiro Shimoda
24516639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
24526639562eSYoshihiro Shimoda		only SH7757 is supported.
24536639562eSYoshihiro Shimoda
2454c609719bSwdenk		CONFIG_SPI_X
2455c609719bSwdenk
2456c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2457c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2458c609719bSwdenk
2459c609719bSwdenk		CONFIG_SOFT_SPI
2460c609719bSwdenk
2461c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2462c609719bSwdenk		using hardware support. This is a general purpose
2463c609719bSwdenk		driver that only requires three general I/O port pins
2464c609719bSwdenk		(two outputs, one input) to function. If this is
2465c609719bSwdenk		defined, the board configuration must define several
2466c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2467c609719bSwdenk		an example, see include/configs/sacsng.h.
2468c609719bSwdenk
246904a9e118SBen Warren		CONFIG_HARD_SPI
247004a9e118SBen Warren
247104a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
247204a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
247304a9e118SBen Warren		must define a list of chip-select function pointers.
247404a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
247504a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
247604a9e118SBen Warren
247738254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
247838254f45SGuennadi Liakhovetski
247938254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
24802e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
248138254f45SGuennadi Liakhovetski
24820133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
24830133502eSMatthias Fuchs
24840133502eSMatthias Fuchs		Enables FPGA subsystem.
24850133502eSMatthias Fuchs
24860133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
24870133502eSMatthias Fuchs
24880133502eSMatthias Fuchs		Enables support for specific chip vendors.
24890133502eSMatthias Fuchs		(ALTERA, XILINX)
24900133502eSMatthias Fuchs
24910133502eSMatthias Fuchs		CONFIG_FPGA_<family>
24920133502eSMatthias Fuchs
24930133502eSMatthias Fuchs		Enables support for FPGA family.
24940133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
24950133502eSMatthias Fuchs
24960133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2497c609719bSwdenk
2498c609719bSwdenk		Specify the number of FPGA devices to support.
2499c609719bSwdenk
25006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2501c609719bSwdenk
2502c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2503c609719bSwdenk
25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2505c609719bSwdenk
2506c609719bSwdenk		Enable checks on FPGA configuration interface busy
2507c609719bSwdenk		status by the configuration function. This option
2508c609719bSwdenk		will require a board or device specific function to
2509c609719bSwdenk		be written.
2510c609719bSwdenk
2511c609719bSwdenk		CONFIG_FPGA_DELAY
2512c609719bSwdenk
2513c609719bSwdenk		If defined, a function that provides delays in the FPGA
2514c609719bSwdenk		configuration driver.
2515c609719bSwdenk
25166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2517c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2518c609719bSwdenk
25196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2520c609719bSwdenk
2521c609719bSwdenk		Check for configuration errors during FPGA bitfile
2522c609719bSwdenk		loading. For example, abort during Virtex II
2523c609719bSwdenk		configuration if the INIT_B line goes low (which
2524c609719bSwdenk		indicated a CRC error).
2525c609719bSwdenk
25266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2527c609719bSwdenk
2528c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2529c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2530c609719bSwdenk		FPGA configuration sequence. The default time is 500
253111ccc33fSMarcel Ziswiler		ms.
2532c609719bSwdenk
25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2534c609719bSwdenk
2535c609719bSwdenk		Maximum time to wait for BUSY to deassert during
253611ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2537c609719bSwdenk
25386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2539c609719bSwdenk
2540c609719bSwdenk		Time to wait after FPGA configuration. The default is
254111ccc33fSMarcel Ziswiler		200 ms.
2542c609719bSwdenk
2543c609719bSwdenk- Configuration Management:
2544c609719bSwdenk		CONFIG_IDENT_STRING
2545c609719bSwdenk
2546c609719bSwdenk		If defined, this string will be added to the U-Boot
2547c609719bSwdenk		version information (U_BOOT_VERSION)
2548c609719bSwdenk
2549c609719bSwdenk- Vendor Parameter Protection:
2550c609719bSwdenk
2551c609719bSwdenk		U-Boot considers the values of the environment
2552c609719bSwdenk		variables "serial#" (Board Serial Number) and
25537152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2554c609719bSwdenk		are set once by the board vendor / manufacturer, and
2555c609719bSwdenk		protects these variables from casual modification by
2556c609719bSwdenk		the user. Once set, these variables are read-only,
2557c609719bSwdenk		and write or delete attempts are rejected. You can
255811ccc33fSMarcel Ziswiler		change this behaviour:
2559c609719bSwdenk
2560c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2561c609719bSwdenk		file, the write protection for vendor parameters is
256247cd00faSwdenk		completely disabled. Anybody can change or delete
2563c609719bSwdenk		these parameters.
2564c609719bSwdenk
2565c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2566c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
256711ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2568c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2569c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2570c609719bSwdenk		read-only.]
2571c609719bSwdenk
25722598090bSJoe Hershberger		The same can be accomplished in a more flexible way
25732598090bSJoe Hershberger		for any variable by configuring the type of access
25742598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
25752598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
25762598090bSJoe Hershberger
2577c609719bSwdenk- Protected RAM:
2578c609719bSwdenk		CONFIG_PRAM
2579c609719bSwdenk
2580c609719bSwdenk		Define this variable to enable the reservation of
2581c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2582c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2583c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2584c609719bSwdenk		this default value by defining an environment
2585c609719bSwdenk		variable "pram" to the number of kB you want to
2586c609719bSwdenk		reserve. Note that the board info structure will
2587c609719bSwdenk		still show the full amount of RAM. If pRAM is
2588c609719bSwdenk		reserved, a new environment variable "mem" will
2589c609719bSwdenk		automatically be defined to hold the amount of
2590c609719bSwdenk		remaining RAM in a form that can be passed as boot
2591c609719bSwdenk		argument to Linux, for instance like that:
2592c609719bSwdenk
2593fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2594c609719bSwdenk			saveenv
2595c609719bSwdenk
2596c609719bSwdenk		This way you can tell Linux not to use this memory,
2597c609719bSwdenk		either, which results in a memory region that will
2598c609719bSwdenk		not be affected by reboots.
2599c609719bSwdenk
2600c609719bSwdenk		*WARNING* If your board configuration uses automatic
2601c609719bSwdenk		detection of the RAM size, you must make sure that
2602c609719bSwdenk		this memory test is non-destructive. So far, the
2603c609719bSwdenk		following board configurations are known to be
2604c609719bSwdenk		"pRAM-clean":
2605c609719bSwdenk
26061b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
26071b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2608544d97e9SWolfgang Denk			FLAGADM, TQM8260
2609c609719bSwdenk
261040fef049SGabe Black- Access to physical memory region (> 4GB)
261140fef049SGabe Black		Some basic support is provided for operations on memory not
261240fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
261340fef049SGabe Black		support access to more than 4GB of memory on 32-bit
261440fef049SGabe Black		machines using physical address extension or similar.
261540fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
261640fef049SGabe Black		currently only supports clearing the memory.
261740fef049SGabe Black
2618c609719bSwdenk- Error Recovery:
2619c609719bSwdenk		CONFIG_PANIC_HANG
2620c609719bSwdenk
2621c609719bSwdenk		Define this variable to stop the system in case of a
2622c609719bSwdenk		fatal error, so that you have to reset it manually.
2623c609719bSwdenk		This is probably NOT a good idea for an embedded
262411ccc33fSMarcel Ziswiler		system where you want the system to reboot
2625c609719bSwdenk		automatically as fast as possible, but it may be
2626c609719bSwdenk		useful during development since you can try to debug
2627c609719bSwdenk		the conditions that lead to the situation.
2628c609719bSwdenk
2629c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2630c609719bSwdenk
2631c609719bSwdenk		This variable defines the number of retries for
2632c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2633c609719bSwdenk		before giving up the operation. If not defined, a
2634c609719bSwdenk		default value of 5 is used.
2635c609719bSwdenk
263640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
263740cb90eeSGuennadi Liakhovetski
263840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
263940cb90eeSGuennadi Liakhovetski
264048a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
264148a3e999STetsuyuki Kobayashi
264248a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
264348a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
264448a3e999STetsuyuki Kobayashi		try longer timeout such as
264548a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
264648a3e999STetsuyuki Kobayashi
2647c609719bSwdenk- Command Interpreter:
26488078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
264904a85b3bSwdenk
265004a85b3bSwdenk		Enable auto completion of commands using TAB.
265104a85b3bSwdenk
26528078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
26538078f1a5SWolfgang Denk		for the "hush" shell.
26548078f1a5SWolfgang Denk
26558078f1a5SWolfgang Denk
26566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2657c609719bSwdenk
2658c609719bSwdenk		Define this variable to enable the "hush" shell (from
2659c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2660c609719bSwdenk		powerful command line syntax like
2661c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2662c609719bSwdenk		constructs ("shell scripts").
2663c609719bSwdenk
2664c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2665c609719bSwdenk		with a somewhat smaller memory footprint.
2666c609719bSwdenk
2667c609719bSwdenk
26686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2669c609719bSwdenk
2670c609719bSwdenk		This defines the secondary prompt string, which is
2671c609719bSwdenk		printed when the command interpreter needs more input
2672c609719bSwdenk		to complete a command. Usually "> ".
2673c609719bSwdenk
2674c609719bSwdenk	Note:
2675c609719bSwdenk
2676c609719bSwdenk		In the current implementation, the local variables
2677c609719bSwdenk		space and global environment variables space are
2678c609719bSwdenk		separated. Local variables are those you define by
26793b57fe0aSwdenk		simply typing `name=value'. To access a local
2680c609719bSwdenk		variable later on, you have write `$name' or
26813b57fe0aSwdenk		`${name}'; to execute the contents of a variable
26823b57fe0aSwdenk		directly type `$name' at the command prompt.
2683c609719bSwdenk
2684c609719bSwdenk		Global environment variables are those you use
2685c609719bSwdenk		setenv/printenv to work with. To run a command stored
2686c609719bSwdenk		in such a variable, you need to use the run command,
2687c609719bSwdenk		and you must not use the '$' sign to access them.
2688c609719bSwdenk
2689c609719bSwdenk		To store commands and special characters in a
2690c609719bSwdenk		variable, please use double quotation marks
2691c609719bSwdenk		surrounding the whole text of the variable, instead
2692c609719bSwdenk		of the backslashes before semicolons and special
2693c609719bSwdenk		symbols.
2694c609719bSwdenk
2695aa0c71acSWolfgang Denk- Commandline Editing and History:
2696aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2697aa0c71acSWolfgang Denk
269811ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2699aa0c71acSWolfgang Denk		commandline input operations
2700aa0c71acSWolfgang Denk
2701a8c7c708Swdenk- Default Environment:
2702c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2703c609719bSwdenk
2704c609719bSwdenk		Define this to contain any number of null terminated
2705c609719bSwdenk		strings (variable = value pairs) that will be part of
27067152b1d0Swdenk		the default environment compiled into the boot image.
27072262cfeeSwdenk
2708c609719bSwdenk		For example, place something like this in your
2709c609719bSwdenk		board's config file:
2710c609719bSwdenk
2711c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2712c609719bSwdenk			"myvar1=value1\0" \
2713c609719bSwdenk			"myvar2=value2\0"
2714c609719bSwdenk
2715c609719bSwdenk		Warning: This method is based on knowledge about the
2716c609719bSwdenk		internal format how the environment is stored by the
27172262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2718c609719bSwdenk		interface! Although it is unlikely that this format
27197152b1d0Swdenk		will change soon, there is no guarantee either.
2720c609719bSwdenk		You better know what you are doing here.
2721c609719bSwdenk
2722c609719bSwdenk		Note: overly (ab)use of the default environment is
2723c609719bSwdenk		discouraged. Make sure to check other ways to preset
272474de7aefSWolfgang Denk		the environment like the "source" command or the
2725c609719bSwdenk		boot command first.
2726c609719bSwdenk
27275e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
27285e724ca2SStephen Warren
27295e724ca2SStephen Warren		Define this in order to add variables describing the
27305e724ca2SStephen Warren		U-Boot build configuration to the default environment.
27315e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
27325e724ca2SStephen Warren
27335e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
27345e724ca2SStephen Warren
27355e724ca2SStephen Warren		- CONFIG_SYS_ARCH
27365e724ca2SStephen Warren		- CONFIG_SYS_CPU
27375e724ca2SStephen Warren		- CONFIG_SYS_BOARD
27385e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
27395e724ca2SStephen Warren		- CONFIG_SYS_SOC
27405e724ca2SStephen Warren
27417e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
27427e27f89fSTom Rini
27437e27f89fSTom Rini		Define this in order to add variables describing certain
27447e27f89fSTom Rini		run-time determined information about the hardware to the
27457e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
27467e27f89fSTom Rini
274706fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
274806fd8538SSimon Glass
274906fd8538SSimon Glass		Normally the environment is loaded when the board is
275006fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
275106fd8538SSimon Glass		that so that the environment is not available until
275206fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
275306fd8538SSimon Glass		this is instead controlled by the value of
275406fd8538SSimon Glass		/config/load-environment.
275506fd8538SSimon Glass
2756a8c7c708Swdenk- DataFlash Support:
27572abbe075Swdenk		CONFIG_HAS_DATAFLASH
27582abbe075Swdenk
27592abbe075Swdenk		Defining this option enables DataFlash features and
27602abbe075Swdenk		allows to read/write in Dataflash via the standard
27612abbe075Swdenk		commands cp, md...
27622abbe075Swdenk
2763f61ec45eSEric Nelson- Serial Flash support
2764f61ec45eSEric Nelson		CONFIG_CMD_SF
2765f61ec45eSEric Nelson
2766f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2767f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2768f61ec45eSEric Nelson
2769f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2770f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2771f61ec45eSEric Nelson		commands.
2772f61ec45eSEric Nelson
2773f61ec45eSEric Nelson		The following defaults may be provided by the platform
2774f61ec45eSEric Nelson		to handle the common case when only a single serial
2775f61ec45eSEric Nelson		flash is present on the system.
2776f61ec45eSEric Nelson
2777f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2778f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2779f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2780f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2781f61ec45eSEric Nelson
278224007273SSimon Glass		CONFIG_CMD_SF_TEST
278324007273SSimon Glass
278424007273SSimon Glass		Define this option to include a destructive SPI flash
278524007273SSimon Glass		test ('sf test').
278624007273SSimon Glass
27871dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
27881dcd6d03SJagannadha Sutradharudu Teki
27891dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
27901dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
27911dcd6d03SJagannadha Sutradharudu Teki
2792b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2793b902e07cSJagannadha Sutradharudu Teki
2794b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2795b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2796b902e07cSJagannadha Sutradharudu Teki		currently Xilinx Zynq qspi support these type of connections.
2797b902e07cSJagannadha Sutradharudu Teki
27983f85ce27Swdenk- SystemACE Support:
27993f85ce27Swdenk		CONFIG_SYSTEMACE
28003f85ce27Swdenk
28013f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
28023f85ce27Swdenk		chips attached via some sort of local bus. The address
280311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
28046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
28053f85ce27Swdenk
28063f85ce27Swdenk		#define CONFIG_SYSTEMACE
28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
28083f85ce27Swdenk
28093f85ce27Swdenk		When SystemACE support is added, the "ace" device type
28103f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
28113f85ce27Swdenk
2812ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2813ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2814ecb0ccd9SWolfgang Denk
281528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2816ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
281728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2818ecb0ccd9SWolfgang Denk		number generator is used.
2819ecb0ccd9SWolfgang Denk
282028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
282128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
282228cb9375SWolfgang Denk		defined, the normal port 69 is used.
282328cb9375SWolfgang Denk
282428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2825ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2826ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2827ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2828ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2829ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2830ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2831ecb0ccd9SWolfgang Denk
2832bf36c5d5SSimon Glass- Hashing support:
2833bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2834bf36c5d5SSimon Glass
2835bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2836bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2837bf36c5d5SSimon Glass
2838bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2839bf36c5d5SSimon Glass
2840bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2841bf36c5d5SSimon Glass		size a little.
2842bf36c5d5SSimon Glass
2843bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2844bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2845bf36c5d5SSimon Glass
2846bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2847bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2848bf36c5d5SSimon Glass
2849a11f1873SRobert Winkler- Freescale i.MX specific commands:
2850a11f1873SRobert Winkler		CONFIG_CMD_HDMIDETECT
2851a11f1873SRobert Winkler		This enables 'hdmidet' command which returns true if an
2852a11f1873SRobert Winkler		HDMI monitor is detected.  This command is i.MX 6 specific.
2853a11f1873SRobert Winkler
2854a11f1873SRobert Winkler		CONFIG_CMD_BMODE
2855a11f1873SRobert Winkler		This enables the 'bmode' (bootmode) command for forcing
2856a11f1873SRobert Winkler		a boot from specific media.
2857a11f1873SRobert Winkler
2858a11f1873SRobert Winkler		This is useful for forcing the ROM's usb downloader to
2859a11f1873SRobert Winkler		activate upon a watchdog reset which is nice when iterating
2860a11f1873SRobert Winkler		on U-Boot.  Using the reset button or running bmode normal
2861a11f1873SRobert Winkler		will set it back to normal.  This command currently
2862a11f1873SRobert Winkler		supports i.MX53 and i.MX6.
2863a11f1873SRobert Winkler
286419c402afSSimon Glass- Signing support:
286519c402afSSimon Glass		CONFIG_RSA
286619c402afSSimon Glass
286719c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
28688bf2aad7SDetlev Zundel		in U-Boot. See doc/uImage.FIT/signature.txt for more information.
286919c402afSSimon Glass
287019c402afSSimon Glass		The signing part is build into mkimage regardless of this
287119c402afSSimon Glass		option.
287219c402afSSimon Glass
28739e50c406SHeiko Schocher- bootcount support:
28749e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
28759e50c406SHeiko Schocher
28769e50c406SHeiko Schocher		This enables the bootcounter support, see:
28779e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
28789e50c406SHeiko Schocher
28799e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
28809e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
28819e50c406SHeiko Schocher		CONFIG_BLACKFIN
28829e50c406SHeiko Schocher		enable special bootcounter support on blackfin based boards.
28839e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
28849e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
28859e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
28869e50c406SHeiko Schocher		enable support for the bootcounter in RAM
28879e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
28889e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
28899e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
28909e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
28919e50c406SHeiko Schocher						    the bootcounter.
28929e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
289319c402afSSimon Glass
2894a8c7c708Swdenk- Show boot progress:
2895c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2896c609719bSwdenk
2897c609719bSwdenk		Defining this option allows to add some board-
2898c609719bSwdenk		specific code (calling a user-provided function
2899c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2900c609719bSwdenk		the system's boot progress on some display (for
2901c609719bSwdenk		example, some LED's) on your board. At the moment,
2902c609719bSwdenk		the following checkpoints are implemented:
2903c609719bSwdenk
29043a608ca0SSimon Glass- Detailed boot stage timing
29053a608ca0SSimon Glass		CONFIG_BOOTSTAGE
29063a608ca0SSimon Glass		Define this option to get detailed timing of each stage
29073a608ca0SSimon Glass		of the boot process.
29083a608ca0SSimon Glass
29093a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
29103a608ca0SSimon Glass		This is the number of available user bootstage records.
29113a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
29123a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
29133a608ca0SSimon Glass		the limit, recording will stop.
29143a608ca0SSimon Glass
29153a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
29163a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
29173a608ca0SSimon Glass
29183a608ca0SSimon Glass		Timer summary in microseconds:
29193a608ca0SSimon Glass		       Mark    Elapsed  Stage
29203a608ca0SSimon Glass			  0          0  reset
29213a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
29223a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
29233a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
29243a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
29253a608ca0SSimon Glass		  3,910,375    250,777  main_loop
29263a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
29273a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
29283a608ca0SSimon Glass
29292eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
29302eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
29312eba38cfSSimon Glass		and un/stashing of bootstage data.
29322eba38cfSSimon Glass
293394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
293494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
293594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
293694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
293794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
293894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
293994fd1316SSimon Glass		For example:
294094fd1316SSimon Glass
294194fd1316SSimon Glass		bootstage {
294294fd1316SSimon Glass			154 {
294394fd1316SSimon Glass				name = "board_init_f";
294494fd1316SSimon Glass				mark = <3575678>;
294594fd1316SSimon Glass			};
294694fd1316SSimon Glass			170 {
294794fd1316SSimon Glass				name = "lcd";
294894fd1316SSimon Glass				accum = <33482>;
294994fd1316SSimon Glass			};
295094fd1316SSimon Glass		};
295194fd1316SSimon Glass
295294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
295394fd1316SSimon Glass
29541372cce2SMarian BalakowiczLegacy uImage format:
29551372cce2SMarian Balakowicz
2956c609719bSwdenk  Arg	Where			When
2957c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2958c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2959c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2960c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2961c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2962c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2963c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2964c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2965c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
29661372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2967c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2968c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2969c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2970c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
29711372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2972c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
29731372cce2SMarian Balakowicz
29741372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
29751372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
29761372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
29771372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
29781372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
29791372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
29801372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
298111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
29821372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
29831372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
29841372cce2SMarian Balakowicz
2985ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2986c609719bSwdenk
2987a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
298863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
298963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
299063e73c9aSwdenk
2991566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2992566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2993566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2994566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2995566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2996566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2997566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2998566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2999566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
3000566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
3001566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
3002566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
3003566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
3004566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
3005566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
3006566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
3007566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
3008566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
3009566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
3010566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
3011566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
3012566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
3013566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
3014566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
3015566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
3016566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
3017566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
3018566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
3019566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
3020566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
3021566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
3022566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
3023566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
3024566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
3025566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
3026566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
3027566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
3028566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
3029566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
3030566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
3031566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
3032566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
3033566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
3034566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
3035566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
3036566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
3037566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
3038c609719bSwdenk
3039566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
3040c609719bSwdenk
3041566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
3042566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
3043566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
3044206c60cbSwdenk
3045566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
3046566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
304711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
3048566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
3049566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
3050566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
305174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
305274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
3053566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
3054c609719bSwdenk
30551372cce2SMarian BalakowiczFIT uImage format:
30561372cce2SMarian Balakowicz
30571372cce2SMarian Balakowicz  Arg	Where			When
30581372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
30591372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
30601372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
30611372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
30621372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
30631372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3064f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
30651372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
30661372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
30671372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
30681372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
30691372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
307011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
307111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
30721372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
30731372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
30741372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
30751372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
30761372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
30771372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
30781372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
30791372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
30801372cce2SMarian Balakowicz
30811372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
30821372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
30831372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
308411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
30851372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
30861372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
30871372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
30881372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
30891372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
30901372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
30911372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
30921372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
30931372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
30941372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
30951372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
30961372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
30971372cce2SMarian Balakowicz
309811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
30991372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
31001372cce2SMarian Balakowicz
310111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
31021372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
31031372cce2SMarian Balakowicz
310411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
31051372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
31061372cce2SMarian Balakowicz
3107d95f6ec7SGabe Black- FIT image support:
3108d95f6ec7SGabe Black		CONFIG_FIT
3109d95f6ec7SGabe Black		Enable support for the FIT uImage format.
3110d95f6ec7SGabe Black
3111d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
3112d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
3113d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
3114d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
3115d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
3116d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
3117d95f6ec7SGabe Black
31183e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
31193e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
31203e569a6bSSimon Glass		using a hash signed and verified using RSA. See
31213e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
31223e569a6bSSimon Glass
31234cf2609bSWolfgang Denk- Standalone program support:
31244cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
31254cf2609bSWolfgang Denk
31266feff899SWolfgang Denk		This option defines a board specific value for the
31276feff899SWolfgang Denk		address where standalone program gets loaded, thus
31286feff899SWolfgang Denk		overwriting the architecture dependent default
31294cf2609bSWolfgang Denk		settings.
31304cf2609bSWolfgang Denk
31314cf2609bSWolfgang Denk- Frame Buffer Address:
31324cf2609bSWolfgang Denk		CONFIG_FB_ADDR
31334cf2609bSWolfgang Denk
31344cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
313544a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
313644a53b57SWolfgang Denk		when using a graphics controller has separate video
313744a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
313844a53b57SWolfgang Denk		the given address instead of dynamically reserving it
313944a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
314044a53b57SWolfgang Denk		the memory for the frame buffer depending on the
314144a53b57SWolfgang Denk		configured panel size.
31424cf2609bSWolfgang Denk
31434cf2609bSWolfgang Denk		Please see board_init_f function.
31444cf2609bSWolfgang Denk
3145cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
3146cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
3147cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
3148cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
3149cccfc2abSDetlev Zundel
3150cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
3151cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
3152cccfc2abSDetlev Zundel
3153cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
3154cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
3155cccfc2abSDetlev Zundel
3156cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
3157cccfc2abSDetlev Zundel		Needed for mtdparts command support.
3158cccfc2abSDetlev Zundel
3159cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
3160cccfc2abSDetlev Zundel
3161cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
3162cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
3163cccfc2abSDetlev Zundel
316470c219cdSJoe Hershberger- UBI support
316570c219cdSJoe Hershberger		CONFIG_CMD_UBI
316670c219cdSJoe Hershberger
316770c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
316870c219cdSJoe Hershberger		with the UBI flash translation layer
316970c219cdSJoe Hershberger
317070c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
317170c219cdSJoe Hershberger
3172147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
3173147162daSJoe Hershberger
3174147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
3175147162daSJoe Hershberger		warnings and errors enabled.
3176147162daSJoe Hershberger
317770c219cdSJoe Hershberger- UBIFS support
317870c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
317970c219cdSJoe Hershberger
318070c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
318170c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
318270c219cdSJoe Hershberger
318370c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
318470c219cdSJoe Hershberger
3185147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
3186147162daSJoe Hershberger
3187147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
3188147162daSJoe Hershberger		warnings and errors enabled.
3189147162daSJoe Hershberger
31906a11cf48SDaniel Schwierzeck- SPL framework
31916a11cf48SDaniel Schwierzeck		CONFIG_SPL
31926a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
31936a11cf48SDaniel Schwierzeck
319495579793STom Rini		CONFIG_SPL_LDSCRIPT
319595579793STom Rini		LDSCRIPT for linking the SPL binary.
319695579793STom Rini
31976ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
31986ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
31996ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
32006ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
32018960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32026ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
32036ebc3461SAlbert ARIBAUD
320495579793STom Rini		CONFIG_SPL_MAX_SIZE
32056ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
32066ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
32076ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
32086ebc3461SAlbert ARIBAUD		not exceed it.
320995579793STom Rini
32106a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
32116a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
32126a11cf48SDaniel Schwierzeck
321394a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
321494a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
321594a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
321694a45bb1SScott Wood
321795579793STom Rini		CONFIG_SPL_BSS_START_ADDR
321895579793STom Rini		Link address for the BSS within the SPL binary.
321995579793STom Rini
322095579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
32216ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
32226ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
32236ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
32248960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
32256ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
322695579793STom Rini
322795579793STom Rini		CONFIG_SPL_STACK
322895579793STom Rini		Adress of the start of the stack SPL will use
322995579793STom Rini
323094a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
323194a45bb1SScott Wood		Adress of the start of the stack SPL will use after
323294a45bb1SScott Wood		relocation.  If unspecified, this is equal to
323394a45bb1SScott Wood		CONFIG_SPL_STACK.
323494a45bb1SScott Wood
323595579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
323695579793STom Rini		Starting address of the malloc pool used in SPL.
323795579793STom Rini
323895579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
323995579793STom Rini		The size of the malloc pool used in SPL.
32406a11cf48SDaniel Schwierzeck
324147f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
324247f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
324347f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
324447f7bcaeSTom Rini		NAND loading of the Linux Kernel.
324547f7bcaeSTom Rini
3246861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3247861a86f4STom Rini		For ARM, enable an optional function to print more information
3248861a86f4STom Rini		about the running system.
3249861a86f4STom Rini
32504b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
32514b919725SScott Wood		Arch init code should be built for a very small image
32524b919725SScott Wood
32536a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
32546a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
32556a11cf48SDaniel Schwierzeck
32566a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
32576a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
32586a11cf48SDaniel Schwierzeck
32596a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
32606a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
32616a11cf48SDaniel Schwierzeck
32626a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
32636a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
32646a11cf48SDaniel Schwierzeck
32656a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
32666a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
32676a11cf48SDaniel Schwierzeck
326895579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
326995579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
327095579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
327195579793STom Rini		Address, size and partition on the MMC to load U-Boot from
327295579793STom Rini		when the MMC is being used in raw mode.
327395579793STom Rini
32742b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
32752b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
32762b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
32772b75b0adSPeter Korsgaard
32782b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
32792b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
32802b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
32812b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
32822b75b0adSPeter Korsgaard		(for falcon mode)
32832b75b0adSPeter Korsgaard
328495579793STom Rini		CONFIG_SPL_FAT_SUPPORT
328595579793STom Rini		Support for fs/fat/libfat.o in SPL binary
328695579793STom Rini
328795579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
328895579793STom Rini		Filename to read to load U-Boot when reading from FAT
328995579793STom Rini
32907ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
32917ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
32927ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
32937ad2cc79SPeter Korsgaard
32947ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
32957ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
32967ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
32977ad2cc79SPeter Korsgaard
329806f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
329906f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
330006f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
330106f60ae3SScott Wood		continuing (the hardware starts execution after just
330206f60ae3SScott Wood		loading the first page rather than the full 4K).
330306f60ae3SScott Wood
33046f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
33056f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
33066f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
33076f2f01b9SScott Wood
33086f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
33096f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
33106f2f01b9SScott Wood
33116f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
33126f2f01b9SScott Wood		Include standard software ECC in the SPL
33136f2f01b9SScott Wood
331495579793STom Rini		CONFIG_SPL_NAND_SIMPLE
33157d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
33167d4b7955SScott Wood		expose the cmd_ctrl() interface.
331795579793STom Rini
3318bb0dc108SYing Zhang		CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3319bb0dc108SYing Zhang		Set for the SPL on PPC mpc8xxx targets, support for
33205614e71bSYork Sun		drivers/ddr/fsl/libddr.o in SPL binary.
3321bb0dc108SYing Zhang
33227c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
33237c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
33247c8eea59SYing Zhang		SPL binary.
33257c8eea59SYing Zhang
332695579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
332795579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
332895579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
332995579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
333095579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
333195579793STom Rini		Defines the size and behavior of the NAND that SPL uses
33327d4b7955SScott Wood		to read U-Boot
333395579793STom Rini
3334fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3335fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3336fbe76ae4SPrabhakar Kushwaha
333795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
33387d4b7955SScott Wood		Location in NAND to read U-Boot from
33397d4b7955SScott Wood
33407d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
33417d4b7955SScott Wood		Location in memory to load U-Boot to
33427d4b7955SScott Wood
33437d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
33447d4b7955SScott Wood		Size of image to load
334595579793STom Rini
334695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
33477d4b7955SScott Wood		Entry point in loaded image to jump to
334895579793STom Rini
334995579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
335095579793STom Rini		Define this if you need to first read the OOB and then the
335195579793STom Rini		data. This is used for example on davinci plattforms.
335295579793STom Rini
335395579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
335495579793STom Rini		Support for an OMAP3-specific set of functions to return the
335595579793STom Rini		ID and MFR of the first attached NAND chip, if present.
335695579793STom Rini
33576a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
33586a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
33596a11cf48SDaniel Schwierzeck
33606a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
33616a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
33626a11cf48SDaniel Schwierzeck
33636a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
33646a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
33656a11cf48SDaniel Schwierzeck
3366c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3367c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3368c57b953dSPavel Machek
33696a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
33706a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
33711372cce2SMarian Balakowicz
3372ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3373ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3374ba1bee43SYing Zhang
3375ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3376ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3377ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3378ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3379ba1bee43SYing Zhang
338074752baaSScott Wood		CONFIG_SPL_PAD_TO
33816113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
33826113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
33836113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
33846113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
33856113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
338674752baaSScott Wood
3387ca2fca22SScott Wood		CONFIG_SPL_TARGET
3388ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3389ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3390ca2fca22SScott Wood		example if more than one image needs to be produced.
3391ca2fca22SScott Wood
339287ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
339387ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
339487ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
339587ebee39SSimon Glass		option to re-enable it. This will affect the output of the
339687ebee39SSimon Glass		bootm command when booting a FIT image.
339787ebee39SSimon Glass
33983aa29de0SYing Zhang- TPL framework
33993aa29de0SYing Zhang		CONFIG_TPL
34003aa29de0SYing Zhang		Enable building of TPL globally.
34013aa29de0SYing Zhang
34023aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
34033aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
34043aa29de0SYing Zhang		the TPL payload. By default, this is defined as
34053aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
34063aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
34073aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
34083aa29de0SYing Zhang
3409c609719bSwdenkModem Support:
3410c609719bSwdenk--------------
3411c609719bSwdenk
3412566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3413c609719bSwdenk
341411ccc33fSMarcel Ziswiler- Modem support enable:
3415c609719bSwdenk		CONFIG_MODEM_SUPPORT
3416c609719bSwdenk
3417c609719bSwdenk- RTS/CTS Flow control enable:
3418c609719bSwdenk		CONFIG_HWFLOW
3419c609719bSwdenk
3420c609719bSwdenk- Modem debug support:
3421c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3422c609719bSwdenk
3423c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3424c609719bSwdenk		for modem support. Useful only with BDI2000.
3425c609719bSwdenk
3426a8c7c708Swdenk- Interrupt support (PPC):
3427a8c7c708Swdenk
3428a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3429a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
343011ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3431a8c7c708Swdenk		should set decrementer_count to appropriate value. If
343211ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3433a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
343411ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3435a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3436a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3437a8c7c708Swdenk		general timer_interrupt().
3438a8c7c708Swdenk
3439c609719bSwdenk- General:
3440c609719bSwdenk
3441c609719bSwdenk		In the target system modem support is enabled when a
3442c609719bSwdenk		specific key (key combination) is pressed during
3443c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
344411ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3445c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3446c609719bSwdenk		function, returning 1 and thus enabling modem
3447c609719bSwdenk		initialization.
3448c609719bSwdenk
3449c609719bSwdenk		If there are no modem init strings in the
3450c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3451c609719bSwdenk		previous output (banner, info printfs) will be
345211ccc33fSMarcel Ziswiler		suppressed, though.
3453c609719bSwdenk
3454c609719bSwdenk		See also: doc/README.Modem
3455c609719bSwdenk
34569660e442SHelmut RaigerBoard initialization settings:
34579660e442SHelmut Raiger------------------------------
34589660e442SHelmut Raiger
34599660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
34609660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
34619660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
34629660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
34639660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
34649660e442SHelmut Raigertypically in board_init_f() and board_init_r().
34659660e442SHelmut Raiger
34669660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
34679660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
34689660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
34699660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3470c609719bSwdenk
3471c609719bSwdenkConfiguration Settings:
3472c609719bSwdenk-----------------------
3473c609719bSwdenk
34744d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
34754d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
34764d1fd7f1SYork Sun
34776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3478c609719bSwdenk		undefine this when you're short of memory.
3479c609719bSwdenk
34802fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
34812fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
34822fb2604dSPeter Tyser
34836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3484c609719bSwdenk		prompt for user input.
3485c609719bSwdenk
34866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3487c609719bSwdenk
34886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3489c609719bSwdenk
34906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3491c609719bSwdenk
34926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3493c609719bSwdenk		the application (usually a Linux kernel) when it is
3494c609719bSwdenk		booted
3495c609719bSwdenk
34966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3497c609719bSwdenk		List of legal baudrate settings for this board.
3498c609719bSwdenk
34996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3500c609719bSwdenk		Suppress display of console information at boot.
3501c609719bSwdenk
35026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3503c609719bSwdenk		If the board specific function
3504c609719bSwdenk			extern int overwrite_console (void);
3505c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3506c609719bSwdenk		serial port, else the settings in the environment are used.
3507c609719bSwdenk
35086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3509c609719bSwdenk		Enable the call to overwrite_console().
3510c609719bSwdenk
35116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3512c609719bSwdenk		Enable overwrite of previous console environment settings.
3513c609719bSwdenk
35146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3515c609719bSwdenk		Begin and End addresses of the area used by the
3516c609719bSwdenk		simple memory test.
3517c609719bSwdenk
35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3519c609719bSwdenk		Enable an alternate, more extensive memory test.
3520c609719bSwdenk
35216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
35225f535fe1Swdenk		Scratch address used by the alternate memory test
35235f535fe1Swdenk		You only need to set this if address zero isn't writeable
35245f535fe1Swdenk
35256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
352714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
352811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
352914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
353014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
353114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
35325e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
353314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
35345e12e75dSStefan Roese		will have to get fixed in Linux additionally.
353514f73ca6SStefan Roese
353614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
353714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
353814f73ca6SStefan Roese		be touched.
353914f73ca6SStefan Roese
354014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
354114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
354214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
354314f73ca6SStefan Roese		non page size aligned address and this could cause major
354414f73ca6SStefan Roese		problems.
354514f73ca6SStefan Roese
35466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3547c609719bSwdenk		Enable temporary baudrate change while serial download
3548c609719bSwdenk
35496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3550c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3551c609719bSwdenk
35526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3553c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3554c609719bSwdenk		Cogent motherboard)
3555c609719bSwdenk
35566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3557c609719bSwdenk		Physical start address of Flash memory.
3558c609719bSwdenk
35596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3560c609719bSwdenk		Physical start address of boot monitor code (set by
3561c609719bSwdenk		make config files to be same as the text base address
356214d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
35636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3564c609719bSwdenk
35656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
35663b57fe0aSwdenk		Size of memory reserved for monitor code, used to
35673b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
35683b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
35693b57fe0aSwdenk		flash sector.
3570c609719bSwdenk
35716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3572c609719bSwdenk		Size of DRAM reserved for malloc() use.
3573c609719bSwdenk
35746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
357515940c9aSStefan Roese		Normally compressed uImages are limited to an
357615940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
35776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
357815940c9aSStefan Roese		to adjust this setting to your needs.
3579c609719bSwdenk
35806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3581c609719bSwdenk		Maximum size of memory mapped by the startup code of
3582c609719bSwdenk		the Linux kernel; all data that must be processed by
35837d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
35847d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
35851bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
35867d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3587c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3588c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3589c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3590c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3591c609719bSwdenk
3592fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3593fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3594fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3595fca43cc8SJohn Rigby		is enabled.
3596fca43cc8SJohn Rigby
3597fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3598fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3599fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3600fca43cc8SJohn Rigby
3601fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3602fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3603fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3604fca43cc8SJohn Rigby
36056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3606c609719bSwdenk		Max number of Flash memory banks
3607c609719bSwdenk
36086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3609c609719bSwdenk		Max number of sectors on a Flash chip
3610c609719bSwdenk
36116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3612c609719bSwdenk		Timeout for Flash erase operations (in ms)
3613c609719bSwdenk
36146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3615c609719bSwdenk		Timeout for Flash write operations (in ms)
3616c609719bSwdenk
36176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
36188564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
36198564acf9Swdenk
36206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
36218564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
36228564acf9Swdenk
36236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
36248564acf9Swdenk		If defined, hardware flash sectors protection is used
36258564acf9Swdenk		instead of U-Boot software protection.
36268564acf9Swdenk
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3628c609719bSwdenk
3629c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3630c609719bSwdenk		without this option such a download has to be
3631c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3632c609719bSwdenk		copy from RAM to flash.
3633c609719bSwdenk
3634c609719bSwdenk		The two-step approach is usually more reliable, since
3635c609719bSwdenk		you can check if the download worked before you erase
363611ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
363711ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3638c609719bSwdenk		downloaded image) this option may be very useful.
3639c609719bSwdenk
36406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3641c609719bSwdenk		Define if the flash driver uses extra elements in the
36425653fc33Swdenk		common flash structure for storing flash geometry.
36435653fc33Swdenk
364400b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
36455653fc33Swdenk		This option also enables the building of the cfi_flash driver
36465653fc33Swdenk		in the drivers directory
364753cf9435Sstroese
364891809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
364991809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
365091809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
365191809ed5SPiotr Ziecik		to the MTD layer.
365291809ed5SPiotr Ziecik
36536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
365496ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
365596ef831fSGuennadi Liakhovetski
365696ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
365796ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
365896ef831fSGuennadi Liakhovetski		write commands.
365996ef831fSGuennadi Liakhovetski
36606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
36615568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
36625568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
36635568e613SStefan Roese		is useful, if some of the configured banks are only
36645568e613SStefan Roese		optionally available.
36655568e613SStefan Roese
36669a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
36679a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
36689a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
36699a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
36709a042e9cSJerry Van Baren
3671352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3672352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3673352ef3f1SStefan Roese		against the source after the write operation. An error message
3674352ef3f1SStefan Roese		will be printed when the contents are not identical.
3675352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3676352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3677352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3678352ef3f1SStefan Roese		this option if you really know what you are doing.
3679352ef3f1SStefan Roese
36806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
368111ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
368211ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
368353cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
368453cf9435Sstroese		buffers can be full shortly after enabling the interface
368511ccc33fSMarcel Ziswiler		on high Ethernet traffic.
368653cf9435Sstroese		Defaults to 4 if not defined.
3687c609719bSwdenk
3688ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3689ea882bafSWolfgang Denk
3690ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3691ea882bafSWolfgang Denk	internally to store the environment settings. The default
3692ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3693ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3694ea882bafSWolfgang Denk	lib/hashtable.c for details.
3695ea882bafSWolfgang Denk
36962598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
36972598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
36981bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
36992598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
37002598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
37012598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
37022598090bSJoe Hershberger
37032598090bSJoe Hershberger	The format of the list is:
37042598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3705267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3706267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
37072598090bSJoe Hershberger		entry = variable_name[:attributes]
37082598090bSJoe Hershberger		list = entry[,list]
37092598090bSJoe Hershberger
37102598090bSJoe Hershberger	The type attributes are:
37112598090bSJoe Hershberger		s - String (default)
37122598090bSJoe Hershberger		d - Decimal
37132598090bSJoe Hershberger		x - Hexadecimal
37142598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
37152598090bSJoe Hershberger		i - IP address
37162598090bSJoe Hershberger		m - MAC address
37172598090bSJoe Hershberger
3718267541f7SJoe Hershberger	The access attributes are:
3719267541f7SJoe Hershberger		a - Any (default)
3720267541f7SJoe Hershberger		r - Read-only
3721267541f7SJoe Hershberger		o - Write-once
3722267541f7SJoe Hershberger		c - Change-default
3723267541f7SJoe Hershberger
37242598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
37252598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
37262598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
37272598090bSJoe Hershberger
37282598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
37292598090bSJoe Hershberger		Define this to a list (string) to define validation that
37302598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
37312598090bSJoe Hershberger		environment variable.  To override a setting in the static
37322598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
37332598090bSJoe Hershberger		".flags" variable.
37342598090bSJoe Hershberger
3735267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3736267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3737267541f7SJoe Hershberger	access flags.
3738267541f7SJoe Hershberger
37395c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
37405c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
37415c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
37425c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
37435c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
37445c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
37455c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
37465c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
37475c1a7ea6SSimon Glass	your board please report the problem and send patches!
37485c1a7ea6SSimon Glass
37490b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
37500b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
37510b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
37520b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3753632efa74SSimon Glass
3754c609719bSwdenkThe following definitions that deal with the placement and management
3755c609719bSwdenkof environment data (variable area); in general, we support the
3756c609719bSwdenkfollowing configurations:
3757c609719bSwdenk
3758c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3759c3eb3fe4SMike Frysinger
3760c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3761c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3762c3eb3fe4SMike Frysinger
37635a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3764c609719bSwdenk
3765c609719bSwdenk	Define this if the environment is in flash memory.
3766c609719bSwdenk
3767c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3768c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3769c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3770c609719bSwdenk	   sector" type flash chips, which have several smaller
3771c609719bSwdenk	   sectors at the start or the end. For instance, such a
3772c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3773c609719bSwdenk	   such a case you would place the environment in one of the
3774c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3775c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3776c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3777c609719bSwdenk	   between U-Boot and the environment.
3778c609719bSwdenk
37790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3780c609719bSwdenk
3781c609719bSwdenk	   Offset of environment data (variable area) to the
3782c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3783c609719bSwdenk	   type flash chips the second sector can be used: the offset
3784c609719bSwdenk	   for this sector is given here.
3785c609719bSwdenk
37866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3787c609719bSwdenk
37880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3789c609719bSwdenk
3790c609719bSwdenk	   This is just another way to specify the start address of
3791c609719bSwdenk	   the flash sector containing the environment (instead of
37920e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3793c609719bSwdenk
37940e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3795c609719bSwdenk
3796c609719bSwdenk	   Size of the sector containing the environment.
3797c609719bSwdenk
3798c609719bSwdenk
3799c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3800c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3801c609719bSwdenk	   the environment.
3802c609719bSwdenk
38030e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3804c609719bSwdenk
38055a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
38060e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3807c609719bSwdenk	   of this flash sector for the environment. This saves
3808c609719bSwdenk	   memory for the RAM copy of the environment.
3809c609719bSwdenk
3810c609719bSwdenk	   It may also save flash memory if you decide to use this
3811c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3812c609719bSwdenk	   since then the remainder of the flash sector could be used
3813c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3814c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3815c609719bSwdenk	   updating the environment in flash makes it always
3816c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3817c609719bSwdenk	   wrong before the contents has been restored from a copy in
3818c609719bSwdenk	   RAM, your target system will be dead.
3819c609719bSwdenk
38200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
38210e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3822c609719bSwdenk
3823c609719bSwdenk	   These settings describe a second storage area used to hold
382411ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
38253e38691eSwdenk	   a valid backup copy in case there is a power failure during
3826c609719bSwdenk	   a "saveenv" operation.
3827c609719bSwdenk
3828c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3829c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3830c609719bSwdenkaccordingly!
3831c609719bSwdenk
3832c609719bSwdenk
38339314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3834c609719bSwdenk
3835c609719bSwdenk	Define this if you have some non-volatile memory device
3836c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3837c609719bSwdenk	environment.
3838c609719bSwdenk
38390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
38400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3841c609719bSwdenk
384211ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3843c609719bSwdenk	  want to use for environment. It is assumed that this memory
3844c609719bSwdenk	  can just be read and written to, without any special
3845c609719bSwdenk	  provision.
3846c609719bSwdenk
3847c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3848c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
384911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3850c609719bSwdenkU-Boot will hang.
3851c609719bSwdenk
3852c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3853c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3854c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3855c609719bSwdenkto save the current settings.
3856c609719bSwdenk
3857c609719bSwdenk
3858bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3859c609719bSwdenk
3860c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3861c609719bSwdenk	device and a driver for it.
3862c609719bSwdenk
38630e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
38640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3865c609719bSwdenk
3866c609719bSwdenk	  These two #defines specify the offset and size of the
3867c609719bSwdenk	  environment area within the total memory of your EEPROM.
3868c609719bSwdenk
38696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3870c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3871c609719bSwdenk	  The default address is zero.
3872c609719bSwdenk
38736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3874c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3875c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3876c609719bSwdenk	  would require six bits.
3877c609719bSwdenk
38786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3879c609719bSwdenk	  If defined, the number of milliseconds to delay between
3880c609719bSwdenk	  page writes.	The default is zero milliseconds.
3881c609719bSwdenk
38826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3883c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3884c609719bSwdenk	  that this is NOT the chip address length!
3885c609719bSwdenk
38866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
38875cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
38885cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
38895cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
38905cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
38915cf91d6bSwdenk	  byte chips.
38925cf91d6bSwdenk
38935cf91d6bSwdenk	  Note that we consider the length of the address field to
38945cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
38955cf91d6bSwdenk	  in the chip address.
38965cf91d6bSwdenk
38976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3898c609719bSwdenk	  The size in bytes of the EEPROM device.
3899c609719bSwdenk
3900548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3901548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3902548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3903548738b4SHeiko Schocher
3904548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3905548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3906548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3907548738b4SHeiko Schocher	  EEPROM. For example:
3908548738b4SHeiko Schocher
3909ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3910548738b4SHeiko Schocher
3911548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3912548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3913c609719bSwdenk
3914057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
39155779d8d9Swdenk
39165779d8d9Swdenk	Define this if you have a DataFlash memory device which you
39175779d8d9Swdenk	want to use for the environment.
39185779d8d9Swdenk
39190e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
39210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
39225779d8d9Swdenk
39235779d8d9Swdenk	  These three #defines specify the offset and size of the
39245779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
39255779d8d9Swdenk	  at the specified address.
39265779d8d9Swdenk
39270a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
39280a85a9e7SLiu Gang
39290a85a9e7SLiu Gang	Define this if you have a remote memory space which you
39300a85a9e7SLiu Gang	want to use for the local device's environment.
39310a85a9e7SLiu Gang
39320a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
39330a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
39340a85a9e7SLiu Gang
39350a85a9e7SLiu Gang	  These two #defines specify the address and size of the
39360a85a9e7SLiu Gang	  environment area within the remote memory space. The
39370a85a9e7SLiu Gang	  local device can get the environment from remote memory
3938fc54c7faSLiu Gang	  space by SRIO or PCIE links.
39390a85a9e7SLiu Gang
39400a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
39410a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3942fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3943fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
39440a85a9e7SLiu Gang
394551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
394613a5695bSwdenk
394713a5695bSwdenk	Define this if you have a NAND device which you want to use
394813a5695bSwdenk	for the environment.
394913a5695bSwdenk
39500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
39510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
395213a5695bSwdenk
395313a5695bSwdenk	  These two #defines specify the offset and size of the environment
3954fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3955fdd813deSScott Wood	  aligned to an erase block boundary.
39565779d8d9Swdenk
3957fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3958e443c944SMarkus Klotzbuecher
39590e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3960fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3961fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3962fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3963fdd813deSScott Wood	  aligned to an erase block boundary.
3964e443c944SMarkus Klotzbuecher
3965fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3966fdd813deSScott Wood
3967fdd813deSScott Wood	  Specifies the length of the region in which the environment
3968fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3969fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3970fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3971fdd813deSScott Wood	  the range to be avoided.
3972fdd813deSScott Wood
3973fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3974fdd813deSScott Wood
3975fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3976fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3977fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3978fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3979fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3980e443c944SMarkus Klotzbuecher
3981b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3982b74ab737SGuennadi Liakhovetski
3983b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3984b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3985b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3986b74ab737SGuennadi Liakhovetski
39872b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
39882b74433fSJoe Hershberger
39892b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
39902b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
39912b74433fSJoe Hershberger	accesses, which is important on NAND.
39922b74433fSJoe Hershberger
39932b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
39942b74433fSJoe Hershberger
39952b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
39962b74433fSJoe Hershberger
39972b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
39982b74433fSJoe Hershberger
39992b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
40002b74433fSJoe Hershberger	  environment in.
40012b74433fSJoe Hershberger
4002785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
4003785881f7SJoe Hershberger
4004785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
4005785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
4006785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
4007785881f7SJoe Hershberger
40082b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
40092b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
40102b74433fSJoe Hershberger
40112b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
40122b74433fSJoe Hershberger	  when storing the env in UBI.
40132b74433fSJoe Hershberger
401406e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
401506e4ae5fSStephen Warren
401606e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
401706e4ae5fSStephen Warren	environment.
401806e4ae5fSStephen Warren
401906e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
402006e4ae5fSStephen Warren
402106e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
402206e4ae5fSStephen Warren
402306e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
402406e4ae5fSStephen Warren
402506e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
402606e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
402706e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
402806e4ae5fSStephen Warren
402906e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
403006e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
403106e4ae5fSStephen Warren
403206e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
403306e4ae5fSStephen Warren	  area within the specified MMC device.
403406e4ae5fSStephen Warren
40355c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
40365c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
40375c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
40385c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
40395c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
40405c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
40415c088ee8SStephen Warren	  maximum possible space before it, to store other data.
40425c088ee8SStephen Warren
404306e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
404406e4ae5fSStephen Warren	  MMC sector boundary.
404506e4ae5fSStephen Warren
404606e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
404706e4ae5fSStephen Warren
404806e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
404906e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
405006e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
405106e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
405206e4ae5fSStephen Warren
40535c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
40545c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
40555c088ee8SStephen Warren
405606e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
405706e4ae5fSStephen Warren	  an MMC sector boundary.
405806e4ae5fSStephen Warren
405906e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
406006e4ae5fSStephen Warren
406106e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
406206e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
406306e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
406406e4ae5fSStephen Warren
40656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
4066c609719bSwdenk
4067c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
4068c609719bSwdenk	area is used at an early stage (ROM part) if the environment
4069c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
4070c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
4071c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4072c609719bSwdenk	to be a good choice since it makes it far enough from the
4073c609719bSwdenk	start of the data area as well as from the stack pointer.
4074c609719bSwdenk
4075e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
4076c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
4077cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
4078c609719bSwdenkuntil then to read environment variables.
4079c609719bSwdenk
408085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
408185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
408285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
408385ec0bccSwdenknecessary, because the first environment variable we need is the
408485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
408585ec0bccSwdenkhave any device yet where we could complain.]
4086c609719bSwdenk
4087c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
4088c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
408985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
4090c609719bSwdenk
40916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
4092fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
4093fc3e2165Swdenk
40946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
4095fc3e2165Swdenk		      also needs to be defined.
4096fc3e2165Swdenk
40976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
4098fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
4099c609719bSwdenk
4100f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
4101f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
4102f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
4103f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
4104f5675aa5SRon Madrid		space for already greatly restricted images, including but not
4105f5675aa5SRon Madrid		limited to NAND_SPL configurations.
4106f5675aa5SRon Madrid
4107b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
4108b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
4109b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
4110b2b92f53SSimon Glass		to do this.
4111b2b92f53SSimon Glass
4112e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
4113e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
4114e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
4115e2e3e2b1SSimon Glass		present.
4116e2e3e2b1SSimon Glass
4117c609719bSwdenkLow Level (hardware related) configuration options:
4118dc7c9a1aSwdenk---------------------------------------------------
4119c609719bSwdenk
41206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
4121c609719bSwdenk		Cache Line Size of the CPU.
4122c609719bSwdenk
41236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
4124c609719bSwdenk		Default address of the IMMR after system reset.
41252535d602Swdenk
41262535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
41272535d602Swdenk		and RPXsuper) to be able to adjust the position of
41282535d602Swdenk		the IMMR register after a reset.
4129c609719bSwdenk
4130e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
4131e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
4132e46fedfeSTimur Tabi		PowerPC SOCs.
4133e46fedfeSTimur Tabi
4134e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
4135e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
4136e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4137e46fedfeSTimur Tabi
4138e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4139e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
4140e46fedfeSTimur Tabi
4141e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
4142e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
4143e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
4144e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
4145e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
4146e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
4147e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
4148e46fedfeSTimur Tabi
4149e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4150e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4151e46fedfeSTimur Tabi
4152e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4153e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
4154e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4155e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4156e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4157e46fedfeSTimur Tabi
4158e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4159e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
4160e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
4161e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
4162e46fedfeSTimur Tabi
4163e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4164e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4165e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
4166e46fedfeSTimur Tabi
41677f6c2cbcSwdenk- Floppy Disk Support:
41686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
41697f6c2cbcSwdenk
41707f6c2cbcSwdenk		the default drive number (default value 0)
41717f6c2cbcSwdenk
41726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
41737f6c2cbcSwdenk
417411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
41757f6c2cbcSwdenk		(default value 1)
41767f6c2cbcSwdenk
41776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
41787f6c2cbcSwdenk
41797f6c2cbcSwdenk		defines the offset of register from address. It
41807f6c2cbcSwdenk		depends on which part of the data bus is connected to
418111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
41827f6c2cbcSwdenk
41836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
41846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
41857f6c2cbcSwdenk		default value.
41867f6c2cbcSwdenk
41876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
41887f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
41897f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
41907f6c2cbcSwdenk		source code. It is used to make hardware dependant
41917f6c2cbcSwdenk		initializations.
41927f6c2cbcSwdenk
41930abddf82SMacpaul Lin- CONFIG_IDE_AHB:
41940abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
41950abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
41960abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
41970abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
41980abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
41990abddf82SMacpaul Lin		is requierd.
42000abddf82SMacpaul Lin
42016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
420225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
420325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
4204c609719bSwdenk
42056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4206c609719bSwdenk
42077152b1d0Swdenk		Start address of memory area that can be used for
4208c609719bSwdenk		initial data and stack; please note that this must be
4209c609719bSwdenk		writable memory that is working WITHOUT special
4210c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4211c609719bSwdenk		will become available only after programming the
4212c609719bSwdenk		memory controller and running certain initialization
4213c609719bSwdenk		sequences.
4214c609719bSwdenk
4215c609719bSwdenk		U-Boot uses the following memory types:
4216c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4217c609719bSwdenk		- MPC824X: data cache
4218c609719bSwdenk		- PPC4xx:  data cache
4219c609719bSwdenk
42206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4221c609719bSwdenk
4222c609719bSwdenk		Offset of the initial data structure in the memory
42236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
42246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4225c609719bSwdenk		data is located at the end of the available space
4226553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
42276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
42286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
42296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4230c609719bSwdenk
4231c609719bSwdenk	Note:
4232c609719bSwdenk		On the MPC824X (or other systems that use the data
4233c609719bSwdenk		cache for initial memory) the address chosen for
42346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4235c609719bSwdenk		point to an otherwise UNUSED address space between
4236c609719bSwdenk		the top of RAM and the start of the PCI space.
4237c609719bSwdenk
42386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4239c609719bSwdenk
42406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4241c609719bSwdenk
42426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4243c609719bSwdenk
42446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4245c609719bSwdenk
42466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4247c609719bSwdenk
42486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4249c609719bSwdenk
42506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4251c609719bSwdenk		SDRAM timing
4252c609719bSwdenk
42536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4254c609719bSwdenk		periodic timer for refresh
4255c609719bSwdenk
42566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4257c609719bSwdenk
42586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
42596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
42606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
42616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4262c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4263c609719bSwdenk
4264c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
42656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
42666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4267c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4268c609719bSwdenk
42696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
42706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4271c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4272c609719bSwdenk		Prescaler definitions (SDRAM timing)
4273c609719bSwdenk
42746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4275c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4276c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4277c609719bSwdenk
42786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4279b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4280b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4281b423d055SHeiko Schocher
42826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4283c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4284c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4285c609719bSwdenk
42866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4287c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4288c609719bSwdenk		wrong setting might damage your board. Read
4289c609719bSwdenk		doc/README.MBX before setting this variable!
4290c609719bSwdenk
42916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4292ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4293ea909b76Swdenk		(Power On Self Tests). This definition overrides
4294ea909b76Swdenk		#define'd default value in commproc.h resp.
4295ea909b76Swdenk		cpm_8260.h.
4296ea909b76Swdenk
42976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
42986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
42996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
43006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
43016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
43026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
43036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
43046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4305a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
43065d232d0eSwdenk
43079cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
43089cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
43099cacf4fcSDirk Eibach		required.
43109cacf4fcSDirk Eibach
431169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
431269fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
431369fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
431469fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
431569fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
431669fd2d3bSAndrew Sharp		by coreboot or similar.
431769fd2d3bSAndrew Sharp
4318842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4319842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4320842033e6SGabor Juhos
4321a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4322a09b9b68SKumar Gala		Chip has SRIO or not
4323a09b9b68SKumar Gala
4324a09b9b68SKumar Gala- CONFIG_SRIO1:
4325a09b9b68SKumar Gala		Board has SRIO 1 port available
4326a09b9b68SKumar Gala
4327a09b9b68SKumar Gala- CONFIG_SRIO2:
4328a09b9b68SKumar Gala		Board has SRIO 2 port available
4329a09b9b68SKumar Gala
4330c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4331c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4332c8b28152SLiu Gang
4333a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4334a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4335a09b9b68SKumar Gala
4336a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4337a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4338a09b9b68SKumar Gala
4339a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4340a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4341a09b9b68SKumar Gala
434266bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
434366bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
434466bd1846SFabio Estevam		a 16 bit bus.
434566bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4346a430e916SFabio Estevam		Example of drivers that use it:
434766bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4348a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4349eced4626SAlex Waterman
4350eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4351eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4352eced4626SAlex Waterman		a default value will be used.
4353eced4626SAlex Waterman
4354bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4355218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4356218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4357218ca724SWolfgang Denk
4358bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4359bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4360bb99ad6dSBen Warren
43616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4362218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4363218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4364218ca724SWolfgang Denk		to something your driver can deal with.
4365bb99ad6dSBen Warren
43661b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
43671b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
43681b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
43691b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
43701b3e3c4fSYork Sun		header files or board specific files.
43711b3e3c4fSYork Sun
43726f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
43736f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
43746f5e1dc5SYork Sun
43756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4376218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4377218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
43782ad6b513STimur Tabi
4379c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4380c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4381c26e454dSwdenk
4382c26e454dSwdenk- CONFIG_FEC[12]_PHY
4383c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
43846e592385Swdenk		to the given FEC; i. e.
4385c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4386c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4387c26e454dSwdenk
4388c26e454dSwdenk		When set to -1, means to probe for first available.
4389c26e454dSwdenk
4390c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4391c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4392c26e454dSwdenk		(so program the FEC to ignore it).
4393c26e454dSwdenk
4394c26e454dSwdenk- CONFIG_RMII
4395c26e454dSwdenk		Enable RMII mode for all FECs.
4396c26e454dSwdenk		Note that this is a global option, we can't
4397c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4398c26e454dSwdenk
43995cf91d6bSwdenk- CONFIG_CRC32_VERIFY
44005cf91d6bSwdenk		Add a verify option to the crc32 command.
44015cf91d6bSwdenk		The syntax is:
44025cf91d6bSwdenk
44035cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
44045cf91d6bSwdenk
44055cf91d6bSwdenk		Where address/count indicate a memory area
44065cf91d6bSwdenk		and crc32 is the correct crc32 which the
44075cf91d6bSwdenk		area should have.
44085cf91d6bSwdenk
440956523f12Swdenk- CONFIG_LOOPW
441056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4411602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
441256523f12Swdenk
44137b466641Sstroese- CONFIG_MX_CYCLIC
44147b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
44157b466641Sstroese		"md/mw" commands.
44167b466641Sstroese		Examples:
44177b466641Sstroese
44187b466641Sstroese		=> mdc.b 10 4 500
44197b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
44207b466641Sstroese
44217b466641Sstroese		=> mwc.l 100 12345678 10
44227b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
44237b466641Sstroese
44247b466641Sstroese		This only takes effect if the memory commands are activated
4425602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
44267b466641Sstroese
44278aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4428afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4429e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4430e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4431e03f3169SWolfgang Denk		relocate itself into RAM.
44328aa1a2d1Swdenk
4433e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4434e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4435e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4436e03f3169SWolfgang Denk		these initializations itself.
44378aa1a2d1Swdenk
4438401bb30bSAneesh V- CONFIG_SPL_BUILD
4439df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4440df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4441df81238bSMagnus Lilja		compiling a NAND SPL.
4442400558b5Swdenk
44433aa29de0SYing Zhang- CONFIG_TPL_BUILD
44443aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
44453aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
44463aa29de0SYing Zhang		It is loaded by the SPL.
44473aa29de0SYing Zhang
44485df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
44495df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
44505df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
44515df572f0SYing Zhang		previous 4k of the .text section.
44525df572f0SYing Zhang
44534213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
44544213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
44554213fc29SSimon Glass		effective address. It is therefore not necessary to regard
44564213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
44574213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
44584213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
44594213fc29SSimon Glass		addressable memory. This option causes some memory accesses
44604213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
44614213fc29SSimon Glass
4462d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4463d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4464d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4465d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4466d8834a13SMatthias Weisser		conditions but may increase the binary size.
4467d8834a13SMatthias Weisser
4468588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4469588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4470588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4471b16f521aSGabe Black
4472fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4473fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4474fc33705eSMark Jackson
4475fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
44765b5ece9eSGabe Black
447716678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
447816678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
447916678eb4SHeiko Schocher
4480f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4481f2717b47STimur Tabi-----------------------------------
4482f2717b47STimur Tabi
4483f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4484f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4485f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4486f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4487f2717b47STimur Tabiwithin that device.
4488f2717b47STimur Tabi
4489f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4490f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4491f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4492f2717b47STimur Tabi	is also specified.
4493f2717b47STimur Tabi
4494f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4495f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4496f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4497f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4498f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4499f2717b47STimur Tabi
4500f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4501f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4502f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4503f2717b47STimur Tabi	virtual address in NOR flash.
4504f2717b47STimur Tabi
4505f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4506f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4507f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4508f2717b47STimur Tabi
4509f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4510f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4511f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4512f2717b47STimur Tabi
4513f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4514f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4515f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4516f2717b47STimur Tabi
4517292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4518292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4519292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4520fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4521fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4522fc54c7faSLiu Gang	master's memory space.
4523f2717b47STimur Tabi
4524c609719bSwdenkBuilding the Software:
4525c609719bSwdenk======================
4526c609719bSwdenk
4527218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4528218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4529218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4530218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4531218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4532218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4533c609719bSwdenk
4534218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4535218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4536218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4537218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4538218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4539c609719bSwdenk
4540218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4541218ca724SWolfgang Denk	$ export CROSS_COMPILE
4542c609719bSwdenk
45432f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
45442f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
45452f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
45462f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
45472f8d396bSPeter Tyser
45482f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
45492f8d396bSPeter Tyser
45502f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
45512f8d396bSPeter Tyser      be executed on computers running Windows.
45522f8d396bSPeter Tyser
4553c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4554c609719bSwdenksources you must configure U-Boot for one specific board type. This
4555c609719bSwdenkis done by typing:
4556c609719bSwdenk
4557c609719bSwdenk	make NAME_config
4558c609719bSwdenk
4559218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
45604d675ae6SMichael Jonesrations; see boards.cfg for supported names.
456154387ac9Swdenk
4562c609719bSwdenkNote: for some board special configuration names may exist; check if
4563c609719bSwdenk      additional information is available from the board vendor; for
45642729af9dSwdenk      instance, the TQM823L systems are available without (standard)
45652729af9dSwdenk      or with LCD support. You can select such additional "features"
456611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4567c609719bSwdenk
45682729af9dSwdenk      make TQM823L_config
45692729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4570c609719bSwdenk
4571c609719bSwdenk      make TQM823L_LCD_config
4572c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4573c609719bSwdenk
4574c609719bSwdenk      etc.
4575c609719bSwdenk
4576c609719bSwdenk
4577c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
45787152b1d0Swdenkimages ready for download to / installation on your system:
4579c609719bSwdenk
4580c609719bSwdenk- "u-boot.bin" is a raw binary image
4581c609719bSwdenk- "u-boot" is an image in ELF binary format
4582c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4583c609719bSwdenk
4584baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4585baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4586baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4587baf31249SMarian Balakowicz
4588baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4589baf31249SMarian Balakowicz
4590baf31249SMarian Balakowicz	make O=/tmp/build distclean
4591baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4592baf31249SMarian Balakowicz	make O=/tmp/build all
4593baf31249SMarian Balakowicz
4594baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4595baf31249SMarian Balakowicz
4596baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4597baf31249SMarian Balakowicz	make distclean
4598baf31249SMarian Balakowicz	make NAME_config
4599baf31249SMarian Balakowicz	make all
4600baf31249SMarian Balakowicz
4601baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4602baf31249SMarian Balakowiczvariable.
4603baf31249SMarian Balakowicz
4604c609719bSwdenk
4605c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4606c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4607c609719bSwdenknative "make".
4608c609719bSwdenk
4609c609719bSwdenk
4610c609719bSwdenkIf the system board that you have is not listed, then you will need
4611c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4612c609719bSwdenksteps:
4613c609719bSwdenk
4614c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
46154d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
46164d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4617c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
461885ec0bccSwdenk    files you need. In your board directory, you will need at least
461985ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
462085ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
462185ec0bccSwdenk    your board
4622c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4623c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
462485ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4625c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4626c609719bSwdenk    to be installed on your target system.
462785ec0bccSwdenk6.  Debug and solve any problems that might arise.
4628c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4629c609719bSwdenk
4630c609719bSwdenk
4631c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4632c609719bSwdenk==============================================================
4633c609719bSwdenk
4634c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4635c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4636c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4637c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4638218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4639c609719bSwdenk
4640c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4641c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4642c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4643c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4644c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
46457152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4646218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4647218ca724SWolfgang Denkyou can type
4648c609719bSwdenk
4649c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4650c609719bSwdenk
4651c609719bSwdenkor to build on a native PowerPC system you can type
4652c609719bSwdenk
4653c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4654c609719bSwdenk
4655218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4656218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4657218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4658218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4659218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4660218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4661218ca724SWolfgang Denkvariable. For example:
4662baf31249SMarian Balakowicz
4663baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4664baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4665baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4666baf31249SMarian Balakowicz
4667218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4668218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4669218ca724SWolfgang Denkduring the whole build process.
4670baf31249SMarian Balakowicz
4671baf31249SMarian Balakowicz
4672c609719bSwdenkSee also "U-Boot Porting Guide" below.
4673c609719bSwdenk
4674c609719bSwdenk
4675c609719bSwdenkMonitor Commands - Overview:
4676c609719bSwdenk============================
4677c609719bSwdenk
4678c609719bSwdenkgo	- start application at address 'addr'
4679c609719bSwdenkrun	- run commands in an environment variable
4680c609719bSwdenkbootm	- boot application image from memory
4681c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
468244f074c7SMarek Vasutbootz   - boot zImage from memory
4683c609719bSwdenktftpboot- boot image via network using TFTP protocol
4684c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4685c609719bSwdenk	       (and eventually "gatewayip")
46861fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4687c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4688c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4689c609719bSwdenkloads	- load S-Record file over serial line
4690c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4691c609719bSwdenkmd	- memory display
4692c609719bSwdenkmm	- memory modify (auto-incrementing)
4693c609719bSwdenknm	- memory modify (constant address)
4694c609719bSwdenkmw	- memory write (fill)
4695c609719bSwdenkcp	- memory copy
4696c609719bSwdenkcmp	- memory compare
4697c609719bSwdenkcrc32	- checksum calculation
46980f89c54bSPeter Tyseri2c	- I2C sub-system
4699c609719bSwdenksspi	- SPI utility commands
4700c609719bSwdenkbase	- print or set address offset
4701c609719bSwdenkprintenv- print environment variables
4702c609719bSwdenksetenv	- set environment variables
4703c609719bSwdenksaveenv - save environment variables to persistent storage
4704c609719bSwdenkprotect - enable or disable FLASH write protection
4705c609719bSwdenkerase	- erase FLASH memory
4706c609719bSwdenkflinfo	- print FLASH memory information
470710635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4708c609719bSwdenkbdinfo	- print Board Info structure
4709c609719bSwdenkiminfo	- print header information for application image
4710c609719bSwdenkconinfo - print console devices and informations
4711c609719bSwdenkide	- IDE sub-system
4712c609719bSwdenkloop	- infinite loop on address range
471356523f12Swdenkloopw	- infinite write loop on address range
4714c609719bSwdenkmtest	- simple RAM test
4715c609719bSwdenkicache	- enable or disable instruction cache
4716c609719bSwdenkdcache	- enable or disable data cache
4717c609719bSwdenkreset	- Perform RESET of the CPU
4718c609719bSwdenkecho	- echo args to console
4719c609719bSwdenkversion - print monitor version
4720c609719bSwdenkhelp	- print online help
4721c609719bSwdenk?	- alias for 'help'
4722c609719bSwdenk
4723c609719bSwdenk
4724c609719bSwdenkMonitor Commands - Detailed Description:
4725c609719bSwdenk========================================
4726c609719bSwdenk
4727c609719bSwdenkTODO.
4728c609719bSwdenk
4729c609719bSwdenkFor now: just type "help <command>".
4730c609719bSwdenk
4731c609719bSwdenk
4732c609719bSwdenkEnvironment Variables:
4733c609719bSwdenk======================
4734c609719bSwdenk
4735c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4736c609719bSwdenkcan be made persistent by saving to Flash memory.
4737c609719bSwdenk
4738c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4739c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4740c609719bSwdenkwithout a value can be used to delete a variable from the
4741c609719bSwdenkenvironment. As long as you don't save the environment you are
4742c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4743c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4744c609719bSwdenk
4745c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4746c96f86eeSWolfgang Denk
4747c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4748c609719bSwdenk
4749c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4750c609719bSwdenk
4751c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4752c609719bSwdenk
4753c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4754c609719bSwdenk
4755c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4756c609719bSwdenk
4757c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4758c609719bSwdenk
47597d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
47607d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47617d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
47627d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
47637d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
47647d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4765c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4766c3624e6eSGrant Likely		  bootm_mapsize.
4767c3624e6eSGrant Likely
4768c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4769c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4770c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4771c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4772c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4773c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4774c3624e6eSGrant Likely		  used otherwise.
47757d721e34SBartlomiej Sieka
47767d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
47777d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
47787d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
47797d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
47807d721e34SBartlomiej Sieka		  environment variable.
47817d721e34SBartlomiej Sieka
47824bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
47834bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
47844bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
47854bae9090SBartlomiej Sieka
4786c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4787c609719bSwdenk		  "bootp" will just load perform a lookup of the
4788c609719bSwdenk		  configuration from the BOOTP server, but not try to
4789c609719bSwdenk		  load any image using TFTP
4790c609719bSwdenk
4791c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4792c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4793c609719bSwdenk		  be automatically started (by internally calling
4794c609719bSwdenk		  "bootm")
4795c609719bSwdenk
47964a6fd34bSwdenk		  If set to "no", a standalone image passed to the
47974a6fd34bSwdenk		  "bootm" command will be copied to the load address
47984a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
47994a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
48004a6fd34bSwdenk		  data.
48014a6fd34bSwdenk
4802a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4803a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4804fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4805fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4806fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4807fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4808fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4809fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4810fa34f6b2SShawn Guo		  access it during the boot procedure.
4811fa34f6b2SShawn Guo
4812a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4813a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4814a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4815a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4816a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4817a28afca5SDavid A. Long		  must be accessible by the kernel.
4818a28afca5SDavid A. Long
4819eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4820eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4821eea63e05SSimon Glass		  defined.
4822eea63e05SSimon Glass
482317ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
482417ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
482517ea1177Swdenk		  mode (400kHZ). This environment variable is used in
482617ea1177Swdenk		  initialization code. So, for changes to be effective
482717ea1177Swdenk		  it must be saved and board must be reset.
482817ea1177Swdenk
4829c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4830c609719bSwdenk		  If this variable is not set, initrd images will be
4831c609719bSwdenk		  copied to the highest possible address in RAM; this
4832c609719bSwdenk		  is usually what you want since it allows for
4833c609719bSwdenk		  maximum initrd size. If for some reason you want to
4834c609719bSwdenk		  make sure that the initrd image is loaded below the
48356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4836c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4837c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4838c609719bSwdenk		  address to use (U-Boot will still check that it
4839c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4840c609719bSwdenk
4841c609719bSwdenk		  For instance, when you have a system with 16 MB
48427152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4843c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4844c609719bSwdenk		  the "bootargs" variable. However, now you must make
48457152b1d0Swdenk		  sure that the initrd image is placed in the first
4846c609719bSwdenk		  12 MB as well - this can be done with
4847c609719bSwdenk
4848c609719bSwdenk		  setenv initrd_high 00c00000
4849c609719bSwdenk
485038b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
485138b99261Swdenk		  indication to U-Boot that all addresses are legal
485238b99261Swdenk		  for the Linux kernel, including addresses in flash
485338b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
485438b99261Swdenk		  ramdisk at all. This may be useful to reduce the
485538b99261Swdenk		  boot time on your system, but requires that this
485638b99261Swdenk		  feature is supported by your Linux kernel.
485738b99261Swdenk
4858c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4859c609719bSwdenk
4860c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4861dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4862c609719bSwdenk
4863c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4864c609719bSwdenk
4865c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4866c609719bSwdenk
4867c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4868c609719bSwdenk
4869c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4870c609719bSwdenk
4871c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4872c609719bSwdenk
4873e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4874a3d991bdSwdenk
4875e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4876e2a53458SMike Frysinger		  For example you can do the following
4877a3d991bdSwdenk
487848690d80SHeiko Schocher		  => setenv ethact FEC
487948690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
488048690d80SHeiko Schocher		  => setenv ethact SCC
488148690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4882a3d991bdSwdenk
4883e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4884e1692577SMatthias Fuchs		  available network interfaces.
4885e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4886e1692577SMatthias Fuchs
4887a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4888a3d991bdSwdenk		  either succeed or fail without retrying.
48896e592385Swdenk		  When set to "once" the network operation will
48906e592385Swdenk		  fail when all the available network interfaces
48916e592385Swdenk		  are tried once without success.
4892a3d991bdSwdenk		  Useful on scripts which control the retry operation
4893a3d991bdSwdenk		  themselves.
4894a3d991bdSwdenk
4895b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4896a1cf027aSJean-Christophe PLAGNIOL-VILLARD
48978d51aacdSSimon Glass  silent_linux  - If set then linux will be told to boot silently, by
48988d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
48998d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
49008d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
49018d51aacdSSimon Glass		  is silent.
49028d51aacdSSimon Glass
490328cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4904ecb0ccd9SWolfgang Denk		  UDP source port.
4905ecb0ccd9SWolfgang Denk
490628cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
490728cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
490828cb9375SWolfgang Denk
4909c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4910c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4911c96f86eeSWolfgang Denk
4912c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4913c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4914c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4915c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4916c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4917c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4918c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4919c96f86eeSWolfgang Denk
4920a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
492111ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4922a3d991bdSwdenk		  VLAN tagged frames.
4923c609719bSwdenk
4924dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4925dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4926dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4927dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4928dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4929dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4930dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4931dc0b7b0eSJason Hobbs
4932dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4933dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4934dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4935dc0b7b0eSJason Hobbs
4936dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4937dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4938dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4939dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4940dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4941dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4942dc0b7b0eSJason Hobbs
4943c609719bSwdenkThe following environment variables may be used and automatically
4944c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4945c609719bSwdenkdepending the information provided by your boot server:
4946c609719bSwdenk
4947c609719bSwdenk  bootfile	- see above
4948c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4949fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4950c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4951c609719bSwdenk  hostname	- Target hostname
4952c609719bSwdenk  ipaddr	- see above
4953c609719bSwdenk  netmask	- Subnet Mask
4954c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4955c609719bSwdenk  serverip	- see above
4956c609719bSwdenk
4957c609719bSwdenk
4958c609719bSwdenkThere are two special Environment Variables:
4959c609719bSwdenk
4960c609719bSwdenk  serial#	- contains hardware identification information such
4961c609719bSwdenk		  as type string and/or serial number
4962c609719bSwdenk  ethaddr	- Ethernet address
4963c609719bSwdenk
4964c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4965c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4966c609719bSwdenkonce they have been set once.
4967c609719bSwdenk
4968c609719bSwdenk
4969c1551ea8SstroeseFurther special Environment Variables:
4970c1551ea8Sstroese
4971c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4972c1551ea8Sstroese		  with the "version" command. This variable is
4973c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4974c1551ea8Sstroese
4975c1551ea8Sstroese
4976c609719bSwdenkPlease note that changes to some configuration parameters may take
4977c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4978c609719bSwdenk
4979c609719bSwdenk
4980170ab110SJoe HershbergerCallback functions for environment variables:
4981170ab110SJoe Hershberger---------------------------------------------
4982170ab110SJoe Hershberger
4983170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4984170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4985170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4986170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4987170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4988170ab110SJoe Hershberger
4989170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4990170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4991170ab110SJoe Hershberger
4992170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4993170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4994170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4995170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4996170ab110SJoe Hershberger
4997170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4998170ab110SJoe Hershberger	list = entry[,list]
4999170ab110SJoe Hershberger
5000170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
5001170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
5002170ab110SJoe Hershberger
5003170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
5004170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
5005170ab110SJoe Hershbergeroverride any association in the static list. You can define
5006170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5007170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
5008170ab110SJoe Hershberger
5009170ab110SJoe Hershberger
5010f07771ccSwdenkCommand Line Parsing:
5011f07771ccSwdenk=====================
5012f07771ccSwdenk
5013f07771ccSwdenkThere are two different command line parsers available with U-Boot:
50147152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
5015f07771ccSwdenk
5016f07771ccSwdenkOld, simple command line parser:
5017f07771ccSwdenk--------------------------------
5018f07771ccSwdenk
5019f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
5020f07771ccSwdenk- several commands on one line, separated by ';'
5021fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
5022f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
5023f07771ccSwdenk  for example:
5024fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
5025f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
5026f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
5027f07771ccSwdenk
5028f07771ccSwdenkHush shell:
5029f07771ccSwdenk-----------
5030f07771ccSwdenk
5031f07771ccSwdenk- similar to Bourne shell, with control structures like
5032f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
5033f07771ccSwdenk  until...do...done, ...
5034f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
5035f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
5036f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
5037f07771ccSwdenk  command
5038f07771ccSwdenk
5039f07771ccSwdenkGeneral rules:
5040f07771ccSwdenk--------------
5041f07771ccSwdenk
5042f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
5043f07771ccSwdenk    command) contains several commands separated by semicolon, and
5044f07771ccSwdenk    one of these commands fails, then the remaining commands will be
5045f07771ccSwdenk    executed anyway.
5046f07771ccSwdenk
5047f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
504811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
5049f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
5050f07771ccSwdenk    variables are not executed.
5051f07771ccSwdenk
5052c609719bSwdenkNote for Redundant Ethernet Interfaces:
5053c609719bSwdenk=======================================
5054c609719bSwdenk
505511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
5056c609719bSwdenksuch configurations and is capable of automatic selection of a
50577152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
5058c609719bSwdenk
5059c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
5060c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5061c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
5062c609719bSwdenk
5063c609719bSwdenkIf the network interface stores some valid MAC address (for instance
5064c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
5065c609719bSwdenkding setting in the environment; if the corresponding environment
5066c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
5067c609719bSwdenk
5068c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
5069c609719bSwdenk  environment, the SROM's address is used.
5070c609719bSwdenk
5071c609719bSwdenko If there is no valid address in the SROM, and a definition in the
5072c609719bSwdenk  environment exists, then the value from the environment variable is
5073c609719bSwdenk  used.
5074c609719bSwdenk
5075c609719bSwdenko If both the SROM and the environment contain a MAC address, and
5076c609719bSwdenk  both addresses are the same, this MAC address is used.
5077c609719bSwdenk
5078c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
5079c609719bSwdenk  addresses differ, the value from the environment is used and a
5080c609719bSwdenk  warning is printed.
5081c609719bSwdenk
5082c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
5083c609719bSwdenk  is raised.
5084c609719bSwdenk
5085ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
5086ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
5087ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
5088ecee9324SBen WarrenThe naming convention is as follows:
5089ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
5090c609719bSwdenk
5091c609719bSwdenkImage Formats:
5092c609719bSwdenk==============
5093c609719bSwdenk
50943310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
50953310c549SMarian Balakowiczimages in two formats:
50963310c549SMarian Balakowicz
50973310c549SMarian BalakowiczNew uImage format (FIT)
50983310c549SMarian Balakowicz-----------------------
50993310c549SMarian Balakowicz
51003310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
51013310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
51023310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
51033310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
51043310c549SMarian Balakowicz
51053310c549SMarian Balakowicz
51063310c549SMarian BalakowiczOld uImage format
51073310c549SMarian Balakowicz-----------------
51083310c549SMarian Balakowicz
51093310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
51103310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
51113310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
5112c609719bSwdenk
5113c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5114c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5115f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5116f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5117f5ed9e39SPeter Tyser  INTEGRITY).
51187b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5119afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5120afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
5121c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
5122c609719bSwdenk* Load Address
5123c609719bSwdenk* Entry Point
5124c609719bSwdenk* Image Name
5125c609719bSwdenk* Image Timestamp
5126c609719bSwdenk
5127c609719bSwdenkThe header is marked by a special Magic Number, and both the header
5128c609719bSwdenkand the data portions of the image are secured against corruption by
5129c609719bSwdenkCRC32 checksums.
5130c609719bSwdenk
5131c609719bSwdenk
5132c609719bSwdenkLinux Support:
5133c609719bSwdenk==============
5134c609719bSwdenk
5135c609719bSwdenkAlthough U-Boot should support any OS or standalone application
51367152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
5137c609719bSwdenkU-Boot.
5138c609719bSwdenk
5139c609719bSwdenkU-Boot includes many features that so far have been part of some
5140c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
5141c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
5142c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
51437152b1d0Swdenkserves several purposes:
5144c609719bSwdenk
5145c609719bSwdenk- the same features can be used for other OS or standalone
5146c609719bSwdenk  applications (for instance: using compressed images to reduce the
5147c609719bSwdenk  Flash memory footprint)
5148c609719bSwdenk
5149c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
51507152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
5151c609719bSwdenk
5152c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
5153c609719bSwdenk  images; of course this also means that different kernel images can
5154c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
5155c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
5156c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
5157c609719bSwdenk  software is easier now.
5158c609719bSwdenk
5159c609719bSwdenk
5160c609719bSwdenkLinux HOWTO:
5161c609719bSwdenk============
5162c609719bSwdenk
5163c609719bSwdenkPorting Linux to U-Boot based systems:
5164c609719bSwdenk---------------------------------------
5165c609719bSwdenk
5166c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
5167c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
5168c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
5169c609719bSwdenkLinux :-).
5170c609719bSwdenk
5171a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5172c609719bSwdenk
5173c609719bSwdenkJust make sure your machine specific header file (for instance
5174c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
51751dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
51761dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
51776d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
5178c609719bSwdenk
5179c609719bSwdenk
5180c609719bSwdenkConfiguring the Linux kernel:
5181c609719bSwdenk-----------------------------
5182c609719bSwdenk
5183c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
5184c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
5185c609719bSwdenk
5186c609719bSwdenk
5187c609719bSwdenkBuilding a Linux Image:
5188c609719bSwdenk-----------------------
5189c609719bSwdenk
519024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
519124ee89b9Swdenknot used. If you use recent kernel source, a new build target
519224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
519324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
519424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
519524ee89b9Swdenk100% compatible format.
5196c609719bSwdenk
5197c609719bSwdenkExample:
5198c609719bSwdenk
5199c609719bSwdenk	make TQM850L_config
5200c609719bSwdenk	make oldconfig
5201c609719bSwdenk	make dep
520224ee89b9Swdenk	make uImage
5203c609719bSwdenk
520424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
520524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
520624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5207c609719bSwdenk
520824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
520924ee89b9Swdenk
521024ee89b9Swdenk* convert the kernel into a raw binary image:
521124ee89b9Swdenk
521224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
521324ee89b9Swdenk				 -R .note -R .comment \
521424ee89b9Swdenk				 -S vmlinux linux.bin
521524ee89b9Swdenk
521624ee89b9Swdenk* compress the binary image:
521724ee89b9Swdenk
521824ee89b9Swdenk	gzip -9 linux.bin
521924ee89b9Swdenk
522024ee89b9Swdenk* package compressed binary image for U-Boot:
522124ee89b9Swdenk
522224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
522324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
522424ee89b9Swdenk		-d linux.bin.gz uImage
522524ee89b9Swdenk
522624ee89b9Swdenk
522724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
522824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
522924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
523024ee89b9Swdenkbyte header containing information about target architecture,
523124ee89b9Swdenkoperating system, image type, compression method, entry points, time
523224ee89b9Swdenkstamp, CRC32 checksums, etc.
523324ee89b9Swdenk
523424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
523524ee89b9Swdenkprint the header information, or to build new images.
5236c609719bSwdenk
5237c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5238c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5239c609719bSwdenkchecksum verification:
5240c609719bSwdenk
5241c609719bSwdenk	tools/mkimage -l image
5242c609719bSwdenk	  -l ==> list image header information
5243c609719bSwdenk
5244c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5245c609719bSwdenkfrom a "data file" which is used as image payload:
5246c609719bSwdenk
5247c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5248c609719bSwdenk		      -n name -d data_file image
5249c609719bSwdenk	  -A ==> set architecture to 'arch'
5250c609719bSwdenk	  -O ==> set operating system to 'os'
5251c609719bSwdenk	  -T ==> set image type to 'type'
5252c609719bSwdenk	  -C ==> set compression type 'comp'
5253c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5254c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5255c609719bSwdenk	  -n ==> set image name to 'name'
5256c609719bSwdenk	  -d ==> use image data from 'datafile'
5257c609719bSwdenk
525869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
525969459791Swdenkaddress (0x00000000), but the entry point address depends on the
526069459791Swdenkkernel version:
5261c609719bSwdenk
5262c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
526324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5264c609719bSwdenk
5265c609719bSwdenkSo a typical call to build a U-Boot image would read:
5266c609719bSwdenk
526724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
526824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5269a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
527024ee89b9Swdenk	> examples/uImage.TQM850L
527124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5272c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5273c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5274c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5275c609719bSwdenk	Load Address: 0x00000000
527624ee89b9Swdenk	Entry Point:  0x00000000
5277c609719bSwdenk
5278c609719bSwdenkTo verify the contents of the image (or check for corruption):
5279c609719bSwdenk
528024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
528124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5282c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5283c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5284c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5285c609719bSwdenk	Load Address: 0x00000000
528624ee89b9Swdenk	Entry Point:  0x00000000
5287c609719bSwdenk
5288c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5289c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5290c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5291c609719bSwdenkneed to be uncompressed:
5292c609719bSwdenk
5293a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
529424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
529524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5296a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
529724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
529824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5299c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5300c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5301c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5302c609719bSwdenk	Load Address: 0x00000000
530324ee89b9Swdenk	Entry Point:  0x00000000
5304c609719bSwdenk
5305c609719bSwdenk
5306c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5307c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5308c609719bSwdenk
5309c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5310c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5311c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5312c609719bSwdenk	Image Name:   Simple Ramdisk Image
5313c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5314c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5315c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5316c609719bSwdenk	Load Address: 0x00000000
5317c609719bSwdenk	Entry Point:  0x00000000
5318c609719bSwdenk
5319a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5320a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5321a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5322a804b5ceSGuilherme Maciel Ferreirafrom the image:
5323a804b5ceSGuilherme Maciel Ferreira
5324a804b5ceSGuilherme Maciel Ferreira	tools/dumpimage -i image -p position data_file
5325a804b5ceSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file', \
5326a804b5ceSGuilherme Maciel Ferreira	   indexed by 'position'
5327a804b5ceSGuilherme Maciel Ferreira
5328c609719bSwdenk
5329c609719bSwdenkInstalling a Linux Image:
5330c609719bSwdenk-------------------------
5331c609719bSwdenk
5332c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5333c609719bSwdenkyou must convert the image to S-Record format:
5334c609719bSwdenk
5335c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5336c609719bSwdenk
5337c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5338c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5339c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5340c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5341c609719bSwdenkcommand.
5342c609719bSwdenk
5343c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5344c609719bSwdenkTQM8xxL is in the first Flash bank):
5345c609719bSwdenk
5346c609719bSwdenk	=> erase 40100000 401FFFFF
5347c609719bSwdenk
5348c609719bSwdenk	.......... done
5349c609719bSwdenk	Erased 8 sectors
5350c609719bSwdenk
5351c609719bSwdenk	=> loads 40100000
5352c609719bSwdenk	## Ready for S-Record download ...
5353c609719bSwdenk	~>examples/image.srec
5354c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5355c609719bSwdenk	...
5356c609719bSwdenk	15989 15990 15991 15992
5357c609719bSwdenk	[file transfer complete]
5358c609719bSwdenk	[connected]
5359c609719bSwdenk	## Start Addr = 0x00000000
5360c609719bSwdenk
5361c609719bSwdenk
5362c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5363c609719bSwdenkthis includes a checksum verification so you can be sure no data
5364c609719bSwdenkcorruption happened:
5365c609719bSwdenk
5366c609719bSwdenk	=> imi 40100000
5367c609719bSwdenk
5368c609719bSwdenk	## Checking Image at 40100000 ...
5369c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5370c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5371c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5372c609719bSwdenk	   Load Address: 00000000
5373c609719bSwdenk	   Entry Point:	 0000000c
5374c609719bSwdenk	   Verifying Checksum ... OK
5375c609719bSwdenk
5376c609719bSwdenk
5377c609719bSwdenkBoot Linux:
5378c609719bSwdenk-----------
5379c609719bSwdenk
5380c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5381c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5382c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5383c609719bSwdenkparameters. You can check and modify this variable using the
5384c609719bSwdenk"printenv" and "setenv" commands:
5385c609719bSwdenk
5386c609719bSwdenk
5387c609719bSwdenk	=> printenv bootargs
5388c609719bSwdenk	bootargs=root=/dev/ram
5389c609719bSwdenk
5390c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5391c609719bSwdenk
5392c609719bSwdenk	=> printenv bootargs
5393c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5394c609719bSwdenk
5395c609719bSwdenk	=> bootm 40020000
5396c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5397c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5398c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5399c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5400c609719bSwdenk	   Load Address: 00000000
5401c609719bSwdenk	   Entry Point:	 0000000c
5402c609719bSwdenk	   Verifying Checksum ... OK
5403c609719bSwdenk	   Uncompressing Kernel Image ... OK
5404c609719bSwdenk	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
5405c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5406c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5407c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5408c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5409c609719bSwdenk	...
5410c609719bSwdenk
541111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
54127152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5413c609719bSwdenkformat!) to the "bootm" command:
5414c609719bSwdenk
5415c609719bSwdenk	=> imi 40100000 40200000
5416c609719bSwdenk
5417c609719bSwdenk	## Checking Image at 40100000 ...
5418c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5419c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5420c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5421c609719bSwdenk	   Load Address: 00000000
5422c609719bSwdenk	   Entry Point:	 0000000c
5423c609719bSwdenk	   Verifying Checksum ... OK
5424c609719bSwdenk
5425c609719bSwdenk	## Checking Image at 40200000 ...
5426c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5427c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5428c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5429c609719bSwdenk	   Load Address: 00000000
5430c609719bSwdenk	   Entry Point:	 00000000
5431c609719bSwdenk	   Verifying Checksum ... OK
5432c609719bSwdenk
5433c609719bSwdenk	=> bootm 40100000 40200000
5434c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5435c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5436c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5437c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5438c609719bSwdenk	   Load Address: 00000000
5439c609719bSwdenk	   Entry Point:	 0000000c
5440c609719bSwdenk	   Verifying Checksum ... OK
5441c609719bSwdenk	   Uncompressing Kernel Image ... OK
5442c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5443c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5444c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5445c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5446c609719bSwdenk	   Load Address: 00000000
5447c609719bSwdenk	   Entry Point:	 00000000
5448c609719bSwdenk	   Verifying Checksum ... OK
5449c609719bSwdenk	   Loading Ramdisk ... OK
5450c609719bSwdenk	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
5451c609719bSwdenk	Boot arguments: root=/dev/ram
5452c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5453c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5454c609719bSwdenk	...
5455c609719bSwdenk	RAMDISK: Compressed image found at block 0
5456c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5457c609719bSwdenk
5458c609719bSwdenk	bash#
5459c609719bSwdenk
54600267768eSMatthew McClintockBoot Linux and pass a flat device tree:
54610267768eSMatthew McClintock-----------
54620267768eSMatthew McClintock
54630267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
54640267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
54650267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
54660267768eSMatthew McClintockflat device tree:
54670267768eSMatthew McClintock
54680267768eSMatthew McClintock=> print oftaddr
54690267768eSMatthew McClintockoftaddr=0x300000
54700267768eSMatthew McClintock=> print oft
54710267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
54720267768eSMatthew McClintock=> tftp $oftaddr $oft
54730267768eSMatthew McClintockSpeed: 1000, full duplex
54740267768eSMatthew McClintockUsing TSEC0 device
54750267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
54760267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
54770267768eSMatthew McClintockLoad address: 0x300000
54780267768eSMatthew McClintockLoading: #
54790267768eSMatthew McClintockdone
54800267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
54810267768eSMatthew McClintock=> tftp $loadaddr $bootfile
54820267768eSMatthew McClintockSpeed: 1000, full duplex
54830267768eSMatthew McClintockUsing TSEC0 device
54840267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
54850267768eSMatthew McClintockFilename 'uImage'.
54860267768eSMatthew McClintockLoad address: 0x200000
54870267768eSMatthew McClintockLoading:############
54880267768eSMatthew McClintockdone
54890267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
54900267768eSMatthew McClintock=> print loadaddr
54910267768eSMatthew McClintockloadaddr=200000
54920267768eSMatthew McClintock=> print oftaddr
54930267768eSMatthew McClintockoftaddr=0x300000
54940267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
54950267768eSMatthew McClintock## Booting image at 00200000 ...
54960267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
54970267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
54980267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
54990267768eSMatthew McClintock   Load Address: 00000000
55000267768eSMatthew McClintock   Entry Point:	 00000000
55010267768eSMatthew McClintock   Verifying Checksum ... OK
55020267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
55030267768eSMatthew McClintockBooting using flat device tree at 0x300000
55040267768eSMatthew McClintockUsing MPC85xx ADS machine description
55050267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
55060267768eSMatthew McClintock[snip]
55070267768eSMatthew McClintock
55080267768eSMatthew McClintock
55096069ff26SwdenkMore About U-Boot Image Types:
55106069ff26Swdenk------------------------------
55116069ff26Swdenk
55126069ff26SwdenkU-Boot supports the following image types:
55136069ff26Swdenk
55146069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
55156069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
55166069ff26Swdenk	well) you can continue to work in U-Boot after return from
55176069ff26Swdenk	the Standalone Program.
55186069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
55196069ff26Swdenk	will take over control completely. Usually these programs
55206069ff26Swdenk	will install their own set of exception handlers, device
55216069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
55226069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
55236069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
55246069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
55256069ff26Swdenk	being started.
55266069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
55276069ff26Swdenk	(Linux) kernel image and one or more data images like
55286069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
55296069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
55306069ff26Swdenk	server provides just a single image file, but you want to get
55316069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
55326069ff26Swdenk
55336069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
55346069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
55356069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
55366069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
55376069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
55386069ff26Swdenk	a multiple of 4 bytes).
55396069ff26Swdenk
55406069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
55416069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
55426069ff26Swdenk	flash memory.
55436069ff26Swdenk
55446069ff26Swdenk   "Script files" are command sequences that will be executed by
55456069ff26Swdenk	U-Boot's command interpreter; this feature is especially
55466069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
55476069ff26Swdenk	as command interpreter.
55486069ff26Swdenk
554944f074c7SMarek VasutBooting the Linux zImage:
555044f074c7SMarek Vasut-------------------------
555144f074c7SMarek Vasut
555244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
555344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
555444f074c7SMarek Vasutas the syntax of "bootm" command.
555544f074c7SMarek Vasut
55568ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5557017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5558017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5559017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5560017e1f3fSMarek Vasut
5561c609719bSwdenk
5562c609719bSwdenkStandalone HOWTO:
5563c609719bSwdenk=================
5564c609719bSwdenk
5565c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5566c609719bSwdenkrun "standalone" applications, which can use some resources of
5567c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5568c609719bSwdenk
5569c609719bSwdenkTwo simple examples are included with the sources:
5570c609719bSwdenk
5571c609719bSwdenk"Hello World" Demo:
5572c609719bSwdenk-------------------
5573c609719bSwdenk
5574c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5575c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5576c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5577c609719bSwdenklike that:
5578c609719bSwdenk
5579c609719bSwdenk	=> loads
5580c609719bSwdenk	## Ready for S-Record download ...
5581c609719bSwdenk	~>examples/hello_world.srec
5582c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5583c609719bSwdenk	[file transfer complete]
5584c609719bSwdenk	[connected]
5585c609719bSwdenk	## Start Addr = 0x00040004
5586c609719bSwdenk
5587c609719bSwdenk	=> go 40004 Hello World! This is a test.
5588c609719bSwdenk	## Starting application at 0x00040004 ...
5589c609719bSwdenk	Hello World
5590c609719bSwdenk	argc = 7
5591c609719bSwdenk	argv[0] = "40004"
5592c609719bSwdenk	argv[1] = "Hello"
5593c609719bSwdenk	argv[2] = "World!"
5594c609719bSwdenk	argv[3] = "This"
5595c609719bSwdenk	argv[4] = "is"
5596c609719bSwdenk	argv[5] = "a"
5597c609719bSwdenk	argv[6] = "test."
5598c609719bSwdenk	argv[7] = "<NULL>"
5599c609719bSwdenk	Hit any key to exit ...
5600c609719bSwdenk
5601c609719bSwdenk	## Application terminated, rc = 0x0
5602c609719bSwdenk
5603c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5604c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5605c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5606c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5607c609719bSwdenkcharacter, but this is just a demo program. The application can be
5608c609719bSwdenkcontrolled by the following keys:
5609c609719bSwdenk
5610c609719bSwdenk	? - print current values og the CPM Timer registers
5611c609719bSwdenk	b - enable interrupts and start timer
5612c609719bSwdenk	e - stop timer and disable interrupts
5613c609719bSwdenk	q - quit application
5614c609719bSwdenk
5615c609719bSwdenk	=> loads
5616c609719bSwdenk	## Ready for S-Record download ...
5617c609719bSwdenk	~>examples/timer.srec
5618c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5619c609719bSwdenk	[file transfer complete]
5620c609719bSwdenk	[connected]
5621c609719bSwdenk	## Start Addr = 0x00040004
5622c609719bSwdenk
5623c609719bSwdenk	=> go 40004
5624c609719bSwdenk	## Starting application at 0x00040004 ...
5625c609719bSwdenk	TIMERS=0xfff00980
5626c609719bSwdenk	Using timer 1
5627c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5628c609719bSwdenk
5629c609719bSwdenkHit 'b':
5630c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5631c609719bSwdenk	Enabling timer
5632c609719bSwdenkHit '?':
5633c609719bSwdenk	[q, b, e, ?] ........
5634c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5635c609719bSwdenkHit '?':
5636c609719bSwdenk	[q, b, e, ?] .
5637c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5638c609719bSwdenkHit '?':
5639c609719bSwdenk	[q, b, e, ?] .
5640c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5641c609719bSwdenkHit '?':
5642c609719bSwdenk	[q, b, e, ?] .
5643c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5644c609719bSwdenkHit 'e':
5645c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5646c609719bSwdenkHit 'q':
5647c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5648c609719bSwdenk
5649c609719bSwdenk
565085ec0bccSwdenkMinicom warning:
565185ec0bccSwdenk================
565285ec0bccSwdenk
56537152b1d0SwdenkOver time, many people have reported problems when trying to use the
565485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
565585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5656f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
565785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5658e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5659e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5660e53515a2SKarl O. Pincfor help with kermit.
5661e53515a2SKarl O. Pinc
566285ec0bccSwdenk
566352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
566452f52c14Swdenkconfiguration to your "File transfer protocols" section:
566552f52c14Swdenk
566652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
566752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
566852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
566952f52c14Swdenk
567052f52c14Swdenk
5671c609719bSwdenkNetBSD Notes:
5672c609719bSwdenk=============
5673c609719bSwdenk
5674c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5675c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5676c609719bSwdenk
5677c609719bSwdenkBuilding requires a cross environment; it is known to work on
5678c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5679c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5680c609719bSwdenkNote that the cross-powerpc package does not install include files;
5681c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5682c609719bSwdenkmissing.  This file has to be installed and patched manually:
5683c609719bSwdenk
5684c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5685c609719bSwdenk	# mkdir powerpc
5686c609719bSwdenk	# ln -s powerpc machine
5687c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5688c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5689c609719bSwdenk
5690c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5691c609719bSwdenkand U-Boot include files.
5692c609719bSwdenk
5693c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5694c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5695c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5696c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
56972a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5698c609719bSwdenk
5699c609719bSwdenk
5700c609719bSwdenkImplementation Internals:
5701c609719bSwdenk=========================
5702c609719bSwdenk
5703c609719bSwdenkThe following is not intended to be a complete description of every
5704c609719bSwdenkimplementation detail. However, it should help to understand the
5705c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5706c609719bSwdenkhardware.
5707c609719bSwdenk
5708c609719bSwdenk
5709c609719bSwdenkInitial Stack, Global Data:
5710c609719bSwdenk---------------------------
5711c609719bSwdenk
5712c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5713c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5714c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5715c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5716c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5717c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5718c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5719c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5720c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5721c609719bSwdenklocked as (mis-) used as memory, etc.
5722c609719bSwdenk
57237152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
57240668236bSWolfgang Denk	U-Boot mailing list:
572543d9616cSwdenk
572643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
572743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
572843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
572943d9616cSwdenk	...
573043d9616cSwdenk
573143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
573243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
573343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
573443d9616cSwdenk	is that the cache is being used as a temporary supply of
573543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
573611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
573743d9616cSwdenk	can see how this works by studying the cache architecture and
573843d9616cSwdenk	operation in the architecture and processor-specific manuals.
573943d9616cSwdenk
574043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
574143d9616cSwdenk	is another option for the system designer to use as an
574211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
574343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
574443d9616cSwdenk	board designers haven't used it for something that would
574543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
574643d9616cSwdenk	used.
574743d9616cSwdenk
57486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
574943d9616cSwdenk	with your processor/board/system design. The default value
575043d9616cSwdenk	you will find in any recent u-boot distribution in
57518a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
575243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
575343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
575443d9616cSwdenk	that are supposed to respond to that address! That code in
575543d9616cSwdenk	start.S has been around a while and should work as is when
575643d9616cSwdenk	you get the config right.
575743d9616cSwdenk
575843d9616cSwdenk	-Chris Hallinan
575943d9616cSwdenk	DS4.COM, Inc.
576043d9616cSwdenk
5761c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5762c609719bSwdenkcode for the initialization procedures:
5763c609719bSwdenk
5764c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5765c609719bSwdenk  to write it.
5766c609719bSwdenk
576711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5768c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
57697152b1d0Swdenk  zation is performed later (when relocating to RAM).
5770c609719bSwdenk
5771c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5772c609719bSwdenk  that.
5773c609719bSwdenk
5774c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5775c609719bSwdenknormal global data to share information beween the code. But it
5776c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5777c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5778c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5779c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5780c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5781c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5782c609719bSwdenkreserve for this purpose.
5783c609719bSwdenk
57847152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5785c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5786c609719bSwdenkGCC's implementation.
5787c609719bSwdenk
5788c609719bSwdenkFor PowerPC, the following registers have specific use:
5789c609719bSwdenk	R1:	stack pointer
5790e7670f6cSWolfgang Denk	R2:	reserved for system use
5791c609719bSwdenk	R3-R4:	parameter passing and return values
5792c609719bSwdenk	R5-R10: parameter passing
5793c609719bSwdenk	R13:	small data area pointer
5794c609719bSwdenk	R30:	GOT pointer
5795c609719bSwdenk	R31:	frame pointer
5796c609719bSwdenk
5797e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5798e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5799e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5800c609719bSwdenk
5801e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5802c609719bSwdenk
5803c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5804c609719bSwdenk    address of the global data structure is known at compile time),
5805c609719bSwdenk    but it turned out that reserving a register results in somewhat
5806c609719bSwdenk    smaller code - although the code savings are not that big (on
5807c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5808c609719bSwdenk    624 text + 127 data).
5809c609719bSwdenk
5810c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
58114c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
58124c58eb55SMike Frysinger
5813c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
58144c58eb55SMike Frysinger
5815c609719bSwdenkOn ARM, the following registers are used:
5816c609719bSwdenk
5817c609719bSwdenk	R0:	function argument word/integer result
5818c609719bSwdenk	R1-R3:	function argument word
581912eba1b4SJeroen Hofstee	R9:	platform specific
582012eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5821c609719bSwdenk	R11:	argument (frame) pointer
5822c609719bSwdenk	R12:	temporary workspace
5823c609719bSwdenk	R13:	stack pointer
5824c609719bSwdenk	R14:	link register
5825c609719bSwdenk	R15:	program counter
5826c609719bSwdenk
582712eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
582812eba1b4SJeroen Hofstee
582912eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5830c609719bSwdenk
58310df01fd3SThomas ChouOn Nios II, the ABI is documented here:
58320df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
58330df01fd3SThomas Chou
58340df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
58350df01fd3SThomas Chou
58360df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
58370df01fd3SThomas Chou    to access small data sections, so gp is free.
58380df01fd3SThomas Chou
5839afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5840afc1ce82SMacpaul Lin
5841afc1ce82SMacpaul Lin	R0-R1:	argument/return
5842afc1ce82SMacpaul Lin	R2-R5:	argument
5843afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5844afc1ce82SMacpaul Lin	R16:	trampoline register
5845afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5846afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5847afc1ce82SMacpaul Lin	R30:	link register (LP)
5848afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5849afc1ce82SMacpaul Lin	PC:	program counter (PC)
5850afc1ce82SMacpaul Lin
5851afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5852afc1ce82SMacpaul Lin
5853d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5854d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5855c609719bSwdenk
5856c609719bSwdenkMemory Management:
5857c609719bSwdenk------------------
5858c609719bSwdenk
5859c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5860c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5861c609719bSwdenk
5862c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5863c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5864c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5865c609719bSwdenkphysical memory banks.
5866c609719bSwdenk
5867c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5868c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5869c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5870c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
58716d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5872c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5873c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5874c609719bSwdenk
5875c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5876c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5877c609719bSwdenk
5878c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5879c609719bSwdenkthis:
5880c609719bSwdenk
5881c609719bSwdenk	0x0000 0000	Exception Vector code
5882c609719bSwdenk	      :
5883c609719bSwdenk	0x0000 1FFF
5884c609719bSwdenk	0x0000 2000	Free for Application Use
5885c609719bSwdenk	      :
5886c609719bSwdenk	      :
5887c609719bSwdenk
5888c609719bSwdenk	      :
5889c609719bSwdenk	      :
5890c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5891c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5892c609719bSwdenk	0x00FC 0000	Malloc Arena
5893c609719bSwdenk	      :
5894c609719bSwdenk	0x00FD FFFF
5895c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5896c609719bSwdenk	...		eventually: LCD or video framebuffer
5897c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5898c609719bSwdenk	0x00FF FFFF	[End of RAM]
5899c609719bSwdenk
5900c609719bSwdenk
5901c609719bSwdenkSystem Initialization:
5902c609719bSwdenk----------------------
5903c609719bSwdenk
5904c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
590511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5906c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
59077152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5908c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5909c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5910c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5911c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5912c609719bSwdenkthe caches and the SIU.
5913c609719bSwdenk
5914c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5915c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5916c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5917c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5918c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5919c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5920c609719bSwdenkbanks.
5921c609719bSwdenk
5922c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
59237152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5924c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5925c609719bSwdenk0x00000000, with any additional banks following immediately to create
5926c609719bSwdenkcontiguous memory starting from 0.
5927c609719bSwdenk
5928c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5929c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5930c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5931c609719bSwdenkpages, and the final stack is set up.
5932c609719bSwdenk
5933c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5934c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5935c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5936c609719bSwdenknew address in RAM.
5937c609719bSwdenk
5938c609719bSwdenk
5939c609719bSwdenkU-Boot Porting Guide:
5940c609719bSwdenk----------------------
5941c609719bSwdenk
5942c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
59436aff3115Swdenklist, October 2002]
5944c609719bSwdenk
5945c609719bSwdenk
5946c609719bSwdenkint main(int argc, char *argv[])
5947c609719bSwdenk{
5948c609719bSwdenk	sighandler_t no_more_time;
5949c609719bSwdenk
5950c609719bSwdenk	signal(SIGALRM, no_more_time);
5951c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5952c609719bSwdenk
5953c609719bSwdenk	if (available_money > available_manpower) {
59546c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5955c609719bSwdenk		return 0;
5956c609719bSwdenk	}
5957c609719bSwdenk
5958c609719bSwdenk	Download latest U-Boot source;
5959c609719bSwdenk
59600668236bSWolfgang Denk	Subscribe to u-boot mailing list;
59616aff3115Swdenk
59626c3fef28SJerry Van Baren	if (clueless)
5963c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5964c609719bSwdenk
5965c609719bSwdenk	while (learning) {
5966c609719bSwdenk		Read the README file in the top level directory;
59677cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
59686c3fef28SJerry Van Baren		Read applicable doc/*.README;
5969c609719bSwdenk		Read the source, Luke;
59706c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5971c609719bSwdenk	}
5972c609719bSwdenk
59736c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
59746c3fef28SJerry Van Baren		Buy a BDI3000;
59756c3fef28SJerry Van Baren	else
5976c609719bSwdenk		Add a lot of aggravation and time;
5977c609719bSwdenk
59786c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
59796c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
59806c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
59816c3fef28SJerry Van Baren	} else {
5982c609719bSwdenk		Create your own board support subdirectory;
59836c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
59846c3fef28SJerry Van Baren	}
59856c3fef28SJerry Van Baren	Edit new board/<myboard> files
59866c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5987c609719bSwdenk
59886c3fef28SJerry Van Baren	while (!accepted) {
5989c609719bSwdenk		while (!running) {
5990c609719bSwdenk			do {
5991c609719bSwdenk				Add / modify source code;
5992c609719bSwdenk			} until (compiles);
5993c609719bSwdenk			Debug;
5994c609719bSwdenk			if (clueless)
5995c609719bSwdenk				email("Hi, I am having problems...");
5996c609719bSwdenk		}
59976c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
59986c3fef28SJerry Van Baren		if (reasonable critiques)
59996c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
60006c3fef28SJerry Van Baren		else
60016c3fef28SJerry Van Baren			Defend code as written;
60026c3fef28SJerry Van Baren	}
6003c609719bSwdenk
6004c609719bSwdenk	return 0;
6005c609719bSwdenk}
6006c609719bSwdenk
6007c609719bSwdenkvoid no_more_time (int sig)
6008c609719bSwdenk{
6009c609719bSwdenk      hire_a_guru();
6010c609719bSwdenk}
6011c609719bSwdenk
6012c609719bSwdenk
6013c609719bSwdenkCoding Standards:
6014c609719bSwdenk-----------------
6015c609719bSwdenk
6016c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
60172c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
60187ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
6019c609719bSwdenk
60202c051651SDetlev ZundelSource files originating from a different project (for example the
60212c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
60222c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
60232c051651SDetlev Zundelsources.
60242c051651SDetlev Zundel
60252c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
60262c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
60272c051651SDetlev Zundelin your code.
6028c609719bSwdenk
6029c178d3daSwdenkPlease also stick to the following formatting rules:
6030180d3f74Swdenk- remove any trailing white space
60317ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
6032180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
60337ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
6034180d3f74Swdenk- do not add trailing empty lines to source files
6035180d3f74Swdenk
6036c609719bSwdenkSubmissions which do not conform to the standards may be returned
6037c609719bSwdenkwith a request to reformat the changes.
6038c609719bSwdenk
6039c609719bSwdenk
6040c609719bSwdenkSubmitting Patches:
6041c609719bSwdenk-------------------
6042c609719bSwdenk
6043c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
6044c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
6045c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
6046c609719bSwdenk
60470d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
6048218ca724SWolfgang Denk
60490668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
60500668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
60510668236bSWolfgang Denk
6052c609719bSwdenkWhen you send a patch, please include the following information with
6053c609719bSwdenkit:
6054c609719bSwdenk
6055c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
6056c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
6057c609719bSwdenk  patch actually fixes something.
6058c609719bSwdenk
6059c609719bSwdenk* For new features: a description of the feature and your
6060c609719bSwdenk  implementation.
6061c609719bSwdenk
6062c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
6063c609719bSwdenk
6064c609719bSwdenk* For major contributions, your entry to the CREDITS file
6065c609719bSwdenk
606627af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
606727af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
6068c609719bSwdenk
6069c609719bSwdenk* If your patch adds new configuration options, don't forget to
6070c609719bSwdenk  document these in the README file.
6071c609719bSwdenk
6072218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
6073218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
60747ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
6075218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
6076218ca724SWolfgang Denk  with some other mail clients.
6077c609719bSwdenk
6078218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
6079218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
6080218ca724SWolfgang Denk  GNU diff.
60816dff5529Swdenk
6082218ca724SWolfgang Denk  The current directory when running this command shall be the parent
6083218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
6084218ca724SWolfgang Denk  your patch includes sufficient directory information for the
6085218ca724SWolfgang Denk  affected files).
6086218ca724SWolfgang Denk
6087218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
6088218ca724SWolfgang Denk  and compressed attachments must not be used.
6089c609719bSwdenk
609052f52c14Swdenk* If one logical set of modifications affects or creates several
609152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
609252f52c14Swdenk
609352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
609452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
609552f52c14Swdenk
609652f52c14Swdenk
6097c609719bSwdenkNotes:
6098c609719bSwdenk
6099c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
6100c609719bSwdenk  source tree and make sure that no errors or warnings are reported
6101c609719bSwdenk  for any of the boards.
6102c609719bSwdenk
6103c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
6104c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
6105c609719bSwdenk  returned with a request to re-formatting / split it.
6106c609719bSwdenk
6107c609719bSwdenk* If you modify existing code, make sure that your new code does not
6108c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
6109c609719bSwdenk  When adding new features, these should compile conditionally only
6110c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
6111c609719bSwdenk  disabled must not need more memory than the old code without your
6112c609719bSwdenk  modification.
611390dc6704Swdenk
61140668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
61150668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
61160668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
61170668236bSWolfgang Denk  bigger than the size limit should be avoided.
6118