xref: /openbmc/u-boot/README (revision ca2fca22)
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
66433a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
66533a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
66633a35bbbSPali Rohár		erase functions and limited graphics rendition control).
66733a35bbbSPali Rohár
668c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
669c609719bSwdenk		default i/o. Serial console can be forced with
670c609719bSwdenk		environment 'console=serial'.
671c609719bSwdenk
672a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
673a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
674a3ad8e26Swdenk		the "silent" environment variable. See
675a3ad8e26Swdenk		doc/README.silent for more information.
676a3ad8e26Swdenk
677c609719bSwdenk- Console Baudrate:
678c609719bSwdenk		CONFIG_BAUDRATE - in bps
679c609719bSwdenk		Select one of the baudrates listed in
6806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
682c609719bSwdenk
683c92fac91SHeiko Schocher- Console Rx buffer length
684c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
685c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6862b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
687c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
688c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
689c92fac91SHeiko Schocher		the SMC.
690c92fac91SHeiko Schocher
6919558b48aSGraeme Russ- Pre-Console Buffer:
6929558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6939558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6949558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6959558b48aSGraeme Russ		buffer any console messages prior to the console being
6969558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6979558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6989558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6999558b48aSGraeme Russ		bytes are output before the console is initialised, the
7009558b48aSGraeme Russ		earlier bytes are discarded.
7019558b48aSGraeme Russ
7029558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7039558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7049558b48aSGraeme Russ
705046a37bdSSonny Rao- Safe printf() functions
706046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
707046a37bdSSonny Rao		the printf() functions. These are defined in
708046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
709046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
710046a37bdSSonny Rao		If this option is not given then these functions will
711046a37bdSSonny Rao		silently discard their buffer size argument - this means
712046a37bdSSonny Rao		you are not getting any overflow checking in this case.
713046a37bdSSonny Rao
714c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
715c609719bSwdenk		Delay before automatically booting the default image;
716c609719bSwdenk		set to -1 to disable autoboot.
71793d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
71893d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
719c609719bSwdenk
720c609719bSwdenk		See doc/README.autoboot for these options that
721c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
722c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
723c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
724c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
725c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
726c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
727c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
728c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
729c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
730c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
731c609719bSwdenk		CONFIG_RESET_TO_RETRY
732c609719bSwdenk
733c609719bSwdenk- Autoboot Command:
734c609719bSwdenk		CONFIG_BOOTCOMMAND
735c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
736c609719bSwdenk		define a command string that is automatically executed
737c609719bSwdenk		when no character is read on the console interface
738c609719bSwdenk		within "Boot Delay" after reset.
739c609719bSwdenk
740c609719bSwdenk		CONFIG_BOOTARGS
741c609719bSwdenk		This can be used to pass arguments to the bootm
742c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
743c609719bSwdenk		environment value "bootargs".
744c609719bSwdenk
745c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
746c609719bSwdenk		The value of these goes into the environment as
747c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
748c609719bSwdenk		as a convenience, when switching between booting from
74911ccc33fSMarcel Ziswiler		RAM and NFS.
750c609719bSwdenk
751c609719bSwdenk- Pre-Boot Commands:
752c609719bSwdenk		CONFIG_PREBOOT
753c609719bSwdenk
754c609719bSwdenk		When this option is #defined, the existence of the
755c609719bSwdenk		environment variable "preboot" will be checked
756c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
757c609719bSwdenk		countdown and/or running the auto-boot command resp.
758c609719bSwdenk		entering interactive mode.
759c609719bSwdenk
760c609719bSwdenk		This feature is especially useful when "preboot" is
761c609719bSwdenk		automatically generated or modified. For an example
762c609719bSwdenk		see the LWMON board specific code: here "preboot" is
763c609719bSwdenk		modified when the user holds down a certain
764c609719bSwdenk		combination of keys on the (special) keyboard when
765c609719bSwdenk		booting the systems
766c609719bSwdenk
767c609719bSwdenk- Serial Download Echo Mode:
768c609719bSwdenk		CONFIG_LOADS_ECHO
769c609719bSwdenk		If defined to 1, all characters received during a
770c609719bSwdenk		serial download (using the "loads" command) are
771c609719bSwdenk		echoed back. This might be needed by some terminal
772c609719bSwdenk		emulations (like "cu"), but may as well just take
773c609719bSwdenk		time on others. This setting #define's the initial
774c609719bSwdenk		value of the "loads_echo" environment variable.
775c609719bSwdenk
776602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
777c609719bSwdenk		CONFIG_KGDB_BAUDRATE
778c609719bSwdenk		Select one of the baudrates listed in
7796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
780c609719bSwdenk
781c609719bSwdenk- Monitor Functions:
782602ad3b3SJon Loeliger		Monitor commands can be included or excluded
783602ad3b3SJon Loeliger		from the build by using the #include files
784c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
785c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
786602ad3b3SJon Loeliger		and augmenting with additional #define's
787602ad3b3SJon Loeliger		for wanted commands.
788c609719bSwdenk
789602ad3b3SJon Loeliger		The default command configuration includes all commands
790602ad3b3SJon Loeliger		except those marked below with a "*".
791602ad3b3SJon Loeliger
792602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
793602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
794602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
795602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
796602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
797602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
798602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
799602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
800710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
801602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
802602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
803602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
804a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
805a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
806a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
807a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
808602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
809602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
810246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
811602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
812602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8130c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
81403e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
81503e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
816bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
817602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
81803e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
819602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
820602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
821602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
822a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
823a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
824602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
825602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
826602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
827602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
828602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
829602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8300c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
831c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
832602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
833602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
834602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
835602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8361ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
837d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
838d22c338eSJoe Hershberger					  (169.254.*.*)
839602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
840602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
84102c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
84202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
843602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
84456523f12Swdenk					  loop, loopw, mtest
845602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
846602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
847602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
84868d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
849602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
850602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
851e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
852e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
853602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
854602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
855602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
856602ad3b3SJon Loeliger					  host
857602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
858602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
859602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
860602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
861602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
862602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
863602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
864602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
865602ad3b3SJon Loeliger					  (4xx only)
866f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
867c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
86802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
86974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
870602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8717a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8721fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
873da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
874da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
875602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
876602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
877c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
878c609719bSwdenk
879c609719bSwdenk
880c609719bSwdenk		EXAMPLE: If you want all functions except of network
881c609719bSwdenk		support you can write:
882c609719bSwdenk
883602ad3b3SJon Loeliger		#include "config_cmd_all.h"
884602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
885c609719bSwdenk
886213bf8c8SGerald Van Baren	Other Commands:
887213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
888c609719bSwdenk
889c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
890602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
891c609719bSwdenk		what you (and your U-Boot users) are doing. Data
892c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
893c609719bSwdenk		8260 (where accesses to the IMMR region must be
894c609719bSwdenk		uncached), and it cannot be disabled on all other
895c609719bSwdenk		systems where we (mis-) use the data cache to hold an
896c609719bSwdenk		initial stack and some data.
897c609719bSwdenk
898c609719bSwdenk
899c609719bSwdenk		XXX - this list needs to get updated!
900c609719bSwdenk
90145ba8077SSimon Glass- Device tree:
90245ba8077SSimon Glass		CONFIG_OF_CONTROL
90345ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
90445ba8077SSimon Glass		to configure its devices, instead of relying on statically
90545ba8077SSimon Glass		compiled #defines in the board file. This option is
90645ba8077SSimon Glass		experimental and only available on a few boards. The device
90745ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
90845ba8077SSimon Glass
9092c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9102c0f79e4SSimon Glass		be done using one of the two options below:
911bbb0b128SSimon Glass
912bbb0b128SSimon Glass		CONFIG_OF_EMBED
913bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
914bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
915bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
916bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
917bbb0b128SSimon Glass		the global data structure as gd->blob.
91845ba8077SSimon Glass
9192c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9202c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9212c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9222c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9232c0f79e4SSimon Glass
9242c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9252c0f79e4SSimon Glass
9262c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9272c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9282c0f79e4SSimon Glass		still use the individual files if you need something more
9292c0f79e4SSimon Glass		exotic.
9302c0f79e4SSimon Glass
931c609719bSwdenk- Watchdog:
932c609719bSwdenk		CONFIG_WATCHDOG
933c609719bSwdenk		If this variable is defined, it enables watchdog
9346abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9356abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9366abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9376abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9386abe6fb6SDetlev Zundel		available, then no further board specific code should
9396abe6fb6SDetlev Zundel		be needed to use it.
9406abe6fb6SDetlev Zundel
9416abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9426abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9436abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9446abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
945c609719bSwdenk
946c1551ea8Sstroese- U-Boot Version:
947c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
948c1551ea8Sstroese		If this variable is defined, an environment variable
949c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
950c1551ea8Sstroese		version as printed by the "version" command.
951a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
952a1ea8e51SBenoît Thébaudeau		next reset.
953c1551ea8Sstroese
954c609719bSwdenk- Real-Time Clock:
955c609719bSwdenk
956602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
957c609719bSwdenk		has to be selected, too. Define exactly one of the
958c609719bSwdenk		following options:
959c609719bSwdenk
960c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
961c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9624e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
963c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9641cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
965c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9667f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9673bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9689536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9694c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
97171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
97271d19f30SHeiko Schocher					  RV3029 RTC.
973c609719bSwdenk
974b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
975b37c7e5eSwdenk		must also be configured. See I2C Support, below.
976b37c7e5eSwdenk
977e92739d3SPeter Tyser- GPIO Support:
978e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
979e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
980e92739d3SPeter Tyser
9815dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9825dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9835dec49caSChris Packham		pins supported by a particular chip.
9845dec49caSChris Packham
985e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
986e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
987e92739d3SPeter Tyser
988c609719bSwdenk- Timestamp Support:
989c609719bSwdenk
990c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
991c609719bSwdenk		(date and time) of an image is printed by image
992c609719bSwdenk		commands like bootm or iminfo. This option is
993602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
994c609719bSwdenk
995923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
996923c46f9SKarl O. Pinc		Zero or more of the following:
997923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
998923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
999923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1000923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1001923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1002923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1003923c46f9SKarl O. Pinc				       disk/part_efi.c
1004923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1005c609719bSwdenk
1006602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1007218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1008923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1009c609719bSwdenk
1010c609719bSwdenk- IDE Reset method:
10114d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10124d13cbadSwdenk		board configurations files but used nowhere!
1013c609719bSwdenk
10144d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10154d13cbadSwdenk		be performed by calling the function
10164d13cbadSwdenk			ide_set_reset(int reset)
10174d13cbadSwdenk		which has to be defined in a board specific file
1018c609719bSwdenk
1019c609719bSwdenk- ATAPI Support:
1020c609719bSwdenk		CONFIG_ATAPI
1021c609719bSwdenk
1022c609719bSwdenk		Set this to enable ATAPI support.
1023c609719bSwdenk
1024c40b2956Swdenk- LBA48 Support
1025c40b2956Swdenk		CONFIG_LBA48
1026c40b2956Swdenk
1027c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10284b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1029c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1030c40b2956Swdenk		support disks up to 2.1TB.
1031c40b2956Swdenk
10326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1033c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1034c40b2956Swdenk			Default is 32bit.
1035c40b2956Swdenk
1036c609719bSwdenk- SCSI Support:
1037c609719bSwdenk		At the moment only there is only support for the
1038c609719bSwdenk		SYM53C8XX SCSI controller; define
1039c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1040c609719bSwdenk
10416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1044c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1045c609719bSwdenk		devices.
10466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1047c609719bSwdenk
1048447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1049447c031bSStefan Reinauer                SCSI devices found during the last scan.
1050447c031bSStefan Reinauer
1051c609719bSwdenk- NETWORK Support (PCI):
1052682011ffSwdenk		CONFIG_E1000
1053ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1054ce5207e1SKyle Moffett
1055ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1056ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1057ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1058ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1059ce5207e1SKyle Moffett
1060ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1061ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1062ce5207e1SKyle Moffett		example with the "sspi" command.
1063ce5207e1SKyle Moffett
1064ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1065ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1066ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1067682011ffSwdenk
1068ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
106911ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1070ac3315c2SAndre Schwarz
1071c609719bSwdenk		CONFIG_EEPRO100
1072c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
107311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1074c609719bSwdenk		write routine for first time initialisation.
1075c609719bSwdenk
1076c609719bSwdenk		CONFIG_TULIP
1077c609719bSwdenk		Support for Digital 2114x chips.
1078c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1079c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1080c609719bSwdenk
1081c609719bSwdenk		CONFIG_NATSEMI
1082c609719bSwdenk		Support for National dp83815 chips.
1083c609719bSwdenk
1084c609719bSwdenk		CONFIG_NS8382X
1085c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1086c609719bSwdenk
108745219c46Swdenk- NETWORK Support (other):
108845219c46Swdenk
1089c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1090c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1091c041e9d2SJens Scharsig
1092c041e9d2SJens Scharsig			CONFIG_RMII
1093c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1094c041e9d2SJens Scharsig
1095c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1096c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1097c041e9d2SJens Scharsig			The driver doen't show link status messages.
1098c041e9d2SJens Scharsig
1099efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1100efdd7319SRob Herring		Support for the Calxeda XGMAC device
1101efdd7319SRob Herring
11023bb46d23SAshok		CONFIG_LAN91C96
110345219c46Swdenk		Support for SMSC's LAN91C96 chips.
110445219c46Swdenk
110545219c46Swdenk			CONFIG_LAN91C96_BASE
110645219c46Swdenk			Define this to hold the physical address
110745219c46Swdenk			of the LAN91C96's I/O space
110845219c46Swdenk
110945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
111045219c46Swdenk			Define this to enable 32 bit addressing
111145219c46Swdenk
11123bb46d23SAshok		CONFIG_SMC91111
1113f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1114f39748aeSwdenk
1115f39748aeSwdenk			CONFIG_SMC91111_BASE
1116f39748aeSwdenk			Define this to hold the physical address
1117f39748aeSwdenk			of the device (I/O space)
1118f39748aeSwdenk
1119f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1120f39748aeSwdenk			Define this if data bus is 32 bits
1121f39748aeSwdenk
1122f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1123f39748aeSwdenk			Define this to use i/o functions instead of macros
1124f39748aeSwdenk			(some hardware wont work with macros)
1125f39748aeSwdenk
1126dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1127dc02badaSHeiko Schocher		Support for davinci emac
1128dc02badaSHeiko Schocher
1129dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1130dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1131dc02badaSHeiko Schocher
1132b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1133b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1134b3dbf4a5SMacpaul Lin
1135b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1136b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1137b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1138b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1139b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1140b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1141b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1142b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1143b3dbf4a5SMacpaul Lin
1144c2fff331SMike Rapoport		CONFIG_SMC911X
1145557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1146557b377dSJens Gehrlein
1147c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1148557b377dSJens Gehrlein			Define this to hold the physical address
1149557b377dSJens Gehrlein			of the device (I/O space)
1150557b377dSJens Gehrlein
1151c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1152557b377dSJens Gehrlein			Define this if data bus is 32 bits
1153557b377dSJens Gehrlein
1154c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1155557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1156557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1157c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1158557b377dSJens Gehrlein
11593d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11603d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11613d0075faSYoshihiro Shimoda
11623d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11633d0075faSYoshihiro Shimoda			Define the number of ports to be used
11643d0075faSYoshihiro Shimoda
11653d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11663d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11673d0075faSYoshihiro Shimoda
116868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
116968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
117068260aabSYoshihiro Shimoda
11715e124724SVadim Bendebury- TPM Support:
11725e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11735e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11745e124724SVadim Bendebury		per system is supported at this time.
11755e124724SVadim Bendebury
11765e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11775e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11785e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11795e124724SVadim Bendebury			0xfed40000.
11805e124724SVadim Bendebury
1181c609719bSwdenk- USB Support:
1182c609719bSwdenk		At the moment only the UHCI host controller is
11834d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1184c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1185c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
118630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1187c609719bSwdenk		storage devices.
1188c609719bSwdenk		Note:
1189c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1190c609719bSwdenk		(TEAC FD-05PUB).
11914d13cbadSwdenk		MPC5200 USB requires additional defines:
11924d13cbadSwdenk			CONFIG_USB_CLOCK
11934d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1194307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1195307ecb6dSEric Millbrandt				for USB on PSC3
11964d13cbadSwdenk			CONFIG_USB_CONFIG
11974d13cbadSwdenk				for differential drivers: 0x00001000
11984d13cbadSwdenk				for single ended drivers: 0x00005000
1199307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1200307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1202fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1203fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12044d13cbadSwdenk
12059ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12069ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12079ab4ce22SSimon Glass
120816c8d5e7SWolfgang Denk- USB Device:
120916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
121016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
121116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
121211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
121316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
121416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
121516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
121616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
121716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
121816c8d5e7SWolfgang Denk		a Linux host by
121916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
122016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
122116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
122216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
122316c8d5e7SWolfgang Denk
122416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
122516c8d5e7SWolfgang Denk			Define this to build a UDC device
122616c8d5e7SWolfgang Denk
122716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
122816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
122916c8d5e7SWolfgang Denk			talk to the UDC device
123016c8d5e7SWolfgang Denk
1231f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1232f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1233f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1234f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1235f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1236f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1237f9da0f89SVipin KUMAR			speed.
1238f9da0f89SVipin KUMAR
12396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
124016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
124116c8d5e7SWolfgang Denk			be set to usbtty.
124216c8d5e7SWolfgang Denk
124316c8d5e7SWolfgang Denk			mpc8xx:
12446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
124516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
124716c8d5e7SWolfgang Denk
12486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
124916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
125116c8d5e7SWolfgang Denk
125216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
125316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
125416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
125516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
125616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
125716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
125816c8d5e7SWolfgang Denk
125916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
126016c8d5e7SWolfgang Denk			Define this string as the name of your company for
126116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
126216c8d5e7SWolfgang Denk
126316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
126416c8d5e7SWolfgang Denk			Define this string as the name of your product
126516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
126616c8d5e7SWolfgang Denk
126716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
126816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
126916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
127016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
127116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
127216c8d5e7SWolfgang Denk
127316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
127416c8d5e7SWolfgang Denk			Define this as the unique Product ID
127516c8d5e7SWolfgang Denk			for your device
127616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1277c609719bSwdenk
1278d70a560fSIgor Grinberg- ULPI Layer Support:
1279d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1280d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1281d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1282d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1283d70a560fSIgor Grinberg		viewport is supported.
1284d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1285d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
12866d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
12876d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
12886d365ea0SLucas Stach		the appropriate value in Hz.
1289c609719bSwdenk
1290c609719bSwdenk- MMC Support:
1291c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1292c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1293c609719bSwdenk		accessed from the boot prompt by mapping the device
1294c609719bSwdenk		to physical memory similar to flash. Command line is
1295602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1296602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1297c609719bSwdenk
1298afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1299afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1300afb35666SYoshihiro Shimoda
1301afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1302afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1303afb35666SYoshihiro Shimoda
1304afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1305afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1306afb35666SYoshihiro Shimoda
13076705d81eSwdenk- Journaling Flash filesystem support:
13086705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
13096705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
13106705d81eSwdenk		Define these for a default partition on a NAND device
13116705d81eSwdenk
13126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
13136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
13146705d81eSwdenk		Define these for a default partition on a NOR device
13156705d81eSwdenk
13166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
13176705d81eSwdenk		Define this to create an own partition. You have to provide a
13186705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
13196705d81eSwdenk
13206705d81eSwdenk		If you define only one JFFS2 partition you may also want to
13216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
13226705d81eSwdenk		to disable the command chpart. This is the default when you
13236705d81eSwdenk		have not defined a custom partition
13246705d81eSwdenk
1325c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1326c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1327656f4c65SDonggeun Kim
1328656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1329656f4c65SDonggeun Kim		file in FAT formatted partition.
1330656f4c65SDonggeun Kim
1331656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1332656f4c65SDonggeun Kim		user to write files to FAT.
1333c30a15e5SDonggeun Kim
133484cd9327SGabe BlackCBFS (Coreboot Filesystem) support
133584cd9327SGabe Black		CONFIG_CMD_CBFS
133684cd9327SGabe Black
133784cd9327SGabe Black		Define this to enable support for reading from a Coreboot
133884cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
133984cd9327SGabe Black		and cbfsload.
134084cd9327SGabe Black
1341c609719bSwdenk- Keyboard Support:
1342c609719bSwdenk		CONFIG_ISA_KEYBOARD
1343c609719bSwdenk
1344c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1345c609719bSwdenk		support
1346c609719bSwdenk
1347c609719bSwdenk		CONFIG_I8042_KBD
1348c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1349c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1350c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1351c609719bSwdenk		for cfb_console. Supports cursor blinking.
1352c609719bSwdenk
1353c609719bSwdenk- Video support:
1354c609719bSwdenk		CONFIG_VIDEO
1355c609719bSwdenk
1356c609719bSwdenk		Define this to enable video support (for output to
1357c609719bSwdenk		video).
1358c609719bSwdenk
1359c609719bSwdenk		CONFIG_VIDEO_CT69000
1360c609719bSwdenk
1361c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1362c609719bSwdenk
1363c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1364eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1365eeb1b77bSwdenk		video output is selected via environment 'videoout'
1366eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1367eeb1b77bSwdenk		assumed.
1368c609719bSwdenk
1369eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
137011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1371eeb1b77bSwdenk		are possible:
1372eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1373eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1374eeb1b77bSwdenk
1375eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1376eeb1b77bSwdenk		-------------+---------------------------------------------
1377eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1378eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1379eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1380eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1381eeb1b77bSwdenk		-------------+---------------------------------------------
1382c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1383c609719bSwdenk
1384eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13857817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1386eeb1b77bSwdenk
1387eeb1b77bSwdenk
1388a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1389a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1390a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1391a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1392a6c7ad2fSwdenk
13937d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13947d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13957d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13967d3053fbSTimur Tabi		support, and should also define these other macros:
13977d3053fbSTimur Tabi
13987d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13997d3053fbSTimur Tabi			CONFIG_VIDEO
14007d3053fbSTimur Tabi			CONFIG_CMD_BMP
14017d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14027d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14037d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14047d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14057d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14067d3053fbSTimur Tabi
1407ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1408ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1409ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1410ba8e76bdSTimur Tabi		description of this variable.
14117d3053fbSTimur Tabi
1412682011ffSwdenk- Keyboard Support:
1413682011ffSwdenk		CONFIG_KEYBOARD
1414682011ffSwdenk
1415682011ffSwdenk		Define this to enable a custom keyboard support.
1416682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1417682011ffSwdenk		defined in your board-specific files.
1418682011ffSwdenk		The only board using this so far is RBC823.
1419a6c7ad2fSwdenk
1420c609719bSwdenk- LCD Support:	CONFIG_LCD
1421c609719bSwdenk
1422c609719bSwdenk		Define this to enable LCD support (for output to LCD
1423c609719bSwdenk		display); also select one of the supported displays
1424c609719bSwdenk		by defining one of these:
1425c609719bSwdenk
142639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
142739cf4804SStelian Pop
142839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
142939cf4804SStelian Pop
1430fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1431c609719bSwdenk
1432fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1433c609719bSwdenk
1434fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1435c609719bSwdenk
1436fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1437fd3103bbSwdenk			Active, color, single scan.
1438fd3103bbSwdenk
1439fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1440fd3103bbSwdenk
1441fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1442c609719bSwdenk			Active, color, single scan.
1443c609719bSwdenk
1444c609719bSwdenk		CONFIG_SHARP_16x9
1445c609719bSwdenk
1446c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1447c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1448c609719bSwdenk
1449c609719bSwdenk		CONFIG_SHARP_LQ64D341
1450c609719bSwdenk
1451c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1452c609719bSwdenk			Active, color, single scan.
1453c609719bSwdenk
1454c609719bSwdenk		CONFIG_HLD1045
1455c609719bSwdenk
1456c609719bSwdenk			HLD1045 display, 640x480.
1457c609719bSwdenk			Active, color, single scan.
1458c609719bSwdenk
1459c609719bSwdenk		CONFIG_OPTREX_BW
1460c609719bSwdenk
1461c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1462c609719bSwdenk			or
1463c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1464c609719bSwdenk			or
1465c609719bSwdenk			Hitachi	 SP14Q002
1466c609719bSwdenk
1467c609719bSwdenk			320x240. Black & white.
1468c609719bSwdenk
1469c609719bSwdenk		Normally display is black on white background; define
14706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1471c609719bSwdenk
147245d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
147345d7f525STom Wai-Hong Tam
147445d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
147545d7f525STom Wai-Hong Tam
147645d7f525STom Wai-Hong Tam
14777152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1478d791b1dcSwdenk
1479d791b1dcSwdenk		If this option is set, the environment is checked for
1480d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1481d791b1dcSwdenk		of logo, copyright and system information on the LCD
1482e94d2cd9Swdenk		is suppressed and the BMP image at the address
1483d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1484d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1485d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1486d791b1dcSwdenk		loaded very quickly after power-on.
1487d791b1dcSwdenk
14881ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14891ca298ceSMatthias Weisser
14901ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14911ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14921ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14931ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14941ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14951ca298ceSMatthias Weisser		specify 'm' for centering the image.
14961ca298ceSMatthias Weisser
14971ca298ceSMatthias Weisser		Example:
14981ca298ceSMatthias Weisser		setenv splashpos m,m
14991ca298ceSMatthias Weisser			=> image at center of screen
15001ca298ceSMatthias Weisser
15011ca298ceSMatthias Weisser		setenv splashpos 30,20
15021ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
15031ca298ceSMatthias Weisser
15041ca298ceSMatthias Weisser		setenv splashpos -10,m
15051ca298ceSMatthias Weisser			=> vertically centered image
15061ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
15071ca298ceSMatthias Weisser
150898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
150998f4a3dfSStefan Roese
151098f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
151198f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
151298f4a3dfSStefan Roese		splashscreen support or the bmp command.
151398f4a3dfSStefan Roese
1514d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1515d5011762SAnatolij Gustschin
1516d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1517d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1518d5011762SAnatolij Gustschin		bmp command.
1519d5011762SAnatolij Gustschin
1520f2b96dfbSLei Wen- Do compresssing for memory range:
1521f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1522f2b96dfbSLei Wen
1523f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1524f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1525f2b96dfbSLei Wen
1526c29fdfc1Swdenk- Compression support:
1527c29fdfc1Swdenk		CONFIG_BZIP2
1528c29fdfc1Swdenk
1529c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1530c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1531c29fdfc1Swdenk		compressed images are supported.
1532c29fdfc1Swdenk
1533c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
15346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1535c29fdfc1Swdenk		be at least 4MB.
1536d791b1dcSwdenk
1537fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1538fc9c1727SLuigi 'Comio' Mantellini
1539fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1540fc9c1727SLuigi 'Comio' Mantellini		images is included.
1541fc9c1727SLuigi 'Comio' Mantellini
1542fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1543fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1544fc9c1727SLuigi 'Comio' Mantellini		formula:
1545fc9c1727SLuigi 'Comio' Mantellini
1546fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1547fc9c1727SLuigi 'Comio' Mantellini
1548fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1549fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1550fc9c1727SLuigi 'Comio' Mantellini
1551fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1552fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1553fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1554fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1555fc9c1727SLuigi 'Comio' Mantellini
1556fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1557fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
15586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1559fc9c1727SLuigi 'Comio' Mantellini
156017ea1177Swdenk- MII/PHY support:
156117ea1177Swdenk		CONFIG_PHY_ADDR
156217ea1177Swdenk
156317ea1177Swdenk		The address of PHY on MII bus.
156417ea1177Swdenk
156517ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
156617ea1177Swdenk
156717ea1177Swdenk		The clock frequency of the MII bus
156817ea1177Swdenk
156917ea1177Swdenk		CONFIG_PHY_GIGE
157017ea1177Swdenk
157117ea1177Swdenk		If this option is set, support for speed/duplex
157211ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
157317ea1177Swdenk
157417ea1177Swdenk		CONFIG_PHY_RESET_DELAY
157517ea1177Swdenk
157617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
157717ea1177Swdenk		reset before any MII register access is possible.
157817ea1177Swdenk		For such PHY, set this option to the usec delay
157917ea1177Swdenk		required. (minimum 300usec for LXT971A)
158017ea1177Swdenk
158117ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
158217ea1177Swdenk
158317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
158417ea1177Swdenk		command issued before MII status register can be read
158517ea1177Swdenk
1586c609719bSwdenk- Ethernet address:
1587c609719bSwdenk		CONFIG_ETHADDR
1588c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1589c609719bSwdenk		CONFIG_ETH2ADDR
1590c609719bSwdenk		CONFIG_ETH3ADDR
1591c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1592c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1593c609719bSwdenk
159411ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
159511ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1596c609719bSwdenk		is not determined automatically.
1597c609719bSwdenk
1598c609719bSwdenk- IP address:
1599c609719bSwdenk		CONFIG_IPADDR
1600c609719bSwdenk
1601c609719bSwdenk		Define a default value for the IP address to use for
160211ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1603c609719bSwdenk		determined through e.g. bootp.
16041ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1605c609719bSwdenk
1606c609719bSwdenk- Server IP address:
1607c609719bSwdenk		CONFIG_SERVERIP
1608c609719bSwdenk
1609c609719bSwdenk		Defines a default value for the IP address of a TFTP
1610c609719bSwdenk		server to contact when using the "tftboot" command.
16111ebcd654SWolfgang Denk		(Environment variable "serverip")
1612c609719bSwdenk
161397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
161497cfe861SRobin Getz
161597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
161697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
161797cfe861SRobin Getz
16181ebcd654SWolfgang Denk- Gateway IP address:
16191ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16201ebcd654SWolfgang Denk
16211ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16221ebcd654SWolfgang Denk		default router where packets to other networks are
16231ebcd654SWolfgang Denk		sent to.
16241ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16251ebcd654SWolfgang Denk
16261ebcd654SWolfgang Denk- Subnet mask:
16271ebcd654SWolfgang Denk		CONFIG_NETMASK
16281ebcd654SWolfgang Denk
16291ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16301ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16311ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16321ebcd654SWolfgang Denk		forwarded through a router.
16331ebcd654SWolfgang Denk		(Environment variable "netmask")
16341ebcd654SWolfgang Denk
163553a5c424SDavid Updegraff- Multicast TFTP Mode:
163653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
163753a5c424SDavid Updegraff
163853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
163953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
164011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
164153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
164253a5c424SDavid Updegraff		multicast group.
164353a5c424SDavid Updegraff
1644c609719bSwdenk- BOOTP Recovery Mode:
1645c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1646c609719bSwdenk
1647c609719bSwdenk		If you have many targets in a network that try to
1648c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1649c609719bSwdenk		systems send out BOOTP requests at precisely the same
1650c609719bSwdenk		moment (which would happen for instance at recovery
1651c609719bSwdenk		from a power failure, when all systems will try to
1652c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1653c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1654c609719bSwdenk		inserted before sending out BOOTP requests. The
16556c33c785SWolfgang Denk		following delays are inserted then:
1656c609719bSwdenk
1657c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1658c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1659c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1660c609719bSwdenk		4th and following
1661c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1662c609719bSwdenk
1663fe389a82Sstroese- DHCP Advanced Options:
16641fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
16651fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1666fe389a82Sstroese
16671fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
16681fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
16691fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16701fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16711fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16721fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16731fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16741fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16751fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16761fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16771fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16781fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16792c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1680fe389a82Sstroese
16815d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16825d110f0aSWilson Callan		environment variable, not the BOOTP server.
1683fe389a82Sstroese
16842c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16852c00e099SJoe Hershberger		after the configured retry count, the call will fail
16862c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16872c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16882c00e099SJoe Hershberger		is not available.
16892c00e099SJoe Hershberger
1690fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1691fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1692fe389a82Sstroese		than one DNS serverip is offered to the client.
1693fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1694fe389a82Sstroese		serverip will be stored in the additional environment
1695fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1696fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16971fe80d79SJon Loeliger		is defined.
1698fe389a82Sstroese
1699fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1700fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1701fe389a82Sstroese		need the hostname of the DHCP requester.
17025d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
17031fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
17041fe80d79SJon Loeliger		option 12 to the DHCP server.
1705fe389a82Sstroese
1706d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1707d9a2f416SAras Vaichas
1708d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1709d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1710d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1711d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1712d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1713d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1714d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1715d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1716d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1717d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1718d9a2f416SAras Vaichas		this delay.
1719d9a2f416SAras Vaichas
1720d22c338eSJoe Hershberger - Link-local IP address negotiation:
1721d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1722d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1723d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1724d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1725d22c338eSJoe Hershberger
1726d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1727d22c338eSJoe Hershberger
1728a3d991bdSwdenk - CDP Options:
1729a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1730a3d991bdSwdenk
1731a3d991bdSwdenk		The device id used in CDP trigger frames.
1732a3d991bdSwdenk
1733a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1734a3d991bdSwdenk
1735a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1736a3d991bdSwdenk		of the device.
1737a3d991bdSwdenk
1738a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1739a3d991bdSwdenk
1740a3d991bdSwdenk		A printf format string which contains the ascii name of
1741a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
174211ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1743a3d991bdSwdenk
1744a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1745a3d991bdSwdenk
1746a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1747a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1748a3d991bdSwdenk
1749a3d991bdSwdenk		CONFIG_CDP_VERSION
1750a3d991bdSwdenk
1751a3d991bdSwdenk		An ascii string containing the version of the software.
1752a3d991bdSwdenk
1753a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1754a3d991bdSwdenk
1755a3d991bdSwdenk		An ascii string containing the name of the platform.
1756a3d991bdSwdenk
1757a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1758a3d991bdSwdenk
1759a3d991bdSwdenk		A 32bit integer sent on the trigger.
1760a3d991bdSwdenk
1761a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1762a3d991bdSwdenk
1763a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1764a3d991bdSwdenk		device in .1 of milliwatts.
1765a3d991bdSwdenk
1766a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1767a3d991bdSwdenk
1768a3d991bdSwdenk		A byte containing the id of the VLAN.
1769a3d991bdSwdenk
1770c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1771c609719bSwdenk
1772c609719bSwdenk		Several configurations allow to display the current
1773c609719bSwdenk		status using a LED. For instance, the LED will blink
1774c609719bSwdenk		fast while running U-Boot code, stop blinking as
1775c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1776c609719bSwdenk		start blinking slow once the Linux kernel is running
1777c609719bSwdenk		(supported by a status LED driver in the Linux
1778c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1779c609719bSwdenk		feature in U-Boot.
1780c609719bSwdenk
1781c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1782c609719bSwdenk
1783c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1784c609719bSwdenk		on those systems that support this (optional)
1785c609719bSwdenk		feature, like the TQM8xxL modules.
1786c609719bSwdenk
1787c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1788c609719bSwdenk
1789b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1790b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
179111ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1792c609719bSwdenk
1793b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1794602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1795b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1796b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1797c609719bSwdenk		command line interface.
1798c609719bSwdenk
1799bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1800c609719bSwdenk
1801b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1802b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1803b37c7e5eSwdenk		support for I2C.
1804c609719bSwdenk
1805b37c7e5eSwdenk		There are several other quantities that must also be
1806b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1807c609719bSwdenk
18086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1809b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
18106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
181111ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1812c609719bSwdenk
18138d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1814a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
18158d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
18168d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
18178d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1818b37c7e5eSwdenk
18195da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
18205da71efaSEric Millbrandt
18215da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
18225da71efaSEric Millbrandt		chips might think that the current transfer is still
18235da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
18245da71efaSEric Millbrandt		commands until the slave device responds.
18255da71efaSEric Millbrandt
1826b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1827b37c7e5eSwdenk
1828b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1829b37c7e5eSwdenk		then the following macros need to be defined (examples are
1830b37c7e5eSwdenk		from include/configs/lwmon.h):
1831c609719bSwdenk
1832c609719bSwdenk		I2C_INIT
1833c609719bSwdenk
1834b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1835c609719bSwdenk		controller or configure ports.
1836c609719bSwdenk
1837b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1838b37c7e5eSwdenk
1839c609719bSwdenk		I2C_PORT
1840c609719bSwdenk
1841c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1842c609719bSwdenk		assumes both bits are on the same port). Valid values
1843c609719bSwdenk		are 0..3 for ports A..D.
1844c609719bSwdenk
1845c609719bSwdenk		I2C_ACTIVE
1846c609719bSwdenk
1847c609719bSwdenk		The code necessary to make the I2C data line active
1848c609719bSwdenk		(driven).  If the data line is open collector, this
1849c609719bSwdenk		define can be null.
1850c609719bSwdenk
1851b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1852b37c7e5eSwdenk
1853c609719bSwdenk		I2C_TRISTATE
1854c609719bSwdenk
1855c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1856c609719bSwdenk		(inactive).  If the data line is open collector, this
1857c609719bSwdenk		define can be null.
1858c609719bSwdenk
1859b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1860b37c7e5eSwdenk
1861c609719bSwdenk		I2C_READ
1862c609719bSwdenk
1863c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1864c609719bSwdenk		FALSE if it is low.
1865c609719bSwdenk
1866b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1867b37c7e5eSwdenk
1868c609719bSwdenk		I2C_SDA(bit)
1869c609719bSwdenk
1870c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1871c609719bSwdenk		is FALSE, it clears it (low).
1872c609719bSwdenk
1873b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1874b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1875b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1876b37c7e5eSwdenk
1877c609719bSwdenk		I2C_SCL(bit)
1878c609719bSwdenk
1879c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1880c609719bSwdenk		is FALSE, it clears it (low).
1881c609719bSwdenk
1882b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1883b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1884b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1885b37c7e5eSwdenk
1886c609719bSwdenk		I2C_DELAY
1887c609719bSwdenk
1888c609719bSwdenk		This delay is invoked four times per clock cycle so this
1889c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1890b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1891b37c7e5eSwdenk		like:
1892b37c7e5eSwdenk
1893b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1894c609719bSwdenk
1895793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1896793b5726SMike Frysinger
1897793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1898793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1899793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1900793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1901793b5726SMike Frysinger
1902793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1903793b5726SMike Frysinger		the generic GPIO functions.
1904793b5726SMike Frysinger
19056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
190647cd00faSwdenk
190747cd00faSwdenk		When a board is reset during an i2c bus transfer
190847cd00faSwdenk		chips might think that the current transfer is still
190947cd00faSwdenk		in progress. On some boards it is possible to access
191047cd00faSwdenk		the i2c SCLK line directly, either by using the
191147cd00faSwdenk		processor pin as a GPIO or by having a second pin
191247cd00faSwdenk		connected to the bus. If this option is defined a
191347cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
191447cd00faSwdenk		is run early in the boot sequence.
191547cd00faSwdenk
191626a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
191726a33504SRichard Retanubun
191826a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
191926a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
192026a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
192126a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
192226a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
192326a33504SRichard Retanubun		controller provide such a method. It is called at the end of
192426a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
192526a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
192626a33504SRichard Retanubun
192717ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
192817ea1177Swdenk
192917ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
193017ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
193117ea1177Swdenk		variable "i2cfast". (see also i2cfast)
193217ea1177Swdenk
1933bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1934bb99ad6dSBen Warren
1935bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1936bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1937bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1938bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1939bb99ad6dSBen Warren
19406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1941bb99ad6dSBen Warren
1942bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
19430f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
19440f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
19450f89c54bSPeter Tyser		a 1D array of device addresses
1946bb99ad6dSBen Warren
1947bb99ad6dSBen Warren		e.g.
1948bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
19496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1950bb99ad6dSBen Warren
1951bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1952bb99ad6dSBen Warren
1953bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
19546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1955bb99ad6dSBen Warren
1956bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1957bb99ad6dSBen Warren
19586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1959be5e6181STimur Tabi
1960be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1961be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1962be5e6181STimur Tabi
19636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
19640dc018ecSStefan Roese
19650dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
19660dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
19670dc018ecSStefan Roese
19686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
19690dc018ecSStefan Roese
19700dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
19710dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
19720dc018ecSStefan Roese
19736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19749ebbb54fSVictor Gallardo
19759ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19769ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19779ebbb54fSVictor Gallardo		specified DTT device.
19789ebbb54fSVictor Gallardo
1979be5e6181STimur Tabi		CONFIG_FSL_I2C
1980be5e6181STimur Tabi
1981be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
19827817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1983be5e6181STimur Tabi
198467b23a32SHeiko Schocher		CONFIG_I2C_MUX
198567b23a32SHeiko Schocher
198667b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
198767b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
198867b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
198967b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
199067b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
199167b23a32SHeiko Schocher		the muxes to activate this new "bus".
199267b23a32SHeiko Schocher
199367b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
199467b23a32SHeiko Schocher		feature!
199567b23a32SHeiko Schocher
199667b23a32SHeiko Schocher		Example:
199767b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
199867b23a32SHeiko Schocher			The First mux with address 70 and channel 6
199967b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
200067b23a32SHeiko Schocher
200167b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
200267b23a32SHeiko Schocher
200367b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
200467b23a32SHeiko Schocher		of I2C Busses with muxes:
200567b23a32SHeiko Schocher
200667b23a32SHeiko Schocher		=> i2c bus
200767b23a32SHeiko Schocher		Busses reached over muxes:
200867b23a32SHeiko Schocher		Bus ID: 2
200967b23a32SHeiko Schocher		  reached over Mux(es):
201067b23a32SHeiko Schocher		    pca9544a@70 ch: 4
201167b23a32SHeiko Schocher		Bus ID: 3
201267b23a32SHeiko Schocher		  reached over Mux(es):
201367b23a32SHeiko Schocher		    pca9544a@70 ch: 6
201467b23a32SHeiko Schocher		    pca9544a@71 ch: 4
201567b23a32SHeiko Schocher		=>
201667b23a32SHeiko Schocher
201767b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2018f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2019f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
202067b23a32SHeiko Schocher		the channel 4.
202167b23a32SHeiko Schocher
202267b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2023f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
202467b23a32SHeiko Schocher		the 2 muxes.
202567b23a32SHeiko Schocher
202667b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
202767b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
202867b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
202967b23a32SHeiko Schocher		to add this option to other architectures.
203067b23a32SHeiko Schocher
20312ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
20322ac6985aSAndrew Dyer
20332ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
20342ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
20352ac6985aSAndrew Dyer		between writing the address pointer and reading the
20362ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
20372ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
20382ac6985aSAndrew Dyer		devices can use either method, but some require one or
20392ac6985aSAndrew Dyer		the other.
2040be5e6181STimur Tabi
2041c609719bSwdenk- SPI Support:	CONFIG_SPI
2042c609719bSwdenk
2043c609719bSwdenk		Enables SPI driver (so far only tested with
2044c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2045c609719bSwdenk		D/As on the SACSng board)
2046c609719bSwdenk
20476639562eSYoshihiro Shimoda		CONFIG_SH_SPI
20486639562eSYoshihiro Shimoda
20496639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
20506639562eSYoshihiro Shimoda		only SH7757 is supported.
20516639562eSYoshihiro Shimoda
2052c609719bSwdenk		CONFIG_SPI_X
2053c609719bSwdenk
2054c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2055c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2056c609719bSwdenk
2057c609719bSwdenk		CONFIG_SOFT_SPI
2058c609719bSwdenk
2059c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2060c609719bSwdenk		using hardware support. This is a general purpose
2061c609719bSwdenk		driver that only requires three general I/O port pins
2062c609719bSwdenk		(two outputs, one input) to function. If this is
2063c609719bSwdenk		defined, the board configuration must define several
2064c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2065c609719bSwdenk		an example, see include/configs/sacsng.h.
2066c609719bSwdenk
206704a9e118SBen Warren		CONFIG_HARD_SPI
206804a9e118SBen Warren
206904a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
207004a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
207104a9e118SBen Warren		must define a list of chip-select function pointers.
207204a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
207304a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
207404a9e118SBen Warren
207538254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
207638254f45SGuennadi Liakhovetski
207738254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20782e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
207938254f45SGuennadi Liakhovetski
20800133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20810133502eSMatthias Fuchs
20820133502eSMatthias Fuchs		Enables FPGA subsystem.
20830133502eSMatthias Fuchs
20840133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20850133502eSMatthias Fuchs
20860133502eSMatthias Fuchs		Enables support for specific chip vendors.
20870133502eSMatthias Fuchs		(ALTERA, XILINX)
20880133502eSMatthias Fuchs
20890133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20900133502eSMatthias Fuchs
20910133502eSMatthias Fuchs		Enables support for FPGA family.
20920133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20930133502eSMatthias Fuchs
20940133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2095c609719bSwdenk
2096c609719bSwdenk		Specify the number of FPGA devices to support.
2097c609719bSwdenk
20986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2099c609719bSwdenk
2100c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2101c609719bSwdenk
21026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2103c609719bSwdenk
2104c609719bSwdenk		Enable checks on FPGA configuration interface busy
2105c609719bSwdenk		status by the configuration function. This option
2106c609719bSwdenk		will require a board or device specific function to
2107c609719bSwdenk		be written.
2108c609719bSwdenk
2109c609719bSwdenk		CONFIG_FPGA_DELAY
2110c609719bSwdenk
2111c609719bSwdenk		If defined, a function that provides delays in the FPGA
2112c609719bSwdenk		configuration driver.
2113c609719bSwdenk
21146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2115c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2116c609719bSwdenk
21176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2118c609719bSwdenk
2119c609719bSwdenk		Check for configuration errors during FPGA bitfile
2120c609719bSwdenk		loading. For example, abort during Virtex II
2121c609719bSwdenk		configuration if the INIT_B line goes low (which
2122c609719bSwdenk		indicated a CRC error).
2123c609719bSwdenk
21246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2125c609719bSwdenk
2126c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2127c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2128c609719bSwdenk		FPGA configuration sequence. The default time is 500
212911ccc33fSMarcel Ziswiler		ms.
2130c609719bSwdenk
21316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2132c609719bSwdenk
2133c609719bSwdenk		Maximum time to wait for BUSY to deassert during
213411ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2135c609719bSwdenk
21366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2137c609719bSwdenk
2138c609719bSwdenk		Time to wait after FPGA configuration. The default is
213911ccc33fSMarcel Ziswiler		200 ms.
2140c609719bSwdenk
2141c609719bSwdenk- Configuration Management:
2142c609719bSwdenk		CONFIG_IDENT_STRING
2143c609719bSwdenk
2144c609719bSwdenk		If defined, this string will be added to the U-Boot
2145c609719bSwdenk		version information (U_BOOT_VERSION)
2146c609719bSwdenk
2147c609719bSwdenk- Vendor Parameter Protection:
2148c609719bSwdenk
2149c609719bSwdenk		U-Boot considers the values of the environment
2150c609719bSwdenk		variables "serial#" (Board Serial Number) and
21517152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2152c609719bSwdenk		are set once by the board vendor / manufacturer, and
2153c609719bSwdenk		protects these variables from casual modification by
2154c609719bSwdenk		the user. Once set, these variables are read-only,
2155c609719bSwdenk		and write or delete attempts are rejected. You can
215611ccc33fSMarcel Ziswiler		change this behaviour:
2157c609719bSwdenk
2158c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2159c609719bSwdenk		file, the write protection for vendor parameters is
216047cd00faSwdenk		completely disabled. Anybody can change or delete
2161c609719bSwdenk		these parameters.
2162c609719bSwdenk
2163c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2164c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
216511ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2166c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2167c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2168c609719bSwdenk		read-only.]
2169c609719bSwdenk
2170c609719bSwdenk- Protected RAM:
2171c609719bSwdenk		CONFIG_PRAM
2172c609719bSwdenk
2173c609719bSwdenk		Define this variable to enable the reservation of
2174c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2175c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2176c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2177c609719bSwdenk		this default value by defining an environment
2178c609719bSwdenk		variable "pram" to the number of kB you want to
2179c609719bSwdenk		reserve. Note that the board info structure will
2180c609719bSwdenk		still show the full amount of RAM. If pRAM is
2181c609719bSwdenk		reserved, a new environment variable "mem" will
2182c609719bSwdenk		automatically be defined to hold the amount of
2183c609719bSwdenk		remaining RAM in a form that can be passed as boot
2184c609719bSwdenk		argument to Linux, for instance like that:
2185c609719bSwdenk
2186fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2187c609719bSwdenk			saveenv
2188c609719bSwdenk
2189c609719bSwdenk		This way you can tell Linux not to use this memory,
2190c609719bSwdenk		either, which results in a memory region that will
2191c609719bSwdenk		not be affected by reboots.
2192c609719bSwdenk
2193c609719bSwdenk		*WARNING* If your board configuration uses automatic
2194c609719bSwdenk		detection of the RAM size, you must make sure that
2195c609719bSwdenk		this memory test is non-destructive. So far, the
2196c609719bSwdenk		following board configurations are known to be
2197c609719bSwdenk		"pRAM-clean":
2198c609719bSwdenk
21991b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
22001b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2201544d97e9SWolfgang Denk			FLAGADM, TQM8260
2202c609719bSwdenk
2203c609719bSwdenk- Error Recovery:
2204c609719bSwdenk		CONFIG_PANIC_HANG
2205c609719bSwdenk
2206c609719bSwdenk		Define this variable to stop the system in case of a
2207c609719bSwdenk		fatal error, so that you have to reset it manually.
2208c609719bSwdenk		This is probably NOT a good idea for an embedded
220911ccc33fSMarcel Ziswiler		system where you want the system to reboot
2210c609719bSwdenk		automatically as fast as possible, but it may be
2211c609719bSwdenk		useful during development since you can try to debug
2212c609719bSwdenk		the conditions that lead to the situation.
2213c609719bSwdenk
2214c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2215c609719bSwdenk
2216c609719bSwdenk		This variable defines the number of retries for
2217c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2218c609719bSwdenk		before giving up the operation. If not defined, a
2219c609719bSwdenk		default value of 5 is used.
2220c609719bSwdenk
222140cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
222240cb90eeSGuennadi Liakhovetski
222340cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
222440cb90eeSGuennadi Liakhovetski
222548a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
222648a3e999STetsuyuki Kobayashi
222748a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
222848a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
222948a3e999STetsuyuki Kobayashi		try longer timeout such as
223048a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
223148a3e999STetsuyuki Kobayashi
2232c609719bSwdenk- Command Interpreter:
22338078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
223404a85b3bSwdenk
223504a85b3bSwdenk		Enable auto completion of commands using TAB.
223604a85b3bSwdenk
22378078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
22388078f1a5SWolfgang Denk		for the "hush" shell.
22398078f1a5SWolfgang Denk
22408078f1a5SWolfgang Denk
22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2242c609719bSwdenk
2243c609719bSwdenk		Define this variable to enable the "hush" shell (from
2244c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2245c609719bSwdenk		powerful command line syntax like
2246c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2247c609719bSwdenk		constructs ("shell scripts").
2248c609719bSwdenk
2249c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2250c609719bSwdenk		with a somewhat smaller memory footprint.
2251c609719bSwdenk
2252c609719bSwdenk
22536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2254c609719bSwdenk
2255c609719bSwdenk		This defines the secondary prompt string, which is
2256c609719bSwdenk		printed when the command interpreter needs more input
2257c609719bSwdenk		to complete a command. Usually "> ".
2258c609719bSwdenk
2259c609719bSwdenk	Note:
2260c609719bSwdenk
2261c609719bSwdenk		In the current implementation, the local variables
2262c609719bSwdenk		space and global environment variables space are
2263c609719bSwdenk		separated. Local variables are those you define by
22643b57fe0aSwdenk		simply typing `name=value'. To access a local
2265c609719bSwdenk		variable later on, you have write `$name' or
22663b57fe0aSwdenk		`${name}'; to execute the contents of a variable
22673b57fe0aSwdenk		directly type `$name' at the command prompt.
2268c609719bSwdenk
2269c609719bSwdenk		Global environment variables are those you use
2270c609719bSwdenk		setenv/printenv to work with. To run a command stored
2271c609719bSwdenk		in such a variable, you need to use the run command,
2272c609719bSwdenk		and you must not use the '$' sign to access them.
2273c609719bSwdenk
2274c609719bSwdenk		To store commands and special characters in a
2275c609719bSwdenk		variable, please use double quotation marks
2276c609719bSwdenk		surrounding the whole text of the variable, instead
2277c609719bSwdenk		of the backslashes before semicolons and special
2278c609719bSwdenk		symbols.
2279c609719bSwdenk
2280aa0c71acSWolfgang Denk- Commandline Editing and History:
2281aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2282aa0c71acSWolfgang Denk
228311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2284aa0c71acSWolfgang Denk		commandline input operations
2285aa0c71acSWolfgang Denk
2286a8c7c708Swdenk- Default Environment:
2287c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2288c609719bSwdenk
2289c609719bSwdenk		Define this to contain any number of null terminated
2290c609719bSwdenk		strings (variable = value pairs) that will be part of
22917152b1d0Swdenk		the default environment compiled into the boot image.
22922262cfeeSwdenk
2293c609719bSwdenk		For example, place something like this in your
2294c609719bSwdenk		board's config file:
2295c609719bSwdenk
2296c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2297c609719bSwdenk			"myvar1=value1\0" \
2298c609719bSwdenk			"myvar2=value2\0"
2299c609719bSwdenk
2300c609719bSwdenk		Warning: This method is based on knowledge about the
2301c609719bSwdenk		internal format how the environment is stored by the
23022262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2303c609719bSwdenk		interface! Although it is unlikely that this format
23047152b1d0Swdenk		will change soon, there is no guarantee either.
2305c609719bSwdenk		You better know what you are doing here.
2306c609719bSwdenk
2307c609719bSwdenk		Note: overly (ab)use of the default environment is
2308c609719bSwdenk		discouraged. Make sure to check other ways to preset
230974de7aefSWolfgang Denk		the environment like the "source" command or the
2310c609719bSwdenk		boot command first.
2311c609719bSwdenk
23125e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
23135e724ca2SStephen Warren
23145e724ca2SStephen Warren		Define this in order to add variables describing the
23155e724ca2SStephen Warren		U-Boot build configuration to the default environment.
23165e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
23175e724ca2SStephen Warren
23185e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
23195e724ca2SStephen Warren
23205e724ca2SStephen Warren		- CONFIG_SYS_ARCH
23215e724ca2SStephen Warren		- CONFIG_SYS_CPU
23225e724ca2SStephen Warren		- CONFIG_SYS_BOARD
23235e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
23245e724ca2SStephen Warren		- CONFIG_SYS_SOC
23255e724ca2SStephen Warren
23267e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
23277e27f89fSTom Rini
23287e27f89fSTom Rini		Define this in order to add variables describing certain
23297e27f89fSTom Rini		run-time determined information about the hardware to the
23307e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
23317e27f89fSTom Rini
2332a8c7c708Swdenk- DataFlash Support:
23332abbe075Swdenk		CONFIG_HAS_DATAFLASH
23342abbe075Swdenk
23352abbe075Swdenk		Defining this option enables DataFlash features and
23362abbe075Swdenk		allows to read/write in Dataflash via the standard
23372abbe075Swdenk		commands cp, md...
23382abbe075Swdenk
2339f61ec45eSEric Nelson- Serial Flash support
2340f61ec45eSEric Nelson		CONFIG_CMD_SF
2341f61ec45eSEric Nelson
2342f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2343f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2344f61ec45eSEric Nelson
2345f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2346f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2347f61ec45eSEric Nelson		commands.
2348f61ec45eSEric Nelson
2349f61ec45eSEric Nelson		The following defaults may be provided by the platform
2350f61ec45eSEric Nelson		to handle the common case when only a single serial
2351f61ec45eSEric Nelson		flash is present on the system.
2352f61ec45eSEric Nelson
2353f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2354f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2355f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2356f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2357f61ec45eSEric Nelson
23583f85ce27Swdenk- SystemACE Support:
23593f85ce27Swdenk		CONFIG_SYSTEMACE
23603f85ce27Swdenk
23613f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
23623f85ce27Swdenk		chips attached via some sort of local bus. The address
236311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
23646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
23653f85ce27Swdenk
23663f85ce27Swdenk		#define CONFIG_SYSTEMACE
23676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
23683f85ce27Swdenk
23693f85ce27Swdenk		When SystemACE support is added, the "ace" device type
23703f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
23713f85ce27Swdenk
2372ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2373ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2374ecb0ccd9SWolfgang Denk
237528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2376ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
237728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2378ecb0ccd9SWolfgang Denk		number generator is used.
2379ecb0ccd9SWolfgang Denk
238028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
238128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
238228cb9375SWolfgang Denk		defined, the normal port 69 is used.
238328cb9375SWolfgang Denk
238428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2385ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2386ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2387ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2388ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2389ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2390ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2391ecb0ccd9SWolfgang Denk
2392a8c7c708Swdenk- Show boot progress:
2393c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2394c609719bSwdenk
2395c609719bSwdenk		Defining this option allows to add some board-
2396c609719bSwdenk		specific code (calling a user-provided function
2397c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2398c609719bSwdenk		the system's boot progress on some display (for
2399c609719bSwdenk		example, some LED's) on your board. At the moment,
2400c609719bSwdenk		the following checkpoints are implemented:
2401c609719bSwdenk
24023a608ca0SSimon Glass- Detailed boot stage timing
24033a608ca0SSimon Glass		CONFIG_BOOTSTAGE
24043a608ca0SSimon Glass		Define this option to get detailed timing of each stage
24053a608ca0SSimon Glass		of the boot process.
24063a608ca0SSimon Glass
24073a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
24083a608ca0SSimon Glass		This is the number of available user bootstage records.
24093a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
24103a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
24113a608ca0SSimon Glass		the limit, recording will stop.
24123a608ca0SSimon Glass
24133a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
24143a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
24153a608ca0SSimon Glass
24163a608ca0SSimon Glass		Timer summary in microseconds:
24173a608ca0SSimon Glass		       Mark    Elapsed  Stage
24183a608ca0SSimon Glass			  0          0  reset
24193a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
24203a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
24213a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
24223a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
24233a608ca0SSimon Glass		  3,910,375    250,777  main_loop
24243a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
24253a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
24263a608ca0SSimon Glass
24272eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
24282eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
24292eba38cfSSimon Glass		and un/stashing of bootstage data.
24302eba38cfSSimon Glass
243194fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
243294fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
243394fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
243494fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
243594fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
243694fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
243794fd1316SSimon Glass		For example:
243894fd1316SSimon Glass
243994fd1316SSimon Glass		bootstage {
244094fd1316SSimon Glass			154 {
244194fd1316SSimon Glass				name = "board_init_f";
244294fd1316SSimon Glass				mark = <3575678>;
244394fd1316SSimon Glass			};
244494fd1316SSimon Glass			170 {
244594fd1316SSimon Glass				name = "lcd";
244694fd1316SSimon Glass				accum = <33482>;
244794fd1316SSimon Glass			};
244894fd1316SSimon Glass		};
244994fd1316SSimon Glass
245094fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
245194fd1316SSimon Glass
24521372cce2SMarian BalakowiczLegacy uImage format:
24531372cce2SMarian Balakowicz
2454c609719bSwdenk  Arg	Where			When
2455c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2456c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2457c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2458c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2459c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2460c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2461c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2462c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2463c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
24641372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2465c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2466c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2467c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2468c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
24691372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2470c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
24711372cce2SMarian Balakowicz
24721372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
24731372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
24741372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
24751372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
24761372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
24771372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
24781372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
247911ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
24801372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
24811372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
24821372cce2SMarian Balakowicz
2483ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2484c609719bSwdenk
2485a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
248663e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
248763e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
248863e73c9aSwdenk
2489566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2490566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2491566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2492566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2493566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2494566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2495566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2496566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2497566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2498566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2499566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2500566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2501566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2502566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2503566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2504566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2505566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2506566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2507566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2508566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2509566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2510566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2511566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2512566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2513566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2514566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2515566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2516566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2517566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2518566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2519566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2520566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2521566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2522566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2523566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2524566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2525566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2526566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2527566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2528566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2529566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2530566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2531566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2532566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2533566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2534566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2535566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2536c609719bSwdenk
2537566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2538c609719bSwdenk
2539566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2540566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2541566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2542206c60cbSwdenk
2543566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2544566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
254511ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2546566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2547566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2548566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
254974de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
255074de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2551566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2552c609719bSwdenk
25531372cce2SMarian BalakowiczFIT uImage format:
25541372cce2SMarian Balakowicz
25551372cce2SMarian Balakowicz  Arg	Where			When
25561372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
25571372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
25581372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
25591372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
25601372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
25611372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2562f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
25631372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
25641372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
25651372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
25661372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
25671372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
256811ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
256911ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
25701372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
25711372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
25721372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
25731372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
25741372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
25751372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
25761372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
25771372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
25781372cce2SMarian Balakowicz
25791372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
25801372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
25811372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
258211ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
25831372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
25841372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
25851372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
25861372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
25871372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
25881372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
25891372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
25901372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
25911372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
25921372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
25931372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
25941372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
25951372cce2SMarian Balakowicz
259611ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
25971372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
25981372cce2SMarian Balakowicz
259911ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
26001372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
26011372cce2SMarian Balakowicz
260211ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
26031372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
26041372cce2SMarian Balakowicz
26054cf2609bSWolfgang Denk- Standalone program support:
26064cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
26074cf2609bSWolfgang Denk
26086feff899SWolfgang Denk		This option defines a board specific value for the
26096feff899SWolfgang Denk		address where standalone program gets loaded, thus
26106feff899SWolfgang Denk		overwriting the architecture dependent default
26114cf2609bSWolfgang Denk		settings.
26124cf2609bSWolfgang Denk
26134cf2609bSWolfgang Denk- Frame Buffer Address:
26144cf2609bSWolfgang Denk		CONFIG_FB_ADDR
26154cf2609bSWolfgang Denk
26164cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
26174cf2609bSWolfgang Denk		address for frame buffer.
26184cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
26194cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
26206feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
26214cf2609bSWolfgang Denk
26224cf2609bSWolfgang Denk		Please see board_init_f function.
26234cf2609bSWolfgang Denk
2624cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2625cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2626cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2627cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2628cccfc2abSDetlev Zundel
2629cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2630cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2631cccfc2abSDetlev Zundel
2632cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2633cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2634cccfc2abSDetlev Zundel
2635cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2636cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2637cccfc2abSDetlev Zundel
2638cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2639cccfc2abSDetlev Zundel
2640cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2641cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2642cccfc2abSDetlev Zundel
26436a11cf48SDaniel Schwierzeck- SPL framework
26446a11cf48SDaniel Schwierzeck		CONFIG_SPL
26456a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
26466a11cf48SDaniel Schwierzeck
264795579793STom Rini		CONFIG_SPL_LDSCRIPT
264895579793STom Rini		LDSCRIPT for linking the SPL binary.
264995579793STom Rini
265095579793STom Rini		CONFIG_SPL_MAX_SIZE
265195579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
265295579793STom Rini
26536a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
26546a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
26556a11cf48SDaniel Schwierzeck
265695579793STom Rini		CONFIG_SPL_BSS_START_ADDR
265795579793STom Rini		Link address for the BSS within the SPL binary.
265895579793STom Rini
265995579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
266095579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
266195579793STom Rini
266295579793STom Rini		CONFIG_SPL_STACK
266395579793STom Rini		Adress of the start of the stack SPL will use
266495579793STom Rini
266595579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
266695579793STom Rini		Starting address of the malloc pool used in SPL.
266795579793STom Rini
266895579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
266995579793STom Rini		The size of the malloc pool used in SPL.
26706a11cf48SDaniel Schwierzeck
267147f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
267247f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
267347f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
267447f7bcaeSTom Rini		NAND loading of the Linux Kernel.
267547f7bcaeSTom Rini
2676861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2677861a86f4STom Rini		For ARM, enable an optional function to print more information
2678861a86f4STom Rini		about the running system.
2679861a86f4STom Rini
26806a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
26816a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
26826a11cf48SDaniel Schwierzeck
26836a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
26846a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
26856a11cf48SDaniel Schwierzeck
26866a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
26876a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
26886a11cf48SDaniel Schwierzeck
26896a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
26906a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
26916a11cf48SDaniel Schwierzeck
26926a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
26936a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
26946a11cf48SDaniel Schwierzeck
269595579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
269695579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
269795579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
269895579793STom Rini		Address, size and partition on the MMC to load U-Boot from
269995579793STom Rini		when the MMC is being used in raw mode.
270095579793STom Rini
270195579793STom Rini		CONFIG_SPL_FAT_SUPPORT
270295579793STom Rini		Support for fs/fat/libfat.o in SPL binary
270395579793STom Rini
270495579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
270595579793STom Rini		Filename to read to load U-Boot when reading from FAT
270695579793STom Rini
270795579793STom Rini		CONFIG_SPL_NAND_SIMPLE
270895579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
270995579793STom Rini
271095579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
271195579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
271295579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
271395579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
271495579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
271595579793STom Rini		Defines the size and behavior of the NAND that SPL uses
271695579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
271795579793STom Rini
271895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
271995579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
272095579793STom Rini		from.
272195579793STom Rini
272295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
272395579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
272495579793STom Rini		to.
272595579793STom Rini
272695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
272795579793STom Rini		Define this if you need to first read the OOB and then the
272895579793STom Rini		data. This is used for example on davinci plattforms.
272995579793STom Rini
273095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
273195579793STom Rini		Support for an OMAP3-specific set of functions to return the
273295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
273395579793STom Rini
27346a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
27356a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
27366a11cf48SDaniel Schwierzeck
27376a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
27386a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
27396a11cf48SDaniel Schwierzeck
27406a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
27416a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
27426a11cf48SDaniel Schwierzeck
2743c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
2744c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
2745c57b953dSPavel Machek
27466a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
27476a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
27481372cce2SMarian Balakowicz
2749*ca2fca22SScott Wood		CONFIG_SPL_TARGET
2750*ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
2751*ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
2752*ca2fca22SScott Wood		example if more than one image needs to be produced.
2753*ca2fca22SScott Wood
2754c609719bSwdenkModem Support:
2755c609719bSwdenk--------------
2756c609719bSwdenk
2757566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2758c609719bSwdenk
275911ccc33fSMarcel Ziswiler- Modem support enable:
2760c609719bSwdenk		CONFIG_MODEM_SUPPORT
2761c609719bSwdenk
2762c609719bSwdenk- RTS/CTS Flow control enable:
2763c609719bSwdenk		CONFIG_HWFLOW
2764c609719bSwdenk
2765c609719bSwdenk- Modem debug support:
2766c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2767c609719bSwdenk
2768c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2769c609719bSwdenk		for modem support. Useful only with BDI2000.
2770c609719bSwdenk
2771a8c7c708Swdenk- Interrupt support (PPC):
2772a8c7c708Swdenk
2773a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2774a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
277511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2776a8c7c708Swdenk		should set decrementer_count to appropriate value. If
277711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2778a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
277911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2780a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2781a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2782a8c7c708Swdenk		general timer_interrupt().
2783a8c7c708Swdenk
2784c609719bSwdenk- General:
2785c609719bSwdenk
2786c609719bSwdenk		In the target system modem support is enabled when a
2787c609719bSwdenk		specific key (key combination) is pressed during
2788c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
278911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2790c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2791c609719bSwdenk		function, returning 1 and thus enabling modem
2792c609719bSwdenk		initialization.
2793c609719bSwdenk
2794c609719bSwdenk		If there are no modem init strings in the
2795c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2796c609719bSwdenk		previous output (banner, info printfs) will be
279711ccc33fSMarcel Ziswiler		suppressed, though.
2798c609719bSwdenk
2799c609719bSwdenk		See also: doc/README.Modem
2800c609719bSwdenk
28019660e442SHelmut RaigerBoard initialization settings:
28029660e442SHelmut Raiger------------------------------
28039660e442SHelmut Raiger
28049660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
28059660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
28069660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
28079660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
28089660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
28099660e442SHelmut Raigertypically in board_init_f() and board_init_r().
28109660e442SHelmut Raiger
28119660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
28129660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
28139660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
28149660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2815c609719bSwdenk
2816c609719bSwdenkConfiguration Settings:
2817c609719bSwdenk-----------------------
2818c609719bSwdenk
28196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2820c609719bSwdenk		undefine this when you're short of memory.
2821c609719bSwdenk
28222fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
28232fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
28242fb2604dSPeter Tyser
28256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2826c609719bSwdenk		prompt for user input.
2827c609719bSwdenk
28286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2829c609719bSwdenk
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2831c609719bSwdenk
28326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2833c609719bSwdenk
28346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2835c609719bSwdenk		the application (usually a Linux kernel) when it is
2836c609719bSwdenk		booted
2837c609719bSwdenk
28386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2839c609719bSwdenk		List of legal baudrate settings for this board.
2840c609719bSwdenk
28416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2842c609719bSwdenk		Suppress display of console information at boot.
2843c609719bSwdenk
28446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2845c609719bSwdenk		If the board specific function
2846c609719bSwdenk			extern int overwrite_console (void);
2847c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2848c609719bSwdenk		serial port, else the settings in the environment are used.
2849c609719bSwdenk
28506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2851c609719bSwdenk		Enable the call to overwrite_console().
2852c609719bSwdenk
28536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2854c609719bSwdenk		Enable overwrite of previous console environment settings.
2855c609719bSwdenk
28566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2857c609719bSwdenk		Begin and End addresses of the area used by the
2858c609719bSwdenk		simple memory test.
2859c609719bSwdenk
28606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2861c609719bSwdenk		Enable an alternate, more extensive memory test.
2862c609719bSwdenk
28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
28645f535fe1Swdenk		Scratch address used by the alternate memory test
28655f535fe1Swdenk		You only need to set this if address zero isn't writeable
28665f535fe1Swdenk
28676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
28686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
286914f73ca6SStefan Roese		this specified memory area will get subtracted from the top
287011ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
287114f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
287214f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
287314f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
28745e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
287514f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
28765e12e75dSStefan Roese		will have to get fixed in Linux additionally.
287714f73ca6SStefan Roese
287814f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
287914f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
288014f73ca6SStefan Roese		be touched.
288114f73ca6SStefan Roese
288214f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
288314f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
288414f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
288514f73ca6SStefan Roese		non page size aligned address and this could cause major
288614f73ca6SStefan Roese		problems.
288714f73ca6SStefan Roese
28886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2889c609719bSwdenk		Default load address for network file downloads
2890c609719bSwdenk
28916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2892c609719bSwdenk		Enable temporary baudrate change while serial download
2893c609719bSwdenk
28946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2895c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2896c609719bSwdenk
28976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2898c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2899c609719bSwdenk		Cogent motherboard)
2900c609719bSwdenk
29016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2902c609719bSwdenk		Physical start address of Flash memory.
2903c609719bSwdenk
29046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2905c609719bSwdenk		Physical start address of boot monitor code (set by
2906c609719bSwdenk		make config files to be same as the text base address
290714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
29086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2909c609719bSwdenk
29106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
29113b57fe0aSwdenk		Size of memory reserved for monitor code, used to
29123b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
29133b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
29143b57fe0aSwdenk		flash sector.
2915c609719bSwdenk
29166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2917c609719bSwdenk		Size of DRAM reserved for malloc() use.
2918c609719bSwdenk
29196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
292015940c9aSStefan Roese		Normally compressed uImages are limited to an
292115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
292315940c9aSStefan Roese		to adjust this setting to your needs.
2924c609719bSwdenk
29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2926c609719bSwdenk		Maximum size of memory mapped by the startup code of
2927c609719bSwdenk		the Linux kernel; all data that must be processed by
29287d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
29297d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
29307d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
29317d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2932c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2933c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2934c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2935c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2936c609719bSwdenk
2937fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2938fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2939fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2940fca43cc8SJohn Rigby		is enabled.
2941fca43cc8SJohn Rigby
2942fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2943fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2944fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2945fca43cc8SJohn Rigby
2946fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2947fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2948fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2949fca43cc8SJohn Rigby
29506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2951c609719bSwdenk		Max number of Flash memory banks
2952c609719bSwdenk
29536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2954c609719bSwdenk		Max number of sectors on a Flash chip
2955c609719bSwdenk
29566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2957c609719bSwdenk		Timeout for Flash erase operations (in ms)
2958c609719bSwdenk
29596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2960c609719bSwdenk		Timeout for Flash write operations (in ms)
2961c609719bSwdenk
29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
29638564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
29648564acf9Swdenk
29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
29668564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
29678564acf9Swdenk
29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
29698564acf9Swdenk		If defined, hardware flash sectors protection is used
29708564acf9Swdenk		instead of U-Boot software protection.
29718564acf9Swdenk
29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2973c609719bSwdenk
2974c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2975c609719bSwdenk		without this option such a download has to be
2976c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2977c609719bSwdenk		copy from RAM to flash.
2978c609719bSwdenk
2979c609719bSwdenk		The two-step approach is usually more reliable, since
2980c609719bSwdenk		you can check if the download worked before you erase
298111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
298211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2983c609719bSwdenk		downloaded image) this option may be very useful.
2984c609719bSwdenk
29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2986c609719bSwdenk		Define if the flash driver uses extra elements in the
29875653fc33Swdenk		common flash structure for storing flash geometry.
29885653fc33Swdenk
298900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
29905653fc33Swdenk		This option also enables the building of the cfi_flash driver
29915653fc33Swdenk		in the drivers directory
299253cf9435Sstroese
299391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
299491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
299591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
299691809ed5SPiotr Ziecik		to the MTD layer.
299791809ed5SPiotr Ziecik
29986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
299996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
300096ef831fSGuennadi Liakhovetski
300196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
300296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
300396ef831fSGuennadi Liakhovetski		write commands.
300496ef831fSGuennadi Liakhovetski
30056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
30065568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
30075568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
30085568e613SStefan Roese		is useful, if some of the configured banks are only
30095568e613SStefan Roese		optionally available.
30105568e613SStefan Roese
30119a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
30129a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
30139a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
30149a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
30159a042e9cSJerry Van Baren
30166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
301711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
301811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
301953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
302053cf9435Sstroese		buffers can be full shortly after enabling the interface
302111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
302253cf9435Sstroese		Defaults to 4 if not defined.
3023c609719bSwdenk
3024ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3025ea882bafSWolfgang Denk
3026ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3027ea882bafSWolfgang Denk	internally to store the environment settings. The default
3028ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3029ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3030ea882bafSWolfgang Denk	lib/hashtable.c for details.
3031ea882bafSWolfgang Denk
3032c609719bSwdenkThe following definitions that deal with the placement and management
3033c609719bSwdenkof environment data (variable area); in general, we support the
3034c609719bSwdenkfollowing configurations:
3035c609719bSwdenk
3036c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3037c3eb3fe4SMike Frysinger
3038c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3039c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3040c3eb3fe4SMike Frysinger
30415a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3042c609719bSwdenk
3043c609719bSwdenk	Define this if the environment is in flash memory.
3044c609719bSwdenk
3045c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3046c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3047c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3048c609719bSwdenk	   sector" type flash chips, which have several smaller
3049c609719bSwdenk	   sectors at the start or the end. For instance, such a
3050c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3051c609719bSwdenk	   such a case you would place the environment in one of the
3052c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3053c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3054c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3055c609719bSwdenk	   between U-Boot and the environment.
3056c609719bSwdenk
30570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3058c609719bSwdenk
3059c609719bSwdenk	   Offset of environment data (variable area) to the
3060c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3061c609719bSwdenk	   type flash chips the second sector can be used: the offset
3062c609719bSwdenk	   for this sector is given here.
3063c609719bSwdenk
30646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3065c609719bSwdenk
30660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3067c609719bSwdenk
3068c609719bSwdenk	   This is just another way to specify the start address of
3069c609719bSwdenk	   the flash sector containing the environment (instead of
30700e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3071c609719bSwdenk
30720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3073c609719bSwdenk
3074c609719bSwdenk	   Size of the sector containing the environment.
3075c609719bSwdenk
3076c609719bSwdenk
3077c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3078c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3079c609719bSwdenk	   the environment.
3080c609719bSwdenk
30810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3082c609719bSwdenk
30835a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
30840e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3085c609719bSwdenk	   of this flash sector for the environment. This saves
3086c609719bSwdenk	   memory for the RAM copy of the environment.
3087c609719bSwdenk
3088c609719bSwdenk	   It may also save flash memory if you decide to use this
3089c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3090c609719bSwdenk	   since then the remainder of the flash sector could be used
3091c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3092c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3093c609719bSwdenk	   updating the environment in flash makes it always
3094c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3095c609719bSwdenk	   wrong before the contents has been restored from a copy in
3096c609719bSwdenk	   RAM, your target system will be dead.
3097c609719bSwdenk
30980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
30990e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3100c609719bSwdenk
3101c609719bSwdenk	   These settings describe a second storage area used to hold
310211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
31033e38691eSwdenk	   a valid backup copy in case there is a power failure during
3104c609719bSwdenk	   a "saveenv" operation.
3105c609719bSwdenk
3106c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3107c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3108c609719bSwdenkaccordingly!
3109c609719bSwdenk
3110c609719bSwdenk
31119314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3112c609719bSwdenk
3113c609719bSwdenk	Define this if you have some non-volatile memory device
3114c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3115c609719bSwdenk	environment.
3116c609719bSwdenk
31170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
31180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3119c609719bSwdenk
312011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3121c609719bSwdenk	  want to use for environment. It is assumed that this memory
3122c609719bSwdenk	  can just be read and written to, without any special
3123c609719bSwdenk	  provision.
3124c609719bSwdenk
3125c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3126c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
312711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3128c609719bSwdenkU-Boot will hang.
3129c609719bSwdenk
3130c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3131c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3132c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3133c609719bSwdenkto save the current settings.
3134c609719bSwdenk
3135c609719bSwdenk
3136bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3137c609719bSwdenk
3138c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3139c609719bSwdenk	device and a driver for it.
3140c609719bSwdenk
31410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3143c609719bSwdenk
3144c609719bSwdenk	  These two #defines specify the offset and size of the
3145c609719bSwdenk	  environment area within the total memory of your EEPROM.
3146c609719bSwdenk
31476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3148c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3149c609719bSwdenk	  The default address is zero.
3150c609719bSwdenk
31516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3152c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3153c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3154c609719bSwdenk	  would require six bits.
3155c609719bSwdenk
31566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3157c609719bSwdenk	  If defined, the number of milliseconds to delay between
3158c609719bSwdenk	  page writes.	The default is zero milliseconds.
3159c609719bSwdenk
31606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3161c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3162c609719bSwdenk	  that this is NOT the chip address length!
3163c609719bSwdenk
31646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
31655cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
31665cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
31675cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
31685cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
31695cf91d6bSwdenk	  byte chips.
31705cf91d6bSwdenk
31715cf91d6bSwdenk	  Note that we consider the length of the address field to
31725cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
31735cf91d6bSwdenk	  in the chip address.
31745cf91d6bSwdenk
31756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3176c609719bSwdenk	  The size in bytes of the EEPROM device.
3177c609719bSwdenk
3178548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3179548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3180548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3181548738b4SHeiko Schocher
3182548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3183548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3184548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3185548738b4SHeiko Schocher	  EEPROM. For example:
3186548738b4SHeiko Schocher
3187548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3188548738b4SHeiko Schocher
3189548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3190548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3191c609719bSwdenk
3192057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
31935779d8d9Swdenk
31945779d8d9Swdenk	Define this if you have a DataFlash memory device which you
31955779d8d9Swdenk	want to use for the environment.
31965779d8d9Swdenk
31970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
31990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
32005779d8d9Swdenk
32015779d8d9Swdenk	  These three #defines specify the offset and size of the
32025779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
32035779d8d9Swdenk	  at the specified address.
32045779d8d9Swdenk
32050a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
32060a85a9e7SLiu Gang
32070a85a9e7SLiu Gang	Define this if you have a remote memory space which you
32080a85a9e7SLiu Gang	want to use for the local device's environment.
32090a85a9e7SLiu Gang
32100a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
32110a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
32120a85a9e7SLiu Gang
32130a85a9e7SLiu Gang	  These two #defines specify the address and size of the
32140a85a9e7SLiu Gang	  environment area within the remote memory space. The
32150a85a9e7SLiu Gang	  local device can get the environment from remote memory
3216fc54c7faSLiu Gang	  space by SRIO or PCIE links.
32170a85a9e7SLiu Gang
32180a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
32190a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3220fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3221fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
32220a85a9e7SLiu Gang
322351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
322413a5695bSwdenk
322513a5695bSwdenk	Define this if you have a NAND device which you want to use
322613a5695bSwdenk	for the environment.
322713a5695bSwdenk
32280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
32290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
323013a5695bSwdenk
323113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3232fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3233fdd813deSScott Wood	  aligned to an erase block boundary.
32345779d8d9Swdenk
3235fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3236e443c944SMarkus Klotzbuecher
32370e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3238fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3239fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3240fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3241fdd813deSScott Wood	  aligned to an erase block boundary.
3242e443c944SMarkus Klotzbuecher
3243fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3244fdd813deSScott Wood
3245fdd813deSScott Wood	  Specifies the length of the region in which the environment
3246fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3247fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3248fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3249fdd813deSScott Wood	  the range to be avoided.
3250fdd813deSScott Wood
3251fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3252fdd813deSScott Wood
3253fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3254fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3255fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3256fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3257fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3258e443c944SMarkus Klotzbuecher
3259b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3260b74ab737SGuennadi Liakhovetski
3261b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3262b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3263b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3264b74ab737SGuennadi Liakhovetski
32656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3266c609719bSwdenk
3267c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3268c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3269c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3270c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3271c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3272c609719bSwdenk	to be a good choice since it makes it far enough from the
3273c609719bSwdenk	start of the data area as well as from the stack pointer.
3274c609719bSwdenk
3275e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3276c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3277cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3278c609719bSwdenkuntil then to read environment variables.
3279c609719bSwdenk
328085ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
328185ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
328285ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
328385ec0bccSwdenknecessary, because the first environment variable we need is the
328485ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
328585ec0bccSwdenkhave any device yet where we could complain.]
3286c609719bSwdenk
3287c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3288c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
328985ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3290c609719bSwdenk
32916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3292fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3293fc3e2165Swdenk
32946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3295fc3e2165Swdenk		      also needs to be defined.
3296fc3e2165Swdenk
32976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3298fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3299c609719bSwdenk
3300f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3301f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3302f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3303f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3304f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3305f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3306f5675aa5SRon Madrid
3307c609719bSwdenkLow Level (hardware related) configuration options:
3308dc7c9a1aSwdenk---------------------------------------------------
3309c609719bSwdenk
33106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3311c609719bSwdenk		Cache Line Size of the CPU.
3312c609719bSwdenk
33136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3314c609719bSwdenk		Default address of the IMMR after system reset.
33152535d602Swdenk
33162535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
33172535d602Swdenk		and RPXsuper) to be able to adjust the position of
33182535d602Swdenk		the IMMR register after a reset.
3319c609719bSwdenk
3320e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3321e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3322e46fedfeSTimur Tabi		PowerPC SOCs.
3323e46fedfeSTimur Tabi
3324e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3325e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3326e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3327e46fedfeSTimur Tabi
3328e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3329e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3330e46fedfeSTimur Tabi
3331e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3332e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3333e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3334e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3335e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3336e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3337e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3338e46fedfeSTimur Tabi
3339e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3340e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3341e46fedfeSTimur Tabi
3342e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3343e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3344e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3345e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3346e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3347e46fedfeSTimur Tabi
3348e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3349e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3350e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3351e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3352e46fedfeSTimur Tabi
3353e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3354e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3355e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3356e46fedfeSTimur Tabi
33577f6c2cbcSwdenk- Floppy Disk Support:
33586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
33597f6c2cbcSwdenk
33607f6c2cbcSwdenk		the default drive number (default value 0)
33617f6c2cbcSwdenk
33626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
33637f6c2cbcSwdenk
336411ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
33657f6c2cbcSwdenk		(default value 1)
33667f6c2cbcSwdenk
33676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
33687f6c2cbcSwdenk
33697f6c2cbcSwdenk		defines the offset of register from address. It
33707f6c2cbcSwdenk		depends on which part of the data bus is connected to
337111ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
33727f6c2cbcSwdenk
33736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
33746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
33757f6c2cbcSwdenk		default value.
33767f6c2cbcSwdenk
33776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
33787f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
33797f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
33807f6c2cbcSwdenk		source code. It is used to make hardware dependant
33817f6c2cbcSwdenk		initializations.
33827f6c2cbcSwdenk
33830abddf82SMacpaul Lin- CONFIG_IDE_AHB:
33840abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
33850abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
33860abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
33870abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
33880abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
33890abddf82SMacpaul Lin		is requierd.
33900abddf82SMacpaul Lin
33916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
339225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
339325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3394c609719bSwdenk
33956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3396c609719bSwdenk
33977152b1d0Swdenk		Start address of memory area that can be used for
3398c609719bSwdenk		initial data and stack; please note that this must be
3399c609719bSwdenk		writable memory that is working WITHOUT special
3400c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3401c609719bSwdenk		will become available only after programming the
3402c609719bSwdenk		memory controller and running certain initialization
3403c609719bSwdenk		sequences.
3404c609719bSwdenk
3405c609719bSwdenk		U-Boot uses the following memory types:
3406c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3407c609719bSwdenk		- MPC824X: data cache
3408c609719bSwdenk		- PPC4xx:  data cache
3409c609719bSwdenk
34106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3411c609719bSwdenk
3412c609719bSwdenk		Offset of the initial data structure in the memory
34136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
34146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3415c609719bSwdenk		data is located at the end of the available space
3416553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
34176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
34186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
34196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3420c609719bSwdenk
3421c609719bSwdenk	Note:
3422c609719bSwdenk		On the MPC824X (or other systems that use the data
3423c609719bSwdenk		cache for initial memory) the address chosen for
34246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3425c609719bSwdenk		point to an otherwise UNUSED address space between
3426c609719bSwdenk		the top of RAM and the start of the PCI space.
3427c609719bSwdenk
34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3429c609719bSwdenk
34306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3431c609719bSwdenk
34326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3433c609719bSwdenk
34346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3435c609719bSwdenk
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3437c609719bSwdenk
34386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3439c609719bSwdenk
34406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3441c609719bSwdenk		SDRAM timing
3442c609719bSwdenk
34436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3444c609719bSwdenk		periodic timer for refresh
3445c609719bSwdenk
34466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3447c609719bSwdenk
34486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
34496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
34506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
34516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3452c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3453c609719bSwdenk
3454c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
34556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3457c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3458c609719bSwdenk
34596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
34606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3461c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3462c609719bSwdenk		Prescaler definitions (SDRAM timing)
3463c609719bSwdenk
34646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3465c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3466c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3467c609719bSwdenk
34686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3469b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3470b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3471b423d055SHeiko Schocher
34726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3473c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3474c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3475c609719bSwdenk
34766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3477c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3478c609719bSwdenk		wrong setting might damage your board. Read
3479c609719bSwdenk		doc/README.MBX before setting this variable!
3480c609719bSwdenk
34816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3482ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3483ea909b76Swdenk		(Power On Self Tests). This definition overrides
3484ea909b76Swdenk		#define'd default value in commproc.h resp.
3485ea909b76Swdenk		cpm_8260.h.
3486ea909b76Swdenk
34876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
34886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
34896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
34906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
34916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
34926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
34936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
34946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3495a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
34965d232d0eSwdenk
34979cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
34989cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
34999cacf4fcSDirk Eibach		required.
35009cacf4fcSDirk Eibach
350169fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
350269fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
350369fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
350469fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
350569fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
350669fd2d3bSAndrew Sharp		by coreboot or similar.
350769fd2d3bSAndrew Sharp
3508a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3509a09b9b68SKumar Gala		Chip has SRIO or not
3510a09b9b68SKumar Gala
3511a09b9b68SKumar Gala- CONFIG_SRIO1:
3512a09b9b68SKumar Gala		Board has SRIO 1 port available
3513a09b9b68SKumar Gala
3514a09b9b68SKumar Gala- CONFIG_SRIO2:
3515a09b9b68SKumar Gala		Board has SRIO 2 port available
3516a09b9b68SKumar Gala
3517a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3518a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3519a09b9b68SKumar Gala
3520a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3521a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3522a09b9b68SKumar Gala
3523a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3524a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3525a09b9b68SKumar Gala
3526eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3527eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3528eced4626SAlex Waterman		16 bit bus.
3529eced4626SAlex Waterman
3530eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3531eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3532eced4626SAlex Waterman		a default value will be used.
3533eced4626SAlex Waterman
3534bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3535218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3536218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3537218ca724SWolfgang Denk
3538bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3539bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3540bb99ad6dSBen Warren
35416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3542218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3543218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3544218ca724SWolfgang Denk		to something your driver can deal with.
3545bb99ad6dSBen Warren
35461b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
35471b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
35481b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
35491b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
35501b3e3c4fSYork Sun		header files or board specific files.
35511b3e3c4fSYork Sun
35526f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
35536f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
35546f5e1dc5SYork Sun
35556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3556218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3557218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
35582ad6b513STimur Tabi
3559c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3560c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3561c26e454dSwdenk
3562c26e454dSwdenk- CONFIG_FEC[12]_PHY
3563c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
35646e592385Swdenk		to the given FEC; i. e.
3565c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3566c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3567c26e454dSwdenk
3568c26e454dSwdenk		When set to -1, means to probe for first available.
3569c26e454dSwdenk
3570c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3571c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3572c26e454dSwdenk		(so program the FEC to ignore it).
3573c26e454dSwdenk
3574c26e454dSwdenk- CONFIG_RMII
3575c26e454dSwdenk		Enable RMII mode for all FECs.
3576c26e454dSwdenk		Note that this is a global option, we can't
3577c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3578c26e454dSwdenk
35795cf91d6bSwdenk- CONFIG_CRC32_VERIFY
35805cf91d6bSwdenk		Add a verify option to the crc32 command.
35815cf91d6bSwdenk		The syntax is:
35825cf91d6bSwdenk
35835cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
35845cf91d6bSwdenk
35855cf91d6bSwdenk		Where address/count indicate a memory area
35865cf91d6bSwdenk		and crc32 is the correct crc32 which the
35875cf91d6bSwdenk		area should have.
35885cf91d6bSwdenk
358956523f12Swdenk- CONFIG_LOOPW
359056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3591602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
359256523f12Swdenk
35937b466641Sstroese- CONFIG_MX_CYCLIC
35947b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
35957b466641Sstroese		"md/mw" commands.
35967b466641Sstroese		Examples:
35977b466641Sstroese
35987b466641Sstroese		=> mdc.b 10 4 500
35997b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
36007b466641Sstroese
36017b466641Sstroese		=> mwc.l 100 12345678 10
36027b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
36037b466641Sstroese
36047b466641Sstroese		This only takes effect if the memory commands are activated
3605602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
36067b466641Sstroese
36078aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3608afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3609e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3610e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3611e03f3169SWolfgang Denk		relocate itself into RAM.
36128aa1a2d1Swdenk
3613e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3614e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3615e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3616e03f3169SWolfgang Denk		these initializations itself.
36178aa1a2d1Swdenk
3618401bb30bSAneesh V- CONFIG_SPL_BUILD
3619df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3620df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3621df81238bSMagnus Lilja		compiling a NAND SPL.
3622400558b5Swdenk
3623d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3624d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3625d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3626d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3627d8834a13SMatthias Weisser		conditions but may increase the binary size.
3628d8834a13SMatthias Weisser
3629f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3630f2717b47STimur Tabi-----------------------------------
3631f2717b47STimur Tabi
3632f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3633f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3634f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3635f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3636f2717b47STimur Tabiwithin that device.
3637f2717b47STimur Tabi
3638f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3639f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3640f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3641f2717b47STimur Tabi	is also specified.
3642f2717b47STimur Tabi
3643f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3644f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3645f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3646f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3647f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3648f2717b47STimur Tabi
3649f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3650f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3651f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3652f2717b47STimur Tabi	virtual address in NOR flash.
3653f2717b47STimur Tabi
3654f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3655f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3656f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3657f2717b47STimur Tabi
3658f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3659f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3660f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3661f2717b47STimur Tabi
3662f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3663f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3664f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3665f2717b47STimur Tabi
3666292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3667292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3668292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3669fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
3670fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
3671fc54c7faSLiu Gang	master's memory space.
3672f2717b47STimur Tabi
3673c609719bSwdenkBuilding the Software:
3674c609719bSwdenk======================
3675c609719bSwdenk
3676218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3677218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3678218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3679218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3680218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3681218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3682c609719bSwdenk
3683218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3684218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3685218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3686218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3687218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3688c609719bSwdenk
3689218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3690218ca724SWolfgang Denk	$ export CROSS_COMPILE
3691c609719bSwdenk
36922f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
36932f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
36942f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
36952f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
36962f8d396bSPeter Tyser
36972f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
36982f8d396bSPeter Tyser
36992f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
37002f8d396bSPeter Tyser      be executed on computers running Windows.
37012f8d396bSPeter Tyser
3702c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3703c609719bSwdenksources you must configure U-Boot for one specific board type. This
3704c609719bSwdenkis done by typing:
3705c609719bSwdenk
3706c609719bSwdenk	make NAME_config
3707c609719bSwdenk
3708218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
37094d675ae6SMichael Jonesrations; see boards.cfg for supported names.
371054387ac9Swdenk
3711c609719bSwdenkNote: for some board special configuration names may exist; check if
3712c609719bSwdenk      additional information is available from the board vendor; for
37132729af9dSwdenk      instance, the TQM823L systems are available without (standard)
37142729af9dSwdenk      or with LCD support. You can select such additional "features"
371511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3716c609719bSwdenk
37172729af9dSwdenk      make TQM823L_config
37182729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3719c609719bSwdenk
3720c609719bSwdenk      make TQM823L_LCD_config
3721c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3722c609719bSwdenk
3723c609719bSwdenk      etc.
3724c609719bSwdenk
3725c609719bSwdenk
3726c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
37277152b1d0Swdenkimages ready for download to / installation on your system:
3728c609719bSwdenk
3729c609719bSwdenk- "u-boot.bin" is a raw binary image
3730c609719bSwdenk- "u-boot" is an image in ELF binary format
3731c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3732c609719bSwdenk
3733baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3734baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3735baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3736baf31249SMarian Balakowicz
3737baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3738baf31249SMarian Balakowicz
3739baf31249SMarian Balakowicz	make O=/tmp/build distclean
3740baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3741baf31249SMarian Balakowicz	make O=/tmp/build all
3742baf31249SMarian Balakowicz
3743baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3744baf31249SMarian Balakowicz
3745baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3746baf31249SMarian Balakowicz	make distclean
3747baf31249SMarian Balakowicz	make NAME_config
3748baf31249SMarian Balakowicz	make all
3749baf31249SMarian Balakowicz
3750baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3751baf31249SMarian Balakowiczvariable.
3752baf31249SMarian Balakowicz
3753c609719bSwdenk
3754c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3755c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3756c609719bSwdenknative "make".
3757c609719bSwdenk
3758c609719bSwdenk
3759c609719bSwdenkIf the system board that you have is not listed, then you will need
3760c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3761c609719bSwdenksteps:
3762c609719bSwdenk
3763c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
37644d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
37654d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3766c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
376785ec0bccSwdenk    files you need. In your board directory, you will need at least
376885ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
376985ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
377085ec0bccSwdenk    your board
3771c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3772c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
377385ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3774c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3775c609719bSwdenk    to be installed on your target system.
377685ec0bccSwdenk6.  Debug and solve any problems that might arise.
3777c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3778c609719bSwdenk
3779c609719bSwdenk
3780c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3781c609719bSwdenk==============================================================
3782c609719bSwdenk
3783c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3784c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3785c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3786c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3787218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3788c609719bSwdenk
3789c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3790c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3791c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3792c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3793c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
37947152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3795218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3796218ca724SWolfgang Denkyou can type
3797c609719bSwdenk
3798c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3799c609719bSwdenk
3800c609719bSwdenkor to build on a native PowerPC system you can type
3801c609719bSwdenk
3802c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3803c609719bSwdenk
3804218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3805218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3806218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3807218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3808218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3809218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3810218ca724SWolfgang Denkvariable. For example:
3811baf31249SMarian Balakowicz
3812baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3813baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3814baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3815baf31249SMarian Balakowicz
3816218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3817218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3818218ca724SWolfgang Denkduring the whole build process.
3819baf31249SMarian Balakowicz
3820baf31249SMarian Balakowicz
3821c609719bSwdenkSee also "U-Boot Porting Guide" below.
3822c609719bSwdenk
3823c609719bSwdenk
3824c609719bSwdenkMonitor Commands - Overview:
3825c609719bSwdenk============================
3826c609719bSwdenk
3827c609719bSwdenkgo	- start application at address 'addr'
3828c609719bSwdenkrun	- run commands in an environment variable
3829c609719bSwdenkbootm	- boot application image from memory
3830c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
383144f074c7SMarek Vasutbootz   - boot zImage from memory
3832c609719bSwdenktftpboot- boot image via network using TFTP protocol
3833c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3834c609719bSwdenk	       (and eventually "gatewayip")
38351fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3836c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3837c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3838c609719bSwdenkloads	- load S-Record file over serial line
3839c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3840c609719bSwdenkmd	- memory display
3841c609719bSwdenkmm	- memory modify (auto-incrementing)
3842c609719bSwdenknm	- memory modify (constant address)
3843c609719bSwdenkmw	- memory write (fill)
3844c609719bSwdenkcp	- memory copy
3845c609719bSwdenkcmp	- memory compare
3846c609719bSwdenkcrc32	- checksum calculation
38470f89c54bSPeter Tyseri2c	- I2C sub-system
3848c609719bSwdenksspi	- SPI utility commands
3849c609719bSwdenkbase	- print or set address offset
3850c609719bSwdenkprintenv- print environment variables
3851c609719bSwdenksetenv	- set environment variables
3852c609719bSwdenksaveenv - save environment variables to persistent storage
3853c609719bSwdenkprotect - enable or disable FLASH write protection
3854c609719bSwdenkerase	- erase FLASH memory
3855c609719bSwdenkflinfo	- print FLASH memory information
3856c609719bSwdenkbdinfo	- print Board Info structure
3857c609719bSwdenkiminfo	- print header information for application image
3858c609719bSwdenkconinfo - print console devices and informations
3859c609719bSwdenkide	- IDE sub-system
3860c609719bSwdenkloop	- infinite loop on address range
386156523f12Swdenkloopw	- infinite write loop on address range
3862c609719bSwdenkmtest	- simple RAM test
3863c609719bSwdenkicache	- enable or disable instruction cache
3864c609719bSwdenkdcache	- enable or disable data cache
3865c609719bSwdenkreset	- Perform RESET of the CPU
3866c609719bSwdenkecho	- echo args to console
3867c609719bSwdenkversion - print monitor version
3868c609719bSwdenkhelp	- print online help
3869c609719bSwdenk?	- alias for 'help'
3870c609719bSwdenk
3871c609719bSwdenk
3872c609719bSwdenkMonitor Commands - Detailed Description:
3873c609719bSwdenk========================================
3874c609719bSwdenk
3875c609719bSwdenkTODO.
3876c609719bSwdenk
3877c609719bSwdenkFor now: just type "help <command>".
3878c609719bSwdenk
3879c609719bSwdenk
3880c609719bSwdenkEnvironment Variables:
3881c609719bSwdenk======================
3882c609719bSwdenk
3883c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3884c609719bSwdenkcan be made persistent by saving to Flash memory.
3885c609719bSwdenk
3886c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3887c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3888c609719bSwdenkwithout a value can be used to delete a variable from the
3889c609719bSwdenkenvironment. As long as you don't save the environment you are
3890c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3891c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3892c609719bSwdenk
3893c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3894c96f86eeSWolfgang Denk
3895c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3896c609719bSwdenk
3897c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3898c609719bSwdenk
3899c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3900c609719bSwdenk
3901c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3902c609719bSwdenk
3903c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3904c609719bSwdenk
3905c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3906c609719bSwdenk
39077d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
39087d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
39097d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
39107d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
39117d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
39127d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3913c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3914c3624e6eSGrant Likely		  bootm_mapsize.
3915c3624e6eSGrant Likely
3916c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3917c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3918c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3919c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3920c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3921c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3922c3624e6eSGrant Likely		  used otherwise.
39237d721e34SBartlomiej Sieka
39247d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
39257d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
39267d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
39277d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
39287d721e34SBartlomiej Sieka		  environment variable.
39297d721e34SBartlomiej Sieka
39304bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
39314bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
39324bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
39334bae9090SBartlomiej Sieka
3934c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3935c609719bSwdenk		  "bootp" will just load perform a lookup of the
3936c609719bSwdenk		  configuration from the BOOTP server, but not try to
3937c609719bSwdenk		  load any image using TFTP
3938c609719bSwdenk
3939c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3940c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3941c609719bSwdenk		  be automatically started (by internally calling
3942c609719bSwdenk		  "bootm")
3943c609719bSwdenk
39444a6fd34bSwdenk		  If set to "no", a standalone image passed to the
39454a6fd34bSwdenk		  "bootm" command will be copied to the load address
39464a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
39474a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
39484a6fd34bSwdenk		  data.
39494a6fd34bSwdenk
3950a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3951a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3952fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3953fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3954fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3955fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3956fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3957fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3958fa34f6b2SShawn Guo		  access it during the boot procedure.
3959fa34f6b2SShawn Guo
3960a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3961a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3962a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3963a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3964a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3965a28afca5SDavid A. Long		  must be accessible by the kernel.
3966a28afca5SDavid A. Long
3967eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3968eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3969eea63e05SSimon Glass		  defined.
3970eea63e05SSimon Glass
397117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
397217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
397317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
397417ea1177Swdenk		  initialization code. So, for changes to be effective
397517ea1177Swdenk		  it must be saved and board must be reset.
397617ea1177Swdenk
3977c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3978c609719bSwdenk		  If this variable is not set, initrd images will be
3979c609719bSwdenk		  copied to the highest possible address in RAM; this
3980c609719bSwdenk		  is usually what you want since it allows for
3981c609719bSwdenk		  maximum initrd size. If for some reason you want to
3982c609719bSwdenk		  make sure that the initrd image is loaded below the
39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3984c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3985c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3986c609719bSwdenk		  address to use (U-Boot will still check that it
3987c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3988c609719bSwdenk
3989c609719bSwdenk		  For instance, when you have a system with 16 MB
39907152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3991c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3992c609719bSwdenk		  the "bootargs" variable. However, now you must make
39937152b1d0Swdenk		  sure that the initrd image is placed in the first
3994c609719bSwdenk		  12 MB as well - this can be done with
3995c609719bSwdenk
3996c609719bSwdenk		  setenv initrd_high 00c00000
3997c609719bSwdenk
399838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
399938b99261Swdenk		  indication to U-Boot that all addresses are legal
400038b99261Swdenk		  for the Linux kernel, including addresses in flash
400138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
400238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
400338b99261Swdenk		  boot time on your system, but requires that this
400438b99261Swdenk		  feature is supported by your Linux kernel.
400538b99261Swdenk
4006c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4007c609719bSwdenk
4008c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4009dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4010c609719bSwdenk
4011c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4012c609719bSwdenk
4013c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4014c609719bSwdenk
4015c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4016c609719bSwdenk
4017c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4018c609719bSwdenk
4019c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4020c609719bSwdenk
4021e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4022a3d991bdSwdenk
4023e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4024e2a53458SMike Frysinger		  For example you can do the following
4025a3d991bdSwdenk
402648690d80SHeiko Schocher		  => setenv ethact FEC
402748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
402848690d80SHeiko Schocher		  => setenv ethact SCC
402948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4030a3d991bdSwdenk
4031e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4032e1692577SMatthias Fuchs		  available network interfaces.
4033e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4034e1692577SMatthias Fuchs
4035a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4036a3d991bdSwdenk		  either succeed or fail without retrying.
40376e592385Swdenk		  When set to "once" the network operation will
40386e592385Swdenk		  fail when all the available network interfaces
40396e592385Swdenk		  are tried once without success.
4040a3d991bdSwdenk		  Useful on scripts which control the retry operation
4041a3d991bdSwdenk		  themselves.
4042a3d991bdSwdenk
4043b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4044a1cf027aSJean-Christophe PLAGNIOL-VILLARD
404528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4046ecb0ccd9SWolfgang Denk		  UDP source port.
4047ecb0ccd9SWolfgang Denk
404828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
404928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
405028cb9375SWolfgang Denk
4051c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4052c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4053c96f86eeSWolfgang Denk
4054c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4055c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4056c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4057c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4058c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4059c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4060c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4061c96f86eeSWolfgang Denk
4062a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
406311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4064a3d991bdSwdenk		  VLAN tagged frames.
4065c609719bSwdenk
4066dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4067dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4068dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4069dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4070dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4071dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4072dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4073dc0b7b0eSJason Hobbs
4074dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4075dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4076dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4077dc0b7b0eSJason Hobbs
4078dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4079dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4080dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4081dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4082dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4083dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4084dc0b7b0eSJason Hobbs
4085c609719bSwdenkThe following environment variables may be used and automatically
4086c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4087c609719bSwdenkdepending the information provided by your boot server:
4088c609719bSwdenk
4089c609719bSwdenk  bootfile	- see above
4090c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4091fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4092c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4093c609719bSwdenk  hostname	- Target hostname
4094c609719bSwdenk  ipaddr	- see above
4095c609719bSwdenk  netmask	- Subnet Mask
4096c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4097c609719bSwdenk  serverip	- see above
4098c609719bSwdenk
4099c609719bSwdenk
4100c609719bSwdenkThere are two special Environment Variables:
4101c609719bSwdenk
4102c609719bSwdenk  serial#	- contains hardware identification information such
4103c609719bSwdenk		  as type string and/or serial number
4104c609719bSwdenk  ethaddr	- Ethernet address
4105c609719bSwdenk
4106c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4107c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4108c609719bSwdenkonce they have been set once.
4109c609719bSwdenk
4110c609719bSwdenk
4111c1551ea8SstroeseFurther special Environment Variables:
4112c1551ea8Sstroese
4113c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4114c1551ea8Sstroese		  with the "version" command. This variable is
4115c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4116c1551ea8Sstroese
4117c1551ea8Sstroese
4118c609719bSwdenkPlease note that changes to some configuration parameters may take
4119c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4120c609719bSwdenk
4121c609719bSwdenk
4122f07771ccSwdenkCommand Line Parsing:
4123f07771ccSwdenk=====================
4124f07771ccSwdenk
4125f07771ccSwdenkThere are two different command line parsers available with U-Boot:
41267152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4127f07771ccSwdenk
4128f07771ccSwdenkOld, simple command line parser:
4129f07771ccSwdenk--------------------------------
4130f07771ccSwdenk
4131f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4132f07771ccSwdenk- several commands on one line, separated by ';'
4133fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4134f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4135f07771ccSwdenk  for example:
4136fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4137f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4138f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4139f07771ccSwdenk
4140f07771ccSwdenkHush shell:
4141f07771ccSwdenk-----------
4142f07771ccSwdenk
4143f07771ccSwdenk- similar to Bourne shell, with control structures like
4144f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4145f07771ccSwdenk  until...do...done, ...
4146f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4147f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4148f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4149f07771ccSwdenk  command
4150f07771ccSwdenk
4151f07771ccSwdenkGeneral rules:
4152f07771ccSwdenk--------------
4153f07771ccSwdenk
4154f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4155f07771ccSwdenk    command) contains several commands separated by semicolon, and
4156f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4157f07771ccSwdenk    executed anyway.
4158f07771ccSwdenk
4159f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
416011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4161f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4162f07771ccSwdenk    variables are not executed.
4163f07771ccSwdenk
4164c609719bSwdenkNote for Redundant Ethernet Interfaces:
4165c609719bSwdenk=======================================
4166c609719bSwdenk
416711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4168c609719bSwdenksuch configurations and is capable of automatic selection of a
41697152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4170c609719bSwdenk
4171c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4172c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4173c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4174c609719bSwdenk
4175c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4176c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4177c609719bSwdenkding setting in the environment; if the corresponding environment
4178c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4179c609719bSwdenk
4180c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4181c609719bSwdenk  environment, the SROM's address is used.
4182c609719bSwdenk
4183c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4184c609719bSwdenk  environment exists, then the value from the environment variable is
4185c609719bSwdenk  used.
4186c609719bSwdenk
4187c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4188c609719bSwdenk  both addresses are the same, this MAC address is used.
4189c609719bSwdenk
4190c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4191c609719bSwdenk  addresses differ, the value from the environment is used and a
4192c609719bSwdenk  warning is printed.
4193c609719bSwdenk
4194c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4195c609719bSwdenk  is raised.
4196c609719bSwdenk
4197ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4198ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4199ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4200ecee9324SBen WarrenThe naming convention is as follows:
4201ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4202c609719bSwdenk
4203c609719bSwdenkImage Formats:
4204c609719bSwdenk==============
4205c609719bSwdenk
42063310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
42073310c549SMarian Balakowiczimages in two formats:
42083310c549SMarian Balakowicz
42093310c549SMarian BalakowiczNew uImage format (FIT)
42103310c549SMarian Balakowicz-----------------------
42113310c549SMarian Balakowicz
42123310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
42133310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
42143310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
42153310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
42163310c549SMarian Balakowicz
42173310c549SMarian Balakowicz
42183310c549SMarian BalakowiczOld uImage format
42193310c549SMarian Balakowicz-----------------
42203310c549SMarian Balakowicz
42213310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
42223310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
42233310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4224c609719bSwdenk
4225c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4226c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4227f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4228f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4229f5ed9e39SPeter Tyser  INTEGRITY).
42307b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4231afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4232afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4233c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4234c609719bSwdenk* Load Address
4235c609719bSwdenk* Entry Point
4236c609719bSwdenk* Image Name
4237c609719bSwdenk* Image Timestamp
4238c609719bSwdenk
4239c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4240c609719bSwdenkand the data portions of the image are secured against corruption by
4241c609719bSwdenkCRC32 checksums.
4242c609719bSwdenk
4243c609719bSwdenk
4244c609719bSwdenkLinux Support:
4245c609719bSwdenk==============
4246c609719bSwdenk
4247c609719bSwdenkAlthough U-Boot should support any OS or standalone application
42487152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4249c609719bSwdenkU-Boot.
4250c609719bSwdenk
4251c609719bSwdenkU-Boot includes many features that so far have been part of some
4252c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4253c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4254c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
42557152b1d0Swdenkserves several purposes:
4256c609719bSwdenk
4257c609719bSwdenk- the same features can be used for other OS or standalone
4258c609719bSwdenk  applications (for instance: using compressed images to reduce the
4259c609719bSwdenk  Flash memory footprint)
4260c609719bSwdenk
4261c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
42627152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4263c609719bSwdenk
4264c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4265c609719bSwdenk  images; of course this also means that different kernel images can
4266c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4267c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4268c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4269c609719bSwdenk  software is easier now.
4270c609719bSwdenk
4271c609719bSwdenk
4272c609719bSwdenkLinux HOWTO:
4273c609719bSwdenk============
4274c609719bSwdenk
4275c609719bSwdenkPorting Linux to U-Boot based systems:
4276c609719bSwdenk---------------------------------------
4277c609719bSwdenk
4278c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4279c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4280c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4281c609719bSwdenkLinux :-).
4282c609719bSwdenk
4283a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4284c609719bSwdenk
4285c609719bSwdenkJust make sure your machine specific header file (for instance
4286c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
42871dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
42881dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
42896d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4290c609719bSwdenk
4291c609719bSwdenk
4292c609719bSwdenkConfiguring the Linux kernel:
4293c609719bSwdenk-----------------------------
4294c609719bSwdenk
4295c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4296c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4297c609719bSwdenk
4298c609719bSwdenk
4299c609719bSwdenkBuilding a Linux Image:
4300c609719bSwdenk-----------------------
4301c609719bSwdenk
430224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
430324ee89b9Swdenknot used. If you use recent kernel source, a new build target
430424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
430524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
430624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
430724ee89b9Swdenk100% compatible format.
4308c609719bSwdenk
4309c609719bSwdenkExample:
4310c609719bSwdenk
4311c609719bSwdenk	make TQM850L_config
4312c609719bSwdenk	make oldconfig
4313c609719bSwdenk	make dep
431424ee89b9Swdenk	make uImage
4315c609719bSwdenk
431624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
431724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
431824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4319c609719bSwdenk
432024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
432124ee89b9Swdenk
432224ee89b9Swdenk* convert the kernel into a raw binary image:
432324ee89b9Swdenk
432424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
432524ee89b9Swdenk				 -R .note -R .comment \
432624ee89b9Swdenk				 -S vmlinux linux.bin
432724ee89b9Swdenk
432824ee89b9Swdenk* compress the binary image:
432924ee89b9Swdenk
433024ee89b9Swdenk	gzip -9 linux.bin
433124ee89b9Swdenk
433224ee89b9Swdenk* package compressed binary image for U-Boot:
433324ee89b9Swdenk
433424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
433524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
433624ee89b9Swdenk		-d linux.bin.gz uImage
433724ee89b9Swdenk
433824ee89b9Swdenk
433924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
434024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
434124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
434224ee89b9Swdenkbyte header containing information about target architecture,
434324ee89b9Swdenkoperating system, image type, compression method, entry points, time
434424ee89b9Swdenkstamp, CRC32 checksums, etc.
434524ee89b9Swdenk
434624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
434724ee89b9Swdenkprint the header information, or to build new images.
4348c609719bSwdenk
4349c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4350c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4351c609719bSwdenkchecksum verification:
4352c609719bSwdenk
4353c609719bSwdenk	tools/mkimage -l image
4354c609719bSwdenk	  -l ==> list image header information
4355c609719bSwdenk
4356c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4357c609719bSwdenkfrom a "data file" which is used as image payload:
4358c609719bSwdenk
4359c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4360c609719bSwdenk		      -n name -d data_file image
4361c609719bSwdenk	  -A ==> set architecture to 'arch'
4362c609719bSwdenk	  -O ==> set operating system to 'os'
4363c609719bSwdenk	  -T ==> set image type to 'type'
4364c609719bSwdenk	  -C ==> set compression type 'comp'
4365c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4366c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4367c609719bSwdenk	  -n ==> set image name to 'name'
4368c609719bSwdenk	  -d ==> use image data from 'datafile'
4369c609719bSwdenk
437069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
437169459791Swdenkaddress (0x00000000), but the entry point address depends on the
437269459791Swdenkkernel version:
4373c609719bSwdenk
4374c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
437524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4376c609719bSwdenk
4377c609719bSwdenkSo a typical call to build a U-Boot image would read:
4378c609719bSwdenk
437924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
438024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4381a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
438224ee89b9Swdenk	> examples/uImage.TQM850L
438324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4384c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4385c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4386c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4387c609719bSwdenk	Load Address: 0x00000000
438824ee89b9Swdenk	Entry Point:  0x00000000
4389c609719bSwdenk
4390c609719bSwdenkTo verify the contents of the image (or check for corruption):
4391c609719bSwdenk
439224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
439324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4394c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4395c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4396c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4397c609719bSwdenk	Load Address: 0x00000000
439824ee89b9Swdenk	Entry Point:  0x00000000
4399c609719bSwdenk
4400c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4401c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4402c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4403c609719bSwdenkneed to be uncompressed:
4404c609719bSwdenk
4405a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
440624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
440724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4408a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
440924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
441024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4411c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4412c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4413c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4414c609719bSwdenk	Load Address: 0x00000000
441524ee89b9Swdenk	Entry Point:  0x00000000
4416c609719bSwdenk
4417c609719bSwdenk
4418c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4419c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4420c609719bSwdenk
4421c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4422c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4423c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4424c609719bSwdenk	Image Name:   Simple Ramdisk Image
4425c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4426c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4427c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4428c609719bSwdenk	Load Address: 0x00000000
4429c609719bSwdenk	Entry Point:  0x00000000
4430c609719bSwdenk
4431c609719bSwdenk
4432c609719bSwdenkInstalling a Linux Image:
4433c609719bSwdenk-------------------------
4434c609719bSwdenk
4435c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4436c609719bSwdenkyou must convert the image to S-Record format:
4437c609719bSwdenk
4438c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4439c609719bSwdenk
4440c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4441c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4442c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4443c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4444c609719bSwdenkcommand.
4445c609719bSwdenk
4446c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4447c609719bSwdenkTQM8xxL is in the first Flash bank):
4448c609719bSwdenk
4449c609719bSwdenk	=> erase 40100000 401FFFFF
4450c609719bSwdenk
4451c609719bSwdenk	.......... done
4452c609719bSwdenk	Erased 8 sectors
4453c609719bSwdenk
4454c609719bSwdenk	=> loads 40100000
4455c609719bSwdenk	## Ready for S-Record download ...
4456c609719bSwdenk	~>examples/image.srec
4457c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4458c609719bSwdenk	...
4459c609719bSwdenk	15989 15990 15991 15992
4460c609719bSwdenk	[file transfer complete]
4461c609719bSwdenk	[connected]
4462c609719bSwdenk	## Start Addr = 0x00000000
4463c609719bSwdenk
4464c609719bSwdenk
4465c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4466c609719bSwdenkthis includes a checksum verification so you can be sure no data
4467c609719bSwdenkcorruption happened:
4468c609719bSwdenk
4469c609719bSwdenk	=> imi 40100000
4470c609719bSwdenk
4471c609719bSwdenk	## Checking Image at 40100000 ...
4472c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4473c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4474c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4475c609719bSwdenk	   Load Address: 00000000
4476c609719bSwdenk	   Entry Point:	 0000000c
4477c609719bSwdenk	   Verifying Checksum ... OK
4478c609719bSwdenk
4479c609719bSwdenk
4480c609719bSwdenkBoot Linux:
4481c609719bSwdenk-----------
4482c609719bSwdenk
4483c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4484c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4485c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4486c609719bSwdenkparameters. You can check and modify this variable using the
4487c609719bSwdenk"printenv" and "setenv" commands:
4488c609719bSwdenk
4489c609719bSwdenk
4490c609719bSwdenk	=> printenv bootargs
4491c609719bSwdenk	bootargs=root=/dev/ram
4492c609719bSwdenk
4493c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4494c609719bSwdenk
4495c609719bSwdenk	=> printenv bootargs
4496c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4497c609719bSwdenk
4498c609719bSwdenk	=> bootm 40020000
4499c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4500c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4501c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4502c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4503c609719bSwdenk	   Load Address: 00000000
4504c609719bSwdenk	   Entry Point:	 0000000c
4505c609719bSwdenk	   Verifying Checksum ... OK
4506c609719bSwdenk	   Uncompressing Kernel Image ... OK
4507c609719bSwdenk	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
4508c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4509c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4510c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4511c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4512c609719bSwdenk	...
4513c609719bSwdenk
451411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
45157152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4516c609719bSwdenkformat!) to the "bootm" command:
4517c609719bSwdenk
4518c609719bSwdenk	=> imi 40100000 40200000
4519c609719bSwdenk
4520c609719bSwdenk	## Checking Image at 40100000 ...
4521c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4522c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4523c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4524c609719bSwdenk	   Load Address: 00000000
4525c609719bSwdenk	   Entry Point:	 0000000c
4526c609719bSwdenk	   Verifying Checksum ... OK
4527c609719bSwdenk
4528c609719bSwdenk	## Checking Image at 40200000 ...
4529c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4530c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4531c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4532c609719bSwdenk	   Load Address: 00000000
4533c609719bSwdenk	   Entry Point:	 00000000
4534c609719bSwdenk	   Verifying Checksum ... OK
4535c609719bSwdenk
4536c609719bSwdenk	=> bootm 40100000 40200000
4537c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4538c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4539c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4540c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4541c609719bSwdenk	   Load Address: 00000000
4542c609719bSwdenk	   Entry Point:	 0000000c
4543c609719bSwdenk	   Verifying Checksum ... OK
4544c609719bSwdenk	   Uncompressing Kernel Image ... OK
4545c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4546c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4547c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4548c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4549c609719bSwdenk	   Load Address: 00000000
4550c609719bSwdenk	   Entry Point:	 00000000
4551c609719bSwdenk	   Verifying Checksum ... OK
4552c609719bSwdenk	   Loading Ramdisk ... OK
4553c609719bSwdenk	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
4554c609719bSwdenk	Boot arguments: root=/dev/ram
4555c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4556c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4557c609719bSwdenk	...
4558c609719bSwdenk	RAMDISK: Compressed image found at block 0
4559c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4560c609719bSwdenk
4561c609719bSwdenk	bash#
4562c609719bSwdenk
45630267768eSMatthew McClintockBoot Linux and pass a flat device tree:
45640267768eSMatthew McClintock-----------
45650267768eSMatthew McClintock
45660267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
45670267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
45680267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
45690267768eSMatthew McClintockflat device tree:
45700267768eSMatthew McClintock
45710267768eSMatthew McClintock=> print oftaddr
45720267768eSMatthew McClintockoftaddr=0x300000
45730267768eSMatthew McClintock=> print oft
45740267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
45750267768eSMatthew McClintock=> tftp $oftaddr $oft
45760267768eSMatthew McClintockSpeed: 1000, full duplex
45770267768eSMatthew McClintockUsing TSEC0 device
45780267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
45790267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
45800267768eSMatthew McClintockLoad address: 0x300000
45810267768eSMatthew McClintockLoading: #
45820267768eSMatthew McClintockdone
45830267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
45840267768eSMatthew McClintock=> tftp $loadaddr $bootfile
45850267768eSMatthew McClintockSpeed: 1000, full duplex
45860267768eSMatthew McClintockUsing TSEC0 device
45870267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
45880267768eSMatthew McClintockFilename 'uImage'.
45890267768eSMatthew McClintockLoad address: 0x200000
45900267768eSMatthew McClintockLoading:############
45910267768eSMatthew McClintockdone
45920267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
45930267768eSMatthew McClintock=> print loadaddr
45940267768eSMatthew McClintockloadaddr=200000
45950267768eSMatthew McClintock=> print oftaddr
45960267768eSMatthew McClintockoftaddr=0x300000
45970267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
45980267768eSMatthew McClintock## Booting image at 00200000 ...
45990267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
46000267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
46010267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
46020267768eSMatthew McClintock   Load Address: 00000000
46030267768eSMatthew McClintock   Entry Point:	 00000000
46040267768eSMatthew McClintock   Verifying Checksum ... OK
46050267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
46060267768eSMatthew McClintockBooting using flat device tree at 0x300000
46070267768eSMatthew McClintockUsing MPC85xx ADS machine description
46080267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
46090267768eSMatthew McClintock[snip]
46100267768eSMatthew McClintock
46110267768eSMatthew McClintock
46126069ff26SwdenkMore About U-Boot Image Types:
46136069ff26Swdenk------------------------------
46146069ff26Swdenk
46156069ff26SwdenkU-Boot supports the following image types:
46166069ff26Swdenk
46176069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
46186069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
46196069ff26Swdenk	well) you can continue to work in U-Boot after return from
46206069ff26Swdenk	the Standalone Program.
46216069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
46226069ff26Swdenk	will take over control completely. Usually these programs
46236069ff26Swdenk	will install their own set of exception handlers, device
46246069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
46256069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
46266069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
46276069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
46286069ff26Swdenk	being started.
46296069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
46306069ff26Swdenk	(Linux) kernel image and one or more data images like
46316069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
46326069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
46336069ff26Swdenk	server provides just a single image file, but you want to get
46346069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
46356069ff26Swdenk
46366069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
46376069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
46386069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
46396069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
46406069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
46416069ff26Swdenk	a multiple of 4 bytes).
46426069ff26Swdenk
46436069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
46446069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
46456069ff26Swdenk	flash memory.
46466069ff26Swdenk
46476069ff26Swdenk   "Script files" are command sequences that will be executed by
46486069ff26Swdenk	U-Boot's command interpreter; this feature is especially
46496069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
46506069ff26Swdenk	as command interpreter.
46516069ff26Swdenk
465244f074c7SMarek VasutBooting the Linux zImage:
465344f074c7SMarek Vasut-------------------------
465444f074c7SMarek Vasut
465544f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
465644f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
465744f074c7SMarek Vasutas the syntax of "bootm" command.
465844f074c7SMarek Vasut
4659017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4660017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4661017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4662017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4663017e1f3fSMarek Vasut
4664c609719bSwdenk
4665c609719bSwdenkStandalone HOWTO:
4666c609719bSwdenk=================
4667c609719bSwdenk
4668c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4669c609719bSwdenkrun "standalone" applications, which can use some resources of
4670c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4671c609719bSwdenk
4672c609719bSwdenkTwo simple examples are included with the sources:
4673c609719bSwdenk
4674c609719bSwdenk"Hello World" Demo:
4675c609719bSwdenk-------------------
4676c609719bSwdenk
4677c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4678c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4679c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4680c609719bSwdenklike that:
4681c609719bSwdenk
4682c609719bSwdenk	=> loads
4683c609719bSwdenk	## Ready for S-Record download ...
4684c609719bSwdenk	~>examples/hello_world.srec
4685c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4686c609719bSwdenk	[file transfer complete]
4687c609719bSwdenk	[connected]
4688c609719bSwdenk	## Start Addr = 0x00040004
4689c609719bSwdenk
4690c609719bSwdenk	=> go 40004 Hello World! This is a test.
4691c609719bSwdenk	## Starting application at 0x00040004 ...
4692c609719bSwdenk	Hello World
4693c609719bSwdenk	argc = 7
4694c609719bSwdenk	argv[0] = "40004"
4695c609719bSwdenk	argv[1] = "Hello"
4696c609719bSwdenk	argv[2] = "World!"
4697c609719bSwdenk	argv[3] = "This"
4698c609719bSwdenk	argv[4] = "is"
4699c609719bSwdenk	argv[5] = "a"
4700c609719bSwdenk	argv[6] = "test."
4701c609719bSwdenk	argv[7] = "<NULL>"
4702c609719bSwdenk	Hit any key to exit ...
4703c609719bSwdenk
4704c609719bSwdenk	## Application terminated, rc = 0x0
4705c609719bSwdenk
4706c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4707c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4708c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4709c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4710c609719bSwdenkcharacter, but this is just a demo program. The application can be
4711c609719bSwdenkcontrolled by the following keys:
4712c609719bSwdenk
4713c609719bSwdenk	? - print current values og the CPM Timer registers
4714c609719bSwdenk	b - enable interrupts and start timer
4715c609719bSwdenk	e - stop timer and disable interrupts
4716c609719bSwdenk	q - quit application
4717c609719bSwdenk
4718c609719bSwdenk	=> loads
4719c609719bSwdenk	## Ready for S-Record download ...
4720c609719bSwdenk	~>examples/timer.srec
4721c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4722c609719bSwdenk	[file transfer complete]
4723c609719bSwdenk	[connected]
4724c609719bSwdenk	## Start Addr = 0x00040004
4725c609719bSwdenk
4726c609719bSwdenk	=> go 40004
4727c609719bSwdenk	## Starting application at 0x00040004 ...
4728c609719bSwdenk	TIMERS=0xfff00980
4729c609719bSwdenk	Using timer 1
4730c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4731c609719bSwdenk
4732c609719bSwdenkHit 'b':
4733c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4734c609719bSwdenk	Enabling timer
4735c609719bSwdenkHit '?':
4736c609719bSwdenk	[q, b, e, ?] ........
4737c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4738c609719bSwdenkHit '?':
4739c609719bSwdenk	[q, b, e, ?] .
4740c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4741c609719bSwdenkHit '?':
4742c609719bSwdenk	[q, b, e, ?] .
4743c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4744c609719bSwdenkHit '?':
4745c609719bSwdenk	[q, b, e, ?] .
4746c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4747c609719bSwdenkHit 'e':
4748c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4749c609719bSwdenkHit 'q':
4750c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4751c609719bSwdenk
4752c609719bSwdenk
475385ec0bccSwdenkMinicom warning:
475485ec0bccSwdenk================
475585ec0bccSwdenk
47567152b1d0SwdenkOver time, many people have reported problems when trying to use the
475785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
475885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4759f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
476085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
4761e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
4762e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
4763e53515a2SKarl O. Pincfor help with kermit.
4764e53515a2SKarl O. Pinc
476585ec0bccSwdenk
476652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
476752f52c14Swdenkconfiguration to your "File transfer protocols" section:
476852f52c14Swdenk
476952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
477052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
477152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
477252f52c14Swdenk
477352f52c14Swdenk
4774c609719bSwdenkNetBSD Notes:
4775c609719bSwdenk=============
4776c609719bSwdenk
4777c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4778c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4779c609719bSwdenk
4780c609719bSwdenkBuilding requires a cross environment; it is known to work on
4781c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4782c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4783c609719bSwdenkNote that the cross-powerpc package does not install include files;
4784c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4785c609719bSwdenkmissing.  This file has to be installed and patched manually:
4786c609719bSwdenk
4787c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4788c609719bSwdenk	# mkdir powerpc
4789c609719bSwdenk	# ln -s powerpc machine
4790c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4791c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4792c609719bSwdenk
4793c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4794c609719bSwdenkand U-Boot include files.
4795c609719bSwdenk
4796c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4797c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4798c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4799c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
48002a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4801c609719bSwdenk
4802c609719bSwdenk
4803c609719bSwdenkImplementation Internals:
4804c609719bSwdenk=========================
4805c609719bSwdenk
4806c609719bSwdenkThe following is not intended to be a complete description of every
4807c609719bSwdenkimplementation detail. However, it should help to understand the
4808c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4809c609719bSwdenkhardware.
4810c609719bSwdenk
4811c609719bSwdenk
4812c609719bSwdenkInitial Stack, Global Data:
4813c609719bSwdenk---------------------------
4814c609719bSwdenk
4815c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4816c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4817c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4818c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4819c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4820c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4821c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4822c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4823c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4824c609719bSwdenklocked as (mis-) used as memory, etc.
4825c609719bSwdenk
48267152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
48270668236bSWolfgang Denk	U-Boot mailing list:
482843d9616cSwdenk
482943d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
483043d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
483143d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
483243d9616cSwdenk	...
483343d9616cSwdenk
483443d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
483543d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
483643d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
483743d9616cSwdenk	is that the cache is being used as a temporary supply of
483843d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
483911ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
484043d9616cSwdenk	can see how this works by studying the cache architecture and
484143d9616cSwdenk	operation in the architecture and processor-specific manuals.
484243d9616cSwdenk
484343d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
484443d9616cSwdenk	is another option for the system designer to use as an
484511ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
484643d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
484743d9616cSwdenk	board designers haven't used it for something that would
484843d9616cSwdenk	cause you grief during the initial boot! It is frequently not
484943d9616cSwdenk	used.
485043d9616cSwdenk
48516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
485243d9616cSwdenk	with your processor/board/system design. The default value
485343d9616cSwdenk	you will find in any recent u-boot distribution in
48548a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
485543d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
485643d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
485743d9616cSwdenk	that are supposed to respond to that address! That code in
485843d9616cSwdenk	start.S has been around a while and should work as is when
485943d9616cSwdenk	you get the config right.
486043d9616cSwdenk
486143d9616cSwdenk	-Chris Hallinan
486243d9616cSwdenk	DS4.COM, Inc.
486343d9616cSwdenk
4864c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4865c609719bSwdenkcode for the initialization procedures:
4866c609719bSwdenk
4867c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4868c609719bSwdenk  to write it.
4869c609719bSwdenk
487011ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4871c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
48727152b1d0Swdenk  zation is performed later (when relocating to RAM).
4873c609719bSwdenk
4874c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4875c609719bSwdenk  that.
4876c609719bSwdenk
4877c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4878c609719bSwdenknormal global data to share information beween the code. But it
4879c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4880c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4881c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4882c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4883c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4884c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4885c609719bSwdenkreserve for this purpose.
4886c609719bSwdenk
48877152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4888c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4889c609719bSwdenkGCC's implementation.
4890c609719bSwdenk
4891c609719bSwdenkFor PowerPC, the following registers have specific use:
4892c609719bSwdenk	R1:	stack pointer
4893e7670f6cSWolfgang Denk	R2:	reserved for system use
4894c609719bSwdenk	R3-R4:	parameter passing and return values
4895c609719bSwdenk	R5-R10: parameter passing
4896c609719bSwdenk	R13:	small data area pointer
4897c609719bSwdenk	R30:	GOT pointer
4898c609719bSwdenk	R31:	frame pointer
4899c609719bSwdenk
4900e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4901e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4902e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4903c609719bSwdenk
4904e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4905c609719bSwdenk
4906c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4907c609719bSwdenk    address of the global data structure is known at compile time),
4908c609719bSwdenk    but it turned out that reserving a register results in somewhat
4909c609719bSwdenk    smaller code - although the code savings are not that big (on
4910c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4911c609719bSwdenk    624 text + 127 data).
4912c609719bSwdenk
4913c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
49144c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
49154c58eb55SMike Frysinger
4916c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
49174c58eb55SMike Frysinger
4918c609719bSwdenkOn ARM, the following registers are used:
4919c609719bSwdenk
4920c609719bSwdenk	R0:	function argument word/integer result
4921c609719bSwdenk	R1-R3:	function argument word
4922c609719bSwdenk	R9:	GOT pointer
4923c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4924c609719bSwdenk	R11:	argument (frame) pointer
4925c609719bSwdenk	R12:	temporary workspace
4926c609719bSwdenk	R13:	stack pointer
4927c609719bSwdenk	R14:	link register
4928c609719bSwdenk	R15:	program counter
4929c609719bSwdenk
4930c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4931c609719bSwdenk
49320df01fd3SThomas ChouOn Nios II, the ABI is documented here:
49330df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
49340df01fd3SThomas Chou
49350df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
49360df01fd3SThomas Chou
49370df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
49380df01fd3SThomas Chou    to access small data sections, so gp is free.
49390df01fd3SThomas Chou
4940afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4941afc1ce82SMacpaul Lin
4942afc1ce82SMacpaul Lin	R0-R1:	argument/return
4943afc1ce82SMacpaul Lin	R2-R5:	argument
4944afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4945afc1ce82SMacpaul Lin	R16:	trampoline register
4946afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4947afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4948afc1ce82SMacpaul Lin	R30:	link register (LP)
4949afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4950afc1ce82SMacpaul Lin	PC:	program counter (PC)
4951afc1ce82SMacpaul Lin
4952afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4953afc1ce82SMacpaul Lin
4954d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4955d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4956c609719bSwdenk
4957c609719bSwdenkMemory Management:
4958c609719bSwdenk------------------
4959c609719bSwdenk
4960c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4961c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4962c609719bSwdenk
4963c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4964c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4965c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4966c609719bSwdenkphysical memory banks.
4967c609719bSwdenk
4968c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4969c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4970c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4971c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
49726d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4973c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4974c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4975c609719bSwdenk
4976c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4977c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4978c609719bSwdenk
4979c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4980c609719bSwdenkthis:
4981c609719bSwdenk
4982c609719bSwdenk	0x0000 0000	Exception Vector code
4983c609719bSwdenk	      :
4984c609719bSwdenk	0x0000 1FFF
4985c609719bSwdenk	0x0000 2000	Free for Application Use
4986c609719bSwdenk	      :
4987c609719bSwdenk	      :
4988c609719bSwdenk
4989c609719bSwdenk	      :
4990c609719bSwdenk	      :
4991c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4992c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4993c609719bSwdenk	0x00FC 0000	Malloc Arena
4994c609719bSwdenk	      :
4995c609719bSwdenk	0x00FD FFFF
4996c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4997c609719bSwdenk	...		eventually: LCD or video framebuffer
4998c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4999c609719bSwdenk	0x00FF FFFF	[End of RAM]
5000c609719bSwdenk
5001c609719bSwdenk
5002c609719bSwdenkSystem Initialization:
5003c609719bSwdenk----------------------
5004c609719bSwdenk
5005c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
500611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5007c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
50087152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5009c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5010c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5011c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5012c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5013c609719bSwdenkthe caches and the SIU.
5014c609719bSwdenk
5015c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5016c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5017c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5018c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5019c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5020c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5021c609719bSwdenkbanks.
5022c609719bSwdenk
5023c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
50247152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5025c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5026c609719bSwdenk0x00000000, with any additional banks following immediately to create
5027c609719bSwdenkcontiguous memory starting from 0.
5028c609719bSwdenk
5029c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5030c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5031c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5032c609719bSwdenkpages, and the final stack is set up.
5033c609719bSwdenk
5034c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5035c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5036c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5037c609719bSwdenknew address in RAM.
5038c609719bSwdenk
5039c609719bSwdenk
5040c609719bSwdenkU-Boot Porting Guide:
5041c609719bSwdenk----------------------
5042c609719bSwdenk
5043c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
50446aff3115Swdenklist, October 2002]
5045c609719bSwdenk
5046c609719bSwdenk
5047c609719bSwdenkint main(int argc, char *argv[])
5048c609719bSwdenk{
5049c609719bSwdenk	sighandler_t no_more_time;
5050c609719bSwdenk
5051c609719bSwdenk	signal(SIGALRM, no_more_time);
5052c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5053c609719bSwdenk
5054c609719bSwdenk	if (available_money > available_manpower) {
50556c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5056c609719bSwdenk		return 0;
5057c609719bSwdenk	}
5058c609719bSwdenk
5059c609719bSwdenk	Download latest U-Boot source;
5060c609719bSwdenk
50610668236bSWolfgang Denk	Subscribe to u-boot mailing list;
50626aff3115Swdenk
50636c3fef28SJerry Van Baren	if (clueless)
5064c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5065c609719bSwdenk
5066c609719bSwdenk	while (learning) {
5067c609719bSwdenk		Read the README file in the top level directory;
50687cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
50696c3fef28SJerry Van Baren		Read applicable doc/*.README;
5070c609719bSwdenk		Read the source, Luke;
50716c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5072c609719bSwdenk	}
5073c609719bSwdenk
50746c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
50756c3fef28SJerry Van Baren		Buy a BDI3000;
50766c3fef28SJerry Van Baren	else
5077c609719bSwdenk		Add a lot of aggravation and time;
5078c609719bSwdenk
50796c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
50806c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
50816c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
50826c3fef28SJerry Van Baren	} else {
5083c609719bSwdenk		Create your own board support subdirectory;
50846c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
50856c3fef28SJerry Van Baren	}
50866c3fef28SJerry Van Baren	Edit new board/<myboard> files
50876c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5088c609719bSwdenk
50896c3fef28SJerry Van Baren	while (!accepted) {
5090c609719bSwdenk		while (!running) {
5091c609719bSwdenk			do {
5092c609719bSwdenk				Add / modify source code;
5093c609719bSwdenk			} until (compiles);
5094c609719bSwdenk			Debug;
5095c609719bSwdenk			if (clueless)
5096c609719bSwdenk				email("Hi, I am having problems...");
5097c609719bSwdenk		}
50986c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
50996c3fef28SJerry Van Baren		if (reasonable critiques)
51006c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
51016c3fef28SJerry Van Baren		else
51026c3fef28SJerry Van Baren			Defend code as written;
51036c3fef28SJerry Van Baren	}
5104c609719bSwdenk
5105c609719bSwdenk	return 0;
5106c609719bSwdenk}
5107c609719bSwdenk
5108c609719bSwdenkvoid no_more_time (int sig)
5109c609719bSwdenk{
5110c609719bSwdenk      hire_a_guru();
5111c609719bSwdenk}
5112c609719bSwdenk
5113c609719bSwdenk
5114c609719bSwdenkCoding Standards:
5115c609719bSwdenk-----------------
5116c609719bSwdenk
5117c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
51182c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
51197ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5120c609719bSwdenk
51212c051651SDetlev ZundelSource files originating from a different project (for example the
51222c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
51232c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
51242c051651SDetlev Zundelsources.
51252c051651SDetlev Zundel
51262c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
51272c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
51282c051651SDetlev Zundelin your code.
5129c609719bSwdenk
5130c178d3daSwdenkPlease also stick to the following formatting rules:
5131180d3f74Swdenk- remove any trailing white space
51327ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5133180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
51347ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5135180d3f74Swdenk- do not add trailing empty lines to source files
5136180d3f74Swdenk
5137c609719bSwdenkSubmissions which do not conform to the standards may be returned
5138c609719bSwdenkwith a request to reformat the changes.
5139c609719bSwdenk
5140c609719bSwdenk
5141c609719bSwdenkSubmitting Patches:
5142c609719bSwdenk-------------------
5143c609719bSwdenk
5144c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5145c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5146c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5147c609719bSwdenk
51480d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5149218ca724SWolfgang Denk
51500668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
51510668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
51520668236bSWolfgang Denk
5153c609719bSwdenkWhen you send a patch, please include the following information with
5154c609719bSwdenkit:
5155c609719bSwdenk
5156c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5157c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5158c609719bSwdenk  patch actually fixes something.
5159c609719bSwdenk
5160c609719bSwdenk* For new features: a description of the feature and your
5161c609719bSwdenk  implementation.
5162c609719bSwdenk
5163c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5164c609719bSwdenk
5165c609719bSwdenk* For major contributions, your entry to the CREDITS file
5166c609719bSwdenk
5167c609719bSwdenk* When you add support for a new board, don't forget to add this
51687ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5169c609719bSwdenk
5170c609719bSwdenk* If your patch adds new configuration options, don't forget to
5171c609719bSwdenk  document these in the README file.
5172c609719bSwdenk
5173218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5174218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
51757ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5176218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5177218ca724SWolfgang Denk  with some other mail clients.
5178c609719bSwdenk
5179218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5180218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5181218ca724SWolfgang Denk  GNU diff.
51826dff5529Swdenk
5183218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5184218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5185218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5186218ca724SWolfgang Denk  affected files).
5187218ca724SWolfgang Denk
5188218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5189218ca724SWolfgang Denk  and compressed attachments must not be used.
5190c609719bSwdenk
519152f52c14Swdenk* If one logical set of modifications affects or creates several
519252f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
519352f52c14Swdenk
519452f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
519552f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
519652f52c14Swdenk
519752f52c14Swdenk
5198c609719bSwdenkNotes:
5199c609719bSwdenk
5200c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5201c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5202c609719bSwdenk  for any of the boards.
5203c609719bSwdenk
5204c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5205c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5206c609719bSwdenk  returned with a request to re-formatting / split it.
5207c609719bSwdenk
5208c609719bSwdenk* If you modify existing code, make sure that your new code does not
5209c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5210c609719bSwdenk  When adding new features, these should compile conditionally only
5211c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5212c609719bSwdenk  disabled must not need more memory than the old code without your
5213c609719bSwdenk  modification.
521490dc6704Swdenk
52150668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
52160668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
52170668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
52180668236bSWolfgang Denk  bigger than the size limit should be avoided.
5219