xref: /openbmc/u-boot/README (revision 03e2ecf6)
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:
366ffd06e02SYork Sun		CONFIG_SYS_PPC64
367ffd06e02SYork Sun
368ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
369ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
370ffd06e02SYork Sun		compliance, among other possible reasons.
371ffd06e02SYork 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
810*03e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
811*03e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
812bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
813602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
814*03e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
815602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
816602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
817602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
818a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
819a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
820602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
821602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
822602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
823602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
824602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
825602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8260c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
827c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
828602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
829602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
830602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
831602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8321ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
833d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
834d22c338eSJoe Hershberger					  (169.254.*.*)
835602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
836602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
83702c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
83802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
839602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
84056523f12Swdenk					  loop, loopw, mtest
841602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
842602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
843602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
84468d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
845602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
846602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
847e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
848e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
849602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
850602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
851602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
852602ad3b3SJon Loeliger					  host
853602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
854602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
855602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
856602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
857602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
858602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
859602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
860602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
861602ad3b3SJon Loeliger					  (4xx only)
862f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
863c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
86402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
86574de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
866602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8677a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8681fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
869da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
870da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
871602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
872602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
873c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
874c609719bSwdenk
875c609719bSwdenk
876c609719bSwdenk		EXAMPLE: If you want all functions except of network
877c609719bSwdenk		support you can write:
878c609719bSwdenk
879602ad3b3SJon Loeliger		#include "config_cmd_all.h"
880602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
881c609719bSwdenk
882213bf8c8SGerald Van Baren	Other Commands:
883213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
884c609719bSwdenk
885c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
886602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
887c609719bSwdenk		what you (and your U-Boot users) are doing. Data
888c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
889c609719bSwdenk		8260 (where accesses to the IMMR region must be
890c609719bSwdenk		uncached), and it cannot be disabled on all other
891c609719bSwdenk		systems where we (mis-) use the data cache to hold an
892c609719bSwdenk		initial stack and some data.
893c609719bSwdenk
894c609719bSwdenk
895c609719bSwdenk		XXX - this list needs to get updated!
896c609719bSwdenk
89745ba8077SSimon Glass- Device tree:
89845ba8077SSimon Glass		CONFIG_OF_CONTROL
89945ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
90045ba8077SSimon Glass		to configure its devices, instead of relying on statically
90145ba8077SSimon Glass		compiled #defines in the board file. This option is
90245ba8077SSimon Glass		experimental and only available on a few boards. The device
90345ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
90445ba8077SSimon Glass
9052c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9062c0f79e4SSimon Glass		be done using one of the two options below:
907bbb0b128SSimon Glass
908bbb0b128SSimon Glass		CONFIG_OF_EMBED
909bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
910bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
911bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
912bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
913bbb0b128SSimon Glass		the global data structure as gd->blob.
91445ba8077SSimon Glass
9152c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9162c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9172c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9182c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9192c0f79e4SSimon Glass
9202c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9212c0f79e4SSimon Glass
9222c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9232c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9242c0f79e4SSimon Glass		still use the individual files if you need something more
9252c0f79e4SSimon Glass		exotic.
9262c0f79e4SSimon Glass
927c609719bSwdenk- Watchdog:
928c609719bSwdenk		CONFIG_WATCHDOG
929c609719bSwdenk		If this variable is defined, it enables watchdog
9306abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9316abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9326abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9336abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9346abe6fb6SDetlev Zundel		available, then no further board specific code should
9356abe6fb6SDetlev Zundel		be needed to use it.
9366abe6fb6SDetlev Zundel
9376abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9386abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9396abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9406abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
941c609719bSwdenk
942c1551ea8Sstroese- U-Boot Version:
943c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
944c1551ea8Sstroese		If this variable is defined, an environment variable
945c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
946c1551ea8Sstroese		version as printed by the "version" command.
947a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
948a1ea8e51SBenoît Thébaudeau		next reset.
949c1551ea8Sstroese
950c609719bSwdenk- Real-Time Clock:
951c609719bSwdenk
952602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
953c609719bSwdenk		has to be selected, too. Define exactly one of the
954c609719bSwdenk		following options:
955c609719bSwdenk
956c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
957c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9584e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
959c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9601cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
961c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9627f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9633bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9649536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9654c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
96771d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
96871d19f30SHeiko Schocher					  RV3029 RTC.
969c609719bSwdenk
970b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
971b37c7e5eSwdenk		must also be configured. See I2C Support, below.
972b37c7e5eSwdenk
973e92739d3SPeter Tyser- GPIO Support:
974e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
975e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
976e92739d3SPeter Tyser
9775dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9785dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9795dec49caSChris Packham		pins supported by a particular chip.
9805dec49caSChris Packham
981e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
982e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
983e92739d3SPeter Tyser
984c609719bSwdenk- Timestamp Support:
985c609719bSwdenk
986c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
987c609719bSwdenk		(date and time) of an image is printed by image
988c609719bSwdenk		commands like bootm or iminfo. This option is
989602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
990c609719bSwdenk
991923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
992923c46f9SKarl O. Pinc		Zero or more of the following:
993923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
994923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
995923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
996923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
997923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
998923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
999923c46f9SKarl O. Pinc				       disk/part_efi.c
1000923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1001c609719bSwdenk
1002602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1003218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1004923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1005c609719bSwdenk
1006c609719bSwdenk- IDE Reset method:
10074d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10084d13cbadSwdenk		board configurations files but used nowhere!
1009c609719bSwdenk
10104d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10114d13cbadSwdenk		be performed by calling the function
10124d13cbadSwdenk			ide_set_reset(int reset)
10134d13cbadSwdenk		which has to be defined in a board specific file
1014c609719bSwdenk
1015c609719bSwdenk- ATAPI Support:
1016c609719bSwdenk		CONFIG_ATAPI
1017c609719bSwdenk
1018c609719bSwdenk		Set this to enable ATAPI support.
1019c609719bSwdenk
1020c40b2956Swdenk- LBA48 Support
1021c40b2956Swdenk		CONFIG_LBA48
1022c40b2956Swdenk
1023c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10244b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1025c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1026c40b2956Swdenk		support disks up to 2.1TB.
1027c40b2956Swdenk
10286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1029c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1030c40b2956Swdenk			Default is 32bit.
1031c40b2956Swdenk
1032c609719bSwdenk- SCSI Support:
1033c609719bSwdenk		At the moment only there is only support for the
1034c609719bSwdenk		SYM53C8XX SCSI controller; define
1035c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1036c609719bSwdenk
10376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1040c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1041c609719bSwdenk		devices.
10426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1043c609719bSwdenk
1044c609719bSwdenk- NETWORK Support (PCI):
1045682011ffSwdenk		CONFIG_E1000
1046ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1047ce5207e1SKyle Moffett
1048ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1049ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1050ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1051ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1052ce5207e1SKyle Moffett
1053ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1054ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1055ce5207e1SKyle Moffett		example with the "sspi" command.
1056ce5207e1SKyle Moffett
1057ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1058ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1059ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1060682011ffSwdenk
1061ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
106211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1063ac3315c2SAndre Schwarz
1064c609719bSwdenk		CONFIG_EEPRO100
1065c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
106611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1067c609719bSwdenk		write routine for first time initialisation.
1068c609719bSwdenk
1069c609719bSwdenk		CONFIG_TULIP
1070c609719bSwdenk		Support for Digital 2114x chips.
1071c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1072c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1073c609719bSwdenk
1074c609719bSwdenk		CONFIG_NATSEMI
1075c609719bSwdenk		Support for National dp83815 chips.
1076c609719bSwdenk
1077c609719bSwdenk		CONFIG_NS8382X
1078c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1079c609719bSwdenk
108045219c46Swdenk- NETWORK Support (other):
108145219c46Swdenk
1082c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1083c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1084c041e9d2SJens Scharsig
1085c041e9d2SJens Scharsig			CONFIG_RMII
1086c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1087c041e9d2SJens Scharsig
1088c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1089c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1090c041e9d2SJens Scharsig			The driver doen't show link status messages.
1091c041e9d2SJens Scharsig
1092efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1093efdd7319SRob Herring		Support for the Calxeda XGMAC device
1094efdd7319SRob Herring
10953bb46d23SAshok		CONFIG_LAN91C96
109645219c46Swdenk		Support for SMSC's LAN91C96 chips.
109745219c46Swdenk
109845219c46Swdenk			CONFIG_LAN91C96_BASE
109945219c46Swdenk			Define this to hold the physical address
110045219c46Swdenk			of the LAN91C96's I/O space
110145219c46Swdenk
110245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
110345219c46Swdenk			Define this to enable 32 bit addressing
110445219c46Swdenk
11053bb46d23SAshok		CONFIG_SMC91111
1106f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1107f39748aeSwdenk
1108f39748aeSwdenk			CONFIG_SMC91111_BASE
1109f39748aeSwdenk			Define this to hold the physical address
1110f39748aeSwdenk			of the device (I/O space)
1111f39748aeSwdenk
1112f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1113f39748aeSwdenk			Define this if data bus is 32 bits
1114f39748aeSwdenk
1115f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1116f39748aeSwdenk			Define this to use i/o functions instead of macros
1117f39748aeSwdenk			(some hardware wont work with macros)
1118f39748aeSwdenk
1119dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1120dc02badaSHeiko Schocher		Support for davinci emac
1121dc02badaSHeiko Schocher
1122dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1123dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1124dc02badaSHeiko Schocher
1125b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1126b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1127b3dbf4a5SMacpaul Lin
1128b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1129b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1130b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1131b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1132b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1133b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1134b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1135b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1136b3dbf4a5SMacpaul Lin
1137c2fff331SMike Rapoport		CONFIG_SMC911X
1138557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1139557b377dSJens Gehrlein
1140c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1141557b377dSJens Gehrlein			Define this to hold the physical address
1142557b377dSJens Gehrlein			of the device (I/O space)
1143557b377dSJens Gehrlein
1144c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1145557b377dSJens Gehrlein			Define this if data bus is 32 bits
1146557b377dSJens Gehrlein
1147c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1148557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1149557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1150c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1151557b377dSJens Gehrlein
11523d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11533d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11543d0075faSYoshihiro Shimoda
11553d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11563d0075faSYoshihiro Shimoda			Define the number of ports to be used
11573d0075faSYoshihiro Shimoda
11583d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11593d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11603d0075faSYoshihiro Shimoda
116168260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
116268260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
116368260aabSYoshihiro Shimoda
11645e124724SVadim Bendebury- TPM Support:
11655e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11665e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11675e124724SVadim Bendebury		per system is supported at this time.
11685e124724SVadim Bendebury
11695e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11705e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11715e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11725e124724SVadim Bendebury			0xfed40000.
11735e124724SVadim Bendebury
1174c609719bSwdenk- USB Support:
1175c609719bSwdenk		At the moment only the UHCI host controller is
11764d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1177c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1178c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
117930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1180c609719bSwdenk		storage devices.
1181c609719bSwdenk		Note:
1182c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1183c609719bSwdenk		(TEAC FD-05PUB).
11844d13cbadSwdenk		MPC5200 USB requires additional defines:
11854d13cbadSwdenk			CONFIG_USB_CLOCK
11864d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1187307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1188307ecb6dSEric Millbrandt				for USB on PSC3
11894d13cbadSwdenk			CONFIG_USB_CONFIG
11904d13cbadSwdenk				for differential drivers: 0x00001000
11914d13cbadSwdenk				for single ended drivers: 0x00005000
1192307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1193307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1195fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1196fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11974d13cbadSwdenk
11989ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11999ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12009ab4ce22SSimon Glass
120116c8d5e7SWolfgang Denk- USB Device:
120216c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
120316c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
120416c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
120511ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
120616c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
120716c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
120816c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
120916c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
121016c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
121116c8d5e7SWolfgang Denk		a Linux host by
121216c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
121316c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
121416c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
121516c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
121616c8d5e7SWolfgang Denk
121716c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
121816c8d5e7SWolfgang Denk			Define this to build a UDC device
121916c8d5e7SWolfgang Denk
122016c8d5e7SWolfgang Denk			CONFIG_USB_TTY
122116c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
122216c8d5e7SWolfgang Denk			talk to the UDC device
122316c8d5e7SWolfgang Denk
1224f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1225f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1226f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1227f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1228f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1229f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1230f9da0f89SVipin KUMAR			speed.
1231f9da0f89SVipin KUMAR
12326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
123316c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
123416c8d5e7SWolfgang Denk			be set to usbtty.
123516c8d5e7SWolfgang Denk
123616c8d5e7SWolfgang Denk			mpc8xx:
12376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
123816c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
124016c8d5e7SWolfgang Denk
12416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
124216c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
124416c8d5e7SWolfgang Denk
124516c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
124616c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
124716c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
124816c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
124916c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
125016c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
125116c8d5e7SWolfgang Denk
125216c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
125316c8d5e7SWolfgang Denk			Define this string as the name of your company for
125416c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
125516c8d5e7SWolfgang Denk
125616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
125716c8d5e7SWolfgang Denk			Define this string as the name of your product
125816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
125916c8d5e7SWolfgang Denk
126016c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
126116c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
126216c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
126316c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
126416c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
126516c8d5e7SWolfgang Denk
126616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
126716c8d5e7SWolfgang Denk			Define this as the unique Product ID
126816c8d5e7SWolfgang Denk			for your device
126916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1270c609719bSwdenk
1271d70a560fSIgor Grinberg- ULPI Layer Support:
1272d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1273d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1274d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1275d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1276d70a560fSIgor Grinberg		viewport is supported.
1277d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1278d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
12796d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
12806d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
12816d365ea0SLucas Stach		the appropriate value in Hz.
1282c609719bSwdenk
1283c609719bSwdenk- MMC Support:
1284c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1285c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1286c609719bSwdenk		accessed from the boot prompt by mapping the device
1287c609719bSwdenk		to physical memory similar to flash. Command line is
1288602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1289602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1290c609719bSwdenk
1291afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1292afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1293afb35666SYoshihiro Shimoda
1294afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1295afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1296afb35666SYoshihiro Shimoda
1297afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1298afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1299afb35666SYoshihiro Shimoda
13006705d81eSwdenk- Journaling Flash filesystem support:
13016705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13026705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13036705d81eSwdenk		Define these for a default partition on a NAND device
13046705d81eSwdenk
13056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13076705d81eSwdenk		Define these for a default partition on a NOR device
13086705d81eSwdenk
13096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13106705d81eSwdenk		Define this to create an own partition. You have to provide a
13116705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13126705d81eSwdenk
13136705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13156705d81eSwdenk		to disable the command chpart. This is the default when you
13166705d81eSwdenk		have not defined a custom partition
13176705d81eSwdenk
1318c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1319c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1320656f4c65SDonggeun Kim
1321656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1322656f4c65SDonggeun Kim		file in FAT formatted partition.
1323656f4c65SDonggeun Kim
1324656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1325656f4c65SDonggeun Kim		user to write files to FAT.
1326c30a15e5SDonggeun Kim
132784cd9327SGabe BlackCBFS (Coreboot Filesystem) support
132884cd9327SGabe Black		CONFIG_CMD_CBFS
132984cd9327SGabe Black
133084cd9327SGabe Black		Define this to enable support for reading from a Coreboot
133184cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
133284cd9327SGabe Black		and cbfsload.
133384cd9327SGabe Black
1334c609719bSwdenk- Keyboard Support:
1335c609719bSwdenk		CONFIG_ISA_KEYBOARD
1336c609719bSwdenk
1337c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1338c609719bSwdenk		support
1339c609719bSwdenk
1340c609719bSwdenk		CONFIG_I8042_KBD
1341c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1342c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1343c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1344c609719bSwdenk		for cfb_console. Supports cursor blinking.
1345c609719bSwdenk
1346c609719bSwdenk- Video support:
1347c609719bSwdenk		CONFIG_VIDEO
1348c609719bSwdenk
1349c609719bSwdenk		Define this to enable video support (for output to
1350c609719bSwdenk		video).
1351c609719bSwdenk
1352c609719bSwdenk		CONFIG_VIDEO_CT69000
1353c609719bSwdenk
1354c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1355c609719bSwdenk
1356c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1357eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1358eeb1b77bSwdenk		video output is selected via environment 'videoout'
1359eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1360eeb1b77bSwdenk		assumed.
1361c609719bSwdenk
1362eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
136311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1364eeb1b77bSwdenk		are possible:
1365eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1366eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1367eeb1b77bSwdenk
1368eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1369eeb1b77bSwdenk		-------------+---------------------------------------------
1370eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1371eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1372eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1373eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1374eeb1b77bSwdenk		-------------+---------------------------------------------
1375c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1376c609719bSwdenk
1377eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13787817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1379eeb1b77bSwdenk
1380eeb1b77bSwdenk
1381a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1382a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1383a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1384a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1385a6c7ad2fSwdenk
13867d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13877d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13887d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13897d3053fbSTimur Tabi		support, and should also define these other macros:
13907d3053fbSTimur Tabi
13917d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13927d3053fbSTimur Tabi			CONFIG_VIDEO
13937d3053fbSTimur Tabi			CONFIG_CMD_BMP
13947d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13957d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13967d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13977d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13987d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13997d3053fbSTimur Tabi
1400ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1401ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1402ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1403ba8e76bdSTimur Tabi		description of this variable.
14047d3053fbSTimur Tabi
1405682011ffSwdenk- Keyboard Support:
1406682011ffSwdenk		CONFIG_KEYBOARD
1407682011ffSwdenk
1408682011ffSwdenk		Define this to enable a custom keyboard support.
1409682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1410682011ffSwdenk		defined in your board-specific files.
1411682011ffSwdenk		The only board using this so far is RBC823.
1412a6c7ad2fSwdenk
1413c609719bSwdenk- LCD Support:	CONFIG_LCD
1414c609719bSwdenk
1415c609719bSwdenk		Define this to enable LCD support (for output to LCD
1416c609719bSwdenk		display); also select one of the supported displays
1417c609719bSwdenk		by defining one of these:
1418c609719bSwdenk
141939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
142039cf4804SStelian Pop
142139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
142239cf4804SStelian Pop
1423fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1424c609719bSwdenk
1425fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1426c609719bSwdenk
1427fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1428c609719bSwdenk
1429fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1430fd3103bbSwdenk			Active, color, single scan.
1431fd3103bbSwdenk
1432fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1433fd3103bbSwdenk
1434fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1435c609719bSwdenk			Active, color, single scan.
1436c609719bSwdenk
1437c609719bSwdenk		CONFIG_SHARP_16x9
1438c609719bSwdenk
1439c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1440c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1441c609719bSwdenk
1442c609719bSwdenk		CONFIG_SHARP_LQ64D341
1443c609719bSwdenk
1444c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1445c609719bSwdenk			Active, color, single scan.
1446c609719bSwdenk
1447c609719bSwdenk		CONFIG_HLD1045
1448c609719bSwdenk
1449c609719bSwdenk			HLD1045 display, 640x480.
1450c609719bSwdenk			Active, color, single scan.
1451c609719bSwdenk
1452c609719bSwdenk		CONFIG_OPTREX_BW
1453c609719bSwdenk
1454c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1455c609719bSwdenk			or
1456c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1457c609719bSwdenk			or
1458c609719bSwdenk			Hitachi	 SP14Q002
1459c609719bSwdenk
1460c609719bSwdenk			320x240. Black & white.
1461c609719bSwdenk
1462c609719bSwdenk		Normally display is black on white background; define
14636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1464c609719bSwdenk
14657152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1466d791b1dcSwdenk
1467d791b1dcSwdenk		If this option is set, the environment is checked for
1468d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1469d791b1dcSwdenk		of logo, copyright and system information on the LCD
1470e94d2cd9Swdenk		is suppressed and the BMP image at the address
1471d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1472d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1473d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1474d791b1dcSwdenk		loaded very quickly after power-on.
1475d791b1dcSwdenk
14761ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14771ca298ceSMatthias Weisser
14781ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14791ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14801ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14811ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14821ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14831ca298ceSMatthias Weisser		specify 'm' for centering the image.
14841ca298ceSMatthias Weisser
14851ca298ceSMatthias Weisser		Example:
14861ca298ceSMatthias Weisser		setenv splashpos m,m
14871ca298ceSMatthias Weisser			=> image at center of screen
14881ca298ceSMatthias Weisser
14891ca298ceSMatthias Weisser		setenv splashpos 30,20
14901ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14911ca298ceSMatthias Weisser
14921ca298ceSMatthias Weisser		setenv splashpos -10,m
14931ca298ceSMatthias Weisser			=> vertically centered image
14941ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14951ca298ceSMatthias Weisser
149698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
149798f4a3dfSStefan Roese
149898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
149998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
150098f4a3dfSStefan Roese		splashscreen support or the bmp command.
150198f4a3dfSStefan Roese
1502d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1503d5011762SAnatolij Gustschin
1504d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1505d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1506d5011762SAnatolij Gustschin		bmp command.
1507d5011762SAnatolij Gustschin
1508f2b96dfbSLei Wen- Do compresssing for memory range:
1509f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1510f2b96dfbSLei Wen
1511f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1512f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1513f2b96dfbSLei Wen
1514c29fdfc1Swdenk- Compression support:
1515c29fdfc1Swdenk		CONFIG_BZIP2
1516c29fdfc1Swdenk
1517c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1518c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1519c29fdfc1Swdenk		compressed images are supported.
1520c29fdfc1Swdenk
1521c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
15226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1523c29fdfc1Swdenk		be at least 4MB.
1524d791b1dcSwdenk
1525fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1526fc9c1727SLuigi 'Comio' Mantellini
1527fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1528fc9c1727SLuigi 'Comio' Mantellini		images is included.
1529fc9c1727SLuigi 'Comio' Mantellini
1530fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1531fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1532fc9c1727SLuigi 'Comio' Mantellini		formula:
1533fc9c1727SLuigi 'Comio' Mantellini
1534fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1535fc9c1727SLuigi 'Comio' Mantellini
1536fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1537fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1538fc9c1727SLuigi 'Comio' Mantellini
1539fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1540fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1541fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1542fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1543fc9c1727SLuigi 'Comio' Mantellini
1544fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1545fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
15466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1547fc9c1727SLuigi 'Comio' Mantellini
154817ea1177Swdenk- MII/PHY support:
154917ea1177Swdenk		CONFIG_PHY_ADDR
155017ea1177Swdenk
155117ea1177Swdenk		The address of PHY on MII bus.
155217ea1177Swdenk
155317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
155417ea1177Swdenk
155517ea1177Swdenk		The clock frequency of the MII bus
155617ea1177Swdenk
155717ea1177Swdenk		CONFIG_PHY_GIGE
155817ea1177Swdenk
155917ea1177Swdenk		If this option is set, support for speed/duplex
156011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
156117ea1177Swdenk
156217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
156317ea1177Swdenk
156417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
156517ea1177Swdenk		reset before any MII register access is possible.
156617ea1177Swdenk		For such PHY, set this option to the usec delay
156717ea1177Swdenk		required. (minimum 300usec for LXT971A)
156817ea1177Swdenk
156917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
157017ea1177Swdenk
157117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
157217ea1177Swdenk		command issued before MII status register can be read
157317ea1177Swdenk
1574c609719bSwdenk- Ethernet address:
1575c609719bSwdenk		CONFIG_ETHADDR
1576c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1577c609719bSwdenk		CONFIG_ETH2ADDR
1578c609719bSwdenk		CONFIG_ETH3ADDR
1579c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1580c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1581c609719bSwdenk
158211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
158311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1584c609719bSwdenk		is not determined automatically.
1585c609719bSwdenk
1586c609719bSwdenk- IP address:
1587c609719bSwdenk		CONFIG_IPADDR
1588c609719bSwdenk
1589c609719bSwdenk		Define a default value for the IP address to use for
159011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1591c609719bSwdenk		determined through e.g. bootp.
15921ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1593c609719bSwdenk
1594c609719bSwdenk- Server IP address:
1595c609719bSwdenk		CONFIG_SERVERIP
1596c609719bSwdenk
1597c609719bSwdenk		Defines a default value for the IP address of a TFTP
1598c609719bSwdenk		server to contact when using the "tftboot" command.
15991ebcd654SWolfgang Denk		(Environment variable "serverip")
1600c609719bSwdenk
160197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
160297cfe861SRobin Getz
160397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
160497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
160597cfe861SRobin Getz
16061ebcd654SWolfgang Denk- Gateway IP address:
16071ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16081ebcd654SWolfgang Denk
16091ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16101ebcd654SWolfgang Denk		default router where packets to other networks are
16111ebcd654SWolfgang Denk		sent to.
16121ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16131ebcd654SWolfgang Denk
16141ebcd654SWolfgang Denk- Subnet mask:
16151ebcd654SWolfgang Denk		CONFIG_NETMASK
16161ebcd654SWolfgang Denk
16171ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16181ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16191ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16201ebcd654SWolfgang Denk		forwarded through a router.
16211ebcd654SWolfgang Denk		(Environment variable "netmask")
16221ebcd654SWolfgang Denk
162353a5c424SDavid Updegraff- Multicast TFTP Mode:
162453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
162553a5c424SDavid Updegraff
162653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
162753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
162811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
162953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
163053a5c424SDavid Updegraff		multicast group.
163153a5c424SDavid Updegraff
1632c609719bSwdenk- BOOTP Recovery Mode:
1633c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1634c609719bSwdenk
1635c609719bSwdenk		If you have many targets in a network that try to
1636c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1637c609719bSwdenk		systems send out BOOTP requests at precisely the same
1638c609719bSwdenk		moment (which would happen for instance at recovery
1639c609719bSwdenk		from a power failure, when all systems will try to
1640c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1641c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1642c609719bSwdenk		inserted before sending out BOOTP requests. The
16436c33c785SWolfgang Denk		following delays are inserted then:
1644c609719bSwdenk
1645c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1646c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1647c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1648c609719bSwdenk		4th and following
1649c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1650c609719bSwdenk
1651fe389a82Sstroese- DHCP Advanced Options:
16521fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
16531fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1654fe389a82Sstroese
16551fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
16561fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
16571fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16581fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16591fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16601fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16611fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16621fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16631fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16641fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16651fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16661fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16672c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1668fe389a82Sstroese
16695d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16705d110f0aSWilson Callan		environment variable, not the BOOTP server.
1671fe389a82Sstroese
16722c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16732c00e099SJoe Hershberger		after the configured retry count, the call will fail
16742c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16752c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16762c00e099SJoe Hershberger		is not available.
16772c00e099SJoe Hershberger
1678fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1679fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1680fe389a82Sstroese		than one DNS serverip is offered to the client.
1681fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1682fe389a82Sstroese		serverip will be stored in the additional environment
1683fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1684fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16851fe80d79SJon Loeliger		is defined.
1686fe389a82Sstroese
1687fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1688fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1689fe389a82Sstroese		need the hostname of the DHCP requester.
16905d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16911fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16921fe80d79SJon Loeliger		option 12 to the DHCP server.
1693fe389a82Sstroese
1694d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1695d9a2f416SAras Vaichas
1696d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1697d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1698d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1699d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1700d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1701d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1702d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1703d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1704d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1705d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1706d9a2f416SAras Vaichas		this delay.
1707d9a2f416SAras Vaichas
1708d22c338eSJoe Hershberger - Link-local IP address negotiation:
1709d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1710d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1711d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1712d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1713d22c338eSJoe Hershberger
1714d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1715d22c338eSJoe Hershberger
1716a3d991bdSwdenk - CDP Options:
1717a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1718a3d991bdSwdenk
1719a3d991bdSwdenk		The device id used in CDP trigger frames.
1720a3d991bdSwdenk
1721a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1722a3d991bdSwdenk
1723a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1724a3d991bdSwdenk		of the device.
1725a3d991bdSwdenk
1726a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1727a3d991bdSwdenk
1728a3d991bdSwdenk		A printf format string which contains the ascii name of
1729a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
173011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1731a3d991bdSwdenk
1732a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1733a3d991bdSwdenk
1734a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1735a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1736a3d991bdSwdenk
1737a3d991bdSwdenk		CONFIG_CDP_VERSION
1738a3d991bdSwdenk
1739a3d991bdSwdenk		An ascii string containing the version of the software.
1740a3d991bdSwdenk
1741a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1742a3d991bdSwdenk
1743a3d991bdSwdenk		An ascii string containing the name of the platform.
1744a3d991bdSwdenk
1745a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1746a3d991bdSwdenk
1747a3d991bdSwdenk		A 32bit integer sent on the trigger.
1748a3d991bdSwdenk
1749a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1750a3d991bdSwdenk
1751a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1752a3d991bdSwdenk		device in .1 of milliwatts.
1753a3d991bdSwdenk
1754a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1755a3d991bdSwdenk
1756a3d991bdSwdenk		A byte containing the id of the VLAN.
1757a3d991bdSwdenk
1758c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1759c609719bSwdenk
1760c609719bSwdenk		Several configurations allow to display the current
1761c609719bSwdenk		status using a LED. For instance, the LED will blink
1762c609719bSwdenk		fast while running U-Boot code, stop blinking as
1763c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1764c609719bSwdenk		start blinking slow once the Linux kernel is running
1765c609719bSwdenk		(supported by a status LED driver in the Linux
1766c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1767c609719bSwdenk		feature in U-Boot.
1768c609719bSwdenk
1769c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1770c609719bSwdenk
1771c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1772c609719bSwdenk		on those systems that support this (optional)
1773c609719bSwdenk		feature, like the TQM8xxL modules.
1774c609719bSwdenk
1775c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1776c609719bSwdenk
1777b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1778b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
177911ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1780c609719bSwdenk
1781b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1782602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1783b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1784b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1785c609719bSwdenk		command line interface.
1786c609719bSwdenk
1787bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1788c609719bSwdenk
1789b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1790b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1791b37c7e5eSwdenk		support for I2C.
1792c609719bSwdenk
1793b37c7e5eSwdenk		There are several other quantities that must also be
1794b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1795c609719bSwdenk
17966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1797b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
17986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
179911ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1800c609719bSwdenk
18018d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1802a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
18038d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
18048d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
18058d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1806b37c7e5eSwdenk
18075da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
18085da71efaSEric Millbrandt
18095da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
18105da71efaSEric Millbrandt		chips might think that the current transfer is still
18115da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
18125da71efaSEric Millbrandt		commands until the slave device responds.
18135da71efaSEric Millbrandt
1814b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1815b37c7e5eSwdenk
1816b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1817b37c7e5eSwdenk		then the following macros need to be defined (examples are
1818b37c7e5eSwdenk		from include/configs/lwmon.h):
1819c609719bSwdenk
1820c609719bSwdenk		I2C_INIT
1821c609719bSwdenk
1822b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1823c609719bSwdenk		controller or configure ports.
1824c609719bSwdenk
1825b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1826b37c7e5eSwdenk
1827c609719bSwdenk		I2C_PORT
1828c609719bSwdenk
1829c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1830c609719bSwdenk		assumes both bits are on the same port). Valid values
1831c609719bSwdenk		are 0..3 for ports A..D.
1832c609719bSwdenk
1833c609719bSwdenk		I2C_ACTIVE
1834c609719bSwdenk
1835c609719bSwdenk		The code necessary to make the I2C data line active
1836c609719bSwdenk		(driven).  If the data line is open collector, this
1837c609719bSwdenk		define can be null.
1838c609719bSwdenk
1839b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1840b37c7e5eSwdenk
1841c609719bSwdenk		I2C_TRISTATE
1842c609719bSwdenk
1843c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1844c609719bSwdenk		(inactive).  If the data line is open collector, this
1845c609719bSwdenk		define can be null.
1846c609719bSwdenk
1847b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1848b37c7e5eSwdenk
1849c609719bSwdenk		I2C_READ
1850c609719bSwdenk
1851c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1852c609719bSwdenk		FALSE if it is low.
1853c609719bSwdenk
1854b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1855b37c7e5eSwdenk
1856c609719bSwdenk		I2C_SDA(bit)
1857c609719bSwdenk
1858c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1859c609719bSwdenk		is FALSE, it clears it (low).
1860c609719bSwdenk
1861b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1862b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1863b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1864b37c7e5eSwdenk
1865c609719bSwdenk		I2C_SCL(bit)
1866c609719bSwdenk
1867c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1868c609719bSwdenk		is FALSE, it clears it (low).
1869c609719bSwdenk
1870b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1871b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1872b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1873b37c7e5eSwdenk
1874c609719bSwdenk		I2C_DELAY
1875c609719bSwdenk
1876c609719bSwdenk		This delay is invoked four times per clock cycle so this
1877c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1878b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1879b37c7e5eSwdenk		like:
1880b37c7e5eSwdenk
1881b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1882c609719bSwdenk
1883793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1884793b5726SMike Frysinger
1885793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1886793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1887793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1888793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1889793b5726SMike Frysinger
1890793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1891793b5726SMike Frysinger		the generic GPIO functions.
1892793b5726SMike Frysinger
18936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
189447cd00faSwdenk
189547cd00faSwdenk		When a board is reset during an i2c bus transfer
189647cd00faSwdenk		chips might think that the current transfer is still
189747cd00faSwdenk		in progress. On some boards it is possible to access
189847cd00faSwdenk		the i2c SCLK line directly, either by using the
189947cd00faSwdenk		processor pin as a GPIO or by having a second pin
190047cd00faSwdenk		connected to the bus. If this option is defined a
190147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
190247cd00faSwdenk		is run early in the boot sequence.
190347cd00faSwdenk
190426a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
190526a33504SRichard Retanubun
190626a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
190726a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
190826a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
190926a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
191026a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
191126a33504SRichard Retanubun		controller provide such a method. It is called at the end of
191226a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
191326a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
191426a33504SRichard Retanubun
191517ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
191617ea1177Swdenk
191717ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
191817ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
191917ea1177Swdenk		variable "i2cfast". (see also i2cfast)
192017ea1177Swdenk
1921bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1922bb99ad6dSBen Warren
1923bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1924bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1925bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1926bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1927bb99ad6dSBen Warren
19286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1929bb99ad6dSBen Warren
1930bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
19310f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
19320f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
19330f89c54bSPeter Tyser		a 1D array of device addresses
1934bb99ad6dSBen Warren
1935bb99ad6dSBen Warren		e.g.
1936bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
19376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1938bb99ad6dSBen Warren
1939bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1940bb99ad6dSBen Warren
1941bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
19426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1943bb99ad6dSBen Warren
1944bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1945bb99ad6dSBen Warren
19466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1947be5e6181STimur Tabi
1948be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1949be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1950be5e6181STimur Tabi
19516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
19520dc018ecSStefan Roese
19530dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
19540dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
19550dc018ecSStefan Roese
19566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
19570dc018ecSStefan Roese
19580dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
19590dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
19600dc018ecSStefan Roese
19616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19629ebbb54fSVictor Gallardo
19639ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19649ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19659ebbb54fSVictor Gallardo		specified DTT device.
19669ebbb54fSVictor Gallardo
1967be5e6181STimur Tabi		CONFIG_FSL_I2C
1968be5e6181STimur Tabi
1969be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
19707817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1971be5e6181STimur Tabi
197267b23a32SHeiko Schocher		CONFIG_I2C_MUX
197367b23a32SHeiko Schocher
197467b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
197567b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
197667b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
197767b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
197867b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
197967b23a32SHeiko Schocher		the muxes to activate this new "bus".
198067b23a32SHeiko Schocher
198167b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
198267b23a32SHeiko Schocher		feature!
198367b23a32SHeiko Schocher
198467b23a32SHeiko Schocher		Example:
198567b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
198667b23a32SHeiko Schocher			The First mux with address 70 and channel 6
198767b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
198867b23a32SHeiko Schocher
198967b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
199067b23a32SHeiko Schocher
199167b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
199267b23a32SHeiko Schocher		of I2C Busses with muxes:
199367b23a32SHeiko Schocher
199467b23a32SHeiko Schocher		=> i2c bus
199567b23a32SHeiko Schocher		Busses reached over muxes:
199667b23a32SHeiko Schocher		Bus ID: 2
199767b23a32SHeiko Schocher		  reached over Mux(es):
199867b23a32SHeiko Schocher		    pca9544a@70 ch: 4
199967b23a32SHeiko Schocher		Bus ID: 3
200067b23a32SHeiko Schocher		  reached over Mux(es):
200167b23a32SHeiko Schocher		    pca9544a@70 ch: 6
200267b23a32SHeiko Schocher		    pca9544a@71 ch: 4
200367b23a32SHeiko Schocher		=>
200467b23a32SHeiko Schocher
200567b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2006f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2007f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
200867b23a32SHeiko Schocher		the channel 4.
200967b23a32SHeiko Schocher
201067b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2011f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
201267b23a32SHeiko Schocher		the 2 muxes.
201367b23a32SHeiko Schocher
201467b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
201567b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
201667b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
201767b23a32SHeiko Schocher		to add this option to other architectures.
201867b23a32SHeiko Schocher
20192ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20202ac6985aSAndrew Dyer
20212ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20222ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20232ac6985aSAndrew Dyer		between writing the address pointer and reading the
20242ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20252ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20262ac6985aSAndrew Dyer		devices can use either method, but some require one or
20272ac6985aSAndrew Dyer		the other.
2028be5e6181STimur Tabi
2029c609719bSwdenk- SPI Support:	CONFIG_SPI
2030c609719bSwdenk
2031c609719bSwdenk		Enables SPI driver (so far only tested with
2032c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2033c609719bSwdenk		D/As on the SACSng board)
2034c609719bSwdenk
20356639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20366639562eSYoshihiro Shimoda
20376639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20386639562eSYoshihiro Shimoda		only SH7757 is supported.
20396639562eSYoshihiro Shimoda
2040c609719bSwdenk		CONFIG_SPI_X
2041c609719bSwdenk
2042c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2043c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2044c609719bSwdenk
2045c609719bSwdenk		CONFIG_SOFT_SPI
2046c609719bSwdenk
2047c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2048c609719bSwdenk		using hardware support. This is a general purpose
2049c609719bSwdenk		driver that only requires three general I/O port pins
2050c609719bSwdenk		(two outputs, one input) to function. If this is
2051c609719bSwdenk		defined, the board configuration must define several
2052c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2053c609719bSwdenk		an example, see include/configs/sacsng.h.
2054c609719bSwdenk
205504a9e118SBen Warren		CONFIG_HARD_SPI
205604a9e118SBen Warren
205704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
205804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
205904a9e118SBen Warren		must define a list of chip-select function pointers.
206004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
206104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
206204a9e118SBen Warren
206338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
206438254f45SGuennadi Liakhovetski
206538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20662e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
206738254f45SGuennadi Liakhovetski
20680133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20690133502eSMatthias Fuchs
20700133502eSMatthias Fuchs		Enables FPGA subsystem.
20710133502eSMatthias Fuchs
20720133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20730133502eSMatthias Fuchs
20740133502eSMatthias Fuchs		Enables support for specific chip vendors.
20750133502eSMatthias Fuchs		(ALTERA, XILINX)
20760133502eSMatthias Fuchs
20770133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20780133502eSMatthias Fuchs
20790133502eSMatthias Fuchs		Enables support for FPGA family.
20800133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20810133502eSMatthias Fuchs
20820133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2083c609719bSwdenk
2084c609719bSwdenk		Specify the number of FPGA devices to support.
2085c609719bSwdenk
20866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2087c609719bSwdenk
2088c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2089c609719bSwdenk
20906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2091c609719bSwdenk
2092c609719bSwdenk		Enable checks on FPGA configuration interface busy
2093c609719bSwdenk		status by the configuration function. This option
2094c609719bSwdenk		will require a board or device specific function to
2095c609719bSwdenk		be written.
2096c609719bSwdenk
2097c609719bSwdenk		CONFIG_FPGA_DELAY
2098c609719bSwdenk
2099c609719bSwdenk		If defined, a function that provides delays in the FPGA
2100c609719bSwdenk		configuration driver.
2101c609719bSwdenk
21026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2103c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2104c609719bSwdenk
21056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2106c609719bSwdenk
2107c609719bSwdenk		Check for configuration errors during FPGA bitfile
2108c609719bSwdenk		loading. For example, abort during Virtex II
2109c609719bSwdenk		configuration if the INIT_B line goes low (which
2110c609719bSwdenk		indicated a CRC error).
2111c609719bSwdenk
21126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2113c609719bSwdenk
2114c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2115c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2116c609719bSwdenk		FPGA configuration sequence. The default time is 500
211711ccc33fSMarcel Ziswiler		ms.
2118c609719bSwdenk
21196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2120c609719bSwdenk
2121c609719bSwdenk		Maximum time to wait for BUSY to deassert during
212211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2123c609719bSwdenk
21246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2125c609719bSwdenk
2126c609719bSwdenk		Time to wait after FPGA configuration. The default is
212711ccc33fSMarcel Ziswiler		200 ms.
2128c609719bSwdenk
2129c609719bSwdenk- Configuration Management:
2130c609719bSwdenk		CONFIG_IDENT_STRING
2131c609719bSwdenk
2132c609719bSwdenk		If defined, this string will be added to the U-Boot
2133c609719bSwdenk		version information (U_BOOT_VERSION)
2134c609719bSwdenk
2135c609719bSwdenk- Vendor Parameter Protection:
2136c609719bSwdenk
2137c609719bSwdenk		U-Boot considers the values of the environment
2138c609719bSwdenk		variables "serial#" (Board Serial Number) and
21397152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2140c609719bSwdenk		are set once by the board vendor / manufacturer, and
2141c609719bSwdenk		protects these variables from casual modification by
2142c609719bSwdenk		the user. Once set, these variables are read-only,
2143c609719bSwdenk		and write or delete attempts are rejected. You can
214411ccc33fSMarcel Ziswiler		change this behaviour:
2145c609719bSwdenk
2146c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2147c609719bSwdenk		file, the write protection for vendor parameters is
214847cd00faSwdenk		completely disabled. Anybody can change or delete
2149c609719bSwdenk		these parameters.
2150c609719bSwdenk
2151c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2152c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
215311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2154c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2155c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2156c609719bSwdenk		read-only.]
2157c609719bSwdenk
2158c609719bSwdenk- Protected RAM:
2159c609719bSwdenk		CONFIG_PRAM
2160c609719bSwdenk
2161c609719bSwdenk		Define this variable to enable the reservation of
2162c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2163c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2164c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2165c609719bSwdenk		this default value by defining an environment
2166c609719bSwdenk		variable "pram" to the number of kB you want to
2167c609719bSwdenk		reserve. Note that the board info structure will
2168c609719bSwdenk		still show the full amount of RAM. If pRAM is
2169c609719bSwdenk		reserved, a new environment variable "mem" will
2170c609719bSwdenk		automatically be defined to hold the amount of
2171c609719bSwdenk		remaining RAM in a form that can be passed as boot
2172c609719bSwdenk		argument to Linux, for instance like that:
2173c609719bSwdenk
2174fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2175c609719bSwdenk			saveenv
2176c609719bSwdenk
2177c609719bSwdenk		This way you can tell Linux not to use this memory,
2178c609719bSwdenk		either, which results in a memory region that will
2179c609719bSwdenk		not be affected by reboots.
2180c609719bSwdenk
2181c609719bSwdenk		*WARNING* If your board configuration uses automatic
2182c609719bSwdenk		detection of the RAM size, you must make sure that
2183c609719bSwdenk		this memory test is non-destructive. So far, the
2184c609719bSwdenk		following board configurations are known to be
2185c609719bSwdenk		"pRAM-clean":
2186c609719bSwdenk
21871b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
21881b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2189544d97e9SWolfgang Denk			FLAGADM, TQM8260
2190c609719bSwdenk
2191c609719bSwdenk- Error Recovery:
2192c609719bSwdenk		CONFIG_PANIC_HANG
2193c609719bSwdenk
2194c609719bSwdenk		Define this variable to stop the system in case of a
2195c609719bSwdenk		fatal error, so that you have to reset it manually.
2196c609719bSwdenk		This is probably NOT a good idea for an embedded
219711ccc33fSMarcel Ziswiler		system where you want the system to reboot
2198c609719bSwdenk		automatically as fast as possible, but it may be
2199c609719bSwdenk		useful during development since you can try to debug
2200c609719bSwdenk		the conditions that lead to the situation.
2201c609719bSwdenk
2202c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2203c609719bSwdenk
2204c609719bSwdenk		This variable defines the number of retries for
2205c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2206c609719bSwdenk		before giving up the operation. If not defined, a
2207c609719bSwdenk		default value of 5 is used.
2208c609719bSwdenk
220940cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
221040cb90eeSGuennadi Liakhovetski
221140cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
221240cb90eeSGuennadi Liakhovetski
221348a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
221448a3e999STetsuyuki Kobayashi
221548a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
221648a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
221748a3e999STetsuyuki Kobayashi		try longer timeout such as
221848a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
221948a3e999STetsuyuki Kobayashi
2220c609719bSwdenk- Command Interpreter:
22218078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
222204a85b3bSwdenk
222304a85b3bSwdenk		Enable auto completion of commands using TAB.
222404a85b3bSwdenk
22258078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
22268078f1a5SWolfgang Denk		for the "hush" shell.
22278078f1a5SWolfgang Denk
22288078f1a5SWolfgang Denk
22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2230c609719bSwdenk
2231c609719bSwdenk		Define this variable to enable the "hush" shell (from
2232c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2233c609719bSwdenk		powerful command line syntax like
2234c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2235c609719bSwdenk		constructs ("shell scripts").
2236c609719bSwdenk
2237c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2238c609719bSwdenk		with a somewhat smaller memory footprint.
2239c609719bSwdenk
2240c609719bSwdenk
22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2242c609719bSwdenk
2243c609719bSwdenk		This defines the secondary prompt string, which is
2244c609719bSwdenk		printed when the command interpreter needs more input
2245c609719bSwdenk		to complete a command. Usually "> ".
2246c609719bSwdenk
2247c609719bSwdenk	Note:
2248c609719bSwdenk
2249c609719bSwdenk		In the current implementation, the local variables
2250c609719bSwdenk		space and global environment variables space are
2251c609719bSwdenk		separated. Local variables are those you define by
22523b57fe0aSwdenk		simply typing `name=value'. To access a local
2253c609719bSwdenk		variable later on, you have write `$name' or
22543b57fe0aSwdenk		`${name}'; to execute the contents of a variable
22553b57fe0aSwdenk		directly type `$name' at the command prompt.
2256c609719bSwdenk
2257c609719bSwdenk		Global environment variables are those you use
2258c609719bSwdenk		setenv/printenv to work with. To run a command stored
2259c609719bSwdenk		in such a variable, you need to use the run command,
2260c609719bSwdenk		and you must not use the '$' sign to access them.
2261c609719bSwdenk
2262c609719bSwdenk		To store commands and special characters in a
2263c609719bSwdenk		variable, please use double quotation marks
2264c609719bSwdenk		surrounding the whole text of the variable, instead
2265c609719bSwdenk		of the backslashes before semicolons and special
2266c609719bSwdenk		symbols.
2267c609719bSwdenk
2268aa0c71acSWolfgang Denk- Commandline Editing and History:
2269aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2270aa0c71acSWolfgang Denk
227111ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2272aa0c71acSWolfgang Denk		commandline input operations
2273aa0c71acSWolfgang Denk
2274a8c7c708Swdenk- Default Environment:
2275c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2276c609719bSwdenk
2277c609719bSwdenk		Define this to contain any number of null terminated
2278c609719bSwdenk		strings (variable = value pairs) that will be part of
22797152b1d0Swdenk		the default environment compiled into the boot image.
22802262cfeeSwdenk
2281c609719bSwdenk		For example, place something like this in your
2282c609719bSwdenk		board's config file:
2283c609719bSwdenk
2284c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2285c609719bSwdenk			"myvar1=value1\0" \
2286c609719bSwdenk			"myvar2=value2\0"
2287c609719bSwdenk
2288c609719bSwdenk		Warning: This method is based on knowledge about the
2289c609719bSwdenk		internal format how the environment is stored by the
22902262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2291c609719bSwdenk		interface! Although it is unlikely that this format
22927152b1d0Swdenk		will change soon, there is no guarantee either.
2293c609719bSwdenk		You better know what you are doing here.
2294c609719bSwdenk
2295c609719bSwdenk		Note: overly (ab)use of the default environment is
2296c609719bSwdenk		discouraged. Make sure to check other ways to preset
229774de7aefSWolfgang Denk		the environment like the "source" command or the
2298c609719bSwdenk		boot command first.
2299c609719bSwdenk
23005e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
23015e724ca2SStephen Warren
23025e724ca2SStephen Warren		Define this in order to add variables describing the
23035e724ca2SStephen Warren		U-Boot build configuration to the default environment.
23045e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
23055e724ca2SStephen Warren
23065e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
23075e724ca2SStephen Warren
23085e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23095e724ca2SStephen Warren		- CONFIG_SYS_CPU
23105e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23115e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23125e724ca2SStephen Warren		- CONFIG_SYS_SOC
23135e724ca2SStephen Warren
2314a8c7c708Swdenk- DataFlash Support:
23152abbe075Swdenk		CONFIG_HAS_DATAFLASH
23162abbe075Swdenk
23172abbe075Swdenk		Defining this option enables DataFlash features and
23182abbe075Swdenk		allows to read/write in Dataflash via the standard
23192abbe075Swdenk		commands cp, md...
23202abbe075Swdenk
2321f61ec45eSEric Nelson- Serial Flash support
2322f61ec45eSEric Nelson		CONFIG_CMD_SF
2323f61ec45eSEric Nelson
2324f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2325f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2326f61ec45eSEric Nelson
2327f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2328f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2329f61ec45eSEric Nelson		commands.
2330f61ec45eSEric Nelson
2331f61ec45eSEric Nelson		The following defaults may be provided by the platform
2332f61ec45eSEric Nelson		to handle the common case when only a single serial
2333f61ec45eSEric Nelson		flash is present on the system.
2334f61ec45eSEric Nelson
2335f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2336f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2337f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2338f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2339f61ec45eSEric Nelson
23403f85ce27Swdenk- SystemACE Support:
23413f85ce27Swdenk		CONFIG_SYSTEMACE
23423f85ce27Swdenk
23433f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
23443f85ce27Swdenk		chips attached via some sort of local bus. The address
234511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
23466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
23473f85ce27Swdenk
23483f85ce27Swdenk		#define CONFIG_SYSTEMACE
23496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
23503f85ce27Swdenk
23513f85ce27Swdenk		When SystemACE support is added, the "ace" device type
23523f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
23533f85ce27Swdenk
2354ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2355ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2356ecb0ccd9SWolfgang Denk
235728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2358ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
235928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2360ecb0ccd9SWolfgang Denk		number generator is used.
2361ecb0ccd9SWolfgang Denk
236228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
236328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
236428cb9375SWolfgang Denk		defined, the normal port 69 is used.
236528cb9375SWolfgang Denk
236628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2367ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2368ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2369ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2370ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2371ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2372ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2373ecb0ccd9SWolfgang Denk
2374a8c7c708Swdenk- Show boot progress:
2375c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2376c609719bSwdenk
2377c609719bSwdenk		Defining this option allows to add some board-
2378c609719bSwdenk		specific code (calling a user-provided function
2379c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2380c609719bSwdenk		the system's boot progress on some display (for
2381c609719bSwdenk		example, some LED's) on your board. At the moment,
2382c609719bSwdenk		the following checkpoints are implemented:
2383c609719bSwdenk
23843a608ca0SSimon Glass- Detailed boot stage timing
23853a608ca0SSimon Glass		CONFIG_BOOTSTAGE
23863a608ca0SSimon Glass		Define this option to get detailed timing of each stage
23873a608ca0SSimon Glass		of the boot process.
23883a608ca0SSimon Glass
23893a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
23903a608ca0SSimon Glass		This is the number of available user bootstage records.
23913a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
23923a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
23933a608ca0SSimon Glass		the limit, recording will stop.
23943a608ca0SSimon Glass
23953a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
23963a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
23973a608ca0SSimon Glass
23983a608ca0SSimon Glass		Timer summary in microseconds:
23993a608ca0SSimon Glass		       Mark    Elapsed  Stage
24003a608ca0SSimon Glass			  0          0  reset
24013a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
24023a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
24033a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
24043a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
24053a608ca0SSimon Glass		  3,910,375    250,777  main_loop
24063a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
24073a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
24083a608ca0SSimon Glass
24092eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
24102eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
24112eba38cfSSimon Glass		and un/stashing of bootstage data.
24122eba38cfSSimon Glass
241394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
241494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
241594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
241694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
241794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
241894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
241994fd1316SSimon Glass		For example:
242094fd1316SSimon Glass
242194fd1316SSimon Glass		bootstage {
242294fd1316SSimon Glass			154 {
242394fd1316SSimon Glass				name = "board_init_f";
242494fd1316SSimon Glass				mark = <3575678>;
242594fd1316SSimon Glass			};
242694fd1316SSimon Glass			170 {
242794fd1316SSimon Glass				name = "lcd";
242894fd1316SSimon Glass				accum = <33482>;
242994fd1316SSimon Glass			};
243094fd1316SSimon Glass		};
243194fd1316SSimon Glass
243294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
243394fd1316SSimon Glass
24341372cce2SMarian BalakowiczLegacy uImage format:
24351372cce2SMarian Balakowicz
2436c609719bSwdenk  Arg	Where			When
2437c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2438c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2439c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2440c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2441c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2442c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2443c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2444c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2445c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
24461372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2447c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2448c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2449c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2450c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
24511372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2452c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
24531372cce2SMarian Balakowicz
24541372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
24551372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
24561372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
24571372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
24581372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
24591372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
24601372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
246111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
24621372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
24631372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
24641372cce2SMarian Balakowicz
2465ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2466c609719bSwdenk
2467a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
246863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
246963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
247063e73c9aSwdenk
2471566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2472566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2473566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2474566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2475566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2476566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2477566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2478566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2479566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2480566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2481566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2482566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2483566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2484566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2485566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2486566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2487566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2488566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2489566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2490566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2491566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2492566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2493566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2494566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2495566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2496566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2497566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2498566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2499566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2500566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2501566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2502566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2503566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2504566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2505566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2506566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2507566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2508566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2509566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2510566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2511566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2512566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2513566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2514566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2515566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2516566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2517566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2518c609719bSwdenk
2519566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2520c609719bSwdenk
2521566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2522566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2523566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2524206c60cbSwdenk
2525566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2526566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
252711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2528566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2529566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2530566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
253174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
253274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2533566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2534c609719bSwdenk
25351372cce2SMarian BalakowiczFIT uImage format:
25361372cce2SMarian Balakowicz
25371372cce2SMarian Balakowicz  Arg	Where			When
25381372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
25391372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
25401372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
25411372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
25421372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
25431372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2544f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
25451372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
25461372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
25471372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
25481372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
25491372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
255011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
255111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
25521372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
25531372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
25541372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
25551372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
25561372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
25571372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
25581372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
25591372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
25601372cce2SMarian Balakowicz
25611372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
25621372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
25631372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
256411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
25651372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
25661372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
25671372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
25681372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
25691372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
25701372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
25711372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
25721372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
25731372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
25741372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
25751372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
25761372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
25771372cce2SMarian Balakowicz
257811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
25791372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
25801372cce2SMarian Balakowicz
258111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
25821372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
25831372cce2SMarian Balakowicz
258411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
25851372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
25861372cce2SMarian Balakowicz
25874cf2609bSWolfgang Denk- Standalone program support:
25884cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
25894cf2609bSWolfgang Denk
25906feff899SWolfgang Denk		This option defines a board specific value for the
25916feff899SWolfgang Denk		address where standalone program gets loaded, thus
25926feff899SWolfgang Denk		overwriting the architecture dependent default
25934cf2609bSWolfgang Denk		settings.
25944cf2609bSWolfgang Denk
25954cf2609bSWolfgang Denk- Frame Buffer Address:
25964cf2609bSWolfgang Denk		CONFIG_FB_ADDR
25974cf2609bSWolfgang Denk
25984cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
25994cf2609bSWolfgang Denk		address for frame buffer.
26004cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
26014cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
26026feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
26034cf2609bSWolfgang Denk
26044cf2609bSWolfgang Denk		Please see board_init_f function.
26054cf2609bSWolfgang Denk
2606cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2607cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2608cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2609cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2610cccfc2abSDetlev Zundel
2611cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2612cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2613cccfc2abSDetlev Zundel
2614cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2615cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2616cccfc2abSDetlev Zundel
2617cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2618cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2619cccfc2abSDetlev Zundel
2620cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2621cccfc2abSDetlev Zundel
2622cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2623cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2624cccfc2abSDetlev Zundel
26256a11cf48SDaniel Schwierzeck- SPL framework
26266a11cf48SDaniel Schwierzeck		CONFIG_SPL
26276a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
26286a11cf48SDaniel Schwierzeck
262995579793STom Rini		CONFIG_SPL_LDSCRIPT
263095579793STom Rini		LDSCRIPT for linking the SPL binary.
263195579793STom Rini
263295579793STom Rini		CONFIG_SPL_MAX_SIZE
263395579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
263495579793STom Rini
26356a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
26366a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
26376a11cf48SDaniel Schwierzeck
263895579793STom Rini		CONFIG_SPL_BSS_START_ADDR
263995579793STom Rini		Link address for the BSS within the SPL binary.
264095579793STom Rini
264195579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
264295579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
264395579793STom Rini
264495579793STom Rini		CONFIG_SPL_STACK
264595579793STom Rini		Adress of the start of the stack SPL will use
264695579793STom Rini
264795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
264895579793STom Rini		Starting address of the malloc pool used in SPL.
264995579793STom Rini
265095579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
265195579793STom Rini		The size of the malloc pool used in SPL.
26526a11cf48SDaniel Schwierzeck
265347f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
265447f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
265547f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
265647f7bcaeSTom Rini		NAND loading of the Linux Kernel.
265747f7bcaeSTom Rini
2658861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2659861a86f4STom Rini		For ARM, enable an optional function to print more information
2660861a86f4STom Rini		about the running system.
2661861a86f4STom Rini
26626a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
26636a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
26646a11cf48SDaniel Schwierzeck
26656a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
26666a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
26676a11cf48SDaniel Schwierzeck
26686a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
26696a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
26706a11cf48SDaniel Schwierzeck
26716a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
26726a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
26736a11cf48SDaniel Schwierzeck
26746a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
26756a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
26766a11cf48SDaniel Schwierzeck
267795579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
267895579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
267995579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
268095579793STom Rini		Address, size and partition on the MMC to load U-Boot from
268195579793STom Rini		when the MMC is being used in raw mode.
268295579793STom Rini
268395579793STom Rini		CONFIG_SPL_FAT_SUPPORT
268495579793STom Rini		Support for fs/fat/libfat.o in SPL binary
268595579793STom Rini
268695579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
268795579793STom Rini		Filename to read to load U-Boot when reading from FAT
268895579793STom Rini
268995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
269095579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
269195579793STom Rini
269295579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
269395579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
269495579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
269595579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
269695579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
269795579793STom Rini		Defines the size and behavior of the NAND that SPL uses
269895579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
269995579793STom Rini
270095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
270195579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
270295579793STom Rini		from.
270395579793STom Rini
270495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
270595579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
270695579793STom Rini		to.
270795579793STom Rini
270895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
270995579793STom Rini		Define this if you need to first read the OOB and then the
271095579793STom Rini		data. This is used for example on davinci plattforms.
271195579793STom Rini
271295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
271395579793STom Rini		Support for an OMAP3-specific set of functions to return the
271495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
271595579793STom Rini
27166a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
27176a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
27186a11cf48SDaniel Schwierzeck
27196a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
27206a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
27216a11cf48SDaniel Schwierzeck
27226a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
27236a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
27246a11cf48SDaniel Schwierzeck
2725c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2726c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2727c57b953dSPavel Machek
27286a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
27296a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
27301372cce2SMarian Balakowicz
2731c609719bSwdenkModem Support:
2732c609719bSwdenk--------------
2733c609719bSwdenk
2734566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2735c609719bSwdenk
273611ccc33fSMarcel Ziswiler- Modem support enable:
2737c609719bSwdenk		CONFIG_MODEM_SUPPORT
2738c609719bSwdenk
2739c609719bSwdenk- RTS/CTS Flow control enable:
2740c609719bSwdenk		CONFIG_HWFLOW
2741c609719bSwdenk
2742c609719bSwdenk- Modem debug support:
2743c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2744c609719bSwdenk
2745c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2746c609719bSwdenk		for modem support. Useful only with BDI2000.
2747c609719bSwdenk
2748a8c7c708Swdenk- Interrupt support (PPC):
2749a8c7c708Swdenk
2750a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2751a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
275211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2753a8c7c708Swdenk		should set decrementer_count to appropriate value. If
275411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2755a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
275611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2757a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2758a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2759a8c7c708Swdenk		general timer_interrupt().
2760a8c7c708Swdenk
2761c609719bSwdenk- General:
2762c609719bSwdenk
2763c609719bSwdenk		In the target system modem support is enabled when a
2764c609719bSwdenk		specific key (key combination) is pressed during
2765c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
276611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2767c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2768c609719bSwdenk		function, returning 1 and thus enabling modem
2769c609719bSwdenk		initialization.
2770c609719bSwdenk
2771c609719bSwdenk		If there are no modem init strings in the
2772c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2773c609719bSwdenk		previous output (banner, info printfs) will be
277411ccc33fSMarcel Ziswiler		suppressed, though.
2775c609719bSwdenk
2776c609719bSwdenk		See also: doc/README.Modem
2777c609719bSwdenk
27789660e442SHelmut RaigerBoard initialization settings:
27799660e442SHelmut Raiger------------------------------
27809660e442SHelmut Raiger
27819660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
27829660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
27839660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
27849660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
27859660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
27869660e442SHelmut Raigertypically in board_init_f() and board_init_r().
27879660e442SHelmut Raiger
27889660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
27899660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
27909660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
27919660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2792c609719bSwdenk
2793c609719bSwdenkConfiguration Settings:
2794c609719bSwdenk-----------------------
2795c609719bSwdenk
27966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2797c609719bSwdenk		undefine this when you're short of memory.
2798c609719bSwdenk
27992fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
28002fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
28012fb2604dSPeter Tyser
28026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2803c609719bSwdenk		prompt for user input.
2804c609719bSwdenk
28056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2806c609719bSwdenk
28076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2808c609719bSwdenk
28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2810c609719bSwdenk
28116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2812c609719bSwdenk		the application (usually a Linux kernel) when it is
2813c609719bSwdenk		booted
2814c609719bSwdenk
28156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2816c609719bSwdenk		List of legal baudrate settings for this board.
2817c609719bSwdenk
28186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2819c609719bSwdenk		Suppress display of console information at boot.
2820c609719bSwdenk
28216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2822c609719bSwdenk		If the board specific function
2823c609719bSwdenk			extern int overwrite_console (void);
2824c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2825c609719bSwdenk		serial port, else the settings in the environment are used.
2826c609719bSwdenk
28276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2828c609719bSwdenk		Enable the call to overwrite_console().
2829c609719bSwdenk
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2831c609719bSwdenk		Enable overwrite of previous console environment settings.
2832c609719bSwdenk
28336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2834c609719bSwdenk		Begin and End addresses of the area used by the
2835c609719bSwdenk		simple memory test.
2836c609719bSwdenk
28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2838c609719bSwdenk		Enable an alternate, more extensive memory test.
2839c609719bSwdenk
28406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
28415f535fe1Swdenk		Scratch address used by the alternate memory test
28425f535fe1Swdenk		You only need to set this if address zero isn't writeable
28435f535fe1Swdenk
28446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
28456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
284614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
284711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
284814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
284914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
285014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
28515e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
285214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
28535e12e75dSStefan Roese		will have to get fixed in Linux additionally.
285414f73ca6SStefan Roese
285514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
285614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
285714f73ca6SStefan Roese		be touched.
285814f73ca6SStefan Roese
285914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
286014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
286114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
286214f73ca6SStefan Roese		non page size aligned address and this could cause major
286314f73ca6SStefan Roese		problems.
286414f73ca6SStefan Roese
28656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2866c609719bSwdenk		Default load address for network file downloads
2867c609719bSwdenk
28686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2869c609719bSwdenk		Enable temporary baudrate change while serial download
2870c609719bSwdenk
28716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2872c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2873c609719bSwdenk
28746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2875c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2876c609719bSwdenk		Cogent motherboard)
2877c609719bSwdenk
28786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2879c609719bSwdenk		Physical start address of Flash memory.
2880c609719bSwdenk
28816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2882c609719bSwdenk		Physical start address of boot monitor code (set by
2883c609719bSwdenk		make config files to be same as the text base address
288414d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
28856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2886c609719bSwdenk
28876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
28883b57fe0aSwdenk		Size of memory reserved for monitor code, used to
28893b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
28903b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
28913b57fe0aSwdenk		flash sector.
2892c609719bSwdenk
28936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2894c609719bSwdenk		Size of DRAM reserved for malloc() use.
2895c609719bSwdenk
28966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
289715940c9aSStefan Roese		Normally compressed uImages are limited to an
289815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
28996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
290015940c9aSStefan Roese		to adjust this setting to your needs.
2901c609719bSwdenk
29026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2903c609719bSwdenk		Maximum size of memory mapped by the startup code of
2904c609719bSwdenk		the Linux kernel; all data that must be processed by
29057d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
29067d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
29077d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
29087d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2909c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2910c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2911c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2912c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2913c609719bSwdenk
2914fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2915fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2916fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2917fca43cc8SJohn Rigby		is enabled.
2918fca43cc8SJohn Rigby
2919fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2920fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2921fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2922fca43cc8SJohn Rigby
2923fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2924fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2925fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2926fca43cc8SJohn Rigby
29276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2928c609719bSwdenk		Max number of Flash memory banks
2929c609719bSwdenk
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2931c609719bSwdenk		Max number of sectors on a Flash chip
2932c609719bSwdenk
29336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2934c609719bSwdenk		Timeout for Flash erase operations (in ms)
2935c609719bSwdenk
29366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2937c609719bSwdenk		Timeout for Flash write operations (in ms)
2938c609719bSwdenk
29396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
29408564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
29418564acf9Swdenk
29426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
29438564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
29448564acf9Swdenk
29456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
29468564acf9Swdenk		If defined, hardware flash sectors protection is used
29478564acf9Swdenk		instead of U-Boot software protection.
29488564acf9Swdenk
29496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2950c609719bSwdenk
2951c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2952c609719bSwdenk		without this option such a download has to be
2953c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2954c609719bSwdenk		copy from RAM to flash.
2955c609719bSwdenk
2956c609719bSwdenk		The two-step approach is usually more reliable, since
2957c609719bSwdenk		you can check if the download worked before you erase
295811ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
295911ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2960c609719bSwdenk		downloaded image) this option may be very useful.
2961c609719bSwdenk
29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2963c609719bSwdenk		Define if the flash driver uses extra elements in the
29645653fc33Swdenk		common flash structure for storing flash geometry.
29655653fc33Swdenk
296600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
29675653fc33Swdenk		This option also enables the building of the cfi_flash driver
29685653fc33Swdenk		in the drivers directory
296953cf9435Sstroese
297091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
297191809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
297291809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
297391809ed5SPiotr Ziecik		to the MTD layer.
297491809ed5SPiotr Ziecik
29756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
297696ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
297796ef831fSGuennadi Liakhovetski
297896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
297996ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
298096ef831fSGuennadi Liakhovetski		write commands.
298196ef831fSGuennadi Liakhovetski
29826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
29835568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
29845568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
29855568e613SStefan Roese		is useful, if some of the configured banks are only
29865568e613SStefan Roese		optionally available.
29875568e613SStefan Roese
29889a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
29899a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
29909a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
29919a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
29929a042e9cSJerry Van Baren
29936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
299411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
299511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
299653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
299753cf9435Sstroese		buffers can be full shortly after enabling the interface
299811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
299953cf9435Sstroese		Defaults to 4 if not defined.
3000c609719bSwdenk
3001ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3002ea882bafSWolfgang Denk
3003ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3004ea882bafSWolfgang Denk	internally to store the environment settings. The default
3005ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3006ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3007ea882bafSWolfgang Denk	lib/hashtable.c for details.
3008ea882bafSWolfgang Denk
3009c609719bSwdenkThe following definitions that deal with the placement and management
3010c609719bSwdenkof environment data (variable area); in general, we support the
3011c609719bSwdenkfollowing configurations:
3012c609719bSwdenk
3013c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3014c3eb3fe4SMike Frysinger
3015c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3016c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3017c3eb3fe4SMike Frysinger
30185a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3019c609719bSwdenk
3020c609719bSwdenk	Define this if the environment is in flash memory.
3021c609719bSwdenk
3022c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3023c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3024c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3025c609719bSwdenk	   sector" type flash chips, which have several smaller
3026c609719bSwdenk	   sectors at the start or the end. For instance, such a
3027c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3028c609719bSwdenk	   such a case you would place the environment in one of the
3029c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3030c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3031c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3032c609719bSwdenk	   between U-Boot and the environment.
3033c609719bSwdenk
30340e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3035c609719bSwdenk
3036c609719bSwdenk	   Offset of environment data (variable area) to the
3037c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3038c609719bSwdenk	   type flash chips the second sector can be used: the offset
3039c609719bSwdenk	   for this sector is given here.
3040c609719bSwdenk
30416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3042c609719bSwdenk
30430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3044c609719bSwdenk
3045c609719bSwdenk	   This is just another way to specify the start address of
3046c609719bSwdenk	   the flash sector containing the environment (instead of
30470e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3048c609719bSwdenk
30490e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3050c609719bSwdenk
3051c609719bSwdenk	   Size of the sector containing the environment.
3052c609719bSwdenk
3053c609719bSwdenk
3054c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3055c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3056c609719bSwdenk	   the environment.
3057c609719bSwdenk
30580e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3059c609719bSwdenk
30605a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
30610e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3062c609719bSwdenk	   of this flash sector for the environment. This saves
3063c609719bSwdenk	   memory for the RAM copy of the environment.
3064c609719bSwdenk
3065c609719bSwdenk	   It may also save flash memory if you decide to use this
3066c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3067c609719bSwdenk	   since then the remainder of the flash sector could be used
3068c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3069c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3070c609719bSwdenk	   updating the environment in flash makes it always
3071c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3072c609719bSwdenk	   wrong before the contents has been restored from a copy in
3073c609719bSwdenk	   RAM, your target system will be dead.
3074c609719bSwdenk
30750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
30760e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3077c609719bSwdenk
3078c609719bSwdenk	   These settings describe a second storage area used to hold
307911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
30803e38691eSwdenk	   a valid backup copy in case there is a power failure during
3081c609719bSwdenk	   a "saveenv" operation.
3082c609719bSwdenk
3083c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3084c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3085c609719bSwdenkaccordingly!
3086c609719bSwdenk
3087c609719bSwdenk
30889314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3089c609719bSwdenk
3090c609719bSwdenk	Define this if you have some non-volatile memory device
3091c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3092c609719bSwdenk	environment.
3093c609719bSwdenk
30940e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30950e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3096c609719bSwdenk
309711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3098c609719bSwdenk	  want to use for environment. It is assumed that this memory
3099c609719bSwdenk	  can just be read and written to, without any special
3100c609719bSwdenk	  provision.
3101c609719bSwdenk
3102c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3103c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
310411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3105c609719bSwdenkU-Boot will hang.
3106c609719bSwdenk
3107c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3108c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3109c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3110c609719bSwdenkto save the current settings.
3111c609719bSwdenk
3112c609719bSwdenk
3113bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3114c609719bSwdenk
3115c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3116c609719bSwdenk	device and a driver for it.
3117c609719bSwdenk
31180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31190e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3120c609719bSwdenk
3121c609719bSwdenk	  These two #defines specify the offset and size of the
3122c609719bSwdenk	  environment area within the total memory of your EEPROM.
3123c609719bSwdenk
31246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3125c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3126c609719bSwdenk	  The default address is zero.
3127c609719bSwdenk
31286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3129c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3130c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3131c609719bSwdenk	  would require six bits.
3132c609719bSwdenk
31336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3134c609719bSwdenk	  If defined, the number of milliseconds to delay between
3135c609719bSwdenk	  page writes.	The default is zero milliseconds.
3136c609719bSwdenk
31376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3138c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3139c609719bSwdenk	  that this is NOT the chip address length!
3140c609719bSwdenk
31416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
31425cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
31435cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
31445cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
31455cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
31465cf91d6bSwdenk	  byte chips.
31475cf91d6bSwdenk
31485cf91d6bSwdenk	  Note that we consider the length of the address field to
31495cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
31505cf91d6bSwdenk	  in the chip address.
31515cf91d6bSwdenk
31526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3153c609719bSwdenk	  The size in bytes of the EEPROM device.
3154c609719bSwdenk
3155548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3156548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3157548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3158548738b4SHeiko Schocher
3159548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3160548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3161548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3162548738b4SHeiko Schocher	  EEPROM. For example:
3163548738b4SHeiko Schocher
3164548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3165548738b4SHeiko Schocher
3166548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3167548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3168c609719bSwdenk
3169057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
31705779d8d9Swdenk
31715779d8d9Swdenk	Define this if you have a DataFlash memory device which you
31725779d8d9Swdenk	want to use for the environment.
31735779d8d9Swdenk
31740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
31760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
31775779d8d9Swdenk
31785779d8d9Swdenk	  These three #defines specify the offset and size of the
31795779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
31805779d8d9Swdenk	  at the specified address.
31815779d8d9Swdenk
31820a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
31830a85a9e7SLiu Gang
31840a85a9e7SLiu Gang	Define this if you have a remote memory space which you
31850a85a9e7SLiu Gang	want to use for the local device's environment.
31860a85a9e7SLiu Gang
31870a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
31880a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
31890a85a9e7SLiu Gang
31900a85a9e7SLiu Gang	  These two #defines specify the address and size of the
31910a85a9e7SLiu Gang	  environment area within the remote memory space. The
31920a85a9e7SLiu Gang	  local device can get the environment from remote memory
3193fc54c7faSLiu Gang	  space by SRIO or PCIE links.
31940a85a9e7SLiu Gang
31950a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
31960a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3197fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3198fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
31990a85a9e7SLiu Gang
320051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
320113a5695bSwdenk
320213a5695bSwdenk	Define this if you have a NAND device which you want to use
320313a5695bSwdenk	for the environment.
320413a5695bSwdenk
32050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
32060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
320713a5695bSwdenk
320813a5695bSwdenk	  These two #defines specify the offset and size of the environment
3209fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3210fdd813deSScott Wood	  aligned to an erase block boundary.
32115779d8d9Swdenk
3212fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3213e443c944SMarkus Klotzbuecher
32140e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3215fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3216fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3217fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3218fdd813deSScott Wood	  aligned to an erase block boundary.
3219e443c944SMarkus Klotzbuecher
3220fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3221fdd813deSScott Wood
3222fdd813deSScott Wood	  Specifies the length of the region in which the environment
3223fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3224fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3225fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3226fdd813deSScott Wood	  the range to be avoided.
3227fdd813deSScott Wood
3228fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3229fdd813deSScott Wood
3230fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3231fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3232fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3233fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3234fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3235e443c944SMarkus Klotzbuecher
3236b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3237b74ab737SGuennadi Liakhovetski
3238b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3239b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3240b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3241b74ab737SGuennadi Liakhovetski
32426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3243c609719bSwdenk
3244c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3245c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3246c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3247c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3248c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3249c609719bSwdenk	to be a good choice since it makes it far enough from the
3250c609719bSwdenk	start of the data area as well as from the stack pointer.
3251c609719bSwdenk
3252e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3253c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3254cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3255c609719bSwdenkuntil then to read environment variables.
3256c609719bSwdenk
325785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
325885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
325985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
326085ec0bccSwdenknecessary, because the first environment variable we need is the
326185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
326285ec0bccSwdenkhave any device yet where we could complain.]
3263c609719bSwdenk
3264c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3265c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
326685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3267c609719bSwdenk
32686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3269fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3270fc3e2165Swdenk
32716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3272fc3e2165Swdenk		      also needs to be defined.
3273fc3e2165Swdenk
32746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3275fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3276c609719bSwdenk
3277f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3278f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3279f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3280f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3281f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3282f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3283f5675aa5SRon Madrid
3284c609719bSwdenkLow Level (hardware related) configuration options:
3285dc7c9a1aSwdenk---------------------------------------------------
3286c609719bSwdenk
32876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3288c609719bSwdenk		Cache Line Size of the CPU.
3289c609719bSwdenk
32906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3291c609719bSwdenk		Default address of the IMMR after system reset.
32922535d602Swdenk
32932535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
32942535d602Swdenk		and RPXsuper) to be able to adjust the position of
32952535d602Swdenk		the IMMR register after a reset.
3296c609719bSwdenk
3297e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3298e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3299e46fedfeSTimur Tabi		PowerPC SOCs.
3300e46fedfeSTimur Tabi
3301e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3302e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3303e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3304e46fedfeSTimur Tabi
3305e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3306e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3307e46fedfeSTimur Tabi
3308e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3309e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3310e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3311e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3312e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3313e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3314e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3315e46fedfeSTimur Tabi
3316e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3317e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3318e46fedfeSTimur Tabi
3319e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3320e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3321e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3322e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3323e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3324e46fedfeSTimur Tabi
3325e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3326e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3327e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3328e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3329e46fedfeSTimur Tabi
3330e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3331e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3332e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3333e46fedfeSTimur Tabi
33347f6c2cbcSwdenk- Floppy Disk Support:
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
33367f6c2cbcSwdenk
33377f6c2cbcSwdenk		the default drive number (default value 0)
33387f6c2cbcSwdenk
33396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
33407f6c2cbcSwdenk
334111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
33427f6c2cbcSwdenk		(default value 1)
33437f6c2cbcSwdenk
33446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
33457f6c2cbcSwdenk
33467f6c2cbcSwdenk		defines the offset of register from address. It
33477f6c2cbcSwdenk		depends on which part of the data bus is connected to
334811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
33497f6c2cbcSwdenk
33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
33516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
33527f6c2cbcSwdenk		default value.
33537f6c2cbcSwdenk
33546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
33557f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
33567f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
33577f6c2cbcSwdenk		source code. It is used to make hardware dependant
33587f6c2cbcSwdenk		initializations.
33597f6c2cbcSwdenk
33600abddf82SMacpaul Lin- CONFIG_IDE_AHB:
33610abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
33620abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
33630abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
33640abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
33650abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
33660abddf82SMacpaul Lin		is requierd.
33670abddf82SMacpaul Lin
33686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
336925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
337025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3371c609719bSwdenk
33726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3373c609719bSwdenk
33747152b1d0Swdenk		Start address of memory area that can be used for
3375c609719bSwdenk		initial data and stack; please note that this must be
3376c609719bSwdenk		writable memory that is working WITHOUT special
3377c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3378c609719bSwdenk		will become available only after programming the
3379c609719bSwdenk		memory controller and running certain initialization
3380c609719bSwdenk		sequences.
3381c609719bSwdenk
3382c609719bSwdenk		U-Boot uses the following memory types:
3383c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3384c609719bSwdenk		- MPC824X: data cache
3385c609719bSwdenk		- PPC4xx:  data cache
3386c609719bSwdenk
33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3388c609719bSwdenk
3389c609719bSwdenk		Offset of the initial data structure in the memory
33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
33916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3392c609719bSwdenk		data is located at the end of the available space
3393553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
33946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
33966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3397c609719bSwdenk
3398c609719bSwdenk	Note:
3399c609719bSwdenk		On the MPC824X (or other systems that use the data
3400c609719bSwdenk		cache for initial memory) the address chosen for
34016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3402c609719bSwdenk		point to an otherwise UNUSED address space between
3403c609719bSwdenk		the top of RAM and the start of the PCI space.
3404c609719bSwdenk
34056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3406c609719bSwdenk
34076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3408c609719bSwdenk
34096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3410c609719bSwdenk
34116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3412c609719bSwdenk
34136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3414c609719bSwdenk
34156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3416c609719bSwdenk
34176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3418c609719bSwdenk		SDRAM timing
3419c609719bSwdenk
34206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3421c609719bSwdenk		periodic timer for refresh
3422c609719bSwdenk
34236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3424c609719bSwdenk
34256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
34266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
34276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3429c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3430c609719bSwdenk
3431c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
34326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
34336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3434c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3435c609719bSwdenk
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
34376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3438c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3439c609719bSwdenk		Prescaler definitions (SDRAM timing)
3440c609719bSwdenk
34416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3442c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3443c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3444c609719bSwdenk
34456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3446b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3447b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3448b423d055SHeiko Schocher
34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3450c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3451c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3452c609719bSwdenk
34536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3454c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3455c609719bSwdenk		wrong setting might damage your board. Read
3456c609719bSwdenk		doc/README.MBX before setting this variable!
3457c609719bSwdenk
34586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3459ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3460ea909b76Swdenk		(Power On Self Tests). This definition overrides
3461ea909b76Swdenk		#define'd default value in commproc.h resp.
3462ea909b76Swdenk		cpm_8260.h.
3463ea909b76Swdenk
34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
34656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
34666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
34676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
34686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
34696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
34706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
34716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3472a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
34735d232d0eSwdenk
34749cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
34759cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
34769cacf4fcSDirk Eibach		required.
34779cacf4fcSDirk Eibach
347869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
347969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
348069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
348169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
348269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
348369fd2d3bSAndrew Sharp		by coreboot or similar.
348469fd2d3bSAndrew Sharp
3485a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3486a09b9b68SKumar Gala		Chip has SRIO or not
3487a09b9b68SKumar Gala
3488a09b9b68SKumar Gala- CONFIG_SRIO1:
3489a09b9b68SKumar Gala		Board has SRIO 1 port available
3490a09b9b68SKumar Gala
3491a09b9b68SKumar Gala- CONFIG_SRIO2:
3492a09b9b68SKumar Gala		Board has SRIO 2 port available
3493a09b9b68SKumar Gala
3494a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3495a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3496a09b9b68SKumar Gala
3497a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3498a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3499a09b9b68SKumar Gala
3500a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3501a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3502a09b9b68SKumar Gala
3503eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3504eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3505eced4626SAlex Waterman		16 bit bus.
3506eced4626SAlex Waterman
3507eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3508eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3509eced4626SAlex Waterman		a default value will be used.
3510eced4626SAlex Waterman
3511bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3512218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3513218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3514218ca724SWolfgang Denk
3515bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3516bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3517bb99ad6dSBen Warren
35186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3519218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3520218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3521218ca724SWolfgang Denk		to something your driver can deal with.
3522bb99ad6dSBen Warren
35231b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
35241b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
35251b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
35261b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
35271b3e3c4fSYork Sun		header files or board specific files.
35281b3e3c4fSYork Sun
35296f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
35306f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
35316f5e1dc5SYork Sun
35326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3533218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3534218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
35352ad6b513STimur Tabi
3536c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3537c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3538c26e454dSwdenk
3539c26e454dSwdenk- CONFIG_FEC[12]_PHY
3540c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
35416e592385Swdenk		to the given FEC; i. e.
3542c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3543c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3544c26e454dSwdenk
3545c26e454dSwdenk		When set to -1, means to probe for first available.
3546c26e454dSwdenk
3547c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3548c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3549c26e454dSwdenk		(so program the FEC to ignore it).
3550c26e454dSwdenk
3551c26e454dSwdenk- CONFIG_RMII
3552c26e454dSwdenk		Enable RMII mode for all FECs.
3553c26e454dSwdenk		Note that this is a global option, we can't
3554c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3555c26e454dSwdenk
35565cf91d6bSwdenk- CONFIG_CRC32_VERIFY
35575cf91d6bSwdenk		Add a verify option to the crc32 command.
35585cf91d6bSwdenk		The syntax is:
35595cf91d6bSwdenk
35605cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
35615cf91d6bSwdenk
35625cf91d6bSwdenk		Where address/count indicate a memory area
35635cf91d6bSwdenk		and crc32 is the correct crc32 which the
35645cf91d6bSwdenk		area should have.
35655cf91d6bSwdenk
356656523f12Swdenk- CONFIG_LOOPW
356756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3568602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
356956523f12Swdenk
35707b466641Sstroese- CONFIG_MX_CYCLIC
35717b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
35727b466641Sstroese		"md/mw" commands.
35737b466641Sstroese		Examples:
35747b466641Sstroese
35757b466641Sstroese		=> mdc.b 10 4 500
35767b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
35777b466641Sstroese
35787b466641Sstroese		=> mwc.l 100 12345678 10
35797b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
35807b466641Sstroese
35817b466641Sstroese		This only takes effect if the memory commands are activated
3582602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
35837b466641Sstroese
35848aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3585afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3586e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3587e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3588e03f3169SWolfgang Denk		relocate itself into RAM.
35898aa1a2d1Swdenk
3590e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3591e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3592e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3593e03f3169SWolfgang Denk		these initializations itself.
35948aa1a2d1Swdenk
3595401bb30bSAneesh V- CONFIG_SPL_BUILD
3596df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3597df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3598df81238bSMagnus Lilja		compiling a NAND SPL.
3599400558b5Swdenk
3600d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3601d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3602d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3603d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3604d8834a13SMatthias Weisser		conditions but may increase the binary size.
3605d8834a13SMatthias Weisser
3606f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3607f2717b47STimur Tabi-----------------------------------
3608f2717b47STimur Tabi
3609f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3610f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3611f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3612f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3613f2717b47STimur Tabiwithin that device.
3614f2717b47STimur Tabi
3615f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3616f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3617f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3618f2717b47STimur Tabi	is also specified.
3619f2717b47STimur Tabi
3620f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3621f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3622f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3623f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3624f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3625f2717b47STimur Tabi
3626f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3627f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3628f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3629f2717b47STimur Tabi	virtual address in NOR flash.
3630f2717b47STimur Tabi
3631f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3632f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3633f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3634f2717b47STimur Tabi
3635f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3636f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3637f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3638f2717b47STimur Tabi
3639f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3640f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3641f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3642f2717b47STimur Tabi
3643292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3644292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3645292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3646fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3647fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3648fc54c7faSLiu Gang	master's memory space.
3649f2717b47STimur Tabi
3650c609719bSwdenkBuilding the Software:
3651c609719bSwdenk======================
3652c609719bSwdenk
3653218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3654218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3655218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3656218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3657218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3658218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3659c609719bSwdenk
3660218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3661218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3662218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3663218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3664218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3665c609719bSwdenk
3666218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3667218ca724SWolfgang Denk	$ export CROSS_COMPILE
3668c609719bSwdenk
36692f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
36702f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
36712f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
36722f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
36732f8d396bSPeter Tyser
36742f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
36752f8d396bSPeter Tyser
36762f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
36772f8d396bSPeter Tyser      be executed on computers running Windows.
36782f8d396bSPeter Tyser
3679c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3680c609719bSwdenksources you must configure U-Boot for one specific board type. This
3681c609719bSwdenkis done by typing:
3682c609719bSwdenk
3683c609719bSwdenk	make NAME_config
3684c609719bSwdenk
3685218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
36864d675ae6SMichael Jonesrations; see boards.cfg for supported names.
368754387ac9Swdenk
3688c609719bSwdenkNote: for some board special configuration names may exist; check if
3689c609719bSwdenk      additional information is available from the board vendor; for
36902729af9dSwdenk      instance, the TQM823L systems are available without (standard)
36912729af9dSwdenk      or with LCD support. You can select such additional "features"
369211ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3693c609719bSwdenk
36942729af9dSwdenk      make TQM823L_config
36952729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3696c609719bSwdenk
3697c609719bSwdenk      make TQM823L_LCD_config
3698c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3699c609719bSwdenk
3700c609719bSwdenk      etc.
3701c609719bSwdenk
3702c609719bSwdenk
3703c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
37047152b1d0Swdenkimages ready for download to / installation on your system:
3705c609719bSwdenk
3706c609719bSwdenk- "u-boot.bin" is a raw binary image
3707c609719bSwdenk- "u-boot" is an image in ELF binary format
3708c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3709c609719bSwdenk
3710baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3711baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3712baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3713baf31249SMarian Balakowicz
3714baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3715baf31249SMarian Balakowicz
3716baf31249SMarian Balakowicz	make O=/tmp/build distclean
3717baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3718baf31249SMarian Balakowicz	make O=/tmp/build all
3719baf31249SMarian Balakowicz
3720baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3721baf31249SMarian Balakowicz
3722baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3723baf31249SMarian Balakowicz	make distclean
3724baf31249SMarian Balakowicz	make NAME_config
3725baf31249SMarian Balakowicz	make all
3726baf31249SMarian Balakowicz
3727baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3728baf31249SMarian Balakowiczvariable.
3729baf31249SMarian Balakowicz
3730c609719bSwdenk
3731c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3732c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3733c609719bSwdenknative "make".
3734c609719bSwdenk
3735c609719bSwdenk
3736c609719bSwdenkIf the system board that you have is not listed, then you will need
3737c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3738c609719bSwdenksteps:
3739c609719bSwdenk
3740c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
37414d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
37424d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3743c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
374485ec0bccSwdenk    files you need. In your board directory, you will need at least
374585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
374685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
374785ec0bccSwdenk    your board
3748c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3749c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
375085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3751c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3752c609719bSwdenk    to be installed on your target system.
375385ec0bccSwdenk6.  Debug and solve any problems that might arise.
3754c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3755c609719bSwdenk
3756c609719bSwdenk
3757c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3758c609719bSwdenk==============================================================
3759c609719bSwdenk
3760c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3761c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3762c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3763c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3764218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3765c609719bSwdenk
3766c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3767c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3768c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3769c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3770c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
37717152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3772218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3773218ca724SWolfgang Denkyou can type
3774c609719bSwdenk
3775c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3776c609719bSwdenk
3777c609719bSwdenkor to build on a native PowerPC system you can type
3778c609719bSwdenk
3779c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3780c609719bSwdenk
3781218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3782218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3783218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3784218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3785218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3786218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3787218ca724SWolfgang Denkvariable. For example:
3788baf31249SMarian Balakowicz
3789baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3790baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3791baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3792baf31249SMarian Balakowicz
3793218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3794218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3795218ca724SWolfgang Denkduring the whole build process.
3796baf31249SMarian Balakowicz
3797baf31249SMarian Balakowicz
3798c609719bSwdenkSee also "U-Boot Porting Guide" below.
3799c609719bSwdenk
3800c609719bSwdenk
3801c609719bSwdenkMonitor Commands - Overview:
3802c609719bSwdenk============================
3803c609719bSwdenk
3804c609719bSwdenkgo	- start application at address 'addr'
3805c609719bSwdenkrun	- run commands in an environment variable
3806c609719bSwdenkbootm	- boot application image from memory
3807c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
380844f074c7SMarek Vasutbootz   - boot zImage from memory
3809c609719bSwdenktftpboot- boot image via network using TFTP protocol
3810c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3811c609719bSwdenk	       (and eventually "gatewayip")
38121fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3813c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3814c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3815c609719bSwdenkloads	- load S-Record file over serial line
3816c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3817c609719bSwdenkmd	- memory display
3818c609719bSwdenkmm	- memory modify (auto-incrementing)
3819c609719bSwdenknm	- memory modify (constant address)
3820c609719bSwdenkmw	- memory write (fill)
3821c609719bSwdenkcp	- memory copy
3822c609719bSwdenkcmp	- memory compare
3823c609719bSwdenkcrc32	- checksum calculation
38240f89c54bSPeter Tyseri2c	- I2C sub-system
3825c609719bSwdenksspi	- SPI utility commands
3826c609719bSwdenkbase	- print or set address offset
3827c609719bSwdenkprintenv- print environment variables
3828c609719bSwdenksetenv	- set environment variables
3829c609719bSwdenksaveenv - save environment variables to persistent storage
3830c609719bSwdenkprotect - enable or disable FLASH write protection
3831c609719bSwdenkerase	- erase FLASH memory
3832c609719bSwdenkflinfo	- print FLASH memory information
3833c609719bSwdenkbdinfo	- print Board Info structure
3834c609719bSwdenkiminfo	- print header information for application image
3835c609719bSwdenkconinfo - print console devices and informations
3836c609719bSwdenkide	- IDE sub-system
3837c609719bSwdenkloop	- infinite loop on address range
383856523f12Swdenkloopw	- infinite write loop on address range
3839c609719bSwdenkmtest	- simple RAM test
3840c609719bSwdenkicache	- enable or disable instruction cache
3841c609719bSwdenkdcache	- enable or disable data cache
3842c609719bSwdenkreset	- Perform RESET of the CPU
3843c609719bSwdenkecho	- echo args to console
3844c609719bSwdenkversion - print monitor version
3845c609719bSwdenkhelp	- print online help
3846c609719bSwdenk?	- alias for 'help'
3847c609719bSwdenk
3848c609719bSwdenk
3849c609719bSwdenkMonitor Commands - Detailed Description:
3850c609719bSwdenk========================================
3851c609719bSwdenk
3852c609719bSwdenkTODO.
3853c609719bSwdenk
3854c609719bSwdenkFor now: just type "help <command>".
3855c609719bSwdenk
3856c609719bSwdenk
3857c609719bSwdenkEnvironment Variables:
3858c609719bSwdenk======================
3859c609719bSwdenk
3860c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3861c609719bSwdenkcan be made persistent by saving to Flash memory.
3862c609719bSwdenk
3863c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3864c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3865c609719bSwdenkwithout a value can be used to delete a variable from the
3866c609719bSwdenkenvironment. As long as you don't save the environment you are
3867c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3868c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3869c609719bSwdenk
3870c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3871c96f86eeSWolfgang Denk
3872c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3873c609719bSwdenk
3874c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3875c609719bSwdenk
3876c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3877c609719bSwdenk
3878c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3879c609719bSwdenk
3880c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3881c609719bSwdenk
3882c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3883c609719bSwdenk
38847d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
38857d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
38867d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
38877d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
38887d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
38897d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3890c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3891c3624e6eSGrant Likely		  bootm_mapsize.
3892c3624e6eSGrant Likely
3893c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3894c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3895c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3896c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3897c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3898c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3899c3624e6eSGrant Likely		  used otherwise.
39007d721e34SBartlomiej Sieka
39017d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
39027d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
39037d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
39047d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
39057d721e34SBartlomiej Sieka		  environment variable.
39067d721e34SBartlomiej Sieka
39074bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
39084bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
39094bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
39104bae9090SBartlomiej Sieka
3911c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3912c609719bSwdenk		  "bootp" will just load perform a lookup of the
3913c609719bSwdenk		  configuration from the BOOTP server, but not try to
3914c609719bSwdenk		  load any image using TFTP
3915c609719bSwdenk
3916c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3917c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3918c609719bSwdenk		  be automatically started (by internally calling
3919c609719bSwdenk		  "bootm")
3920c609719bSwdenk
39214a6fd34bSwdenk		  If set to "no", a standalone image passed to the
39224a6fd34bSwdenk		  "bootm" command will be copied to the load address
39234a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
39244a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
39254a6fd34bSwdenk		  data.
39264a6fd34bSwdenk
3927a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3928a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3929fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3930fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3931fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3932fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3933fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3934fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3935fa34f6b2SShawn Guo		  access it during the boot procedure.
3936fa34f6b2SShawn Guo
3937a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3938a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3939a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3940a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3941a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3942a28afca5SDavid A. Long		  must be accessible by the kernel.
3943a28afca5SDavid A. Long
3944eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3945eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3946eea63e05SSimon Glass		  defined.
3947eea63e05SSimon Glass
394817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
394917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
395017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
395117ea1177Swdenk		  initialization code. So, for changes to be effective
395217ea1177Swdenk		  it must be saved and board must be reset.
395317ea1177Swdenk
3954c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3955c609719bSwdenk		  If this variable is not set, initrd images will be
3956c609719bSwdenk		  copied to the highest possible address in RAM; this
3957c609719bSwdenk		  is usually what you want since it allows for
3958c609719bSwdenk		  maximum initrd size. If for some reason you want to
3959c609719bSwdenk		  make sure that the initrd image is loaded below the
39606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3961c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3962c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3963c609719bSwdenk		  address to use (U-Boot will still check that it
3964c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3965c609719bSwdenk
3966c609719bSwdenk		  For instance, when you have a system with 16 MB
39677152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3968c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3969c609719bSwdenk		  the "bootargs" variable. However, now you must make
39707152b1d0Swdenk		  sure that the initrd image is placed in the first
3971c609719bSwdenk		  12 MB as well - this can be done with
3972c609719bSwdenk
3973c609719bSwdenk		  setenv initrd_high 00c00000
3974c609719bSwdenk
397538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
397638b99261Swdenk		  indication to U-Boot that all addresses are legal
397738b99261Swdenk		  for the Linux kernel, including addresses in flash
397838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
397938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
398038b99261Swdenk		  boot time on your system, but requires that this
398138b99261Swdenk		  feature is supported by your Linux kernel.
398238b99261Swdenk
3983c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3984c609719bSwdenk
3985c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3986dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3987c609719bSwdenk
3988c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3989c609719bSwdenk
3990c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3991c609719bSwdenk
3992c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3993c609719bSwdenk
3994c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3995c609719bSwdenk
3996c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3997c609719bSwdenk
3998e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3999a3d991bdSwdenk
4000e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4001e2a53458SMike Frysinger		  For example you can do the following
4002a3d991bdSwdenk
400348690d80SHeiko Schocher		  => setenv ethact FEC
400448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
400548690d80SHeiko Schocher		  => setenv ethact SCC
400648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4007a3d991bdSwdenk
4008e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4009e1692577SMatthias Fuchs		  available network interfaces.
4010e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4011e1692577SMatthias Fuchs
4012a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4013a3d991bdSwdenk		  either succeed or fail without retrying.
40146e592385Swdenk		  When set to "once" the network operation will
40156e592385Swdenk		  fail when all the available network interfaces
40166e592385Swdenk		  are tried once without success.
4017a3d991bdSwdenk		  Useful on scripts which control the retry operation
4018a3d991bdSwdenk		  themselves.
4019a3d991bdSwdenk
4020b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4021a1cf027aSJean-Christophe PLAGNIOL-VILLARD
402228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4023ecb0ccd9SWolfgang Denk		  UDP source port.
4024ecb0ccd9SWolfgang Denk
402528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
402628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
402728cb9375SWolfgang Denk
4028c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4029c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4030c96f86eeSWolfgang Denk
4031c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4032c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4033c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4034c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4035c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4036c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4037c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4038c96f86eeSWolfgang Denk
4039a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
404011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4041a3d991bdSwdenk		  VLAN tagged frames.
4042c609719bSwdenk
4043dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4044dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4045dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4046dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4047dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4048dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4049dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4050dc0b7b0eSJason Hobbs
4051dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4052dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4053dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4054dc0b7b0eSJason Hobbs
4055dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4056dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4057dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4058dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4059dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4060dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4061dc0b7b0eSJason Hobbs
4062c609719bSwdenkThe following environment variables may be used and automatically
4063c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4064c609719bSwdenkdepending the information provided by your boot server:
4065c609719bSwdenk
4066c609719bSwdenk  bootfile	- see above
4067c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4068fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4069c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4070c609719bSwdenk  hostname	- Target hostname
4071c609719bSwdenk  ipaddr	- see above
4072c609719bSwdenk  netmask	- Subnet Mask
4073c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4074c609719bSwdenk  serverip	- see above
4075c609719bSwdenk
4076c609719bSwdenk
4077c609719bSwdenkThere are two special Environment Variables:
4078c609719bSwdenk
4079c609719bSwdenk  serial#	- contains hardware identification information such
4080c609719bSwdenk		  as type string and/or serial number
4081c609719bSwdenk  ethaddr	- Ethernet address
4082c609719bSwdenk
4083c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4084c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4085c609719bSwdenkonce they have been set once.
4086c609719bSwdenk
4087c609719bSwdenk
4088c1551ea8SstroeseFurther special Environment Variables:
4089c1551ea8Sstroese
4090c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4091c1551ea8Sstroese		  with the "version" command. This variable is
4092c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4093c1551ea8Sstroese
4094c1551ea8Sstroese
4095c609719bSwdenkPlease note that changes to some configuration parameters may take
4096c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4097c609719bSwdenk
4098c609719bSwdenk
4099f07771ccSwdenkCommand Line Parsing:
4100f07771ccSwdenk=====================
4101f07771ccSwdenk
4102f07771ccSwdenkThere are two different command line parsers available with U-Boot:
41037152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4104f07771ccSwdenk
4105f07771ccSwdenkOld, simple command line parser:
4106f07771ccSwdenk--------------------------------
4107f07771ccSwdenk
4108f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4109f07771ccSwdenk- several commands on one line, separated by ';'
4110fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4111f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4112f07771ccSwdenk  for example:
4113fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4114f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4115f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4116f07771ccSwdenk
4117f07771ccSwdenkHush shell:
4118f07771ccSwdenk-----------
4119f07771ccSwdenk
4120f07771ccSwdenk- similar to Bourne shell, with control structures like
4121f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4122f07771ccSwdenk  until...do...done, ...
4123f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4124f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4125f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4126f07771ccSwdenk  command
4127f07771ccSwdenk
4128f07771ccSwdenkGeneral rules:
4129f07771ccSwdenk--------------
4130f07771ccSwdenk
4131f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4132f07771ccSwdenk    command) contains several commands separated by semicolon, and
4133f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4134f07771ccSwdenk    executed anyway.
4135f07771ccSwdenk
4136f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
413711ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4138f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4139f07771ccSwdenk    variables are not executed.
4140f07771ccSwdenk
4141c609719bSwdenkNote for Redundant Ethernet Interfaces:
4142c609719bSwdenk=======================================
4143c609719bSwdenk
414411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4145c609719bSwdenksuch configurations and is capable of automatic selection of a
41467152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4147c609719bSwdenk
4148c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4149c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4150c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4151c609719bSwdenk
4152c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4153c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4154c609719bSwdenkding setting in the environment; if the corresponding environment
4155c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4156c609719bSwdenk
4157c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4158c609719bSwdenk  environment, the SROM's address is used.
4159c609719bSwdenk
4160c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4161c609719bSwdenk  environment exists, then the value from the environment variable is
4162c609719bSwdenk  used.
4163c609719bSwdenk
4164c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4165c609719bSwdenk  both addresses are the same, this MAC address is used.
4166c609719bSwdenk
4167c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4168c609719bSwdenk  addresses differ, the value from the environment is used and a
4169c609719bSwdenk  warning is printed.
4170c609719bSwdenk
4171c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4172c609719bSwdenk  is raised.
4173c609719bSwdenk
4174ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4175ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4176ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4177ecee9324SBen WarrenThe naming convention is as follows:
4178ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4179c609719bSwdenk
4180c609719bSwdenkImage Formats:
4181c609719bSwdenk==============
4182c609719bSwdenk
41833310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
41843310c549SMarian Balakowiczimages in two formats:
41853310c549SMarian Balakowicz
41863310c549SMarian BalakowiczNew uImage format (FIT)
41873310c549SMarian Balakowicz-----------------------
41883310c549SMarian Balakowicz
41893310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
41903310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
41913310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
41923310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
41933310c549SMarian Balakowicz
41943310c549SMarian Balakowicz
41953310c549SMarian BalakowiczOld uImage format
41963310c549SMarian Balakowicz-----------------
41973310c549SMarian Balakowicz
41983310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
41993310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
42003310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4201c609719bSwdenk
4202c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4203c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4204f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4205f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4206f5ed9e39SPeter Tyser  INTEGRITY).
42077b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4208afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4209afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4210c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4211c609719bSwdenk* Load Address
4212c609719bSwdenk* Entry Point
4213c609719bSwdenk* Image Name
4214c609719bSwdenk* Image Timestamp
4215c609719bSwdenk
4216c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4217c609719bSwdenkand the data portions of the image are secured against corruption by
4218c609719bSwdenkCRC32 checksums.
4219c609719bSwdenk
4220c609719bSwdenk
4221c609719bSwdenkLinux Support:
4222c609719bSwdenk==============
4223c609719bSwdenk
4224c609719bSwdenkAlthough U-Boot should support any OS or standalone application
42257152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4226c609719bSwdenkU-Boot.
4227c609719bSwdenk
4228c609719bSwdenkU-Boot includes many features that so far have been part of some
4229c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4230c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4231c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
42327152b1d0Swdenkserves several purposes:
4233c609719bSwdenk
4234c609719bSwdenk- the same features can be used for other OS or standalone
4235c609719bSwdenk  applications (for instance: using compressed images to reduce the
4236c609719bSwdenk  Flash memory footprint)
4237c609719bSwdenk
4238c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
42397152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4240c609719bSwdenk
4241c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4242c609719bSwdenk  images; of course this also means that different kernel images can
4243c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4244c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4245c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4246c609719bSwdenk  software is easier now.
4247c609719bSwdenk
4248c609719bSwdenk
4249c609719bSwdenkLinux HOWTO:
4250c609719bSwdenk============
4251c609719bSwdenk
4252c609719bSwdenkPorting Linux to U-Boot based systems:
4253c609719bSwdenk---------------------------------------
4254c609719bSwdenk
4255c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4256c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4257c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4258c609719bSwdenkLinux :-).
4259c609719bSwdenk
4260a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4261c609719bSwdenk
4262c609719bSwdenkJust make sure your machine specific header file (for instance
4263c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
42641dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
42651dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
42666d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4267c609719bSwdenk
4268c609719bSwdenk
4269c609719bSwdenkConfiguring the Linux kernel:
4270c609719bSwdenk-----------------------------
4271c609719bSwdenk
4272c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4273c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4274c609719bSwdenk
4275c609719bSwdenk
4276c609719bSwdenkBuilding a Linux Image:
4277c609719bSwdenk-----------------------
4278c609719bSwdenk
427924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
428024ee89b9Swdenknot used. If you use recent kernel source, a new build target
428124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
428224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
428324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
428424ee89b9Swdenk100% compatible format.
4285c609719bSwdenk
4286c609719bSwdenkExample:
4287c609719bSwdenk
4288c609719bSwdenk	make TQM850L_config
4289c609719bSwdenk	make oldconfig
4290c609719bSwdenk	make dep
429124ee89b9Swdenk	make uImage
4292c609719bSwdenk
429324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
429424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
429524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4296c609719bSwdenk
429724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
429824ee89b9Swdenk
429924ee89b9Swdenk* convert the kernel into a raw binary image:
430024ee89b9Swdenk
430124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
430224ee89b9Swdenk				 -R .note -R .comment \
430324ee89b9Swdenk				 -S vmlinux linux.bin
430424ee89b9Swdenk
430524ee89b9Swdenk* compress the binary image:
430624ee89b9Swdenk
430724ee89b9Swdenk	gzip -9 linux.bin
430824ee89b9Swdenk
430924ee89b9Swdenk* package compressed binary image for U-Boot:
431024ee89b9Swdenk
431124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
431224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
431324ee89b9Swdenk		-d linux.bin.gz uImage
431424ee89b9Swdenk
431524ee89b9Swdenk
431624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
431724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
431824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
431924ee89b9Swdenkbyte header containing information about target architecture,
432024ee89b9Swdenkoperating system, image type, compression method, entry points, time
432124ee89b9Swdenkstamp, CRC32 checksums, etc.
432224ee89b9Swdenk
432324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
432424ee89b9Swdenkprint the header information, or to build new images.
4325c609719bSwdenk
4326c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4327c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4328c609719bSwdenkchecksum verification:
4329c609719bSwdenk
4330c609719bSwdenk	tools/mkimage -l image
4331c609719bSwdenk	  -l ==> list image header information
4332c609719bSwdenk
4333c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4334c609719bSwdenkfrom a "data file" which is used as image payload:
4335c609719bSwdenk
4336c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4337c609719bSwdenk		      -n name -d data_file image
4338c609719bSwdenk	  -A ==> set architecture to 'arch'
4339c609719bSwdenk	  -O ==> set operating system to 'os'
4340c609719bSwdenk	  -T ==> set image type to 'type'
4341c609719bSwdenk	  -C ==> set compression type 'comp'
4342c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4343c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4344c609719bSwdenk	  -n ==> set image name to 'name'
4345c609719bSwdenk	  -d ==> use image data from 'datafile'
4346c609719bSwdenk
434769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
434869459791Swdenkaddress (0x00000000), but the entry point address depends on the
434969459791Swdenkkernel version:
4350c609719bSwdenk
4351c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
435224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4353c609719bSwdenk
4354c609719bSwdenkSo a typical call to build a U-Boot image would read:
4355c609719bSwdenk
435624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
435724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4358a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
435924ee89b9Swdenk	> examples/uImage.TQM850L
436024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4361c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4362c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4363c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4364c609719bSwdenk	Load Address: 0x00000000
436524ee89b9Swdenk	Entry Point:  0x00000000
4366c609719bSwdenk
4367c609719bSwdenkTo verify the contents of the image (or check for corruption):
4368c609719bSwdenk
436924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
437024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4371c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4372c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4373c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4374c609719bSwdenk	Load Address: 0x00000000
437524ee89b9Swdenk	Entry Point:  0x00000000
4376c609719bSwdenk
4377c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4378c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4379c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4380c609719bSwdenkneed to be uncompressed:
4381c609719bSwdenk
4382a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
438324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
438424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4385a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
438624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
438724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4388c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4389c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4390c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4391c609719bSwdenk	Load Address: 0x00000000
439224ee89b9Swdenk	Entry Point:  0x00000000
4393c609719bSwdenk
4394c609719bSwdenk
4395c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4396c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4397c609719bSwdenk
4398c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4399c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4400c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4401c609719bSwdenk	Image Name:   Simple Ramdisk Image
4402c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4403c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4404c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4405c609719bSwdenk	Load Address: 0x00000000
4406c609719bSwdenk	Entry Point:  0x00000000
4407c609719bSwdenk
4408c609719bSwdenk
4409c609719bSwdenkInstalling a Linux Image:
4410c609719bSwdenk-------------------------
4411c609719bSwdenk
4412c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4413c609719bSwdenkyou must convert the image to S-Record format:
4414c609719bSwdenk
4415c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4416c609719bSwdenk
4417c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4418c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4419c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4420c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4421c609719bSwdenkcommand.
4422c609719bSwdenk
4423c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4424c609719bSwdenkTQM8xxL is in the first Flash bank):
4425c609719bSwdenk
4426c609719bSwdenk	=> erase 40100000 401FFFFF
4427c609719bSwdenk
4428c609719bSwdenk	.......... done
4429c609719bSwdenk	Erased 8 sectors
4430c609719bSwdenk
4431c609719bSwdenk	=> loads 40100000
4432c609719bSwdenk	## Ready for S-Record download ...
4433c609719bSwdenk	~>examples/image.srec
4434c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4435c609719bSwdenk	...
4436c609719bSwdenk	15989 15990 15991 15992
4437c609719bSwdenk	[file transfer complete]
4438c609719bSwdenk	[connected]
4439c609719bSwdenk	## Start Addr = 0x00000000
4440c609719bSwdenk
4441c609719bSwdenk
4442c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4443c609719bSwdenkthis includes a checksum verification so you can be sure no data
4444c609719bSwdenkcorruption happened:
4445c609719bSwdenk
4446c609719bSwdenk	=> imi 40100000
4447c609719bSwdenk
4448c609719bSwdenk	## Checking Image at 40100000 ...
4449c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4450c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4451c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4452c609719bSwdenk	   Load Address: 00000000
4453c609719bSwdenk	   Entry Point:	 0000000c
4454c609719bSwdenk	   Verifying Checksum ... OK
4455c609719bSwdenk
4456c609719bSwdenk
4457c609719bSwdenkBoot Linux:
4458c609719bSwdenk-----------
4459c609719bSwdenk
4460c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4461c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4462c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4463c609719bSwdenkparameters. You can check and modify this variable using the
4464c609719bSwdenk"printenv" and "setenv" commands:
4465c609719bSwdenk
4466c609719bSwdenk
4467c609719bSwdenk	=> printenv bootargs
4468c609719bSwdenk	bootargs=root=/dev/ram
4469c609719bSwdenk
4470c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4471c609719bSwdenk
4472c609719bSwdenk	=> printenv bootargs
4473c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4474c609719bSwdenk
4475c609719bSwdenk	=> bootm 40020000
4476c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4477c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4478c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4479c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4480c609719bSwdenk	   Load Address: 00000000
4481c609719bSwdenk	   Entry Point:	 0000000c
4482c609719bSwdenk	   Verifying Checksum ... OK
4483c609719bSwdenk	   Uncompressing Kernel Image ... OK
4484c609719bSwdenk	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
4485c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4486c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4487c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4488c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4489c609719bSwdenk	...
4490c609719bSwdenk
449111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
44927152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4493c609719bSwdenkformat!) to the "bootm" command:
4494c609719bSwdenk
4495c609719bSwdenk	=> imi 40100000 40200000
4496c609719bSwdenk
4497c609719bSwdenk	## Checking Image at 40100000 ...
4498c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4499c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4500c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4501c609719bSwdenk	   Load Address: 00000000
4502c609719bSwdenk	   Entry Point:	 0000000c
4503c609719bSwdenk	   Verifying Checksum ... OK
4504c609719bSwdenk
4505c609719bSwdenk	## Checking Image at 40200000 ...
4506c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4507c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4508c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4509c609719bSwdenk	   Load Address: 00000000
4510c609719bSwdenk	   Entry Point:	 00000000
4511c609719bSwdenk	   Verifying Checksum ... OK
4512c609719bSwdenk
4513c609719bSwdenk	=> bootm 40100000 40200000
4514c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4515c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4516c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4517c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4518c609719bSwdenk	   Load Address: 00000000
4519c609719bSwdenk	   Entry Point:	 0000000c
4520c609719bSwdenk	   Verifying Checksum ... OK
4521c609719bSwdenk	   Uncompressing Kernel Image ... OK
4522c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4523c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4524c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4525c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4526c609719bSwdenk	   Load Address: 00000000
4527c609719bSwdenk	   Entry Point:	 00000000
4528c609719bSwdenk	   Verifying Checksum ... OK
4529c609719bSwdenk	   Loading Ramdisk ... OK
4530c609719bSwdenk	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
4531c609719bSwdenk	Boot arguments: root=/dev/ram
4532c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4533c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4534c609719bSwdenk	...
4535c609719bSwdenk	RAMDISK: Compressed image found at block 0
4536c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4537c609719bSwdenk
4538c609719bSwdenk	bash#
4539c609719bSwdenk
45400267768eSMatthew McClintockBoot Linux and pass a flat device tree:
45410267768eSMatthew McClintock-----------
45420267768eSMatthew McClintock
45430267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
45440267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
45450267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
45460267768eSMatthew McClintockflat device tree:
45470267768eSMatthew McClintock
45480267768eSMatthew McClintock=> print oftaddr
45490267768eSMatthew McClintockoftaddr=0x300000
45500267768eSMatthew McClintock=> print oft
45510267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
45520267768eSMatthew McClintock=> tftp $oftaddr $oft
45530267768eSMatthew McClintockSpeed: 1000, full duplex
45540267768eSMatthew McClintockUsing TSEC0 device
45550267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
45560267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
45570267768eSMatthew McClintockLoad address: 0x300000
45580267768eSMatthew McClintockLoading: #
45590267768eSMatthew McClintockdone
45600267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
45610267768eSMatthew McClintock=> tftp $loadaddr $bootfile
45620267768eSMatthew McClintockSpeed: 1000, full duplex
45630267768eSMatthew McClintockUsing TSEC0 device
45640267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
45650267768eSMatthew McClintockFilename 'uImage'.
45660267768eSMatthew McClintockLoad address: 0x200000
45670267768eSMatthew McClintockLoading:############
45680267768eSMatthew McClintockdone
45690267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
45700267768eSMatthew McClintock=> print loadaddr
45710267768eSMatthew McClintockloadaddr=200000
45720267768eSMatthew McClintock=> print oftaddr
45730267768eSMatthew McClintockoftaddr=0x300000
45740267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
45750267768eSMatthew McClintock## Booting image at 00200000 ...
45760267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
45770267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
45780267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
45790267768eSMatthew McClintock   Load Address: 00000000
45800267768eSMatthew McClintock   Entry Point:	 00000000
45810267768eSMatthew McClintock   Verifying Checksum ... OK
45820267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
45830267768eSMatthew McClintockBooting using flat device tree at 0x300000
45840267768eSMatthew McClintockUsing MPC85xx ADS machine description
45850267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
45860267768eSMatthew McClintock[snip]
45870267768eSMatthew McClintock
45880267768eSMatthew McClintock
45896069ff26SwdenkMore About U-Boot Image Types:
45906069ff26Swdenk------------------------------
45916069ff26Swdenk
45926069ff26SwdenkU-Boot supports the following image types:
45936069ff26Swdenk
45946069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
45956069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
45966069ff26Swdenk	well) you can continue to work in U-Boot after return from
45976069ff26Swdenk	the Standalone Program.
45986069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
45996069ff26Swdenk	will take over control completely. Usually these programs
46006069ff26Swdenk	will install their own set of exception handlers, device
46016069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
46026069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
46036069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
46046069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
46056069ff26Swdenk	being started.
46066069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
46076069ff26Swdenk	(Linux) kernel image and one or more data images like
46086069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
46096069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
46106069ff26Swdenk	server provides just a single image file, but you want to get
46116069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
46126069ff26Swdenk
46136069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
46146069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
46156069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
46166069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
46176069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
46186069ff26Swdenk	a multiple of 4 bytes).
46196069ff26Swdenk
46206069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
46216069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
46226069ff26Swdenk	flash memory.
46236069ff26Swdenk
46246069ff26Swdenk   "Script files" are command sequences that will be executed by
46256069ff26Swdenk	U-Boot's command interpreter; this feature is especially
46266069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
46276069ff26Swdenk	as command interpreter.
46286069ff26Swdenk
462944f074c7SMarek VasutBooting the Linux zImage:
463044f074c7SMarek Vasut-------------------------
463144f074c7SMarek Vasut
463244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
463344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
463444f074c7SMarek Vasutas the syntax of "bootm" command.
463544f074c7SMarek Vasut
4636017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4637017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4638017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4639017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4640017e1f3fSMarek Vasut
4641c609719bSwdenk
4642c609719bSwdenkStandalone HOWTO:
4643c609719bSwdenk=================
4644c609719bSwdenk
4645c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4646c609719bSwdenkrun "standalone" applications, which can use some resources of
4647c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4648c609719bSwdenk
4649c609719bSwdenkTwo simple examples are included with the sources:
4650c609719bSwdenk
4651c609719bSwdenk"Hello World" Demo:
4652c609719bSwdenk-------------------
4653c609719bSwdenk
4654c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4655c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4656c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4657c609719bSwdenklike that:
4658c609719bSwdenk
4659c609719bSwdenk	=> loads
4660c609719bSwdenk	## Ready for S-Record download ...
4661c609719bSwdenk	~>examples/hello_world.srec
4662c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4663c609719bSwdenk	[file transfer complete]
4664c609719bSwdenk	[connected]
4665c609719bSwdenk	## Start Addr = 0x00040004
4666c609719bSwdenk
4667c609719bSwdenk	=> go 40004 Hello World! This is a test.
4668c609719bSwdenk	## Starting application at 0x00040004 ...
4669c609719bSwdenk	Hello World
4670c609719bSwdenk	argc = 7
4671c609719bSwdenk	argv[0] = "40004"
4672c609719bSwdenk	argv[1] = "Hello"
4673c609719bSwdenk	argv[2] = "World!"
4674c609719bSwdenk	argv[3] = "This"
4675c609719bSwdenk	argv[4] = "is"
4676c609719bSwdenk	argv[5] = "a"
4677c609719bSwdenk	argv[6] = "test."
4678c609719bSwdenk	argv[7] = "<NULL>"
4679c609719bSwdenk	Hit any key to exit ...
4680c609719bSwdenk
4681c609719bSwdenk	## Application terminated, rc = 0x0
4682c609719bSwdenk
4683c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4684c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4685c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4686c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4687c609719bSwdenkcharacter, but this is just a demo program. The application can be
4688c609719bSwdenkcontrolled by the following keys:
4689c609719bSwdenk
4690c609719bSwdenk	? - print current values og the CPM Timer registers
4691c609719bSwdenk	b - enable interrupts and start timer
4692c609719bSwdenk	e - stop timer and disable interrupts
4693c609719bSwdenk	q - quit application
4694c609719bSwdenk
4695c609719bSwdenk	=> loads
4696c609719bSwdenk	## Ready for S-Record download ...
4697c609719bSwdenk	~>examples/timer.srec
4698c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4699c609719bSwdenk	[file transfer complete]
4700c609719bSwdenk	[connected]
4701c609719bSwdenk	## Start Addr = 0x00040004
4702c609719bSwdenk
4703c609719bSwdenk	=> go 40004
4704c609719bSwdenk	## Starting application at 0x00040004 ...
4705c609719bSwdenk	TIMERS=0xfff00980
4706c609719bSwdenk	Using timer 1
4707c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4708c609719bSwdenk
4709c609719bSwdenkHit 'b':
4710c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4711c609719bSwdenk	Enabling timer
4712c609719bSwdenkHit '?':
4713c609719bSwdenk	[q, b, e, ?] ........
4714c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4715c609719bSwdenkHit '?':
4716c609719bSwdenk	[q, b, e, ?] .
4717c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4718c609719bSwdenkHit '?':
4719c609719bSwdenk	[q, b, e, ?] .
4720c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4721c609719bSwdenkHit '?':
4722c609719bSwdenk	[q, b, e, ?] .
4723c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4724c609719bSwdenkHit 'e':
4725c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4726c609719bSwdenkHit 'q':
4727c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4728c609719bSwdenk
4729c609719bSwdenk
473085ec0bccSwdenkMinicom warning:
473185ec0bccSwdenk================
473285ec0bccSwdenk
47337152b1d0SwdenkOver time, many people have reported problems when trying to use the
473485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
473585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4736f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
473785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4738e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4739e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4740e53515a2SKarl O. Pincfor help with kermit.
4741e53515a2SKarl O. Pinc
474285ec0bccSwdenk
474352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
474452f52c14Swdenkconfiguration to your "File transfer protocols" section:
474552f52c14Swdenk
474652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
474752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
474852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
474952f52c14Swdenk
475052f52c14Swdenk
4751c609719bSwdenkNetBSD Notes:
4752c609719bSwdenk=============
4753c609719bSwdenk
4754c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4755c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4756c609719bSwdenk
4757c609719bSwdenkBuilding requires a cross environment; it is known to work on
4758c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4759c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4760c609719bSwdenkNote that the cross-powerpc package does not install include files;
4761c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4762c609719bSwdenkmissing.  This file has to be installed and patched manually:
4763c609719bSwdenk
4764c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4765c609719bSwdenk	# mkdir powerpc
4766c609719bSwdenk	# ln -s powerpc machine
4767c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4768c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4769c609719bSwdenk
4770c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4771c609719bSwdenkand U-Boot include files.
4772c609719bSwdenk
4773c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4774c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4775c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4776c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
47772a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4778c609719bSwdenk
4779c609719bSwdenk
4780c609719bSwdenkImplementation Internals:
4781c609719bSwdenk=========================
4782c609719bSwdenk
4783c609719bSwdenkThe following is not intended to be a complete description of every
4784c609719bSwdenkimplementation detail. However, it should help to understand the
4785c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4786c609719bSwdenkhardware.
4787c609719bSwdenk
4788c609719bSwdenk
4789c609719bSwdenkInitial Stack, Global Data:
4790c609719bSwdenk---------------------------
4791c609719bSwdenk
4792c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4793c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4794c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4795c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4796c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4797c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4798c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4799c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4800c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4801c609719bSwdenklocked as (mis-) used as memory, etc.
4802c609719bSwdenk
48037152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
48040668236bSWolfgang Denk	U-Boot mailing list:
480543d9616cSwdenk
480643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
480743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
480843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
480943d9616cSwdenk	...
481043d9616cSwdenk
481143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
481243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
481343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
481443d9616cSwdenk	is that the cache is being used as a temporary supply of
481543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
481611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
481743d9616cSwdenk	can see how this works by studying the cache architecture and
481843d9616cSwdenk	operation in the architecture and processor-specific manuals.
481943d9616cSwdenk
482043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
482143d9616cSwdenk	is another option for the system designer to use as an
482211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
482343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
482443d9616cSwdenk	board designers haven't used it for something that would
482543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
482643d9616cSwdenk	used.
482743d9616cSwdenk
48286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
482943d9616cSwdenk	with your processor/board/system design. The default value
483043d9616cSwdenk	you will find in any recent u-boot distribution in
48318a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
483243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
483343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
483443d9616cSwdenk	that are supposed to respond to that address! That code in
483543d9616cSwdenk	start.S has been around a while and should work as is when
483643d9616cSwdenk	you get the config right.
483743d9616cSwdenk
483843d9616cSwdenk	-Chris Hallinan
483943d9616cSwdenk	DS4.COM, Inc.
484043d9616cSwdenk
4841c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4842c609719bSwdenkcode for the initialization procedures:
4843c609719bSwdenk
4844c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4845c609719bSwdenk  to write it.
4846c609719bSwdenk
484711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4848c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
48497152b1d0Swdenk  zation is performed later (when relocating to RAM).
4850c609719bSwdenk
4851c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4852c609719bSwdenk  that.
4853c609719bSwdenk
4854c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4855c609719bSwdenknormal global data to share information beween the code. But it
4856c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4857c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4858c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4859c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4860c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4861c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4862c609719bSwdenkreserve for this purpose.
4863c609719bSwdenk
48647152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4865c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4866c609719bSwdenkGCC's implementation.
4867c609719bSwdenk
4868c609719bSwdenkFor PowerPC, the following registers have specific use:
4869c609719bSwdenk	R1:	stack pointer
4870e7670f6cSWolfgang Denk	R2:	reserved for system use
4871c609719bSwdenk	R3-R4:	parameter passing and return values
4872c609719bSwdenk	R5-R10: parameter passing
4873c609719bSwdenk	R13:	small data area pointer
4874c609719bSwdenk	R30:	GOT pointer
4875c609719bSwdenk	R31:	frame pointer
4876c609719bSwdenk
4877e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4878e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4879e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4880c609719bSwdenk
4881e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4882c609719bSwdenk
4883c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4884c609719bSwdenk    address of the global data structure is known at compile time),
4885c609719bSwdenk    but it turned out that reserving a register results in somewhat
4886c609719bSwdenk    smaller code - although the code savings are not that big (on
4887c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4888c609719bSwdenk    624 text + 127 data).
4889c609719bSwdenk
4890c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
48914c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
48924c58eb55SMike Frysinger
4893c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
48944c58eb55SMike Frysinger
4895c609719bSwdenkOn ARM, the following registers are used:
4896c609719bSwdenk
4897c609719bSwdenk	R0:	function argument word/integer result
4898c609719bSwdenk	R1-R3:	function argument word
4899c609719bSwdenk	R9:	GOT pointer
4900c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4901c609719bSwdenk	R11:	argument (frame) pointer
4902c609719bSwdenk	R12:	temporary workspace
4903c609719bSwdenk	R13:	stack pointer
4904c609719bSwdenk	R14:	link register
4905c609719bSwdenk	R15:	program counter
4906c609719bSwdenk
4907c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4908c609719bSwdenk
49090df01fd3SThomas ChouOn Nios II, the ABI is documented here:
49100df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
49110df01fd3SThomas Chou
49120df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
49130df01fd3SThomas Chou
49140df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
49150df01fd3SThomas Chou    to access small data sections, so gp is free.
49160df01fd3SThomas Chou
4917afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4918afc1ce82SMacpaul Lin
4919afc1ce82SMacpaul Lin	R0-R1:	argument/return
4920afc1ce82SMacpaul Lin	R2-R5:	argument
4921afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4922afc1ce82SMacpaul Lin	R16:	trampoline register
4923afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4924afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4925afc1ce82SMacpaul Lin	R30:	link register (LP)
4926afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4927afc1ce82SMacpaul Lin	PC:	program counter (PC)
4928afc1ce82SMacpaul Lin
4929afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4930afc1ce82SMacpaul Lin
4931d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4932d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4933c609719bSwdenk
4934c609719bSwdenkMemory Management:
4935c609719bSwdenk------------------
4936c609719bSwdenk
4937c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4938c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4939c609719bSwdenk
4940c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4941c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4942c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4943c609719bSwdenkphysical memory banks.
4944c609719bSwdenk
4945c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4946c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4947c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4948c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
49496d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4950c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4951c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4952c609719bSwdenk
4953c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4954c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4955c609719bSwdenk
4956c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4957c609719bSwdenkthis:
4958c609719bSwdenk
4959c609719bSwdenk	0x0000 0000	Exception Vector code
4960c609719bSwdenk	      :
4961c609719bSwdenk	0x0000 1FFF
4962c609719bSwdenk	0x0000 2000	Free for Application Use
4963c609719bSwdenk	      :
4964c609719bSwdenk	      :
4965c609719bSwdenk
4966c609719bSwdenk	      :
4967c609719bSwdenk	      :
4968c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4969c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4970c609719bSwdenk	0x00FC 0000	Malloc Arena
4971c609719bSwdenk	      :
4972c609719bSwdenk	0x00FD FFFF
4973c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4974c609719bSwdenk	...		eventually: LCD or video framebuffer
4975c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4976c609719bSwdenk	0x00FF FFFF	[End of RAM]
4977c609719bSwdenk
4978c609719bSwdenk
4979c609719bSwdenkSystem Initialization:
4980c609719bSwdenk----------------------
4981c609719bSwdenk
4982c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
498311ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4984c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
49857152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4986c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4987c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4988c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4989c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4990c609719bSwdenkthe caches and the SIU.
4991c609719bSwdenk
4992c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4993c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4994c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4995c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4996c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4997c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4998c609719bSwdenkbanks.
4999c609719bSwdenk
5000c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
50017152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5002c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5003c609719bSwdenk0x00000000, with any additional banks following immediately to create
5004c609719bSwdenkcontiguous memory starting from 0.
5005c609719bSwdenk
5006c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5007c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5008c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5009c609719bSwdenkpages, and the final stack is set up.
5010c609719bSwdenk
5011c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5012c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5013c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5014c609719bSwdenknew address in RAM.
5015c609719bSwdenk
5016c609719bSwdenk
5017c609719bSwdenkU-Boot Porting Guide:
5018c609719bSwdenk----------------------
5019c609719bSwdenk
5020c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
50216aff3115Swdenklist, October 2002]
5022c609719bSwdenk
5023c609719bSwdenk
5024c609719bSwdenkint main(int argc, char *argv[])
5025c609719bSwdenk{
5026c609719bSwdenk	sighandler_t no_more_time;
5027c609719bSwdenk
5028c609719bSwdenk	signal(SIGALRM, no_more_time);
5029c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5030c609719bSwdenk
5031c609719bSwdenk	if (available_money > available_manpower) {
50326c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5033c609719bSwdenk		return 0;
5034c609719bSwdenk	}
5035c609719bSwdenk
5036c609719bSwdenk	Download latest U-Boot source;
5037c609719bSwdenk
50380668236bSWolfgang Denk	Subscribe to u-boot mailing list;
50396aff3115Swdenk
50406c3fef28SJerry Van Baren	if (clueless)
5041c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5042c609719bSwdenk
5043c609719bSwdenk	while (learning) {
5044c609719bSwdenk		Read the README file in the top level directory;
50457cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
50466c3fef28SJerry Van Baren		Read applicable doc/*.README;
5047c609719bSwdenk		Read the source, Luke;
50486c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5049c609719bSwdenk	}
5050c609719bSwdenk
50516c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
50526c3fef28SJerry Van Baren		Buy a BDI3000;
50536c3fef28SJerry Van Baren	else
5054c609719bSwdenk		Add a lot of aggravation and time;
5055c609719bSwdenk
50566c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
50576c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
50586c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
50596c3fef28SJerry Van Baren	} else {
5060c609719bSwdenk		Create your own board support subdirectory;
50616c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
50626c3fef28SJerry Van Baren	}
50636c3fef28SJerry Van Baren	Edit new board/<myboard> files
50646c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5065c609719bSwdenk
50666c3fef28SJerry Van Baren	while (!accepted) {
5067c609719bSwdenk		while (!running) {
5068c609719bSwdenk			do {
5069c609719bSwdenk				Add / modify source code;
5070c609719bSwdenk			} until (compiles);
5071c609719bSwdenk			Debug;
5072c609719bSwdenk			if (clueless)
5073c609719bSwdenk				email("Hi, I am having problems...");
5074c609719bSwdenk		}
50756c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
50766c3fef28SJerry Van Baren		if (reasonable critiques)
50776c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
50786c3fef28SJerry Van Baren		else
50796c3fef28SJerry Van Baren			Defend code as written;
50806c3fef28SJerry Van Baren	}
5081c609719bSwdenk
5082c609719bSwdenk	return 0;
5083c609719bSwdenk}
5084c609719bSwdenk
5085c609719bSwdenkvoid no_more_time (int sig)
5086c609719bSwdenk{
5087c609719bSwdenk      hire_a_guru();
5088c609719bSwdenk}
5089c609719bSwdenk
5090c609719bSwdenk
5091c609719bSwdenkCoding Standards:
5092c609719bSwdenk-----------------
5093c609719bSwdenk
5094c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
50952c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
50967ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5097c609719bSwdenk
50982c051651SDetlev ZundelSource files originating from a different project (for example the
50992c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
51002c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
51012c051651SDetlev Zundelsources.
51022c051651SDetlev Zundel
51032c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
51042c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
51052c051651SDetlev Zundelin your code.
5106c609719bSwdenk
5107c178d3daSwdenkPlease also stick to the following formatting rules:
5108180d3f74Swdenk- remove any trailing white space
51097ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5110180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
51117ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5112180d3f74Swdenk- do not add trailing empty lines to source files
5113180d3f74Swdenk
5114c609719bSwdenkSubmissions which do not conform to the standards may be returned
5115c609719bSwdenkwith a request to reformat the changes.
5116c609719bSwdenk
5117c609719bSwdenk
5118c609719bSwdenkSubmitting Patches:
5119c609719bSwdenk-------------------
5120c609719bSwdenk
5121c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5122c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5123c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5124c609719bSwdenk
51250d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5126218ca724SWolfgang Denk
51270668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
51280668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
51290668236bSWolfgang Denk
5130c609719bSwdenkWhen you send a patch, please include the following information with
5131c609719bSwdenkit:
5132c609719bSwdenk
5133c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5134c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5135c609719bSwdenk  patch actually fixes something.
5136c609719bSwdenk
5137c609719bSwdenk* For new features: a description of the feature and your
5138c609719bSwdenk  implementation.
5139c609719bSwdenk
5140c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5141c609719bSwdenk
5142c609719bSwdenk* For major contributions, your entry to the CREDITS file
5143c609719bSwdenk
5144c609719bSwdenk* When you add support for a new board, don't forget to add this
51457ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5146c609719bSwdenk
5147c609719bSwdenk* If your patch adds new configuration options, don't forget to
5148c609719bSwdenk  document these in the README file.
5149c609719bSwdenk
5150218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5151218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
51527ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5153218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5154218ca724SWolfgang Denk  with some other mail clients.
5155c609719bSwdenk
5156218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5157218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5158218ca724SWolfgang Denk  GNU diff.
51596dff5529Swdenk
5160218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5161218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5162218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5163218ca724SWolfgang Denk  affected files).
5164218ca724SWolfgang Denk
5165218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5166218ca724SWolfgang Denk  and compressed attachments must not be used.
5167c609719bSwdenk
516852f52c14Swdenk* If one logical set of modifications affects or creates several
516952f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
517052f52c14Swdenk
517152f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
517252f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
517352f52c14Swdenk
517452f52c14Swdenk
5175c609719bSwdenkNotes:
5176c609719bSwdenk
5177c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5178c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5179c609719bSwdenk  for any of the boards.
5180c609719bSwdenk
5181c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5182c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5183c609719bSwdenk  returned with a request to re-formatting / split it.
5184c609719bSwdenk
5185c609719bSwdenk* If you modify existing code, make sure that your new code does not
5186c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5187c609719bSwdenk  When adding new features, these should compile conditionally only
5188c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5189c609719bSwdenk  disabled must not need more memory than the old code without your
5190c609719bSwdenk  modification.
519190dc6704Swdenk
51920668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
51930668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
51940668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
51950668236bSWolfgang Denk  bigger than the size limit should be avoided.
5196