xref: /openbmc/u-boot/README (revision ffd06e0231ac3fd0c5810f39f6e23527948df1c7)
1c609719bSwdenk#
2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1506eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
167fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
18392bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
18480421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1858d321b81SPeter Tyser    /lib		Architecture specific library files
186afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
187afc1ce82SMacpaul Lin    /cpu		CPU specific files
188afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
189afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser    /lib		Architecture specific library files
193a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1948d321b81SPeter Tyser    /cpu		CPU specific files
1958d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1968d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1978d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1988d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1998d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
2008d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
2018d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
2028d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
2038d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sh			Files generic to SH architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2088d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2098d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2108d321b81SPeter Tyser    /lib		Architecture specific library files
2118d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2128d321b81SPeter Tyser    /cpu		CPU specific files
2138d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2148d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2158d321b81SPeter Tyser    /lib		Architecture specific library files
2168d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2178d321b81SPeter Tyser/board			Board dependent files
2188d321b81SPeter Tyser/common			Misc architecture independent functions
2198d321b81SPeter Tyser/disk			Code for disk drive partition handling
2208d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2218d321b81SPeter Tyser/drivers		Commonly used device drivers
2228d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2238d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2248d321b81SPeter Tyser/include		Header Files
2258d321b81SPeter Tyser/lib			Files generic to all architectures
2268d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2278d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2288d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2298d321b81SPeter Tyser/net			Networking code
2308d321b81SPeter Tyser/post			Power On Self Test
2318d321b81SPeter Tyser/rtc			Real Time Clock drivers
2328d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
233c609719bSwdenk
234c609719bSwdenkSoftware Configuration:
235c609719bSwdenk=======================
236c609719bSwdenk
237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
238c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
239c609719bSwdenk
240c609719bSwdenkThere are two classes of configuration variables:
241c609719bSwdenk
242c609719bSwdenk* Configuration _OPTIONS_:
243c609719bSwdenk  These are selectable by the user and have names beginning with
244c609719bSwdenk  "CONFIG_".
245c609719bSwdenk
246c609719bSwdenk* Configuration _SETTINGS_:
247c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
248c609719bSwdenk  you don't know what you're doing; they have names beginning with
2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
250c609719bSwdenk
251c609719bSwdenkLater we will add a configuration tool - probably similar to or even
252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
253c609719bSwdenkdo the configuration by hand, which means creating some symbolic
254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
255c609719bSwdenkas an example here.
256c609719bSwdenk
257c609719bSwdenk
258c609719bSwdenkSelection of Processor Architecture and Board Type:
259c609719bSwdenk---------------------------------------------------
260c609719bSwdenk
261c609719bSwdenkFor all supported boards there are ready-to-use default
262c609719bSwdenkconfigurations available; just type "make <board_name>_config".
263c609719bSwdenk
264c609719bSwdenkExample: For a TQM823L module type:
265c609719bSwdenk
266c609719bSwdenk	cd u-boot
267c609719bSwdenk	make TQM823L_config
268c609719bSwdenk
26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
271c609719bSwdenkdirectory according to the instructions in cogent/README.
272c609719bSwdenk
273c609719bSwdenk
274c609719bSwdenkConfiguration Options:
275c609719bSwdenk----------------------
276c609719bSwdenk
277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
278c609719bSwdenksuch information is kept in a configuration file
279c609719bSwdenk"include/configs/<board_name>.h".
280c609719bSwdenk
281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
282c609719bSwdenk"include/configs/TQM823L.h".
283c609719bSwdenk
284c609719bSwdenk
2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2877f6c2cbcSwdenkbuild a config tool - later.
2887f6c2cbcSwdenk
2897f6c2cbcSwdenk
290c609719bSwdenkThe following options need to be configured:
291c609719bSwdenk
2922628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
293c609719bSwdenk
2942628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2956ccec449SWolfgang Denk
2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
298c609719bSwdenk
299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define exactly one of
301c609719bSwdenk		CONFIG_CMA286_60_OLD
302c609719bSwdenk--- FIXME --- not tested yet:
303c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
305c609719bSwdenk
306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
307c609719bSwdenk		Define exactly one of
308c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
309c609719bSwdenk
310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define one or more of
312c609719bSwdenk		CONFIG_CMA302
313c609719bSwdenk
314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31711ccc33fSMarcel Ziswiler					  the LCD display every second with
318c609719bSwdenk					  a "rotator" |\-/|\-/
319c609719bSwdenk
3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3212535d602Swdenk		CONFIG_ADSTYPE
3222535d602Swdenk		Possible values are:
3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3272535d602Swdenk
328cf946c6dSLei Wen- Marvell Family Member
329cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
330cf946c6dSLei Wen					  multiple fs option at one time
331cf946c6dSLei Wen					  for marvell soc family
332cf946c6dSLei Wen
333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
334c609719bSwdenk		Define exactly one of
335c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
336c609719bSwdenk
33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33966ca92a5Swdenk					  get_gclk_freq() cannot work
3405da627a4Swdenk					  e.g. if there is no 32KHz
3415da627a4Swdenk					  reference PIT/RTC clock
34266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34366ca92a5Swdenk					  or XTAL/EXTAL)
344c609719bSwdenk
34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34975d1ea7fSwdenk			See doc/README.MPC866
35075d1ea7fSwdenk
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35275d1ea7fSwdenk
35375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35475d1ea7fSwdenk		of relying on the correctness of the configured
35575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35975d1ea7fSwdenk
360506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
361506f3918SHeiko Schocher
362506f3918SHeiko Schocher		Define this option if you want to enable the
363506f3918SHeiko Schocher		ICache only when Code runs from RAM.
364506f3918SHeiko Schocher
36566412c63SKumar Gala- 85xx CPU Options:
366*ffd06e02SYork Sun		CONFIG_SYS_PPC64
367*ffd06e02SYork Sun
368*ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
369*ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
370*ffd06e02SYork Sun		compliance, among other possible reasons.
371*ffd06e02SYork Sun
37266412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
37366412c63SKumar Gala
37466412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37566412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37666412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37766412c63SKumar Gala
3788f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3798f29084aSKumar Gala
3808f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3818f29084aSKumar Gala		tree nodes for the given platform.
3828f29084aSKumar Gala
383afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
384afa6b551SPrabhakar Kushwaha
385afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
386afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
387afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
388afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
389afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
390afa6b551SPrabhakar Kushwaha		purpose.
391afa6b551SPrabhakar Kushwaha
39233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
39333eee330SScott Wood
39433eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39533eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
39633eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
39733eee330SScott Wood
39833eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
39933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
40033eee330SScott Wood
40133eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
40233eee330SScott Wood		for which the A004510 workaround should be applied.
40333eee330SScott Wood
40433eee330SScott Wood		The rest of SVR is either not relevant to the decision
40533eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
40633eee330SScott Wood		p2041) or is implied by the build target, which controls
40733eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
40833eee330SScott Wood
40933eee330SScott Wood		See Freescale App Note 4493 for more information about
41033eee330SScott Wood		this erratum.
41133eee330SScott Wood
41233eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
41333eee330SScott Wood
41433eee330SScott Wood		This is the value to write into CCSR offset 0x18600
41533eee330SScott Wood		according to the A004510 workaround.
41633eee330SScott Wood
4176cb461b4SDaniel Schwierzeck- Generic CPU options:
4186cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4196cb461b4SDaniel Schwierzeck
4206cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4216cb461b4SDaniel Schwierzeck		values is arch specific.
4226cb461b4SDaniel Schwierzeck
4230b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4250b953ffcSMarkus Klotzbuecher
4260b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4270b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4280b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4290b953ffcSMarkus Klotzbuecher
4306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4310b953ffcSMarkus Klotzbuecher
4320b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4330b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4340b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4350b953ffcSMarkus Klotzbuecher		by this value.
4360b953ffcSMarkus Klotzbuecher
43792bbd64eSDaniel Schwierzeck- MIPS CPU options:
43892bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
43992bbd64eSDaniel Schwierzeck
44092bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
44192bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
44292bbd64eSDaniel Schwierzeck		relocation.
44392bbd64eSDaniel Schwierzeck
44492bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
44592bbd64eSDaniel Schwierzeck
44692bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
44792bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
44892bbd64eSDaniel Schwierzeck		Possible values are:
44992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
45092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
45192bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
45292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
45392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
45492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
45592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
45692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
45792bbd64eSDaniel Schwierzeck
45892bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
45992bbd64eSDaniel Schwierzeck
46092bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
46192bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
46292bbd64eSDaniel Schwierzeck
46392bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
46492bbd64eSDaniel Schwierzeck
46592bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
46692bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
46792bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
46892bbd64eSDaniel Schwierzeck
469b67d8816SChristian Riesch- ARM options:
470b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
471b67d8816SChristian Riesch
472b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
473b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
474b67d8816SChristian Riesch
4755356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4765356f545SAneesh V
4775356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4785356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4795356f545SAneesh V		better code density. For ARM architectures that support
4805356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4815356f545SAneesh V		GCC.
4825356f545SAneesh V
4835da627a4Swdenk- Linux Kernel Interface:
484c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
485c609719bSwdenk
486c609719bSwdenk		U-Boot stores all clock information in Hz
487c609719bSwdenk		internally. For binary compatibility with older Linux
488c609719bSwdenk		kernels (which expect the clocks passed in the
489c609719bSwdenk		bd_info data to be in MHz) the environment variable
490c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
491c609719bSwdenk		converts clock data to MHZ before passing it to the
492c609719bSwdenk		Linux kernel.
493c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
494c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
495c609719bSwdenk		default environment.
496c609719bSwdenk
4975da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4985da627a4Swdenk
49911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5005da627a4Swdenk		expect it to be in bytes, others in MB.
5015da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5025da627a4Swdenk
503fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
504f57f70aaSWolfgang Denk
505f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
506213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
507213bf8c8SGerald Van Baren		concepts).
508213bf8c8SGerald Van Baren
509213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
510213bf8c8SGerald Van Baren		 * New libfdt-based support
511213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5123bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
513213bf8c8SGerald Van Baren
514b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
515b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
516b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
517b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
518f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
519c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
520f57f70aaSWolfgang Denk
52111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
52211ccc33fSMarcel Ziswiler		addresses
5233bb342fcSKim Phillips
5244e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5254e253137SKumar Gala
5264e253137SKumar Gala		Board code has addition modification that it wants to make
5274e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5286705d81eSwdenk
5290267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5300267768eSMatthew McClintock
53111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5320267768eSMatthew McClintock		param header, the default value is zero if undefined.
5330267768eSMatthew McClintock
5343887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5353887c3fbSHeiko Schocher
5363887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5373887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5383887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5393887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5403887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5413887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5423887c3fbSHeiko Schocher
5437eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5447eb29398SIgor Grinberg
5457eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5467eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5477eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5487eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5497eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5507eb29398SIgor Grinberg		in a single configuration file and the machine type is
5517eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5527eb29398SIgor Grinberg
5530b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5540b2f4ecaSNiklaus Giger
5550b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5560b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5570b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5580b2f4ecaSNiklaus Giger
5590b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5600b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5610b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5620b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5630b2f4ecaSNiklaus Giger
5640b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5650b2f4ecaSNiklaus Giger
5660b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5670b2f4ecaSNiklaus Giger
5680b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5690b2f4ecaSNiklaus Giger		the defaults discussed just above.
5700b2f4ecaSNiklaus Giger
5712c451f78SAneesh V- Cache Configuration:
5722c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5732c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5742c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5752c451f78SAneesh V
57693bc2193SAneesh V- Cache Configuration for ARM:
57793bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
57893bc2193SAneesh V				      controller
57993bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
58093bc2193SAneesh V					controller register space
58193bc2193SAneesh V
5826705d81eSwdenk- Serial Ports:
58348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5846705d81eSwdenk
5856705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5866705d81eSwdenk
58748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5886705d81eSwdenk
5896705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5906705d81eSwdenk
5916705d81eSwdenk		CONFIG_PL011_CLOCK
5926705d81eSwdenk
5936705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5946705d81eSwdenk		the clock speed of the UARTs.
5956705d81eSwdenk
5966705d81eSwdenk		CONFIG_PL01x_PORTS
5976705d81eSwdenk
5986705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5996705d81eSwdenk		define this to a list of base addresses for each (supported)
6006705d81eSwdenk		port. See e.g. include/configs/versatile.h
6016705d81eSwdenk
602910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
603910f1ae3SJohn Rigby
604910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
605910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
606910f1ae3SJohn Rigby		this variable to initialize the extra register.
607910f1ae3SJohn Rigby
608910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
609910f1ae3SJohn Rigby
610910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
611910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
612910f1ae3SJohn Rigby		variable to flush the UART at init time.
613910f1ae3SJohn Rigby
6146705d81eSwdenk
615c609719bSwdenk- Console Interface:
616c609719bSwdenk		Depending on board, define exactly one serial port
617c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
618c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
619c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
620c609719bSwdenk
621c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
622c609719bSwdenk		port routines must be defined elsewhere
623c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
624c609719bSwdenk
625c609719bSwdenk		CONFIG_CFB_CONSOLE
626c609719bSwdenk		Enables console device for a color framebuffer. Needs following
627c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
628c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
629c609719bSwdenk						(default big endian)
630c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
631c609719bSwdenk						rectangle fill
632c609719bSwdenk						(cf. smiLynxEM)
633c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
634c609719bSwdenk						bit-blit (cf. smiLynxEM)
635c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
636c609719bSwdenk						(cols=pitch)
637c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
638c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
639c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
640c609719bSwdenk						(0-5, cf. cfb_console.c)
641c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
642c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
643c609719bSwdenk						(i.e. i8042_kbd_init())
644c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
645c609719bSwdenk						(i.e. i8042_tstc)
646c609719bSwdenk			VIDEO_GETC_FCT		get char fct
647c609719bSwdenk						(i.e. i8042_getc)
648c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
649c609719bSwdenk						(requires blink timer
650c609719bSwdenk						cf. i8042.c)
6516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
652c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
653c609719bSwdenk						upper right corner
654602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
655c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
656c609719bSwdenk						upper left corner
657a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
658a6c7ad2fSwdenk						linux_logo.h for logo.
659a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
660c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
66111ccc33fSMarcel Ziswiler						additional board info beside
662c609719bSwdenk						the logo
663c609719bSwdenk
664c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
665c609719bSwdenk		default i/o. Serial console can be forced with
666c609719bSwdenk		environment 'console=serial'.
667c609719bSwdenk
668a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
669a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
670a3ad8e26Swdenk		the "silent" environment variable. See
671a3ad8e26Swdenk		doc/README.silent for more information.
672a3ad8e26Swdenk
673c609719bSwdenk- Console Baudrate:
674c609719bSwdenk		CONFIG_BAUDRATE - in bps
675c609719bSwdenk		Select one of the baudrates listed in
6766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
678c609719bSwdenk
679c92fac91SHeiko Schocher- Console Rx buffer length
680c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
681c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6822b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
683c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
684c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
685c92fac91SHeiko Schocher		the SMC.
686c92fac91SHeiko Schocher
6879558b48aSGraeme Russ- Pre-Console Buffer:
6889558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6899558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6909558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6919558b48aSGraeme Russ		buffer any console messages prior to the console being
6929558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6939558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6949558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6959558b48aSGraeme Russ		bytes are output before the console is initialised, the
6969558b48aSGraeme Russ		earlier bytes are discarded.
6979558b48aSGraeme Russ
6989558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6999558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7009558b48aSGraeme Russ
701046a37bdSSonny Rao- Safe printf() functions
702046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
703046a37bdSSonny Rao		the printf() functions. These are defined in
704046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
705046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
706046a37bdSSonny Rao		If this option is not given then these functions will
707046a37bdSSonny Rao		silently discard their buffer size argument - this means
708046a37bdSSonny Rao		you are not getting any overflow checking in this case.
709046a37bdSSonny Rao
710c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
711c609719bSwdenk		Delay before automatically booting the default image;
712c609719bSwdenk		set to -1 to disable autoboot.
71393d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
71493d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
715c609719bSwdenk
716c609719bSwdenk		See doc/README.autoboot for these options that
717c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
718c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
719c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
720c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
721c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
722c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
723c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
724c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
725c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
726c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
727c609719bSwdenk		CONFIG_RESET_TO_RETRY
728c609719bSwdenk
729c609719bSwdenk- Autoboot Command:
730c609719bSwdenk		CONFIG_BOOTCOMMAND
731c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
732c609719bSwdenk		define a command string that is automatically executed
733c609719bSwdenk		when no character is read on the console interface
734c609719bSwdenk		within "Boot Delay" after reset.
735c609719bSwdenk
736c609719bSwdenk		CONFIG_BOOTARGS
737c609719bSwdenk		This can be used to pass arguments to the bootm
738c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
739c609719bSwdenk		environment value "bootargs".
740c609719bSwdenk
741c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
742c609719bSwdenk		The value of these goes into the environment as
743c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
744c609719bSwdenk		as a convenience, when switching between booting from
74511ccc33fSMarcel Ziswiler		RAM and NFS.
746c609719bSwdenk
747c609719bSwdenk- Pre-Boot Commands:
748c609719bSwdenk		CONFIG_PREBOOT
749c609719bSwdenk
750c609719bSwdenk		When this option is #defined, the existence of the
751c609719bSwdenk		environment variable "preboot" will be checked
752c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
753c609719bSwdenk		countdown and/or running the auto-boot command resp.
754c609719bSwdenk		entering interactive mode.
755c609719bSwdenk
756c609719bSwdenk		This feature is especially useful when "preboot" is
757c609719bSwdenk		automatically generated or modified. For an example
758c609719bSwdenk		see the LWMON board specific code: here "preboot" is
759c609719bSwdenk		modified when the user holds down a certain
760c609719bSwdenk		combination of keys on the (special) keyboard when
761c609719bSwdenk		booting the systems
762c609719bSwdenk
763c609719bSwdenk- Serial Download Echo Mode:
764c609719bSwdenk		CONFIG_LOADS_ECHO
765c609719bSwdenk		If defined to 1, all characters received during a
766c609719bSwdenk		serial download (using the "loads" command) are
767c609719bSwdenk		echoed back. This might be needed by some terminal
768c609719bSwdenk		emulations (like "cu"), but may as well just take
769c609719bSwdenk		time on others. This setting #define's the initial
770c609719bSwdenk		value of the "loads_echo" environment variable.
771c609719bSwdenk
772602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
773c609719bSwdenk		CONFIG_KGDB_BAUDRATE
774c609719bSwdenk		Select one of the baudrates listed in
7756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
776c609719bSwdenk
777c609719bSwdenk- Monitor Functions:
778602ad3b3SJon Loeliger		Monitor commands can be included or excluded
779602ad3b3SJon Loeliger		from the build by using the #include files
780c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
781c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
782602ad3b3SJon Loeliger		and augmenting with additional #define's
783602ad3b3SJon Loeliger		for wanted commands.
784c609719bSwdenk
785602ad3b3SJon Loeliger		The default command configuration includes all commands
786602ad3b3SJon Loeliger		except those marked below with a "*".
787602ad3b3SJon Loeliger
788602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
789602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
790602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
791602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
792602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
793602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
794602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
795602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
796710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
797602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
798602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
799602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
800a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
801a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
802a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
803a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
804602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
805602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
806246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
807602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
808602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8090c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
810bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
811602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
812602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
813602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
814602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
815602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
816a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
817a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
818602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
819602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
820602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
821602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
822602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
823602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8240c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
825c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
826602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
827602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
828602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
829602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8301ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
831d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
832d22c338eSJoe Hershberger					  (169.254.*.*)
833602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
834602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
83502c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
83602c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
837602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
83856523f12Swdenk					  loop, loopw, mtest
839602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
840602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
841602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
84268d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
843602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
844602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
845e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
846e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
847602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
848602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
849602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
850602ad3b3SJon Loeliger					  host
851602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
852602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
853602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
854602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
855602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
856602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
857602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
858602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
859602ad3b3SJon Loeliger					  (4xx only)
860f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
861c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
86202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
86374de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
864602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8657a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8661fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
867da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
868da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
869602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
870602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
871c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
872c609719bSwdenk
873c609719bSwdenk
874c609719bSwdenk		EXAMPLE: If you want all functions except of network
875c609719bSwdenk		support you can write:
876c609719bSwdenk
877602ad3b3SJon Loeliger		#include "config_cmd_all.h"
878602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
879c609719bSwdenk
880213bf8c8SGerald Van Baren	Other Commands:
881213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
882c609719bSwdenk
883c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
884602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
885c609719bSwdenk		what you (and your U-Boot users) are doing. Data
886c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
887c609719bSwdenk		8260 (where accesses to the IMMR region must be
888c609719bSwdenk		uncached), and it cannot be disabled on all other
889c609719bSwdenk		systems where we (mis-) use the data cache to hold an
890c609719bSwdenk		initial stack and some data.
891c609719bSwdenk
892c609719bSwdenk
893c609719bSwdenk		XXX - this list needs to get updated!
894c609719bSwdenk
89545ba8077SSimon Glass- Device tree:
89645ba8077SSimon Glass		CONFIG_OF_CONTROL
89745ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
89845ba8077SSimon Glass		to configure its devices, instead of relying on statically
89945ba8077SSimon Glass		compiled #defines in the board file. This option is
90045ba8077SSimon Glass		experimental and only available on a few boards. The device
90145ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
90245ba8077SSimon Glass
9032c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9042c0f79e4SSimon Glass		be done using one of the two options below:
905bbb0b128SSimon Glass
906bbb0b128SSimon Glass		CONFIG_OF_EMBED
907bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
908bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
909bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
910bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
911bbb0b128SSimon Glass		the global data structure as gd->blob.
91245ba8077SSimon Glass
9132c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9142c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9152c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9162c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9172c0f79e4SSimon Glass
9182c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9192c0f79e4SSimon Glass
9202c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9212c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9222c0f79e4SSimon Glass		still use the individual files if you need something more
9232c0f79e4SSimon Glass		exotic.
9242c0f79e4SSimon Glass
925c609719bSwdenk- Watchdog:
926c609719bSwdenk		CONFIG_WATCHDOG
927c609719bSwdenk		If this variable is defined, it enables watchdog
9286abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9296abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9306abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9316abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9326abe6fb6SDetlev Zundel		available, then no further board specific code should
9336abe6fb6SDetlev Zundel		be needed to use it.
9346abe6fb6SDetlev Zundel
9356abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9366abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9376abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9386abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
939c609719bSwdenk
940c1551ea8Sstroese- U-Boot Version:
941c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
942c1551ea8Sstroese		If this variable is defined, an environment variable
943c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
944c1551ea8Sstroese		version as printed by the "version" command.
945a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
946a1ea8e51SBenoît Thébaudeau		next reset.
947c1551ea8Sstroese
948c609719bSwdenk- Real-Time Clock:
949c609719bSwdenk
950602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
951c609719bSwdenk		has to be selected, too. Define exactly one of the
952c609719bSwdenk		following options:
953c609719bSwdenk
954c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
955c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9564e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
957c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9581cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
959c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9607f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9613bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9629536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9634c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
96571d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
96671d19f30SHeiko Schocher					  RV3029 RTC.
967c609719bSwdenk
968b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
969b37c7e5eSwdenk		must also be configured. See I2C Support, below.
970b37c7e5eSwdenk
971e92739d3SPeter Tyser- GPIO Support:
972e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
973e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
974e92739d3SPeter Tyser
9755dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9765dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9775dec49caSChris Packham		pins supported by a particular chip.
9785dec49caSChris Packham
979e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
980e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
981e92739d3SPeter Tyser
982c609719bSwdenk- Timestamp Support:
983c609719bSwdenk
984c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
985c609719bSwdenk		(date and time) of an image is printed by image
986c609719bSwdenk		commands like bootm or iminfo. This option is
987602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
988c609719bSwdenk
989923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
990923c46f9SKarl O. Pinc		Zero or more of the following:
991923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
992923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
993923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
994923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
995923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
996923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
997923c46f9SKarl O. Pinc				       disk/part_efi.c
998923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
999c609719bSwdenk
1000602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1001218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1002923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1003c609719bSwdenk
1004c609719bSwdenk- IDE Reset method:
10054d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10064d13cbadSwdenk		board configurations files but used nowhere!
1007c609719bSwdenk
10084d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10094d13cbadSwdenk		be performed by calling the function
10104d13cbadSwdenk			ide_set_reset(int reset)
10114d13cbadSwdenk		which has to be defined in a board specific file
1012c609719bSwdenk
1013c609719bSwdenk- ATAPI Support:
1014c609719bSwdenk		CONFIG_ATAPI
1015c609719bSwdenk
1016c609719bSwdenk		Set this to enable ATAPI support.
1017c609719bSwdenk
1018c40b2956Swdenk- LBA48 Support
1019c40b2956Swdenk		CONFIG_LBA48
1020c40b2956Swdenk
1021c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10224b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1023c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1024c40b2956Swdenk		support disks up to 2.1TB.
1025c40b2956Swdenk
10266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1027c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1028c40b2956Swdenk			Default is 32bit.
1029c40b2956Swdenk
1030c609719bSwdenk- SCSI Support:
1031c609719bSwdenk		At the moment only there is only support for the
1032c609719bSwdenk		SYM53C8XX SCSI controller; define
1033c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1034c609719bSwdenk
10356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1038c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1039c609719bSwdenk		devices.
10406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1041c609719bSwdenk
1042c609719bSwdenk- NETWORK Support (PCI):
1043682011ffSwdenk		CONFIG_E1000
1044ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1045ce5207e1SKyle Moffett
1046ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1047ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1048ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1049ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1050ce5207e1SKyle Moffett
1051ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1052ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1053ce5207e1SKyle Moffett		example with the "sspi" command.
1054ce5207e1SKyle Moffett
1055ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1056ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1057ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1058682011ffSwdenk
1059ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
106011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1061ac3315c2SAndre Schwarz
1062c609719bSwdenk		CONFIG_EEPRO100
1063c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
106411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1065c609719bSwdenk		write routine for first time initialisation.
1066c609719bSwdenk
1067c609719bSwdenk		CONFIG_TULIP
1068c609719bSwdenk		Support for Digital 2114x chips.
1069c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1070c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1071c609719bSwdenk
1072c609719bSwdenk		CONFIG_NATSEMI
1073c609719bSwdenk		Support for National dp83815 chips.
1074c609719bSwdenk
1075c609719bSwdenk		CONFIG_NS8382X
1076c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1077c609719bSwdenk
107845219c46Swdenk- NETWORK Support (other):
107945219c46Swdenk
1080c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1081c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1082c041e9d2SJens Scharsig
1083c041e9d2SJens Scharsig			CONFIG_RMII
1084c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1085c041e9d2SJens Scharsig
1086c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1087c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1088c041e9d2SJens Scharsig			The driver doen't show link status messages.
1089c041e9d2SJens Scharsig
1090efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1091efdd7319SRob Herring		Support for the Calxeda XGMAC device
1092efdd7319SRob Herring
109345219c46Swdenk		CONFIG_DRIVER_LAN91C96
109445219c46Swdenk		Support for SMSC's LAN91C96 chips.
109545219c46Swdenk
109645219c46Swdenk			CONFIG_LAN91C96_BASE
109745219c46Swdenk			Define this to hold the physical address
109845219c46Swdenk			of the LAN91C96's I/O space
109945219c46Swdenk
110045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
110145219c46Swdenk			Define this to enable 32 bit addressing
110245219c46Swdenk
1103f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1104f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1105f39748aeSwdenk
1106f39748aeSwdenk			CONFIG_SMC91111_BASE
1107f39748aeSwdenk			Define this to hold the physical address
1108f39748aeSwdenk			of the device (I/O space)
1109f39748aeSwdenk
1110f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1111f39748aeSwdenk			Define this if data bus is 32 bits
1112f39748aeSwdenk
1113f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1114f39748aeSwdenk			Define this to use i/o functions instead of macros
1115f39748aeSwdenk			(some hardware wont work with macros)
1116f39748aeSwdenk
1117dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1118dc02badaSHeiko Schocher		Support for davinci emac
1119dc02badaSHeiko Schocher
1120dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1121dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1122dc02badaSHeiko Schocher
1123b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1124b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1125b3dbf4a5SMacpaul Lin
1126b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1127b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1128b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1129b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1130b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1131b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1132b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1133b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1134b3dbf4a5SMacpaul Lin
1135c2fff331SMike Rapoport		CONFIG_SMC911X
1136557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1137557b377dSJens Gehrlein
1138c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1139557b377dSJens Gehrlein			Define this to hold the physical address
1140557b377dSJens Gehrlein			of the device (I/O space)
1141557b377dSJens Gehrlein
1142c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1143557b377dSJens Gehrlein			Define this if data bus is 32 bits
1144557b377dSJens Gehrlein
1145c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1146557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1147557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1148c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1149557b377dSJens Gehrlein
11503d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11513d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11523d0075faSYoshihiro Shimoda
11533d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11543d0075faSYoshihiro Shimoda			Define the number of ports to be used
11553d0075faSYoshihiro Shimoda
11563d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11573d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11583d0075faSYoshihiro Shimoda
115968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
116068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
116168260aabSYoshihiro Shimoda
11625e124724SVadim Bendebury- TPM Support:
11635e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11645e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11655e124724SVadim Bendebury		per system is supported at this time.
11665e124724SVadim Bendebury
11675e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11685e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11695e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11705e124724SVadim Bendebury			0xfed40000.
11715e124724SVadim Bendebury
1172c609719bSwdenk- USB Support:
1173c609719bSwdenk		At the moment only the UHCI host controller is
11744d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1175c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1176c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
117730d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1178c609719bSwdenk		storage devices.
1179c609719bSwdenk		Note:
1180c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1181c609719bSwdenk		(TEAC FD-05PUB).
11824d13cbadSwdenk		MPC5200 USB requires additional defines:
11834d13cbadSwdenk			CONFIG_USB_CLOCK
11844d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1185307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1186307ecb6dSEric Millbrandt				for USB on PSC3
11874d13cbadSwdenk			CONFIG_USB_CONFIG
11884d13cbadSwdenk				for differential drivers: 0x00001000
11894d13cbadSwdenk				for single ended drivers: 0x00005000
1190307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1191307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1193fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1194fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11954d13cbadSwdenk
11969ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11979ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
11989ab4ce22SSimon Glass
119916c8d5e7SWolfgang Denk- USB Device:
120016c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
120116c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
120216c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
120311ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
120416c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
120516c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
120616c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
120716c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
120816c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
120916c8d5e7SWolfgang Denk		a Linux host by
121016c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
121116c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
121216c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
121316c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
121416c8d5e7SWolfgang Denk
121516c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
121616c8d5e7SWolfgang Denk			Define this to build a UDC device
121716c8d5e7SWolfgang Denk
121816c8d5e7SWolfgang Denk			CONFIG_USB_TTY
121916c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
122016c8d5e7SWolfgang Denk			talk to the UDC device
122116c8d5e7SWolfgang Denk
1222f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1223f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1224f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1225f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1226f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1227f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1228f9da0f89SVipin KUMAR			speed.
1229f9da0f89SVipin KUMAR
12306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
123116c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
123216c8d5e7SWolfgang Denk			be set to usbtty.
123316c8d5e7SWolfgang Denk
123416c8d5e7SWolfgang Denk			mpc8xx:
12356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
123616c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
123816c8d5e7SWolfgang Denk
12396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
124016c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
124216c8d5e7SWolfgang Denk
124316c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
124416c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
124516c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
124616c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
124716c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
124816c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
124916c8d5e7SWolfgang Denk
125016c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
125116c8d5e7SWolfgang Denk			Define this string as the name of your company for
125216c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
125316c8d5e7SWolfgang Denk
125416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
125516c8d5e7SWolfgang Denk			Define this string as the name of your product
125616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
125716c8d5e7SWolfgang Denk
125816c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
125916c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
126016c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
126116c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
126216c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
126316c8d5e7SWolfgang Denk
126416c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
126516c8d5e7SWolfgang Denk			Define this as the unique Product ID
126616c8d5e7SWolfgang Denk			for your device
126716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1268c609719bSwdenk
1269d70a560fSIgor Grinberg- ULPI Layer Support:
1270d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1271d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1272d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1273d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1274d70a560fSIgor Grinberg		viewport is supported.
1275d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1276d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
12776d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
12786d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
12796d365ea0SLucas Stach		the appropriate value in Hz.
1280c609719bSwdenk
1281c609719bSwdenk- MMC Support:
1282c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1283c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1284c609719bSwdenk		accessed from the boot prompt by mapping the device
1285c609719bSwdenk		to physical memory similar to flash. Command line is
1286602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1287602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1288c609719bSwdenk
1289afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1290afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1291afb35666SYoshihiro Shimoda
1292afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1293afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1294afb35666SYoshihiro Shimoda
1295afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1296afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1297afb35666SYoshihiro Shimoda
12986705d81eSwdenk- Journaling Flash filesystem support:
12996705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13006705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13016705d81eSwdenk		Define these for a default partition on a NAND device
13026705d81eSwdenk
13036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13056705d81eSwdenk		Define these for a default partition on a NOR device
13066705d81eSwdenk
13076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13086705d81eSwdenk		Define this to create an own partition. You have to provide a
13096705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13106705d81eSwdenk
13116705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13136705d81eSwdenk		to disable the command chpart. This is the default when you
13146705d81eSwdenk		have not defined a custom partition
13156705d81eSwdenk
1316c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1317c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1318656f4c65SDonggeun Kim
1319656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1320656f4c65SDonggeun Kim		file in FAT formatted partition.
1321656f4c65SDonggeun Kim
1322656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1323656f4c65SDonggeun Kim		user to write files to FAT.
1324c30a15e5SDonggeun Kim
1325c609719bSwdenk- Keyboard Support:
1326c609719bSwdenk		CONFIG_ISA_KEYBOARD
1327c609719bSwdenk
1328c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1329c609719bSwdenk		support
1330c609719bSwdenk
1331c609719bSwdenk		CONFIG_I8042_KBD
1332c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1333c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1334c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1335c609719bSwdenk		for cfb_console. Supports cursor blinking.
1336c609719bSwdenk
1337c609719bSwdenk- Video support:
1338c609719bSwdenk		CONFIG_VIDEO
1339c609719bSwdenk
1340c609719bSwdenk		Define this to enable video support (for output to
1341c609719bSwdenk		video).
1342c609719bSwdenk
1343c609719bSwdenk		CONFIG_VIDEO_CT69000
1344c609719bSwdenk
1345c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1346c609719bSwdenk
1347c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1348eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1349eeb1b77bSwdenk		video output is selected via environment 'videoout'
1350eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1351eeb1b77bSwdenk		assumed.
1352c609719bSwdenk
1353eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
135411ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1355eeb1b77bSwdenk		are possible:
1356eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1357eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1358eeb1b77bSwdenk
1359eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1360eeb1b77bSwdenk		-------------+---------------------------------------------
1361eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1362eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1363eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1364eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1365eeb1b77bSwdenk		-------------+---------------------------------------------
1366c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1367c609719bSwdenk
1368eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13697817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1370eeb1b77bSwdenk
1371eeb1b77bSwdenk
1372a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1373a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1374a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1375a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1376a6c7ad2fSwdenk
13777d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13787d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13797d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13807d3053fbSTimur Tabi		support, and should also define these other macros:
13817d3053fbSTimur Tabi
13827d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13837d3053fbSTimur Tabi			CONFIG_VIDEO
13847d3053fbSTimur Tabi			CONFIG_CMD_BMP
13857d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13867d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13877d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13887d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13897d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13907d3053fbSTimur Tabi
1391ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1392ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1393ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1394ba8e76bdSTimur Tabi		description of this variable.
13957d3053fbSTimur Tabi
1396682011ffSwdenk- Keyboard Support:
1397682011ffSwdenk		CONFIG_KEYBOARD
1398682011ffSwdenk
1399682011ffSwdenk		Define this to enable a custom keyboard support.
1400682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1401682011ffSwdenk		defined in your board-specific files.
1402682011ffSwdenk		The only board using this so far is RBC823.
1403a6c7ad2fSwdenk
1404c609719bSwdenk- LCD Support:	CONFIG_LCD
1405c609719bSwdenk
1406c609719bSwdenk		Define this to enable LCD support (for output to LCD
1407c609719bSwdenk		display); also select one of the supported displays
1408c609719bSwdenk		by defining one of these:
1409c609719bSwdenk
141039cf4804SStelian Pop		CONFIG_ATMEL_LCD:
141139cf4804SStelian Pop
141239cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
141339cf4804SStelian Pop
1414fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1415c609719bSwdenk
1416fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1417c609719bSwdenk
1418fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1419c609719bSwdenk
1420fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1421fd3103bbSwdenk			Active, color, single scan.
1422fd3103bbSwdenk
1423fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1424fd3103bbSwdenk
1425fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1426c609719bSwdenk			Active, color, single scan.
1427c609719bSwdenk
1428c609719bSwdenk		CONFIG_SHARP_16x9
1429c609719bSwdenk
1430c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1431c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1432c609719bSwdenk
1433c609719bSwdenk		CONFIG_SHARP_LQ64D341
1434c609719bSwdenk
1435c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1436c609719bSwdenk			Active, color, single scan.
1437c609719bSwdenk
1438c609719bSwdenk		CONFIG_HLD1045
1439c609719bSwdenk
1440c609719bSwdenk			HLD1045 display, 640x480.
1441c609719bSwdenk			Active, color, single scan.
1442c609719bSwdenk
1443c609719bSwdenk		CONFIG_OPTREX_BW
1444c609719bSwdenk
1445c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1446c609719bSwdenk			or
1447c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1448c609719bSwdenk			or
1449c609719bSwdenk			Hitachi	 SP14Q002
1450c609719bSwdenk
1451c609719bSwdenk			320x240. Black & white.
1452c609719bSwdenk
1453c609719bSwdenk		Normally display is black on white background; define
14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1455c609719bSwdenk
14567152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1457d791b1dcSwdenk
1458d791b1dcSwdenk		If this option is set, the environment is checked for
1459d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1460d791b1dcSwdenk		of logo, copyright and system information on the LCD
1461e94d2cd9Swdenk		is suppressed and the BMP image at the address
1462d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1463d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1464d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1465d791b1dcSwdenk		loaded very quickly after power-on.
1466d791b1dcSwdenk
14671ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14681ca298ceSMatthias Weisser
14691ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14701ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14711ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14721ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14731ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14741ca298ceSMatthias Weisser		specify 'm' for centering the image.
14751ca298ceSMatthias Weisser
14761ca298ceSMatthias Weisser		Example:
14771ca298ceSMatthias Weisser		setenv splashpos m,m
14781ca298ceSMatthias Weisser			=> image at center of screen
14791ca298ceSMatthias Weisser
14801ca298ceSMatthias Weisser		setenv splashpos 30,20
14811ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14821ca298ceSMatthias Weisser
14831ca298ceSMatthias Weisser		setenv splashpos -10,m
14841ca298ceSMatthias Weisser			=> vertically centered image
14851ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14861ca298ceSMatthias Weisser
148798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
148898f4a3dfSStefan Roese
148998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
149098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
149198f4a3dfSStefan Roese		splashscreen support or the bmp command.
149298f4a3dfSStefan Roese
1493d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1494d5011762SAnatolij Gustschin
1495d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1496d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1497d5011762SAnatolij Gustschin		bmp command.
1498d5011762SAnatolij Gustschin
1499f2b96dfbSLei Wen- Do compresssing for memory range:
1500f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1501f2b96dfbSLei Wen
1502f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1503f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1504f2b96dfbSLei Wen
1505c29fdfc1Swdenk- Compression support:
1506c29fdfc1Swdenk		CONFIG_BZIP2
1507c29fdfc1Swdenk
1508c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1509c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1510c29fdfc1Swdenk		compressed images are supported.
1511c29fdfc1Swdenk
1512c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
15136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1514c29fdfc1Swdenk		be at least 4MB.
1515d791b1dcSwdenk
1516fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1517fc9c1727SLuigi 'Comio' Mantellini
1518fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1519fc9c1727SLuigi 'Comio' Mantellini		images is included.
1520fc9c1727SLuigi 'Comio' Mantellini
1521fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1522fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1523fc9c1727SLuigi 'Comio' Mantellini		formula:
1524fc9c1727SLuigi 'Comio' Mantellini
1525fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1526fc9c1727SLuigi 'Comio' Mantellini
1527fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1528fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1529fc9c1727SLuigi 'Comio' Mantellini
1530fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1531fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1532fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1533fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1534fc9c1727SLuigi 'Comio' Mantellini
1535fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1536fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
15376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1538fc9c1727SLuigi 'Comio' Mantellini
153917ea1177Swdenk- MII/PHY support:
154017ea1177Swdenk		CONFIG_PHY_ADDR
154117ea1177Swdenk
154217ea1177Swdenk		The address of PHY on MII bus.
154317ea1177Swdenk
154417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
154517ea1177Swdenk
154617ea1177Swdenk		The clock frequency of the MII bus
154717ea1177Swdenk
154817ea1177Swdenk		CONFIG_PHY_GIGE
154917ea1177Swdenk
155017ea1177Swdenk		If this option is set, support for speed/duplex
155111ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
155217ea1177Swdenk
155317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
155417ea1177Swdenk
155517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
155617ea1177Swdenk		reset before any MII register access is possible.
155717ea1177Swdenk		For such PHY, set this option to the usec delay
155817ea1177Swdenk		required. (minimum 300usec for LXT971A)
155917ea1177Swdenk
156017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
156117ea1177Swdenk
156217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
156317ea1177Swdenk		command issued before MII status register can be read
156417ea1177Swdenk
1565c609719bSwdenk- Ethernet address:
1566c609719bSwdenk		CONFIG_ETHADDR
1567c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1568c609719bSwdenk		CONFIG_ETH2ADDR
1569c609719bSwdenk		CONFIG_ETH3ADDR
1570c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1571c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1572c609719bSwdenk
157311ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
157411ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1575c609719bSwdenk		is not determined automatically.
1576c609719bSwdenk
1577c609719bSwdenk- IP address:
1578c609719bSwdenk		CONFIG_IPADDR
1579c609719bSwdenk
1580c609719bSwdenk		Define a default value for the IP address to use for
158111ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1582c609719bSwdenk		determined through e.g. bootp.
15831ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1584c609719bSwdenk
1585c609719bSwdenk- Server IP address:
1586c609719bSwdenk		CONFIG_SERVERIP
1587c609719bSwdenk
1588c609719bSwdenk		Defines a default value for the IP address of a TFTP
1589c609719bSwdenk		server to contact when using the "tftboot" command.
15901ebcd654SWolfgang Denk		(Environment variable "serverip")
1591c609719bSwdenk
159297cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
159397cfe861SRobin Getz
159497cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
159597cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
159697cfe861SRobin Getz
15971ebcd654SWolfgang Denk- Gateway IP address:
15981ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15991ebcd654SWolfgang Denk
16001ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16011ebcd654SWolfgang Denk		default router where packets to other networks are
16021ebcd654SWolfgang Denk		sent to.
16031ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16041ebcd654SWolfgang Denk
16051ebcd654SWolfgang Denk- Subnet mask:
16061ebcd654SWolfgang Denk		CONFIG_NETMASK
16071ebcd654SWolfgang Denk
16081ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16091ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16101ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16111ebcd654SWolfgang Denk		forwarded through a router.
16121ebcd654SWolfgang Denk		(Environment variable "netmask")
16131ebcd654SWolfgang Denk
161453a5c424SDavid Updegraff- Multicast TFTP Mode:
161553a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
161653a5c424SDavid Updegraff
161753a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
161853a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
161911ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
162053a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
162153a5c424SDavid Updegraff		multicast group.
162253a5c424SDavid Updegraff
1623c609719bSwdenk- BOOTP Recovery Mode:
1624c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1625c609719bSwdenk
1626c609719bSwdenk		If you have many targets in a network that try to
1627c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1628c609719bSwdenk		systems send out BOOTP requests at precisely the same
1629c609719bSwdenk		moment (which would happen for instance at recovery
1630c609719bSwdenk		from a power failure, when all systems will try to
1631c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1632c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1633c609719bSwdenk		inserted before sending out BOOTP requests. The
16346c33c785SWolfgang Denk		following delays are inserted then:
1635c609719bSwdenk
1636c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1637c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1638c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1639c609719bSwdenk		4th and following
1640c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1641c609719bSwdenk
1642fe389a82Sstroese- DHCP Advanced Options:
16431fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
16441fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1645fe389a82Sstroese
16461fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
16471fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
16481fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16491fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16501fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16511fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16521fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16531fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16541fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16551fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16561fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16571fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16582c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1659fe389a82Sstroese
16605d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16615d110f0aSWilson Callan		environment variable, not the BOOTP server.
1662fe389a82Sstroese
16632c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16642c00e099SJoe Hershberger		after the configured retry count, the call will fail
16652c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16662c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16672c00e099SJoe Hershberger		is not available.
16682c00e099SJoe Hershberger
1669fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1670fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1671fe389a82Sstroese		than one DNS serverip is offered to the client.
1672fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1673fe389a82Sstroese		serverip will be stored in the additional environment
1674fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1675fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16761fe80d79SJon Loeliger		is defined.
1677fe389a82Sstroese
1678fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1679fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1680fe389a82Sstroese		need the hostname of the DHCP requester.
16815d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16821fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16831fe80d79SJon Loeliger		option 12 to the DHCP server.
1684fe389a82Sstroese
1685d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1686d9a2f416SAras Vaichas
1687d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1688d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1689d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1690d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1691d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1692d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1693d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1694d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1695d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1696d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1697d9a2f416SAras Vaichas		this delay.
1698d9a2f416SAras Vaichas
1699d22c338eSJoe Hershberger - Link-local IP address negotiation:
1700d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1701d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1702d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1703d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1704d22c338eSJoe Hershberger
1705d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1706d22c338eSJoe Hershberger
1707a3d991bdSwdenk - CDP Options:
1708a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1709a3d991bdSwdenk
1710a3d991bdSwdenk		The device id used in CDP trigger frames.
1711a3d991bdSwdenk
1712a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1713a3d991bdSwdenk
1714a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1715a3d991bdSwdenk		of the device.
1716a3d991bdSwdenk
1717a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1718a3d991bdSwdenk
1719a3d991bdSwdenk		A printf format string which contains the ascii name of
1720a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
172111ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1722a3d991bdSwdenk
1723a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1724a3d991bdSwdenk
1725a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1726a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1727a3d991bdSwdenk
1728a3d991bdSwdenk		CONFIG_CDP_VERSION
1729a3d991bdSwdenk
1730a3d991bdSwdenk		An ascii string containing the version of the software.
1731a3d991bdSwdenk
1732a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1733a3d991bdSwdenk
1734a3d991bdSwdenk		An ascii string containing the name of the platform.
1735a3d991bdSwdenk
1736a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1737a3d991bdSwdenk
1738a3d991bdSwdenk		A 32bit integer sent on the trigger.
1739a3d991bdSwdenk
1740a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1741a3d991bdSwdenk
1742a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1743a3d991bdSwdenk		device in .1 of milliwatts.
1744a3d991bdSwdenk
1745a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1746a3d991bdSwdenk
1747a3d991bdSwdenk		A byte containing the id of the VLAN.
1748a3d991bdSwdenk
1749c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1750c609719bSwdenk
1751c609719bSwdenk		Several configurations allow to display the current
1752c609719bSwdenk		status using a LED. For instance, the LED will blink
1753c609719bSwdenk		fast while running U-Boot code, stop blinking as
1754c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1755c609719bSwdenk		start blinking slow once the Linux kernel is running
1756c609719bSwdenk		(supported by a status LED driver in the Linux
1757c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1758c609719bSwdenk		feature in U-Boot.
1759c609719bSwdenk
1760c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1761c609719bSwdenk
1762c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1763c609719bSwdenk		on those systems that support this (optional)
1764c609719bSwdenk		feature, like the TQM8xxL modules.
1765c609719bSwdenk
1766c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1767c609719bSwdenk
1768b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1769b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
177011ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1771c609719bSwdenk
1772b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1773602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1774b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1775b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1776c609719bSwdenk		command line interface.
1777c609719bSwdenk
1778bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1779c609719bSwdenk
1780b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1781b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1782b37c7e5eSwdenk		support for I2C.
1783c609719bSwdenk
1784b37c7e5eSwdenk		There are several other quantities that must also be
1785b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1786c609719bSwdenk
17876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1788b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
17896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
179011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1791c609719bSwdenk
17928d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1793a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
17948d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
17958d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
17968d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1797b37c7e5eSwdenk
17985da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
17995da71efaSEric Millbrandt
18005da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
18015da71efaSEric Millbrandt		chips might think that the current transfer is still
18025da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
18035da71efaSEric Millbrandt		commands until the slave device responds.
18045da71efaSEric Millbrandt
1805b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1806b37c7e5eSwdenk
1807b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1808b37c7e5eSwdenk		then the following macros need to be defined (examples are
1809b37c7e5eSwdenk		from include/configs/lwmon.h):
1810c609719bSwdenk
1811c609719bSwdenk		I2C_INIT
1812c609719bSwdenk
1813b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1814c609719bSwdenk		controller or configure ports.
1815c609719bSwdenk
1816b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1817b37c7e5eSwdenk
1818c609719bSwdenk		I2C_PORT
1819c609719bSwdenk
1820c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1821c609719bSwdenk		assumes both bits are on the same port). Valid values
1822c609719bSwdenk		are 0..3 for ports A..D.
1823c609719bSwdenk
1824c609719bSwdenk		I2C_ACTIVE
1825c609719bSwdenk
1826c609719bSwdenk		The code necessary to make the I2C data line active
1827c609719bSwdenk		(driven).  If the data line is open collector, this
1828c609719bSwdenk		define can be null.
1829c609719bSwdenk
1830b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1831b37c7e5eSwdenk
1832c609719bSwdenk		I2C_TRISTATE
1833c609719bSwdenk
1834c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1835c609719bSwdenk		(inactive).  If the data line is open collector, this
1836c609719bSwdenk		define can be null.
1837c609719bSwdenk
1838b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1839b37c7e5eSwdenk
1840c609719bSwdenk		I2C_READ
1841c609719bSwdenk
1842c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1843c609719bSwdenk		FALSE if it is low.
1844c609719bSwdenk
1845b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1846b37c7e5eSwdenk
1847c609719bSwdenk		I2C_SDA(bit)
1848c609719bSwdenk
1849c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1850c609719bSwdenk		is FALSE, it clears it (low).
1851c609719bSwdenk
1852b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1853b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1854b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1855b37c7e5eSwdenk
1856c609719bSwdenk		I2C_SCL(bit)
1857c609719bSwdenk
1858c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1859c609719bSwdenk		is FALSE, it clears it (low).
1860c609719bSwdenk
1861b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1862b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1863b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1864b37c7e5eSwdenk
1865c609719bSwdenk		I2C_DELAY
1866c609719bSwdenk
1867c609719bSwdenk		This delay is invoked four times per clock cycle so this
1868c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1869b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1870b37c7e5eSwdenk		like:
1871b37c7e5eSwdenk
1872b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1873c609719bSwdenk
1874793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1875793b5726SMike Frysinger
1876793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1877793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1878793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1879793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1880793b5726SMike Frysinger
1881793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1882793b5726SMike Frysinger		the generic GPIO functions.
1883793b5726SMike Frysinger
18846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
188547cd00faSwdenk
188647cd00faSwdenk		When a board is reset during an i2c bus transfer
188747cd00faSwdenk		chips might think that the current transfer is still
188847cd00faSwdenk		in progress. On some boards it is possible to access
188947cd00faSwdenk		the i2c SCLK line directly, either by using the
189047cd00faSwdenk		processor pin as a GPIO or by having a second pin
189147cd00faSwdenk		connected to the bus. If this option is defined a
189247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
189347cd00faSwdenk		is run early in the boot sequence.
189447cd00faSwdenk
189526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
189626a33504SRichard Retanubun
189726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
189826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
189926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
190026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
190126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
190226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
190326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
190426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
190526a33504SRichard Retanubun
190617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
190717ea1177Swdenk
190817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
190917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
191017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
191117ea1177Swdenk
1912bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1913bb99ad6dSBen Warren
1914bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1915bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1916bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1917bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1918bb99ad6dSBen Warren
19196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1920bb99ad6dSBen Warren
1921bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
19220f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
19230f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
19240f89c54bSPeter Tyser		a 1D array of device addresses
1925bb99ad6dSBen Warren
1926bb99ad6dSBen Warren		e.g.
1927bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
19286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1929bb99ad6dSBen Warren
1930bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1931bb99ad6dSBen Warren
1932bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
19336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1934bb99ad6dSBen Warren
1935bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1936bb99ad6dSBen Warren
19376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1938be5e6181STimur Tabi
1939be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1940be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1941be5e6181STimur Tabi
19426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
19430dc018ecSStefan Roese
19440dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
19450dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
19460dc018ecSStefan Roese
19476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
19480dc018ecSStefan Roese
19490dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
19500dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
19510dc018ecSStefan Roese
19526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19539ebbb54fSVictor Gallardo
19549ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19559ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19569ebbb54fSVictor Gallardo		specified DTT device.
19579ebbb54fSVictor Gallardo
1958be5e6181STimur Tabi		CONFIG_FSL_I2C
1959be5e6181STimur Tabi
1960be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
19617817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1962be5e6181STimur Tabi
196367b23a32SHeiko Schocher		CONFIG_I2C_MUX
196467b23a32SHeiko Schocher
196567b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
196667b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
196767b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
196867b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
196967b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
197067b23a32SHeiko Schocher		the muxes to activate this new "bus".
197167b23a32SHeiko Schocher
197267b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
197367b23a32SHeiko Schocher		feature!
197467b23a32SHeiko Schocher
197567b23a32SHeiko Schocher		Example:
197667b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
197767b23a32SHeiko Schocher			The First mux with address 70 and channel 6
197867b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
197967b23a32SHeiko Schocher
198067b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
198167b23a32SHeiko Schocher
198267b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
198367b23a32SHeiko Schocher		of I2C Busses with muxes:
198467b23a32SHeiko Schocher
198567b23a32SHeiko Schocher		=> i2c bus
198667b23a32SHeiko Schocher		Busses reached over muxes:
198767b23a32SHeiko Schocher		Bus ID: 2
198867b23a32SHeiko Schocher		  reached over Mux(es):
198967b23a32SHeiko Schocher		    pca9544a@70 ch: 4
199067b23a32SHeiko Schocher		Bus ID: 3
199167b23a32SHeiko Schocher		  reached over Mux(es):
199267b23a32SHeiko Schocher		    pca9544a@70 ch: 6
199367b23a32SHeiko Schocher		    pca9544a@71 ch: 4
199467b23a32SHeiko Schocher		=>
199567b23a32SHeiko Schocher
199667b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1997f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1998f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
199967b23a32SHeiko Schocher		the channel 4.
200067b23a32SHeiko Schocher
200167b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2002f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
200367b23a32SHeiko Schocher		the 2 muxes.
200467b23a32SHeiko Schocher
200567b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
200667b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
200767b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
200867b23a32SHeiko Schocher		to add this option to other architectures.
200967b23a32SHeiko Schocher
20102ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20112ac6985aSAndrew Dyer
20122ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20132ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20142ac6985aSAndrew Dyer		between writing the address pointer and reading the
20152ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20162ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20172ac6985aSAndrew Dyer		devices can use either method, but some require one or
20182ac6985aSAndrew Dyer		the other.
2019be5e6181STimur Tabi
2020c609719bSwdenk- SPI Support:	CONFIG_SPI
2021c609719bSwdenk
2022c609719bSwdenk		Enables SPI driver (so far only tested with
2023c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2024c609719bSwdenk		D/As on the SACSng board)
2025c609719bSwdenk
20266639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20276639562eSYoshihiro Shimoda
20286639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20296639562eSYoshihiro Shimoda		only SH7757 is supported.
20306639562eSYoshihiro Shimoda
2031c609719bSwdenk		CONFIG_SPI_X
2032c609719bSwdenk
2033c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2034c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2035c609719bSwdenk
2036c609719bSwdenk		CONFIG_SOFT_SPI
2037c609719bSwdenk
2038c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2039c609719bSwdenk		using hardware support. This is a general purpose
2040c609719bSwdenk		driver that only requires three general I/O port pins
2041c609719bSwdenk		(two outputs, one input) to function. If this is
2042c609719bSwdenk		defined, the board configuration must define several
2043c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2044c609719bSwdenk		an example, see include/configs/sacsng.h.
2045c609719bSwdenk
204604a9e118SBen Warren		CONFIG_HARD_SPI
204704a9e118SBen Warren
204804a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
204904a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
205004a9e118SBen Warren		must define a list of chip-select function pointers.
205104a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
205204a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
205304a9e118SBen Warren
205438254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
205538254f45SGuennadi Liakhovetski
205638254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20572e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
205838254f45SGuennadi Liakhovetski
20590133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20600133502eSMatthias Fuchs
20610133502eSMatthias Fuchs		Enables FPGA subsystem.
20620133502eSMatthias Fuchs
20630133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20640133502eSMatthias Fuchs
20650133502eSMatthias Fuchs		Enables support for specific chip vendors.
20660133502eSMatthias Fuchs		(ALTERA, XILINX)
20670133502eSMatthias Fuchs
20680133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20690133502eSMatthias Fuchs
20700133502eSMatthias Fuchs		Enables support for FPGA family.
20710133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20720133502eSMatthias Fuchs
20730133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2074c609719bSwdenk
2075c609719bSwdenk		Specify the number of FPGA devices to support.
2076c609719bSwdenk
20776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2078c609719bSwdenk
2079c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2080c609719bSwdenk
20816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2082c609719bSwdenk
2083c609719bSwdenk		Enable checks on FPGA configuration interface busy
2084c609719bSwdenk		status by the configuration function. This option
2085c609719bSwdenk		will require a board or device specific function to
2086c609719bSwdenk		be written.
2087c609719bSwdenk
2088c609719bSwdenk		CONFIG_FPGA_DELAY
2089c609719bSwdenk
2090c609719bSwdenk		If defined, a function that provides delays in the FPGA
2091c609719bSwdenk		configuration driver.
2092c609719bSwdenk
20936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2094c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2095c609719bSwdenk
20966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2097c609719bSwdenk
2098c609719bSwdenk		Check for configuration errors during FPGA bitfile
2099c609719bSwdenk		loading. For example, abort during Virtex II
2100c609719bSwdenk		configuration if the INIT_B line goes low (which
2101c609719bSwdenk		indicated a CRC error).
2102c609719bSwdenk
21036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2104c609719bSwdenk
2105c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2106c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2107c609719bSwdenk		FPGA configuration sequence. The default time is 500
210811ccc33fSMarcel Ziswiler		ms.
2109c609719bSwdenk
21106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2111c609719bSwdenk
2112c609719bSwdenk		Maximum time to wait for BUSY to deassert during
211311ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2114c609719bSwdenk
21156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2116c609719bSwdenk
2117c609719bSwdenk		Time to wait after FPGA configuration. The default is
211811ccc33fSMarcel Ziswiler		200 ms.
2119c609719bSwdenk
2120c609719bSwdenk- Configuration Management:
2121c609719bSwdenk		CONFIG_IDENT_STRING
2122c609719bSwdenk
2123c609719bSwdenk		If defined, this string will be added to the U-Boot
2124c609719bSwdenk		version information (U_BOOT_VERSION)
2125c609719bSwdenk
2126c609719bSwdenk- Vendor Parameter Protection:
2127c609719bSwdenk
2128c609719bSwdenk		U-Boot considers the values of the environment
2129c609719bSwdenk		variables "serial#" (Board Serial Number) and
21307152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2131c609719bSwdenk		are set once by the board vendor / manufacturer, and
2132c609719bSwdenk		protects these variables from casual modification by
2133c609719bSwdenk		the user. Once set, these variables are read-only,
2134c609719bSwdenk		and write or delete attempts are rejected. You can
213511ccc33fSMarcel Ziswiler		change this behaviour:
2136c609719bSwdenk
2137c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2138c609719bSwdenk		file, the write protection for vendor parameters is
213947cd00faSwdenk		completely disabled. Anybody can change or delete
2140c609719bSwdenk		these parameters.
2141c609719bSwdenk
2142c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2143c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
214411ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2145c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2146c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2147c609719bSwdenk		read-only.]
2148c609719bSwdenk
2149c609719bSwdenk- Protected RAM:
2150c609719bSwdenk		CONFIG_PRAM
2151c609719bSwdenk
2152c609719bSwdenk		Define this variable to enable the reservation of
2153c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2154c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2155c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2156c609719bSwdenk		this default value by defining an environment
2157c609719bSwdenk		variable "pram" to the number of kB you want to
2158c609719bSwdenk		reserve. Note that the board info structure will
2159c609719bSwdenk		still show the full amount of RAM. If pRAM is
2160c609719bSwdenk		reserved, a new environment variable "mem" will
2161c609719bSwdenk		automatically be defined to hold the amount of
2162c609719bSwdenk		remaining RAM in a form that can be passed as boot
2163c609719bSwdenk		argument to Linux, for instance like that:
2164c609719bSwdenk
2165fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2166c609719bSwdenk			saveenv
2167c609719bSwdenk
2168c609719bSwdenk		This way you can tell Linux not to use this memory,
2169c609719bSwdenk		either, which results in a memory region that will
2170c609719bSwdenk		not be affected by reboots.
2171c609719bSwdenk
2172c609719bSwdenk		*WARNING* If your board configuration uses automatic
2173c609719bSwdenk		detection of the RAM size, you must make sure that
2174c609719bSwdenk		this memory test is non-destructive. So far, the
2175c609719bSwdenk		following board configurations are known to be
2176c609719bSwdenk		"pRAM-clean":
2177c609719bSwdenk
2178c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2179c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
2180544d97e9SWolfgang Denk			FLAGADM, TQM8260
2181c609719bSwdenk
2182c609719bSwdenk- Error Recovery:
2183c609719bSwdenk		CONFIG_PANIC_HANG
2184c609719bSwdenk
2185c609719bSwdenk		Define this variable to stop the system in case of a
2186c609719bSwdenk		fatal error, so that you have to reset it manually.
2187c609719bSwdenk		This is probably NOT a good idea for an embedded
218811ccc33fSMarcel Ziswiler		system where you want the system to reboot
2189c609719bSwdenk		automatically as fast as possible, but it may be
2190c609719bSwdenk		useful during development since you can try to debug
2191c609719bSwdenk		the conditions that lead to the situation.
2192c609719bSwdenk
2193c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2194c609719bSwdenk
2195c609719bSwdenk		This variable defines the number of retries for
2196c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2197c609719bSwdenk		before giving up the operation. If not defined, a
2198c609719bSwdenk		default value of 5 is used.
2199c609719bSwdenk
220040cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
220140cb90eeSGuennadi Liakhovetski
220240cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
220340cb90eeSGuennadi Liakhovetski
220448a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
220548a3e999STetsuyuki Kobayashi
220648a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
220748a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
220848a3e999STetsuyuki Kobayashi		try longer timeout such as
220948a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
221048a3e999STetsuyuki Kobayashi
2211c609719bSwdenk- Command Interpreter:
22128078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
221304a85b3bSwdenk
221404a85b3bSwdenk		Enable auto completion of commands using TAB.
221504a85b3bSwdenk
22168078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
22178078f1a5SWolfgang Denk		for the "hush" shell.
22188078f1a5SWolfgang Denk
22198078f1a5SWolfgang Denk
22206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2221c609719bSwdenk
2222c609719bSwdenk		Define this variable to enable the "hush" shell (from
2223c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2224c609719bSwdenk		powerful command line syntax like
2225c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2226c609719bSwdenk		constructs ("shell scripts").
2227c609719bSwdenk
2228c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2229c609719bSwdenk		with a somewhat smaller memory footprint.
2230c609719bSwdenk
2231c609719bSwdenk
22326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2233c609719bSwdenk
2234c609719bSwdenk		This defines the secondary prompt string, which is
2235c609719bSwdenk		printed when the command interpreter needs more input
2236c609719bSwdenk		to complete a command. Usually "> ".
2237c609719bSwdenk
2238c609719bSwdenk	Note:
2239c609719bSwdenk
2240c609719bSwdenk		In the current implementation, the local variables
2241c609719bSwdenk		space and global environment variables space are
2242c609719bSwdenk		separated. Local variables are those you define by
22433b57fe0aSwdenk		simply typing `name=value'. To access a local
2244c609719bSwdenk		variable later on, you have write `$name' or
22453b57fe0aSwdenk		`${name}'; to execute the contents of a variable
22463b57fe0aSwdenk		directly type `$name' at the command prompt.
2247c609719bSwdenk
2248c609719bSwdenk		Global environment variables are those you use
2249c609719bSwdenk		setenv/printenv to work with. To run a command stored
2250c609719bSwdenk		in such a variable, you need to use the run command,
2251c609719bSwdenk		and you must not use the '$' sign to access them.
2252c609719bSwdenk
2253c609719bSwdenk		To store commands and special characters in a
2254c609719bSwdenk		variable, please use double quotation marks
2255c609719bSwdenk		surrounding the whole text of the variable, instead
2256c609719bSwdenk		of the backslashes before semicolons and special
2257c609719bSwdenk		symbols.
2258c609719bSwdenk
2259aa0c71acSWolfgang Denk- Commandline Editing and History:
2260aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2261aa0c71acSWolfgang Denk
226211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2263aa0c71acSWolfgang Denk		commandline input operations
2264aa0c71acSWolfgang Denk
2265a8c7c708Swdenk- Default Environment:
2266c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2267c609719bSwdenk
2268c609719bSwdenk		Define this to contain any number of null terminated
2269c609719bSwdenk		strings (variable = value pairs) that will be part of
22707152b1d0Swdenk		the default environment compiled into the boot image.
22712262cfeeSwdenk
2272c609719bSwdenk		For example, place something like this in your
2273c609719bSwdenk		board's config file:
2274c609719bSwdenk
2275c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2276c609719bSwdenk			"myvar1=value1\0" \
2277c609719bSwdenk			"myvar2=value2\0"
2278c609719bSwdenk
2279c609719bSwdenk		Warning: This method is based on knowledge about the
2280c609719bSwdenk		internal format how the environment is stored by the
22812262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2282c609719bSwdenk		interface! Although it is unlikely that this format
22837152b1d0Swdenk		will change soon, there is no guarantee either.
2284c609719bSwdenk		You better know what you are doing here.
2285c609719bSwdenk
2286c609719bSwdenk		Note: overly (ab)use of the default environment is
2287c609719bSwdenk		discouraged. Make sure to check other ways to preset
228874de7aefSWolfgang Denk		the environment like the "source" command or the
2289c609719bSwdenk		boot command first.
2290c609719bSwdenk
22915e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
22925e724ca2SStephen Warren
22935e724ca2SStephen Warren		Define this in order to add variables describing the
22945e724ca2SStephen Warren		U-Boot build configuration to the default environment.
22955e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
22965e724ca2SStephen Warren
22975e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
22985e724ca2SStephen Warren
22995e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23005e724ca2SStephen Warren		- CONFIG_SYS_CPU
23015e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23025e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23035e724ca2SStephen Warren		- CONFIG_SYS_SOC
23045e724ca2SStephen Warren
2305a8c7c708Swdenk- DataFlash Support:
23062abbe075Swdenk		CONFIG_HAS_DATAFLASH
23072abbe075Swdenk
23082abbe075Swdenk		Defining this option enables DataFlash features and
23092abbe075Swdenk		allows to read/write in Dataflash via the standard
23102abbe075Swdenk		commands cp, md...
23112abbe075Swdenk
2312f61ec45eSEric Nelson- Serial Flash support
2313f61ec45eSEric Nelson		CONFIG_CMD_SF
2314f61ec45eSEric Nelson
2315f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2316f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2317f61ec45eSEric Nelson
2318f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2319f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2320f61ec45eSEric Nelson		commands.
2321f61ec45eSEric Nelson
2322f61ec45eSEric Nelson		The following defaults may be provided by the platform
2323f61ec45eSEric Nelson		to handle the common case when only a single serial
2324f61ec45eSEric Nelson		flash is present on the system.
2325f61ec45eSEric Nelson
2326f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2327f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2328f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2329f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2330f61ec45eSEric Nelson
23313f85ce27Swdenk- SystemACE Support:
23323f85ce27Swdenk		CONFIG_SYSTEMACE
23333f85ce27Swdenk
23343f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
23353f85ce27Swdenk		chips attached via some sort of local bus. The address
233611ccc33fSMarcel Ziswiler		of the chip must also be defined in the
23376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
23383f85ce27Swdenk
23393f85ce27Swdenk		#define CONFIG_SYSTEMACE
23406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
23413f85ce27Swdenk
23423f85ce27Swdenk		When SystemACE support is added, the "ace" device type
23433f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
23443f85ce27Swdenk
2345ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2346ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2347ecb0ccd9SWolfgang Denk
234828cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2349ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
235028cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2351ecb0ccd9SWolfgang Denk		number generator is used.
2352ecb0ccd9SWolfgang Denk
235328cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
235428cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
235528cb9375SWolfgang Denk		defined, the normal port 69 is used.
235628cb9375SWolfgang Denk
235728cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2358ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2359ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2360ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2361ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2362ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2363ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2364ecb0ccd9SWolfgang Denk
2365a8c7c708Swdenk- Show boot progress:
2366c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2367c609719bSwdenk
2368c609719bSwdenk		Defining this option allows to add some board-
2369c609719bSwdenk		specific code (calling a user-provided function
2370c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2371c609719bSwdenk		the system's boot progress on some display (for
2372c609719bSwdenk		example, some LED's) on your board. At the moment,
2373c609719bSwdenk		the following checkpoints are implemented:
2374c609719bSwdenk
23753a608ca0SSimon Glass- Detailed boot stage timing
23763a608ca0SSimon Glass		CONFIG_BOOTSTAGE
23773a608ca0SSimon Glass		Define this option to get detailed timing of each stage
23783a608ca0SSimon Glass		of the boot process.
23793a608ca0SSimon Glass
23803a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
23813a608ca0SSimon Glass		This is the number of available user bootstage records.
23823a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
23833a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
23843a608ca0SSimon Glass		the limit, recording will stop.
23853a608ca0SSimon Glass
23863a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
23873a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
23883a608ca0SSimon Glass
23893a608ca0SSimon Glass		Timer summary in microseconds:
23903a608ca0SSimon Glass		       Mark    Elapsed  Stage
23913a608ca0SSimon Glass			  0          0  reset
23923a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
23933a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
23943a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
23953a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
23963a608ca0SSimon Glass		  3,910,375    250,777  main_loop
23973a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
23983a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
23993a608ca0SSimon Glass
24002eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
24012eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
24022eba38cfSSimon Glass		and un/stashing of bootstage data.
24032eba38cfSSimon Glass
240494fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
240594fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
240694fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
240794fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
240894fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
240994fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
241094fd1316SSimon Glass		For example:
241194fd1316SSimon Glass
241294fd1316SSimon Glass		bootstage {
241394fd1316SSimon Glass			154 {
241494fd1316SSimon Glass				name = "board_init_f";
241594fd1316SSimon Glass				mark = <3575678>;
241694fd1316SSimon Glass			};
241794fd1316SSimon Glass			170 {
241894fd1316SSimon Glass				name = "lcd";
241994fd1316SSimon Glass				accum = <33482>;
242094fd1316SSimon Glass			};
242194fd1316SSimon Glass		};
242294fd1316SSimon Glass
242394fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
242494fd1316SSimon Glass
24251372cce2SMarian BalakowiczLegacy uImage format:
24261372cce2SMarian Balakowicz
2427c609719bSwdenk  Arg	Where			When
2428c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2429c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2430c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2431c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2432c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2433c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2434c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2435c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2436c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
24371372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2438c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2439c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2440c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2441c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
24421372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2443c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
24441372cce2SMarian Balakowicz
24451372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
24461372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
24471372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
24481372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
24491372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
24501372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
24511372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
245211ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
24531372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
24541372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
24551372cce2SMarian Balakowicz
2456ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2457c609719bSwdenk
2458a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
245963e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
246063e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
246163e73c9aSwdenk
2462566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2463566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2464566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2465566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2466566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2467566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2468566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2469566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2470566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2471566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2472566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2473566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2474566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2475566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2476566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2477566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2478566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2479566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2480566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2481566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2482566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2483566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2484566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2485566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2486566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2487566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2488566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2489566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2490566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2491566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2492566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2493566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2494566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2495566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2496566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2497566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2498566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2499566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2500566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2501566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2502566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2503566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2504566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2505566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2506566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2507566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2508566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2509c609719bSwdenk
2510566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2511c609719bSwdenk
2512566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2513566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2514566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2515206c60cbSwdenk
2516566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2517566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
251811ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2519566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2520566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2521566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
252274de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
252374de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2524566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2525c609719bSwdenk
25261372cce2SMarian BalakowiczFIT uImage format:
25271372cce2SMarian Balakowicz
25281372cce2SMarian Balakowicz  Arg	Where			When
25291372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
25301372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
25311372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
25321372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
25331372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
25341372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2535f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
25361372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
25371372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
25381372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
25391372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
25401372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
254111ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
254211ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
25431372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
25441372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
25451372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
25461372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
25471372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
25481372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
25491372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
25501372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
25511372cce2SMarian Balakowicz
25521372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
25531372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
25541372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
255511ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
25561372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
25571372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
25581372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
25591372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
25601372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
25611372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
25621372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
25631372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
25641372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
25651372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
25661372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
25671372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
25681372cce2SMarian Balakowicz
256911ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
25701372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
25711372cce2SMarian Balakowicz
257211ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
25731372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
25741372cce2SMarian Balakowicz
257511ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
25761372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
25771372cce2SMarian Balakowicz
25784cf2609bSWolfgang Denk- Standalone program support:
25794cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
25804cf2609bSWolfgang Denk
25816feff899SWolfgang Denk		This option defines a board specific value for the
25826feff899SWolfgang Denk		address where standalone program gets loaded, thus
25836feff899SWolfgang Denk		overwriting the architecture dependent default
25844cf2609bSWolfgang Denk		settings.
25854cf2609bSWolfgang Denk
25864cf2609bSWolfgang Denk- Frame Buffer Address:
25874cf2609bSWolfgang Denk		CONFIG_FB_ADDR
25884cf2609bSWolfgang Denk
25894cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
25904cf2609bSWolfgang Denk		address for frame buffer.
25914cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
25924cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
25936feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
25944cf2609bSWolfgang Denk
25954cf2609bSWolfgang Denk		Please see board_init_f function.
25964cf2609bSWolfgang Denk
2597cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2598cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2599cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2600cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2601cccfc2abSDetlev Zundel
2602cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2603cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2604cccfc2abSDetlev Zundel
2605cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2606cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2607cccfc2abSDetlev Zundel
2608cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2609cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2610cccfc2abSDetlev Zundel
2611cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2612cccfc2abSDetlev Zundel
2613cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2614cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2615cccfc2abSDetlev Zundel
26166a11cf48SDaniel Schwierzeck- SPL framework
26176a11cf48SDaniel Schwierzeck		CONFIG_SPL
26186a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
26196a11cf48SDaniel Schwierzeck
262095579793STom Rini		CONFIG_SPL_LDSCRIPT
262195579793STom Rini		LDSCRIPT for linking the SPL binary.
262295579793STom Rini
262395579793STom Rini		CONFIG_SPL_MAX_SIZE
262495579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
262595579793STom Rini
26266a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
26276a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
26286a11cf48SDaniel Schwierzeck
262995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
263095579793STom Rini		Link address for the BSS within the SPL binary.
263195579793STom Rini
263295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
263395579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
263495579793STom Rini
263595579793STom Rini		CONFIG_SPL_STACK
263695579793STom Rini		Adress of the start of the stack SPL will use
263795579793STom Rini
263895579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
263995579793STom Rini		Starting address of the malloc pool used in SPL.
264095579793STom Rini
264195579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
264295579793STom Rini		The size of the malloc pool used in SPL.
26436a11cf48SDaniel Schwierzeck
264447f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
264547f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
264647f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
264747f7bcaeSTom Rini		NAND loading of the Linux Kernel.
264847f7bcaeSTom Rini
2649861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2650861a86f4STom Rini		For ARM, enable an optional function to print more information
2651861a86f4STom Rini		about the running system.
2652861a86f4STom Rini
26536a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
26546a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
26556a11cf48SDaniel Schwierzeck
26566a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
26576a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
26586a11cf48SDaniel Schwierzeck
26596a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
26606a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
26616a11cf48SDaniel Schwierzeck
26626a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
26636a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
26646a11cf48SDaniel Schwierzeck
26656a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
26666a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
26676a11cf48SDaniel Schwierzeck
266895579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
266995579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
267095579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
267195579793STom Rini		Address, size and partition on the MMC to load U-Boot from
267295579793STom Rini		when the MMC is being used in raw mode.
267395579793STom Rini
267495579793STom Rini		CONFIG_SPL_FAT_SUPPORT
267595579793STom Rini		Support for fs/fat/libfat.o in SPL binary
267695579793STom Rini
267795579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
267895579793STom Rini		Filename to read to load U-Boot when reading from FAT
267995579793STom Rini
268095579793STom Rini		CONFIG_SPL_NAND_SIMPLE
268195579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
268295579793STom Rini
268395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
268495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
268595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
268695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
268795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
268895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
268995579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
269095579793STom Rini
269195579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
269295579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
269395579793STom Rini		from.
269495579793STom Rini
269595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
269695579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
269795579793STom Rini		to.
269895579793STom Rini
269995579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
270095579793STom Rini		Define this if you need to first read the OOB and then the
270195579793STom Rini		data. This is used for example on davinci plattforms.
270295579793STom Rini
270395579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
270495579793STom Rini		Support for an OMAP3-specific set of functions to return the
270595579793STom Rini		ID and MFR of the first attached NAND chip, if present.
270695579793STom Rini
27076a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
27086a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
27096a11cf48SDaniel Schwierzeck
27106a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
27116a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
27126a11cf48SDaniel Schwierzeck
27136a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
27146a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
27156a11cf48SDaniel Schwierzeck
2716c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2717c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2718c57b953dSPavel Machek
27196a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
27206a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
27211372cce2SMarian Balakowicz
2722c609719bSwdenkModem Support:
2723c609719bSwdenk--------------
2724c609719bSwdenk
2725566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2726c609719bSwdenk
272711ccc33fSMarcel Ziswiler- Modem support enable:
2728c609719bSwdenk		CONFIG_MODEM_SUPPORT
2729c609719bSwdenk
2730c609719bSwdenk- RTS/CTS Flow control enable:
2731c609719bSwdenk		CONFIG_HWFLOW
2732c609719bSwdenk
2733c609719bSwdenk- Modem debug support:
2734c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2735c609719bSwdenk
2736c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2737c609719bSwdenk		for modem support. Useful only with BDI2000.
2738c609719bSwdenk
2739a8c7c708Swdenk- Interrupt support (PPC):
2740a8c7c708Swdenk
2741a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2742a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
274311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2744a8c7c708Swdenk		should set decrementer_count to appropriate value. If
274511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2746a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
274711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2748a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2749a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2750a8c7c708Swdenk		general timer_interrupt().
2751a8c7c708Swdenk
2752c609719bSwdenk- General:
2753c609719bSwdenk
2754c609719bSwdenk		In the target system modem support is enabled when a
2755c609719bSwdenk		specific key (key combination) is pressed during
2756c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
275711ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2758c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2759c609719bSwdenk		function, returning 1 and thus enabling modem
2760c609719bSwdenk		initialization.
2761c609719bSwdenk
2762c609719bSwdenk		If there are no modem init strings in the
2763c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2764c609719bSwdenk		previous output (banner, info printfs) will be
276511ccc33fSMarcel Ziswiler		suppressed, though.
2766c609719bSwdenk
2767c609719bSwdenk		See also: doc/README.Modem
2768c609719bSwdenk
27699660e442SHelmut RaigerBoard initialization settings:
27709660e442SHelmut Raiger------------------------------
27719660e442SHelmut Raiger
27729660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
27739660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
27749660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
27759660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
27769660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
27779660e442SHelmut Raigertypically in board_init_f() and board_init_r().
27789660e442SHelmut Raiger
27799660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
27809660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
27819660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
27829660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2783c609719bSwdenk
2784c609719bSwdenkConfiguration Settings:
2785c609719bSwdenk-----------------------
2786c609719bSwdenk
27876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2788c609719bSwdenk		undefine this when you're short of memory.
2789c609719bSwdenk
27902fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
27912fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
27922fb2604dSPeter Tyser
27936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2794c609719bSwdenk		prompt for user input.
2795c609719bSwdenk
27966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2797c609719bSwdenk
27986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2799c609719bSwdenk
28006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2801c609719bSwdenk
28026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2803c609719bSwdenk		the application (usually a Linux kernel) when it is
2804c609719bSwdenk		booted
2805c609719bSwdenk
28066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2807c609719bSwdenk		List of legal baudrate settings for this board.
2808c609719bSwdenk
28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2810c609719bSwdenk		Suppress display of console information at boot.
2811c609719bSwdenk
28126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2813c609719bSwdenk		If the board specific function
2814c609719bSwdenk			extern int overwrite_console (void);
2815c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2816c609719bSwdenk		serial port, else the settings in the environment are used.
2817c609719bSwdenk
28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2819c609719bSwdenk		Enable the call to overwrite_console().
2820c609719bSwdenk
28216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2822c609719bSwdenk		Enable overwrite of previous console environment settings.
2823c609719bSwdenk
28246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2825c609719bSwdenk		Begin and End addresses of the area used by the
2826c609719bSwdenk		simple memory test.
2827c609719bSwdenk
28286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2829c609719bSwdenk		Enable an alternate, more extensive memory test.
2830c609719bSwdenk
28316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
28325f535fe1Swdenk		Scratch address used by the alternate memory test
28335f535fe1Swdenk		You only need to set this if address zero isn't writeable
28345f535fe1Swdenk
28356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
283714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
283811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
283914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
284014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
284114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
28425e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
284314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
28445e12e75dSStefan Roese		will have to get fixed in Linux additionally.
284514f73ca6SStefan Roese
284614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
284714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
284814f73ca6SStefan Roese		be touched.
284914f73ca6SStefan Roese
285014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
285114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
285214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
285314f73ca6SStefan Roese		non page size aligned address and this could cause major
285414f73ca6SStefan Roese		problems.
285514f73ca6SStefan Roese
28566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2857c609719bSwdenk		Default load address for network file downloads
2858c609719bSwdenk
28596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2860c609719bSwdenk		Enable temporary baudrate change while serial download
2861c609719bSwdenk
28626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2863c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2864c609719bSwdenk
28656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2866c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2867c609719bSwdenk		Cogent motherboard)
2868c609719bSwdenk
28696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2870c609719bSwdenk		Physical start address of Flash memory.
2871c609719bSwdenk
28726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2873c609719bSwdenk		Physical start address of boot monitor code (set by
2874c609719bSwdenk		make config files to be same as the text base address
287514d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
28766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2877c609719bSwdenk
28786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
28793b57fe0aSwdenk		Size of memory reserved for monitor code, used to
28803b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
28813b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
28823b57fe0aSwdenk		flash sector.
2883c609719bSwdenk
28846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2885c609719bSwdenk		Size of DRAM reserved for malloc() use.
2886c609719bSwdenk
28876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
288815940c9aSStefan Roese		Normally compressed uImages are limited to an
288915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
28906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
289115940c9aSStefan Roese		to adjust this setting to your needs.
2892c609719bSwdenk
28936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2894c609719bSwdenk		Maximum size of memory mapped by the startup code of
2895c609719bSwdenk		the Linux kernel; all data that must be processed by
28967d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
28977d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
28987d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
28997d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2900c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2901c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2902c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2903c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2904c609719bSwdenk
2905fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2906fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2907fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2908fca43cc8SJohn Rigby		is enabled.
2909fca43cc8SJohn Rigby
2910fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2911fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2912fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2913fca43cc8SJohn Rigby
2914fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2915fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2916fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2917fca43cc8SJohn Rigby
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2919c609719bSwdenk		Max number of Flash memory banks
2920c609719bSwdenk
29216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2922c609719bSwdenk		Max number of sectors on a Flash chip
2923c609719bSwdenk
29246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2925c609719bSwdenk		Timeout for Flash erase operations (in ms)
2926c609719bSwdenk
29276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2928c609719bSwdenk		Timeout for Flash write operations (in ms)
2929c609719bSwdenk
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
29318564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
29328564acf9Swdenk
29336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
29348564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
29358564acf9Swdenk
29366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
29378564acf9Swdenk		If defined, hardware flash sectors protection is used
29388564acf9Swdenk		instead of U-Boot software protection.
29398564acf9Swdenk
29406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2941c609719bSwdenk
2942c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2943c609719bSwdenk		without this option such a download has to be
2944c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2945c609719bSwdenk		copy from RAM to flash.
2946c609719bSwdenk
2947c609719bSwdenk		The two-step approach is usually more reliable, since
2948c609719bSwdenk		you can check if the download worked before you erase
294911ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
295011ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2951c609719bSwdenk		downloaded image) this option may be very useful.
2952c609719bSwdenk
29536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2954c609719bSwdenk		Define if the flash driver uses extra elements in the
29555653fc33Swdenk		common flash structure for storing flash geometry.
29565653fc33Swdenk
295700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
29585653fc33Swdenk		This option also enables the building of the cfi_flash driver
29595653fc33Swdenk		in the drivers directory
296053cf9435Sstroese
296191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
296291809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
296391809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
296491809ed5SPiotr Ziecik		to the MTD layer.
296591809ed5SPiotr Ziecik
29666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
296796ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
296896ef831fSGuennadi Liakhovetski
296996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
297096ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
297196ef831fSGuennadi Liakhovetski		write commands.
297296ef831fSGuennadi Liakhovetski
29736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
29745568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
29755568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
29765568e613SStefan Roese		is useful, if some of the configured banks are only
29775568e613SStefan Roese		optionally available.
29785568e613SStefan Roese
29799a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
29809a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
29819a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
29829a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
29839a042e9cSJerry Van Baren
29846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
298511ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
298611ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
298753cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
298853cf9435Sstroese		buffers can be full shortly after enabling the interface
298911ccc33fSMarcel Ziswiler		on high Ethernet traffic.
299053cf9435Sstroese		Defaults to 4 if not defined.
2991c609719bSwdenk
2992ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2993ea882bafSWolfgang Denk
2994ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2995ea882bafSWolfgang Denk	internally to store the environment settings. The default
2996ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2997ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2998ea882bafSWolfgang Denk	lib/hashtable.c for details.
2999ea882bafSWolfgang Denk
3000c609719bSwdenkThe following definitions that deal with the placement and management
3001c609719bSwdenkof environment data (variable area); in general, we support the
3002c609719bSwdenkfollowing configurations:
3003c609719bSwdenk
3004c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3005c3eb3fe4SMike Frysinger
3006c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3007c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3008c3eb3fe4SMike Frysinger
30095a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3010c609719bSwdenk
3011c609719bSwdenk	Define this if the environment is in flash memory.
3012c609719bSwdenk
3013c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3014c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3015c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3016c609719bSwdenk	   sector" type flash chips, which have several smaller
3017c609719bSwdenk	   sectors at the start or the end. For instance, such a
3018c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3019c609719bSwdenk	   such a case you would place the environment in one of the
3020c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3021c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3022c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3023c609719bSwdenk	   between U-Boot and the environment.
3024c609719bSwdenk
30250e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3026c609719bSwdenk
3027c609719bSwdenk	   Offset of environment data (variable area) to the
3028c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3029c609719bSwdenk	   type flash chips the second sector can be used: the offset
3030c609719bSwdenk	   for this sector is given here.
3031c609719bSwdenk
30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3033c609719bSwdenk
30340e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3035c609719bSwdenk
3036c609719bSwdenk	   This is just another way to specify the start address of
3037c609719bSwdenk	   the flash sector containing the environment (instead of
30380e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3039c609719bSwdenk
30400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3041c609719bSwdenk
3042c609719bSwdenk	   Size of the sector containing the environment.
3043c609719bSwdenk
3044c609719bSwdenk
3045c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3046c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3047c609719bSwdenk	   the environment.
3048c609719bSwdenk
30490e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3050c609719bSwdenk
30515a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
30520e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3053c609719bSwdenk	   of this flash sector for the environment. This saves
3054c609719bSwdenk	   memory for the RAM copy of the environment.
3055c609719bSwdenk
3056c609719bSwdenk	   It may also save flash memory if you decide to use this
3057c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3058c609719bSwdenk	   since then the remainder of the flash sector could be used
3059c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3060c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3061c609719bSwdenk	   updating the environment in flash makes it always
3062c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3063c609719bSwdenk	   wrong before the contents has been restored from a copy in
3064c609719bSwdenk	   RAM, your target system will be dead.
3065c609719bSwdenk
30660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
30670e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3068c609719bSwdenk
3069c609719bSwdenk	   These settings describe a second storage area used to hold
307011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
30713e38691eSwdenk	   a valid backup copy in case there is a power failure during
3072c609719bSwdenk	   a "saveenv" operation.
3073c609719bSwdenk
3074c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3075c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3076c609719bSwdenkaccordingly!
3077c609719bSwdenk
3078c609719bSwdenk
30799314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3080c609719bSwdenk
3081c609719bSwdenk	Define this if you have some non-volatile memory device
3082c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3083c609719bSwdenk	environment.
3084c609719bSwdenk
30850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3087c609719bSwdenk
308811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3089c609719bSwdenk	  want to use for environment. It is assumed that this memory
3090c609719bSwdenk	  can just be read and written to, without any special
3091c609719bSwdenk	  provision.
3092c609719bSwdenk
3093c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3094c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
309511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3096c609719bSwdenkU-Boot will hang.
3097c609719bSwdenk
3098c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3099c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3100c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3101c609719bSwdenkto save the current settings.
3102c609719bSwdenk
3103c609719bSwdenk
3104bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3105c609719bSwdenk
3106c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3107c609719bSwdenk	device and a driver for it.
3108c609719bSwdenk
31090e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3111c609719bSwdenk
3112c609719bSwdenk	  These two #defines specify the offset and size of the
3113c609719bSwdenk	  environment area within the total memory of your EEPROM.
3114c609719bSwdenk
31156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3116c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3117c609719bSwdenk	  The default address is zero.
3118c609719bSwdenk
31196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3120c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3121c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3122c609719bSwdenk	  would require six bits.
3123c609719bSwdenk
31246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3125c609719bSwdenk	  If defined, the number of milliseconds to delay between
3126c609719bSwdenk	  page writes.	The default is zero milliseconds.
3127c609719bSwdenk
31286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3129c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3130c609719bSwdenk	  that this is NOT the chip address length!
3131c609719bSwdenk
31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
31335cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
31345cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
31355cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
31365cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
31375cf91d6bSwdenk	  byte chips.
31385cf91d6bSwdenk
31395cf91d6bSwdenk	  Note that we consider the length of the address field to
31405cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
31415cf91d6bSwdenk	  in the chip address.
31425cf91d6bSwdenk
31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3144c609719bSwdenk	  The size in bytes of the EEPROM device.
3145c609719bSwdenk
3146548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3147548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3148548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3149548738b4SHeiko Schocher
3150548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3151548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3152548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3153548738b4SHeiko Schocher	  EEPROM. For example:
3154548738b4SHeiko Schocher
3155548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3156548738b4SHeiko Schocher
3157548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3158548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3159c609719bSwdenk
3160057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
31615779d8d9Swdenk
31625779d8d9Swdenk	Define this if you have a DataFlash memory device which you
31635779d8d9Swdenk	want to use for the environment.
31645779d8d9Swdenk
31650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
31670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
31685779d8d9Swdenk
31695779d8d9Swdenk	  These three #defines specify the offset and size of the
31705779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
31715779d8d9Swdenk	  at the specified address.
31725779d8d9Swdenk
31730a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
31740a85a9e7SLiu Gang
31750a85a9e7SLiu Gang	Define this if you have a remote memory space which you
31760a85a9e7SLiu Gang	want to use for the local device's environment.
31770a85a9e7SLiu Gang
31780a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
31790a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
31800a85a9e7SLiu Gang
31810a85a9e7SLiu Gang	  These two #defines specify the address and size of the
31820a85a9e7SLiu Gang	  environment area within the remote memory space. The
31830a85a9e7SLiu Gang	  local device can get the environment from remote memory
3184fc54c7faSLiu Gang	  space by SRIO or PCIE links.
31850a85a9e7SLiu Gang
31860a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
31870a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3188fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3189fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
31900a85a9e7SLiu Gang
319151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
319213a5695bSwdenk
319313a5695bSwdenk	Define this if you have a NAND device which you want to use
319413a5695bSwdenk	for the environment.
319513a5695bSwdenk
31960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
319813a5695bSwdenk
319913a5695bSwdenk	  These two #defines specify the offset and size of the environment
3200fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3201fdd813deSScott Wood	  aligned to an erase block boundary.
32025779d8d9Swdenk
3203fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3204e443c944SMarkus Klotzbuecher
32050e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3206fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3207fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3208fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3209fdd813deSScott Wood	  aligned to an erase block boundary.
3210e443c944SMarkus Klotzbuecher
3211fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3212fdd813deSScott Wood
3213fdd813deSScott Wood	  Specifies the length of the region in which the environment
3214fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3215fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3216fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3217fdd813deSScott Wood	  the range to be avoided.
3218fdd813deSScott Wood
3219fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3220fdd813deSScott Wood
3221fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3222fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3223fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3224fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3225fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3226e443c944SMarkus Klotzbuecher
3227b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3228b74ab737SGuennadi Liakhovetski
3229b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3230b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3231b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3232b74ab737SGuennadi Liakhovetski
32336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3234c609719bSwdenk
3235c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3236c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3237c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3238c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3239c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3240c609719bSwdenk	to be a good choice since it makes it far enough from the
3241c609719bSwdenk	start of the data area as well as from the stack pointer.
3242c609719bSwdenk
3243e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3244c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3245cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3246c609719bSwdenkuntil then to read environment variables.
3247c609719bSwdenk
324885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
324985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
325085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
325185ec0bccSwdenknecessary, because the first environment variable we need is the
325285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
325385ec0bccSwdenkhave any device yet where we could complain.]
3254c609719bSwdenk
3255c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3256c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
325785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3258c609719bSwdenk
32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3260fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3261fc3e2165Swdenk
32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3263fc3e2165Swdenk		      also needs to be defined.
3264fc3e2165Swdenk
32656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3266fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3267c609719bSwdenk
3268f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3269f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3270f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3271f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3272f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3273f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3274f5675aa5SRon Madrid
3275c609719bSwdenkLow Level (hardware related) configuration options:
3276dc7c9a1aSwdenk---------------------------------------------------
3277c609719bSwdenk
32786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3279c609719bSwdenk		Cache Line Size of the CPU.
3280c609719bSwdenk
32816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3282c609719bSwdenk		Default address of the IMMR after system reset.
32832535d602Swdenk
32842535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
32852535d602Swdenk		and RPXsuper) to be able to adjust the position of
32862535d602Swdenk		the IMMR register after a reset.
3287c609719bSwdenk
3288e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3289e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3290e46fedfeSTimur Tabi		PowerPC SOCs.
3291e46fedfeSTimur Tabi
3292e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3293e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3294e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3295e46fedfeSTimur Tabi
3296e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3297e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3298e46fedfeSTimur Tabi
3299e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3300e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3301e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3302e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3303e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3304e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3305e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3306e46fedfeSTimur Tabi
3307e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3308e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3309e46fedfeSTimur Tabi
3310e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3311e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3312e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3313e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3314e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3315e46fedfeSTimur Tabi
3316e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3317e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3318e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3319e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3320e46fedfeSTimur Tabi
3321e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3322e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3323e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3324e46fedfeSTimur Tabi
33257f6c2cbcSwdenk- Floppy Disk Support:
33266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
33277f6c2cbcSwdenk
33287f6c2cbcSwdenk		the default drive number (default value 0)
33297f6c2cbcSwdenk
33306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
33317f6c2cbcSwdenk
333211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
33337f6c2cbcSwdenk		(default value 1)
33347f6c2cbcSwdenk
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
33367f6c2cbcSwdenk
33377f6c2cbcSwdenk		defines the offset of register from address. It
33387f6c2cbcSwdenk		depends on which part of the data bus is connected to
333911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
33407f6c2cbcSwdenk
33416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
33437f6c2cbcSwdenk		default value.
33447f6c2cbcSwdenk
33456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
33467f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
33477f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
33487f6c2cbcSwdenk		source code. It is used to make hardware dependant
33497f6c2cbcSwdenk		initializations.
33507f6c2cbcSwdenk
33510abddf82SMacpaul Lin- CONFIG_IDE_AHB:
33520abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
33530abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
33540abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
33550abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
33560abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
33570abddf82SMacpaul Lin		is requierd.
33580abddf82SMacpaul Lin
33596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
336025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
336125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3362c609719bSwdenk
33636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3364c609719bSwdenk
33657152b1d0Swdenk		Start address of memory area that can be used for
3366c609719bSwdenk		initial data and stack; please note that this must be
3367c609719bSwdenk		writable memory that is working WITHOUT special
3368c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3369c609719bSwdenk		will become available only after programming the
3370c609719bSwdenk		memory controller and running certain initialization
3371c609719bSwdenk		sequences.
3372c609719bSwdenk
3373c609719bSwdenk		U-Boot uses the following memory types:
3374c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3375c609719bSwdenk		- MPC824X: data cache
3376c609719bSwdenk		- PPC4xx:  data cache
3377c609719bSwdenk
33786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3379c609719bSwdenk
3380c609719bSwdenk		Offset of the initial data structure in the memory
33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
33826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3383c609719bSwdenk		data is located at the end of the available space
3384553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
33856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
33866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3388c609719bSwdenk
3389c609719bSwdenk	Note:
3390c609719bSwdenk		On the MPC824X (or other systems that use the data
3391c609719bSwdenk		cache for initial memory) the address chosen for
33926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3393c609719bSwdenk		point to an otherwise UNUSED address space between
3394c609719bSwdenk		the top of RAM and the start of the PCI space.
3395c609719bSwdenk
33966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3397c609719bSwdenk
33986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3399c609719bSwdenk
34006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3401c609719bSwdenk
34026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3403c609719bSwdenk
34046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3405c609719bSwdenk
34066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3407c609719bSwdenk
34086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3409c609719bSwdenk		SDRAM timing
3410c609719bSwdenk
34116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3412c609719bSwdenk		periodic timer for refresh
3413c609719bSwdenk
34146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3415c609719bSwdenk
34166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
34176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3420c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3421c609719bSwdenk
3422c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
34236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3425c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3426c609719bSwdenk
34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3429c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3430c609719bSwdenk		Prescaler definitions (SDRAM timing)
3431c609719bSwdenk
34326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3433c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3434c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3435c609719bSwdenk
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3437b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3438b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3439b423d055SHeiko Schocher
34406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3441c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3442c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3443c609719bSwdenk
34446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3445c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3446c609719bSwdenk		wrong setting might damage your board. Read
3447c609719bSwdenk		doc/README.MBX before setting this variable!
3448c609719bSwdenk
34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3450ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3451ea909b76Swdenk		(Power On Self Tests). This definition overrides
3452ea909b76Swdenk		#define'd default value in commproc.h resp.
3453ea909b76Swdenk		cpm_8260.h.
3454ea909b76Swdenk
34556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
34576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
34606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
34616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
34626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3463a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
34645d232d0eSwdenk
34659cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
34669cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
34679cacf4fcSDirk Eibach		required.
34689cacf4fcSDirk Eibach
346969fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
347069fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
347169fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
347269fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
347369fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
347469fd2d3bSAndrew Sharp		by coreboot or similar.
347569fd2d3bSAndrew Sharp
3476a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3477a09b9b68SKumar Gala		Chip has SRIO or not
3478a09b9b68SKumar Gala
3479a09b9b68SKumar Gala- CONFIG_SRIO1:
3480a09b9b68SKumar Gala		Board has SRIO 1 port available
3481a09b9b68SKumar Gala
3482a09b9b68SKumar Gala- CONFIG_SRIO2:
3483a09b9b68SKumar Gala		Board has SRIO 2 port available
3484a09b9b68SKumar Gala
3485a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3486a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3487a09b9b68SKumar Gala
3488a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3489a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3490a09b9b68SKumar Gala
3491a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3492a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3493a09b9b68SKumar Gala
3494eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3495eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3496eced4626SAlex Waterman		16 bit bus.
3497eced4626SAlex Waterman
3498eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3499eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3500eced4626SAlex Waterman		a default value will be used.
3501eced4626SAlex Waterman
3502bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3503218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3504218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3505218ca724SWolfgang Denk
3506bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3507bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3508bb99ad6dSBen Warren
35096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3510218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3511218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3512218ca724SWolfgang Denk		to something your driver can deal with.
3513bb99ad6dSBen Warren
35141b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
35151b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
35161b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
35171b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
35181b3e3c4fSYork Sun		header files or board specific files.
35191b3e3c4fSYork Sun
35206f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
35216f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
35226f5e1dc5SYork Sun
35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3524218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3525218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
35262ad6b513STimur Tabi
3527c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3528c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3529c26e454dSwdenk
3530c26e454dSwdenk- CONFIG_FEC[12]_PHY
3531c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
35326e592385Swdenk		to the given FEC; i. e.
3533c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3534c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3535c26e454dSwdenk
3536c26e454dSwdenk		When set to -1, means to probe for first available.
3537c26e454dSwdenk
3538c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3539c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3540c26e454dSwdenk		(so program the FEC to ignore it).
3541c26e454dSwdenk
3542c26e454dSwdenk- CONFIG_RMII
3543c26e454dSwdenk		Enable RMII mode for all FECs.
3544c26e454dSwdenk		Note that this is a global option, we can't
3545c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3546c26e454dSwdenk
35475cf91d6bSwdenk- CONFIG_CRC32_VERIFY
35485cf91d6bSwdenk		Add a verify option to the crc32 command.
35495cf91d6bSwdenk		The syntax is:
35505cf91d6bSwdenk
35515cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
35525cf91d6bSwdenk
35535cf91d6bSwdenk		Where address/count indicate a memory area
35545cf91d6bSwdenk		and crc32 is the correct crc32 which the
35555cf91d6bSwdenk		area should have.
35565cf91d6bSwdenk
355756523f12Swdenk- CONFIG_LOOPW
355856523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3559602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
356056523f12Swdenk
35617b466641Sstroese- CONFIG_MX_CYCLIC
35627b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
35637b466641Sstroese		"md/mw" commands.
35647b466641Sstroese		Examples:
35657b466641Sstroese
35667b466641Sstroese		=> mdc.b 10 4 500
35677b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
35687b466641Sstroese
35697b466641Sstroese		=> mwc.l 100 12345678 10
35707b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
35717b466641Sstroese
35727b466641Sstroese		This only takes effect if the memory commands are activated
3573602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
35747b466641Sstroese
35758aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3576afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3577e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3578e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3579e03f3169SWolfgang Denk		relocate itself into RAM.
35808aa1a2d1Swdenk
3581e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3582e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3583e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3584e03f3169SWolfgang Denk		these initializations itself.
35858aa1a2d1Swdenk
3586401bb30bSAneesh V- CONFIG_SPL_BUILD
3587df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3588df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3589df81238bSMagnus Lilja		compiling a NAND SPL.
3590400558b5Swdenk
3591d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3592d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3593d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3594d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3595d8834a13SMatthias Weisser		conditions but may increase the binary size.
3596d8834a13SMatthias Weisser
3597f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3598f2717b47STimur Tabi-----------------------------------
3599f2717b47STimur Tabi
3600f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3601f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3602f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3603f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3604f2717b47STimur Tabiwithin that device.
3605f2717b47STimur Tabi
3606f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3607f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3608f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3609f2717b47STimur Tabi	is also specified.
3610f2717b47STimur Tabi
3611f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3612f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3613f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3614f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3615f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3616f2717b47STimur Tabi
3617f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3618f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3619f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3620f2717b47STimur Tabi	virtual address in NOR flash.
3621f2717b47STimur Tabi
3622f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3623f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3624f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3625f2717b47STimur Tabi
3626f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3627f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3628f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3629f2717b47STimur Tabi
3630f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3631f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3632f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3633f2717b47STimur Tabi
3634292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3635292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3636292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3637fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3638fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3639fc54c7faSLiu Gang	master's memory space.
3640f2717b47STimur Tabi
3641c609719bSwdenkBuilding the Software:
3642c609719bSwdenk======================
3643c609719bSwdenk
3644218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3645218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3646218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3647218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3648218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3649218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3650c609719bSwdenk
3651218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3652218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3653218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3654218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3655218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3656c609719bSwdenk
3657218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3658218ca724SWolfgang Denk	$ export CROSS_COMPILE
3659c609719bSwdenk
36602f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
36612f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
36622f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
36632f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
36642f8d396bSPeter Tyser
36652f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
36662f8d396bSPeter Tyser
36672f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
36682f8d396bSPeter Tyser      be executed on computers running Windows.
36692f8d396bSPeter Tyser
3670c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3671c609719bSwdenksources you must configure U-Boot for one specific board type. This
3672c609719bSwdenkis done by typing:
3673c609719bSwdenk
3674c609719bSwdenk	make NAME_config
3675c609719bSwdenk
3676218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
36774d675ae6SMichael Jonesrations; see boards.cfg for supported names.
367854387ac9Swdenk
3679c609719bSwdenkNote: for some board special configuration names may exist; check if
3680c609719bSwdenk      additional information is available from the board vendor; for
36812729af9dSwdenk      instance, the TQM823L systems are available without (standard)
36822729af9dSwdenk      or with LCD support. You can select such additional "features"
368311ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3684c609719bSwdenk
36852729af9dSwdenk      make TQM823L_config
36862729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3687c609719bSwdenk
3688c609719bSwdenk      make TQM823L_LCD_config
3689c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3690c609719bSwdenk
3691c609719bSwdenk      etc.
3692c609719bSwdenk
3693c609719bSwdenk
3694c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
36957152b1d0Swdenkimages ready for download to / installation on your system:
3696c609719bSwdenk
3697c609719bSwdenk- "u-boot.bin" is a raw binary image
3698c609719bSwdenk- "u-boot" is an image in ELF binary format
3699c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3700c609719bSwdenk
3701baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3702baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3703baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3704baf31249SMarian Balakowicz
3705baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3706baf31249SMarian Balakowicz
3707baf31249SMarian Balakowicz	make O=/tmp/build distclean
3708baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3709baf31249SMarian Balakowicz	make O=/tmp/build all
3710baf31249SMarian Balakowicz
3711baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3712baf31249SMarian Balakowicz
3713baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3714baf31249SMarian Balakowicz	make distclean
3715baf31249SMarian Balakowicz	make NAME_config
3716baf31249SMarian Balakowicz	make all
3717baf31249SMarian Balakowicz
3718baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3719baf31249SMarian Balakowiczvariable.
3720baf31249SMarian Balakowicz
3721c609719bSwdenk
3722c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3723c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3724c609719bSwdenknative "make".
3725c609719bSwdenk
3726c609719bSwdenk
3727c609719bSwdenkIf the system board that you have is not listed, then you will need
3728c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3729c609719bSwdenksteps:
3730c609719bSwdenk
3731c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
37324d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
37334d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3734c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
373585ec0bccSwdenk    files you need. In your board directory, you will need at least
373685ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
373785ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
373885ec0bccSwdenk    your board
3739c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3740c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
374185ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3742c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3743c609719bSwdenk    to be installed on your target system.
374485ec0bccSwdenk6.  Debug and solve any problems that might arise.
3745c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3746c609719bSwdenk
3747c609719bSwdenk
3748c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3749c609719bSwdenk==============================================================
3750c609719bSwdenk
3751c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3752c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3753c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3754c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3755218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3756c609719bSwdenk
3757c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3758c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3759c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3760c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3761c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
37627152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3763218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3764218ca724SWolfgang Denkyou can type
3765c609719bSwdenk
3766c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3767c609719bSwdenk
3768c609719bSwdenkor to build on a native PowerPC system you can type
3769c609719bSwdenk
3770c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3771c609719bSwdenk
3772218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3773218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3774218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3775218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3776218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3777218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3778218ca724SWolfgang Denkvariable. For example:
3779baf31249SMarian Balakowicz
3780baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3781baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3782baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3783baf31249SMarian Balakowicz
3784218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3785218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3786218ca724SWolfgang Denkduring the whole build process.
3787baf31249SMarian Balakowicz
3788baf31249SMarian Balakowicz
3789c609719bSwdenkSee also "U-Boot Porting Guide" below.
3790c609719bSwdenk
3791c609719bSwdenk
3792c609719bSwdenkMonitor Commands - Overview:
3793c609719bSwdenk============================
3794c609719bSwdenk
3795c609719bSwdenkgo	- start application at address 'addr'
3796c609719bSwdenkrun	- run commands in an environment variable
3797c609719bSwdenkbootm	- boot application image from memory
3798c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
379944f074c7SMarek Vasutbootz   - boot zImage from memory
3800c609719bSwdenktftpboot- boot image via network using TFTP protocol
3801c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3802c609719bSwdenk	       (and eventually "gatewayip")
38031fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3804c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3805c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3806c609719bSwdenkloads	- load S-Record file over serial line
3807c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3808c609719bSwdenkmd	- memory display
3809c609719bSwdenkmm	- memory modify (auto-incrementing)
3810c609719bSwdenknm	- memory modify (constant address)
3811c609719bSwdenkmw	- memory write (fill)
3812c609719bSwdenkcp	- memory copy
3813c609719bSwdenkcmp	- memory compare
3814c609719bSwdenkcrc32	- checksum calculation
38150f89c54bSPeter Tyseri2c	- I2C sub-system
3816c609719bSwdenksspi	- SPI utility commands
3817c609719bSwdenkbase	- print or set address offset
3818c609719bSwdenkprintenv- print environment variables
3819c609719bSwdenksetenv	- set environment variables
3820c609719bSwdenksaveenv - save environment variables to persistent storage
3821c609719bSwdenkprotect - enable or disable FLASH write protection
3822c609719bSwdenkerase	- erase FLASH memory
3823c609719bSwdenkflinfo	- print FLASH memory information
3824c609719bSwdenkbdinfo	- print Board Info structure
3825c609719bSwdenkiminfo	- print header information for application image
3826c609719bSwdenkconinfo - print console devices and informations
3827c609719bSwdenkide	- IDE sub-system
3828c609719bSwdenkloop	- infinite loop on address range
382956523f12Swdenkloopw	- infinite write loop on address range
3830c609719bSwdenkmtest	- simple RAM test
3831c609719bSwdenkicache	- enable or disable instruction cache
3832c609719bSwdenkdcache	- enable or disable data cache
3833c609719bSwdenkreset	- Perform RESET of the CPU
3834c609719bSwdenkecho	- echo args to console
3835c609719bSwdenkversion - print monitor version
3836c609719bSwdenkhelp	- print online help
3837c609719bSwdenk?	- alias for 'help'
3838c609719bSwdenk
3839c609719bSwdenk
3840c609719bSwdenkMonitor Commands - Detailed Description:
3841c609719bSwdenk========================================
3842c609719bSwdenk
3843c609719bSwdenkTODO.
3844c609719bSwdenk
3845c609719bSwdenkFor now: just type "help <command>".
3846c609719bSwdenk
3847c609719bSwdenk
3848c609719bSwdenkEnvironment Variables:
3849c609719bSwdenk======================
3850c609719bSwdenk
3851c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3852c609719bSwdenkcan be made persistent by saving to Flash memory.
3853c609719bSwdenk
3854c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3855c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3856c609719bSwdenkwithout a value can be used to delete a variable from the
3857c609719bSwdenkenvironment. As long as you don't save the environment you are
3858c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3859c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3860c609719bSwdenk
3861c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3862c96f86eeSWolfgang Denk
3863c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3864c609719bSwdenk
3865c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3866c609719bSwdenk
3867c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3868c609719bSwdenk
3869c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3870c609719bSwdenk
3871c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3872c609719bSwdenk
3873c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3874c609719bSwdenk
38757d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
38767d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
38777d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
38787d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
38797d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
38807d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3881c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3882c3624e6eSGrant Likely		  bootm_mapsize.
3883c3624e6eSGrant Likely
3884c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3885c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3886c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3887c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3888c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3889c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3890c3624e6eSGrant Likely		  used otherwise.
38917d721e34SBartlomiej Sieka
38927d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
38937d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
38947d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
38957d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
38967d721e34SBartlomiej Sieka		  environment variable.
38977d721e34SBartlomiej Sieka
38984bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
38994bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
39004bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
39014bae9090SBartlomiej Sieka
3902c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3903c609719bSwdenk		  "bootp" will just load perform a lookup of the
3904c609719bSwdenk		  configuration from the BOOTP server, but not try to
3905c609719bSwdenk		  load any image using TFTP
3906c609719bSwdenk
3907c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3908c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3909c609719bSwdenk		  be automatically started (by internally calling
3910c609719bSwdenk		  "bootm")
3911c609719bSwdenk
39124a6fd34bSwdenk		  If set to "no", a standalone image passed to the
39134a6fd34bSwdenk		  "bootm" command will be copied to the load address
39144a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
39154a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
39164a6fd34bSwdenk		  data.
39174a6fd34bSwdenk
3918a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3919a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3920fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3921fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3922fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3923fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3924fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3925fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3926fa34f6b2SShawn Guo		  access it during the boot procedure.
3927fa34f6b2SShawn Guo
3928a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3929a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3930a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3931a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3932a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3933a28afca5SDavid A. Long		  must be accessible by the kernel.
3934a28afca5SDavid A. Long
3935eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3936eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3937eea63e05SSimon Glass		  defined.
3938eea63e05SSimon Glass
393917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
394017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
394117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
394217ea1177Swdenk		  initialization code. So, for changes to be effective
394317ea1177Swdenk		  it must be saved and board must be reset.
394417ea1177Swdenk
3945c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3946c609719bSwdenk		  If this variable is not set, initrd images will be
3947c609719bSwdenk		  copied to the highest possible address in RAM; this
3948c609719bSwdenk		  is usually what you want since it allows for
3949c609719bSwdenk		  maximum initrd size. If for some reason you want to
3950c609719bSwdenk		  make sure that the initrd image is loaded below the
39516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3952c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3953c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3954c609719bSwdenk		  address to use (U-Boot will still check that it
3955c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3956c609719bSwdenk
3957c609719bSwdenk		  For instance, when you have a system with 16 MB
39587152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3959c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3960c609719bSwdenk		  the "bootargs" variable. However, now you must make
39617152b1d0Swdenk		  sure that the initrd image is placed in the first
3962c609719bSwdenk		  12 MB as well - this can be done with
3963c609719bSwdenk
3964c609719bSwdenk		  setenv initrd_high 00c00000
3965c609719bSwdenk
396638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
396738b99261Swdenk		  indication to U-Boot that all addresses are legal
396838b99261Swdenk		  for the Linux kernel, including addresses in flash
396938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
397038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
397138b99261Swdenk		  boot time on your system, but requires that this
397238b99261Swdenk		  feature is supported by your Linux kernel.
397338b99261Swdenk
3974c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3975c609719bSwdenk
3976c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3977dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3978c609719bSwdenk
3979c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3980c609719bSwdenk
3981c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3982c609719bSwdenk
3983c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3984c609719bSwdenk
3985c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3986c609719bSwdenk
3987c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3988c609719bSwdenk
3989e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3990a3d991bdSwdenk
3991e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3992e2a53458SMike Frysinger		  For example you can do the following
3993a3d991bdSwdenk
399448690d80SHeiko Schocher		  => setenv ethact FEC
399548690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
399648690d80SHeiko Schocher		  => setenv ethact SCC
399748690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3998a3d991bdSwdenk
3999e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4000e1692577SMatthias Fuchs		  available network interfaces.
4001e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4002e1692577SMatthias Fuchs
4003a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4004a3d991bdSwdenk		  either succeed or fail without retrying.
40056e592385Swdenk		  When set to "once" the network operation will
40066e592385Swdenk		  fail when all the available network interfaces
40076e592385Swdenk		  are tried once without success.
4008a3d991bdSwdenk		  Useful on scripts which control the retry operation
4009a3d991bdSwdenk		  themselves.
4010a3d991bdSwdenk
4011b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4012a1cf027aSJean-Christophe PLAGNIOL-VILLARD
401328cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4014ecb0ccd9SWolfgang Denk		  UDP source port.
4015ecb0ccd9SWolfgang Denk
401628cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
401728cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
401828cb9375SWolfgang Denk
4019c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4020c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4021c96f86eeSWolfgang Denk
4022c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4023c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4024c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4025c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4026c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4027c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4028c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4029c96f86eeSWolfgang Denk
4030a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
403111ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4032a3d991bdSwdenk		  VLAN tagged frames.
4033c609719bSwdenk
4034dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4035dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4036dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4037dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4038dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4039dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4040dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4041dc0b7b0eSJason Hobbs
4042dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4043dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4044dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4045dc0b7b0eSJason Hobbs
4046dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4047dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4048dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4049dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4050dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4051dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4052dc0b7b0eSJason Hobbs
4053c609719bSwdenkThe following environment variables may be used and automatically
4054c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4055c609719bSwdenkdepending the information provided by your boot server:
4056c609719bSwdenk
4057c609719bSwdenk  bootfile	- see above
4058c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4059fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4060c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4061c609719bSwdenk  hostname	- Target hostname
4062c609719bSwdenk  ipaddr	- see above
4063c609719bSwdenk  netmask	- Subnet Mask
4064c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4065c609719bSwdenk  serverip	- see above
4066c609719bSwdenk
4067c609719bSwdenk
4068c609719bSwdenkThere are two special Environment Variables:
4069c609719bSwdenk
4070c609719bSwdenk  serial#	- contains hardware identification information such
4071c609719bSwdenk		  as type string and/or serial number
4072c609719bSwdenk  ethaddr	- Ethernet address
4073c609719bSwdenk
4074c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4075c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4076c609719bSwdenkonce they have been set once.
4077c609719bSwdenk
4078c609719bSwdenk
4079c1551ea8SstroeseFurther special Environment Variables:
4080c1551ea8Sstroese
4081c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4082c1551ea8Sstroese		  with the "version" command. This variable is
4083c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4084c1551ea8Sstroese
4085c1551ea8Sstroese
4086c609719bSwdenkPlease note that changes to some configuration parameters may take
4087c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4088c609719bSwdenk
4089c609719bSwdenk
4090f07771ccSwdenkCommand Line Parsing:
4091f07771ccSwdenk=====================
4092f07771ccSwdenk
4093f07771ccSwdenkThere are two different command line parsers available with U-Boot:
40947152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4095f07771ccSwdenk
4096f07771ccSwdenkOld, simple command line parser:
4097f07771ccSwdenk--------------------------------
4098f07771ccSwdenk
4099f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4100f07771ccSwdenk- several commands on one line, separated by ';'
4101fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4102f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4103f07771ccSwdenk  for example:
4104fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4105f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4106f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4107f07771ccSwdenk
4108f07771ccSwdenkHush shell:
4109f07771ccSwdenk-----------
4110f07771ccSwdenk
4111f07771ccSwdenk- similar to Bourne shell, with control structures like
4112f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4113f07771ccSwdenk  until...do...done, ...
4114f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4115f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4116f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4117f07771ccSwdenk  command
4118f07771ccSwdenk
4119f07771ccSwdenkGeneral rules:
4120f07771ccSwdenk--------------
4121f07771ccSwdenk
4122f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4123f07771ccSwdenk    command) contains several commands separated by semicolon, and
4124f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4125f07771ccSwdenk    executed anyway.
4126f07771ccSwdenk
4127f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
412811ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4129f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4130f07771ccSwdenk    variables are not executed.
4131f07771ccSwdenk
4132c609719bSwdenkNote for Redundant Ethernet Interfaces:
4133c609719bSwdenk=======================================
4134c609719bSwdenk
413511ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4136c609719bSwdenksuch configurations and is capable of automatic selection of a
41377152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4138c609719bSwdenk
4139c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4140c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4141c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4142c609719bSwdenk
4143c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4144c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4145c609719bSwdenkding setting in the environment; if the corresponding environment
4146c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4147c609719bSwdenk
4148c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4149c609719bSwdenk  environment, the SROM's address is used.
4150c609719bSwdenk
4151c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4152c609719bSwdenk  environment exists, then the value from the environment variable is
4153c609719bSwdenk  used.
4154c609719bSwdenk
4155c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4156c609719bSwdenk  both addresses are the same, this MAC address is used.
4157c609719bSwdenk
4158c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4159c609719bSwdenk  addresses differ, the value from the environment is used and a
4160c609719bSwdenk  warning is printed.
4161c609719bSwdenk
4162c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4163c609719bSwdenk  is raised.
4164c609719bSwdenk
4165ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4166ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4167ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4168ecee9324SBen WarrenThe naming convention is as follows:
4169ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4170c609719bSwdenk
4171c609719bSwdenkImage Formats:
4172c609719bSwdenk==============
4173c609719bSwdenk
41743310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
41753310c549SMarian Balakowiczimages in two formats:
41763310c549SMarian Balakowicz
41773310c549SMarian BalakowiczNew uImage format (FIT)
41783310c549SMarian Balakowicz-----------------------
41793310c549SMarian Balakowicz
41803310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
41813310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
41823310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
41833310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
41843310c549SMarian Balakowicz
41853310c549SMarian Balakowicz
41863310c549SMarian BalakowiczOld uImage format
41873310c549SMarian Balakowicz-----------------
41883310c549SMarian Balakowicz
41893310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
41903310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
41913310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4192c609719bSwdenk
4193c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4194c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4195f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4196f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4197f5ed9e39SPeter Tyser  INTEGRITY).
41987b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4199afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4200afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4201c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4202c609719bSwdenk* Load Address
4203c609719bSwdenk* Entry Point
4204c609719bSwdenk* Image Name
4205c609719bSwdenk* Image Timestamp
4206c609719bSwdenk
4207c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4208c609719bSwdenkand the data portions of the image are secured against corruption by
4209c609719bSwdenkCRC32 checksums.
4210c609719bSwdenk
4211c609719bSwdenk
4212c609719bSwdenkLinux Support:
4213c609719bSwdenk==============
4214c609719bSwdenk
4215c609719bSwdenkAlthough U-Boot should support any OS or standalone application
42167152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4217c609719bSwdenkU-Boot.
4218c609719bSwdenk
4219c609719bSwdenkU-Boot includes many features that so far have been part of some
4220c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4221c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4222c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
42237152b1d0Swdenkserves several purposes:
4224c609719bSwdenk
4225c609719bSwdenk- the same features can be used for other OS or standalone
4226c609719bSwdenk  applications (for instance: using compressed images to reduce the
4227c609719bSwdenk  Flash memory footprint)
4228c609719bSwdenk
4229c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
42307152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4231c609719bSwdenk
4232c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4233c609719bSwdenk  images; of course this also means that different kernel images can
4234c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4235c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4236c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4237c609719bSwdenk  software is easier now.
4238c609719bSwdenk
4239c609719bSwdenk
4240c609719bSwdenkLinux HOWTO:
4241c609719bSwdenk============
4242c609719bSwdenk
4243c609719bSwdenkPorting Linux to U-Boot based systems:
4244c609719bSwdenk---------------------------------------
4245c609719bSwdenk
4246c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4247c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4248c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4249c609719bSwdenkLinux :-).
4250c609719bSwdenk
4251a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4252c609719bSwdenk
4253c609719bSwdenkJust make sure your machine specific header file (for instance
4254c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
42551dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
42561dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
42576d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4258c609719bSwdenk
4259c609719bSwdenk
4260c609719bSwdenkConfiguring the Linux kernel:
4261c609719bSwdenk-----------------------------
4262c609719bSwdenk
4263c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4264c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4265c609719bSwdenk
4266c609719bSwdenk
4267c609719bSwdenkBuilding a Linux Image:
4268c609719bSwdenk-----------------------
4269c609719bSwdenk
427024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
427124ee89b9Swdenknot used. If you use recent kernel source, a new build target
427224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
427324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
427424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
427524ee89b9Swdenk100% compatible format.
4276c609719bSwdenk
4277c609719bSwdenkExample:
4278c609719bSwdenk
4279c609719bSwdenk	make TQM850L_config
4280c609719bSwdenk	make oldconfig
4281c609719bSwdenk	make dep
428224ee89b9Swdenk	make uImage
4283c609719bSwdenk
428424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
428524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
428624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4287c609719bSwdenk
428824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
428924ee89b9Swdenk
429024ee89b9Swdenk* convert the kernel into a raw binary image:
429124ee89b9Swdenk
429224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
429324ee89b9Swdenk				 -R .note -R .comment \
429424ee89b9Swdenk				 -S vmlinux linux.bin
429524ee89b9Swdenk
429624ee89b9Swdenk* compress the binary image:
429724ee89b9Swdenk
429824ee89b9Swdenk	gzip -9 linux.bin
429924ee89b9Swdenk
430024ee89b9Swdenk* package compressed binary image for U-Boot:
430124ee89b9Swdenk
430224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
430324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
430424ee89b9Swdenk		-d linux.bin.gz uImage
430524ee89b9Swdenk
430624ee89b9Swdenk
430724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
430824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
430924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
431024ee89b9Swdenkbyte header containing information about target architecture,
431124ee89b9Swdenkoperating system, image type, compression method, entry points, time
431224ee89b9Swdenkstamp, CRC32 checksums, etc.
431324ee89b9Swdenk
431424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
431524ee89b9Swdenkprint the header information, or to build new images.
4316c609719bSwdenk
4317c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4318c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4319c609719bSwdenkchecksum verification:
4320c609719bSwdenk
4321c609719bSwdenk	tools/mkimage -l image
4322c609719bSwdenk	  -l ==> list image header information
4323c609719bSwdenk
4324c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4325c609719bSwdenkfrom a "data file" which is used as image payload:
4326c609719bSwdenk
4327c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4328c609719bSwdenk		      -n name -d data_file image
4329c609719bSwdenk	  -A ==> set architecture to 'arch'
4330c609719bSwdenk	  -O ==> set operating system to 'os'
4331c609719bSwdenk	  -T ==> set image type to 'type'
4332c609719bSwdenk	  -C ==> set compression type 'comp'
4333c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4334c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4335c609719bSwdenk	  -n ==> set image name to 'name'
4336c609719bSwdenk	  -d ==> use image data from 'datafile'
4337c609719bSwdenk
433869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
433969459791Swdenkaddress (0x00000000), but the entry point address depends on the
434069459791Swdenkkernel version:
4341c609719bSwdenk
4342c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
434324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4344c609719bSwdenk
4345c609719bSwdenkSo a typical call to build a U-Boot image would read:
4346c609719bSwdenk
434724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
434824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4349a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
435024ee89b9Swdenk	> examples/uImage.TQM850L
435124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4352c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4353c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4354c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4355c609719bSwdenk	Load Address: 0x00000000
435624ee89b9Swdenk	Entry Point:  0x00000000
4357c609719bSwdenk
4358c609719bSwdenkTo verify the contents of the image (or check for corruption):
4359c609719bSwdenk
436024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
436124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4362c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4363c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4364c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4365c609719bSwdenk	Load Address: 0x00000000
436624ee89b9Swdenk	Entry Point:  0x00000000
4367c609719bSwdenk
4368c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4369c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4370c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4371c609719bSwdenkneed to be uncompressed:
4372c609719bSwdenk
4373a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
437424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
437524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4376a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
437724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
437824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4379c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4380c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4381c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4382c609719bSwdenk	Load Address: 0x00000000
438324ee89b9Swdenk	Entry Point:  0x00000000
4384c609719bSwdenk
4385c609719bSwdenk
4386c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4387c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4388c609719bSwdenk
4389c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4390c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4391c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4392c609719bSwdenk	Image Name:   Simple Ramdisk Image
4393c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4394c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4395c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4396c609719bSwdenk	Load Address: 0x00000000
4397c609719bSwdenk	Entry Point:  0x00000000
4398c609719bSwdenk
4399c609719bSwdenk
4400c609719bSwdenkInstalling a Linux Image:
4401c609719bSwdenk-------------------------
4402c609719bSwdenk
4403c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4404c609719bSwdenkyou must convert the image to S-Record format:
4405c609719bSwdenk
4406c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4407c609719bSwdenk
4408c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4409c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4410c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4411c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4412c609719bSwdenkcommand.
4413c609719bSwdenk
4414c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4415c609719bSwdenkTQM8xxL is in the first Flash bank):
4416c609719bSwdenk
4417c609719bSwdenk	=> erase 40100000 401FFFFF
4418c609719bSwdenk
4419c609719bSwdenk	.......... done
4420c609719bSwdenk	Erased 8 sectors
4421c609719bSwdenk
4422c609719bSwdenk	=> loads 40100000
4423c609719bSwdenk	## Ready for S-Record download ...
4424c609719bSwdenk	~>examples/image.srec
4425c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4426c609719bSwdenk	...
4427c609719bSwdenk	15989 15990 15991 15992
4428c609719bSwdenk	[file transfer complete]
4429c609719bSwdenk	[connected]
4430c609719bSwdenk	## Start Addr = 0x00000000
4431c609719bSwdenk
4432c609719bSwdenk
4433c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4434c609719bSwdenkthis includes a checksum verification so you can be sure no data
4435c609719bSwdenkcorruption happened:
4436c609719bSwdenk
4437c609719bSwdenk	=> imi 40100000
4438c609719bSwdenk
4439c609719bSwdenk	## Checking Image at 40100000 ...
4440c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4441c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4442c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4443c609719bSwdenk	   Load Address: 00000000
4444c609719bSwdenk	   Entry Point:	 0000000c
4445c609719bSwdenk	   Verifying Checksum ... OK
4446c609719bSwdenk
4447c609719bSwdenk
4448c609719bSwdenkBoot Linux:
4449c609719bSwdenk-----------
4450c609719bSwdenk
4451c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4452c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4453c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4454c609719bSwdenkparameters. You can check and modify this variable using the
4455c609719bSwdenk"printenv" and "setenv" commands:
4456c609719bSwdenk
4457c609719bSwdenk
4458c609719bSwdenk	=> printenv bootargs
4459c609719bSwdenk	bootargs=root=/dev/ram
4460c609719bSwdenk
4461c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4462c609719bSwdenk
4463c609719bSwdenk	=> printenv bootargs
4464c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4465c609719bSwdenk
4466c609719bSwdenk	=> bootm 40020000
4467c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4468c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4469c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4470c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4471c609719bSwdenk	   Load Address: 00000000
4472c609719bSwdenk	   Entry Point:	 0000000c
4473c609719bSwdenk	   Verifying Checksum ... OK
4474c609719bSwdenk	   Uncompressing Kernel Image ... OK
4475c609719bSwdenk	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
4476c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4477c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4478c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4479c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4480c609719bSwdenk	...
4481c609719bSwdenk
448211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
44837152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4484c609719bSwdenkformat!) to the "bootm" command:
4485c609719bSwdenk
4486c609719bSwdenk	=> imi 40100000 40200000
4487c609719bSwdenk
4488c609719bSwdenk	## Checking Image at 40100000 ...
4489c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4490c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4491c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4492c609719bSwdenk	   Load Address: 00000000
4493c609719bSwdenk	   Entry Point:	 0000000c
4494c609719bSwdenk	   Verifying Checksum ... OK
4495c609719bSwdenk
4496c609719bSwdenk	## Checking Image at 40200000 ...
4497c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4498c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4499c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4500c609719bSwdenk	   Load Address: 00000000
4501c609719bSwdenk	   Entry Point:	 00000000
4502c609719bSwdenk	   Verifying Checksum ... OK
4503c609719bSwdenk
4504c609719bSwdenk	=> bootm 40100000 40200000
4505c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4506c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4507c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4508c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4509c609719bSwdenk	   Load Address: 00000000
4510c609719bSwdenk	   Entry Point:	 0000000c
4511c609719bSwdenk	   Verifying Checksum ... OK
4512c609719bSwdenk	   Uncompressing Kernel Image ... OK
4513c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4514c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4515c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4516c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4517c609719bSwdenk	   Load Address: 00000000
4518c609719bSwdenk	   Entry Point:	 00000000
4519c609719bSwdenk	   Verifying Checksum ... OK
4520c609719bSwdenk	   Loading Ramdisk ... OK
4521c609719bSwdenk	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
4522c609719bSwdenk	Boot arguments: root=/dev/ram
4523c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4524c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4525c609719bSwdenk	...
4526c609719bSwdenk	RAMDISK: Compressed image found at block 0
4527c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4528c609719bSwdenk
4529c609719bSwdenk	bash#
4530c609719bSwdenk
45310267768eSMatthew McClintockBoot Linux and pass a flat device tree:
45320267768eSMatthew McClintock-----------
45330267768eSMatthew McClintock
45340267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
45350267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
45360267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
45370267768eSMatthew McClintockflat device tree:
45380267768eSMatthew McClintock
45390267768eSMatthew McClintock=> print oftaddr
45400267768eSMatthew McClintockoftaddr=0x300000
45410267768eSMatthew McClintock=> print oft
45420267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
45430267768eSMatthew McClintock=> tftp $oftaddr $oft
45440267768eSMatthew McClintockSpeed: 1000, full duplex
45450267768eSMatthew McClintockUsing TSEC0 device
45460267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
45470267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
45480267768eSMatthew McClintockLoad address: 0x300000
45490267768eSMatthew McClintockLoading: #
45500267768eSMatthew McClintockdone
45510267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
45520267768eSMatthew McClintock=> tftp $loadaddr $bootfile
45530267768eSMatthew McClintockSpeed: 1000, full duplex
45540267768eSMatthew McClintockUsing TSEC0 device
45550267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
45560267768eSMatthew McClintockFilename 'uImage'.
45570267768eSMatthew McClintockLoad address: 0x200000
45580267768eSMatthew McClintockLoading:############
45590267768eSMatthew McClintockdone
45600267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
45610267768eSMatthew McClintock=> print loadaddr
45620267768eSMatthew McClintockloadaddr=200000
45630267768eSMatthew McClintock=> print oftaddr
45640267768eSMatthew McClintockoftaddr=0x300000
45650267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
45660267768eSMatthew McClintock## Booting image at 00200000 ...
45670267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
45680267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
45690267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
45700267768eSMatthew McClintock   Load Address: 00000000
45710267768eSMatthew McClintock   Entry Point:	 00000000
45720267768eSMatthew McClintock   Verifying Checksum ... OK
45730267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
45740267768eSMatthew McClintockBooting using flat device tree at 0x300000
45750267768eSMatthew McClintockUsing MPC85xx ADS machine description
45760267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
45770267768eSMatthew McClintock[snip]
45780267768eSMatthew McClintock
45790267768eSMatthew McClintock
45806069ff26SwdenkMore About U-Boot Image Types:
45816069ff26Swdenk------------------------------
45826069ff26Swdenk
45836069ff26SwdenkU-Boot supports the following image types:
45846069ff26Swdenk
45856069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
45866069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
45876069ff26Swdenk	well) you can continue to work in U-Boot after return from
45886069ff26Swdenk	the Standalone Program.
45896069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
45906069ff26Swdenk	will take over control completely. Usually these programs
45916069ff26Swdenk	will install their own set of exception handlers, device
45926069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
45936069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
45946069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
45956069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
45966069ff26Swdenk	being started.
45976069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
45986069ff26Swdenk	(Linux) kernel image and one or more data images like
45996069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
46006069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
46016069ff26Swdenk	server provides just a single image file, but you want to get
46026069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
46036069ff26Swdenk
46046069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
46056069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
46066069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
46076069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
46086069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
46096069ff26Swdenk	a multiple of 4 bytes).
46106069ff26Swdenk
46116069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
46126069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
46136069ff26Swdenk	flash memory.
46146069ff26Swdenk
46156069ff26Swdenk   "Script files" are command sequences that will be executed by
46166069ff26Swdenk	U-Boot's command interpreter; this feature is especially
46176069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
46186069ff26Swdenk	as command interpreter.
46196069ff26Swdenk
462044f074c7SMarek VasutBooting the Linux zImage:
462144f074c7SMarek Vasut-------------------------
462244f074c7SMarek Vasut
462344f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
462444f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
462544f074c7SMarek Vasutas the syntax of "bootm" command.
462644f074c7SMarek Vasut
4627017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4628017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4629017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4630017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4631017e1f3fSMarek Vasut
4632c609719bSwdenk
4633c609719bSwdenkStandalone HOWTO:
4634c609719bSwdenk=================
4635c609719bSwdenk
4636c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4637c609719bSwdenkrun "standalone" applications, which can use some resources of
4638c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4639c609719bSwdenk
4640c609719bSwdenkTwo simple examples are included with the sources:
4641c609719bSwdenk
4642c609719bSwdenk"Hello World" Demo:
4643c609719bSwdenk-------------------
4644c609719bSwdenk
4645c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4646c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4647c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4648c609719bSwdenklike that:
4649c609719bSwdenk
4650c609719bSwdenk	=> loads
4651c609719bSwdenk	## Ready for S-Record download ...
4652c609719bSwdenk	~>examples/hello_world.srec
4653c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4654c609719bSwdenk	[file transfer complete]
4655c609719bSwdenk	[connected]
4656c609719bSwdenk	## Start Addr = 0x00040004
4657c609719bSwdenk
4658c609719bSwdenk	=> go 40004 Hello World! This is a test.
4659c609719bSwdenk	## Starting application at 0x00040004 ...
4660c609719bSwdenk	Hello World
4661c609719bSwdenk	argc = 7
4662c609719bSwdenk	argv[0] = "40004"
4663c609719bSwdenk	argv[1] = "Hello"
4664c609719bSwdenk	argv[2] = "World!"
4665c609719bSwdenk	argv[3] = "This"
4666c609719bSwdenk	argv[4] = "is"
4667c609719bSwdenk	argv[5] = "a"
4668c609719bSwdenk	argv[6] = "test."
4669c609719bSwdenk	argv[7] = "<NULL>"
4670c609719bSwdenk	Hit any key to exit ...
4671c609719bSwdenk
4672c609719bSwdenk	## Application terminated, rc = 0x0
4673c609719bSwdenk
4674c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4675c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4676c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4677c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4678c609719bSwdenkcharacter, but this is just a demo program. The application can be
4679c609719bSwdenkcontrolled by the following keys:
4680c609719bSwdenk
4681c609719bSwdenk	? - print current values og the CPM Timer registers
4682c609719bSwdenk	b - enable interrupts and start timer
4683c609719bSwdenk	e - stop timer and disable interrupts
4684c609719bSwdenk	q - quit application
4685c609719bSwdenk
4686c609719bSwdenk	=> loads
4687c609719bSwdenk	## Ready for S-Record download ...
4688c609719bSwdenk	~>examples/timer.srec
4689c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4690c609719bSwdenk	[file transfer complete]
4691c609719bSwdenk	[connected]
4692c609719bSwdenk	## Start Addr = 0x00040004
4693c609719bSwdenk
4694c609719bSwdenk	=> go 40004
4695c609719bSwdenk	## Starting application at 0x00040004 ...
4696c609719bSwdenk	TIMERS=0xfff00980
4697c609719bSwdenk	Using timer 1
4698c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4699c609719bSwdenk
4700c609719bSwdenkHit 'b':
4701c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4702c609719bSwdenk	Enabling timer
4703c609719bSwdenkHit '?':
4704c609719bSwdenk	[q, b, e, ?] ........
4705c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4706c609719bSwdenkHit '?':
4707c609719bSwdenk	[q, b, e, ?] .
4708c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4709c609719bSwdenkHit '?':
4710c609719bSwdenk	[q, b, e, ?] .
4711c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4712c609719bSwdenkHit '?':
4713c609719bSwdenk	[q, b, e, ?] .
4714c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4715c609719bSwdenkHit 'e':
4716c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4717c609719bSwdenkHit 'q':
4718c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4719c609719bSwdenk
4720c609719bSwdenk
472185ec0bccSwdenkMinicom warning:
472285ec0bccSwdenk================
472385ec0bccSwdenk
47247152b1d0SwdenkOver time, many people have reported problems when trying to use the
472585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
472685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4727f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
472885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4729e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4730e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4731e53515a2SKarl O. Pincfor help with kermit.
4732e53515a2SKarl O. Pinc
473385ec0bccSwdenk
473452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
473552f52c14Swdenkconfiguration to your "File transfer protocols" section:
473652f52c14Swdenk
473752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
473852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
473952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
474052f52c14Swdenk
474152f52c14Swdenk
4742c609719bSwdenkNetBSD Notes:
4743c609719bSwdenk=============
4744c609719bSwdenk
4745c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4746c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4747c609719bSwdenk
4748c609719bSwdenkBuilding requires a cross environment; it is known to work on
4749c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4750c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4751c609719bSwdenkNote that the cross-powerpc package does not install include files;
4752c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4753c609719bSwdenkmissing.  This file has to be installed and patched manually:
4754c609719bSwdenk
4755c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4756c609719bSwdenk	# mkdir powerpc
4757c609719bSwdenk	# ln -s powerpc machine
4758c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4759c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4760c609719bSwdenk
4761c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4762c609719bSwdenkand U-Boot include files.
4763c609719bSwdenk
4764c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4765c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4766c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4767c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
47682a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4769c609719bSwdenk
4770c609719bSwdenk
4771c609719bSwdenkImplementation Internals:
4772c609719bSwdenk=========================
4773c609719bSwdenk
4774c609719bSwdenkThe following is not intended to be a complete description of every
4775c609719bSwdenkimplementation detail. However, it should help to understand the
4776c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4777c609719bSwdenkhardware.
4778c609719bSwdenk
4779c609719bSwdenk
4780c609719bSwdenkInitial Stack, Global Data:
4781c609719bSwdenk---------------------------
4782c609719bSwdenk
4783c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4784c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4785c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4786c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4787c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4788c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4789c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4790c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4791c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4792c609719bSwdenklocked as (mis-) used as memory, etc.
4793c609719bSwdenk
47947152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
47950668236bSWolfgang Denk	U-Boot mailing list:
479643d9616cSwdenk
479743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
479843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
479943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
480043d9616cSwdenk	...
480143d9616cSwdenk
480243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
480343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
480443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
480543d9616cSwdenk	is that the cache is being used as a temporary supply of
480643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
480711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
480843d9616cSwdenk	can see how this works by studying the cache architecture and
480943d9616cSwdenk	operation in the architecture and processor-specific manuals.
481043d9616cSwdenk
481143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
481243d9616cSwdenk	is another option for the system designer to use as an
481311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
481443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
481543d9616cSwdenk	board designers haven't used it for something that would
481643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
481743d9616cSwdenk	used.
481843d9616cSwdenk
48196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
482043d9616cSwdenk	with your processor/board/system design. The default value
482143d9616cSwdenk	you will find in any recent u-boot distribution in
48228a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
482343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
482443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
482543d9616cSwdenk	that are supposed to respond to that address! That code in
482643d9616cSwdenk	start.S has been around a while and should work as is when
482743d9616cSwdenk	you get the config right.
482843d9616cSwdenk
482943d9616cSwdenk	-Chris Hallinan
483043d9616cSwdenk	DS4.COM, Inc.
483143d9616cSwdenk
4832c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4833c609719bSwdenkcode for the initialization procedures:
4834c609719bSwdenk
4835c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4836c609719bSwdenk  to write it.
4837c609719bSwdenk
483811ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4839c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
48407152b1d0Swdenk  zation is performed later (when relocating to RAM).
4841c609719bSwdenk
4842c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4843c609719bSwdenk  that.
4844c609719bSwdenk
4845c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4846c609719bSwdenknormal global data to share information beween the code. But it
4847c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4848c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4849c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4850c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4851c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4852c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4853c609719bSwdenkreserve for this purpose.
4854c609719bSwdenk
48557152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4856c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4857c609719bSwdenkGCC's implementation.
4858c609719bSwdenk
4859c609719bSwdenkFor PowerPC, the following registers have specific use:
4860c609719bSwdenk	R1:	stack pointer
4861e7670f6cSWolfgang Denk	R2:	reserved for system use
4862c609719bSwdenk	R3-R4:	parameter passing and return values
4863c609719bSwdenk	R5-R10: parameter passing
4864c609719bSwdenk	R13:	small data area pointer
4865c609719bSwdenk	R30:	GOT pointer
4866c609719bSwdenk	R31:	frame pointer
4867c609719bSwdenk
4868e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4869e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4870e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4871c609719bSwdenk
4872e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4873c609719bSwdenk
4874c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4875c609719bSwdenk    address of the global data structure is known at compile time),
4876c609719bSwdenk    but it turned out that reserving a register results in somewhat
4877c609719bSwdenk    smaller code - although the code savings are not that big (on
4878c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4879c609719bSwdenk    624 text + 127 data).
4880c609719bSwdenk
4881c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
48824c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
48834c58eb55SMike Frysinger
4884c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
48854c58eb55SMike Frysinger
4886c609719bSwdenkOn ARM, the following registers are used:
4887c609719bSwdenk
4888c609719bSwdenk	R0:	function argument word/integer result
4889c609719bSwdenk	R1-R3:	function argument word
4890c609719bSwdenk	R9:	GOT pointer
4891c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4892c609719bSwdenk	R11:	argument (frame) pointer
4893c609719bSwdenk	R12:	temporary workspace
4894c609719bSwdenk	R13:	stack pointer
4895c609719bSwdenk	R14:	link register
4896c609719bSwdenk	R15:	program counter
4897c609719bSwdenk
4898c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4899c609719bSwdenk
49000df01fd3SThomas ChouOn Nios II, the ABI is documented here:
49010df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
49020df01fd3SThomas Chou
49030df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
49040df01fd3SThomas Chou
49050df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
49060df01fd3SThomas Chou    to access small data sections, so gp is free.
49070df01fd3SThomas Chou
4908afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4909afc1ce82SMacpaul Lin
4910afc1ce82SMacpaul Lin	R0-R1:	argument/return
4911afc1ce82SMacpaul Lin	R2-R5:	argument
4912afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4913afc1ce82SMacpaul Lin	R16:	trampoline register
4914afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4915afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4916afc1ce82SMacpaul Lin	R30:	link register (LP)
4917afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4918afc1ce82SMacpaul Lin	PC:	program counter (PC)
4919afc1ce82SMacpaul Lin
4920afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4921afc1ce82SMacpaul Lin
4922d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4923d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4924c609719bSwdenk
4925c609719bSwdenkMemory Management:
4926c609719bSwdenk------------------
4927c609719bSwdenk
4928c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4929c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4930c609719bSwdenk
4931c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4932c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4933c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4934c609719bSwdenkphysical memory banks.
4935c609719bSwdenk
4936c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4937c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4938c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4939c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
49406d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4941c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4942c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4943c609719bSwdenk
4944c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4945c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4946c609719bSwdenk
4947c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4948c609719bSwdenkthis:
4949c609719bSwdenk
4950c609719bSwdenk	0x0000 0000	Exception Vector code
4951c609719bSwdenk	      :
4952c609719bSwdenk	0x0000 1FFF
4953c609719bSwdenk	0x0000 2000	Free for Application Use
4954c609719bSwdenk	      :
4955c609719bSwdenk	      :
4956c609719bSwdenk
4957c609719bSwdenk	      :
4958c609719bSwdenk	      :
4959c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4960c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4961c609719bSwdenk	0x00FC 0000	Malloc Arena
4962c609719bSwdenk	      :
4963c609719bSwdenk	0x00FD FFFF
4964c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4965c609719bSwdenk	...		eventually: LCD or video framebuffer
4966c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4967c609719bSwdenk	0x00FF FFFF	[End of RAM]
4968c609719bSwdenk
4969c609719bSwdenk
4970c609719bSwdenkSystem Initialization:
4971c609719bSwdenk----------------------
4972c609719bSwdenk
4973c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
497411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4975c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
49767152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4977c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4978c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4979c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4980c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4981c609719bSwdenkthe caches and the SIU.
4982c609719bSwdenk
4983c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4984c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4985c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4986c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4987c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4988c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4989c609719bSwdenkbanks.
4990c609719bSwdenk
4991c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
49927152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4993c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4994c609719bSwdenk0x00000000, with any additional banks following immediately to create
4995c609719bSwdenkcontiguous memory starting from 0.
4996c609719bSwdenk
4997c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4998c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4999c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5000c609719bSwdenkpages, and the final stack is set up.
5001c609719bSwdenk
5002c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5003c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5004c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5005c609719bSwdenknew address in RAM.
5006c609719bSwdenk
5007c609719bSwdenk
5008c609719bSwdenkU-Boot Porting Guide:
5009c609719bSwdenk----------------------
5010c609719bSwdenk
5011c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
50126aff3115Swdenklist, October 2002]
5013c609719bSwdenk
5014c609719bSwdenk
5015c609719bSwdenkint main(int argc, char *argv[])
5016c609719bSwdenk{
5017c609719bSwdenk	sighandler_t no_more_time;
5018c609719bSwdenk
5019c609719bSwdenk	signal(SIGALRM, no_more_time);
5020c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5021c609719bSwdenk
5022c609719bSwdenk	if (available_money > available_manpower) {
50236c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5024c609719bSwdenk		return 0;
5025c609719bSwdenk	}
5026c609719bSwdenk
5027c609719bSwdenk	Download latest U-Boot source;
5028c609719bSwdenk
50290668236bSWolfgang Denk	Subscribe to u-boot mailing list;
50306aff3115Swdenk
50316c3fef28SJerry Van Baren	if (clueless)
5032c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5033c609719bSwdenk
5034c609719bSwdenk	while (learning) {
5035c609719bSwdenk		Read the README file in the top level directory;
50367cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
50376c3fef28SJerry Van Baren		Read applicable doc/*.README;
5038c609719bSwdenk		Read the source, Luke;
50396c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5040c609719bSwdenk	}
5041c609719bSwdenk
50426c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
50436c3fef28SJerry Van Baren		Buy a BDI3000;
50446c3fef28SJerry Van Baren	else
5045c609719bSwdenk		Add a lot of aggravation and time;
5046c609719bSwdenk
50476c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
50486c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
50496c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
50506c3fef28SJerry Van Baren	} else {
5051c609719bSwdenk		Create your own board support subdirectory;
50526c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
50536c3fef28SJerry Van Baren	}
50546c3fef28SJerry Van Baren	Edit new board/<myboard> files
50556c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5056c609719bSwdenk
50576c3fef28SJerry Van Baren	while (!accepted) {
5058c609719bSwdenk		while (!running) {
5059c609719bSwdenk			do {
5060c609719bSwdenk				Add / modify source code;
5061c609719bSwdenk			} until (compiles);
5062c609719bSwdenk			Debug;
5063c609719bSwdenk			if (clueless)
5064c609719bSwdenk				email("Hi, I am having problems...");
5065c609719bSwdenk		}
50666c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
50676c3fef28SJerry Van Baren		if (reasonable critiques)
50686c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
50696c3fef28SJerry Van Baren		else
50706c3fef28SJerry Van Baren			Defend code as written;
50716c3fef28SJerry Van Baren	}
5072c609719bSwdenk
5073c609719bSwdenk	return 0;
5074c609719bSwdenk}
5075c609719bSwdenk
5076c609719bSwdenkvoid no_more_time (int sig)
5077c609719bSwdenk{
5078c609719bSwdenk      hire_a_guru();
5079c609719bSwdenk}
5080c609719bSwdenk
5081c609719bSwdenk
5082c609719bSwdenkCoding Standards:
5083c609719bSwdenk-----------------
5084c609719bSwdenk
5085c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
50862c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
50877ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5088c609719bSwdenk
50892c051651SDetlev ZundelSource files originating from a different project (for example the
50902c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
50912c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
50922c051651SDetlev Zundelsources.
50932c051651SDetlev Zundel
50942c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
50952c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
50962c051651SDetlev Zundelin your code.
5097c609719bSwdenk
5098c178d3daSwdenkPlease also stick to the following formatting rules:
5099180d3f74Swdenk- remove any trailing white space
51007ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5101180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
51027ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5103180d3f74Swdenk- do not add trailing empty lines to source files
5104180d3f74Swdenk
5105c609719bSwdenkSubmissions which do not conform to the standards may be returned
5106c609719bSwdenkwith a request to reformat the changes.
5107c609719bSwdenk
5108c609719bSwdenk
5109c609719bSwdenkSubmitting Patches:
5110c609719bSwdenk-------------------
5111c609719bSwdenk
5112c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5113c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5114c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5115c609719bSwdenk
51160d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5117218ca724SWolfgang Denk
51180668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
51190668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
51200668236bSWolfgang Denk
5121c609719bSwdenkWhen you send a patch, please include the following information with
5122c609719bSwdenkit:
5123c609719bSwdenk
5124c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5125c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5126c609719bSwdenk  patch actually fixes something.
5127c609719bSwdenk
5128c609719bSwdenk* For new features: a description of the feature and your
5129c609719bSwdenk  implementation.
5130c609719bSwdenk
5131c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5132c609719bSwdenk
5133c609719bSwdenk* For major contributions, your entry to the CREDITS file
5134c609719bSwdenk
5135c609719bSwdenk* When you add support for a new board, don't forget to add this
51367ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5137c609719bSwdenk
5138c609719bSwdenk* If your patch adds new configuration options, don't forget to
5139c609719bSwdenk  document these in the README file.
5140c609719bSwdenk
5141218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5142218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
51437ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5144218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5145218ca724SWolfgang Denk  with some other mail clients.
5146c609719bSwdenk
5147218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5148218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5149218ca724SWolfgang Denk  GNU diff.
51506dff5529Swdenk
5151218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5152218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5153218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5154218ca724SWolfgang Denk  affected files).
5155218ca724SWolfgang Denk
5156218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5157218ca724SWolfgang Denk  and compressed attachments must not be used.
5158c609719bSwdenk
515952f52c14Swdenk* If one logical set of modifications affects or creates several
516052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
516152f52c14Swdenk
516252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
516352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
516452f52c14Swdenk
516552f52c14Swdenk
5166c609719bSwdenkNotes:
5167c609719bSwdenk
5168c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5169c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5170c609719bSwdenk  for any of the boards.
5171c609719bSwdenk
5172c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5173c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5174c609719bSwdenk  returned with a request to re-formatting / split it.
5175c609719bSwdenk
5176c609719bSwdenk* If you modify existing code, make sure that your new code does not
5177c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5178c609719bSwdenk  When adding new features, these should compile conditionally only
5179c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5180c609719bSwdenk  disabled must not need more memory than the old code without your
5181c609719bSwdenk  modification.
518290dc6704Swdenk
51830668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
51840668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
51850668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
51860668236bSWolfgang Denk  bigger than the size limit should be avoided.
5187