xref: /openbmc/u-boot/README (revision c30a15e590c7e5bfd27e4704c81648071f11d51f)
1c609719bSwdenk#
26abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011
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:
36666412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36766412c63SKumar Gala
36866412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36966412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37066412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37166412c63SKumar Gala
3728f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3738f29084aSKumar Gala
3748f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3758f29084aSKumar Gala		tree nodes for the given platform.
3768f29084aSKumar Gala
3770b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3790b953ffcSMarkus Klotzbuecher
3800b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3810b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3820b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3830b953ffcSMarkus Klotzbuecher
3846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3850b953ffcSMarkus Klotzbuecher
3860b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3870b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3880b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3890b953ffcSMarkus Klotzbuecher		by this value.
3900b953ffcSMarkus Klotzbuecher
39192bbd64eSDaniel Schwierzeck- MIPS CPU options:
39292bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
39392bbd64eSDaniel Schwierzeck
39492bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
39592bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
39692bbd64eSDaniel Schwierzeck		relocation.
39792bbd64eSDaniel Schwierzeck
39892bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
39992bbd64eSDaniel Schwierzeck
40092bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
40192bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
40292bbd64eSDaniel Schwierzeck		Possible values are:
40392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
40492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
40592bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
40692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
40792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
40892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
40992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
41092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
41192bbd64eSDaniel Schwierzeck
41292bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
41392bbd64eSDaniel Schwierzeck
41492bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
41592bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
41692bbd64eSDaniel Schwierzeck
41792bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
41892bbd64eSDaniel Schwierzeck
41992bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
42092bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
42192bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
42292bbd64eSDaniel Schwierzeck
4235da627a4Swdenk- Linux Kernel Interface:
424c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
425c609719bSwdenk
426c609719bSwdenk		U-Boot stores all clock information in Hz
427c609719bSwdenk		internally. For binary compatibility with older Linux
428c609719bSwdenk		kernels (which expect the clocks passed in the
429c609719bSwdenk		bd_info data to be in MHz) the environment variable
430c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
431c609719bSwdenk		converts clock data to MHZ before passing it to the
432c609719bSwdenk		Linux kernel.
433c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
434c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
435c609719bSwdenk		default environment.
436c609719bSwdenk
4375da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4385da627a4Swdenk
43911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4405da627a4Swdenk		expect it to be in bytes, others in MB.
4415da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4425da627a4Swdenk
443fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
444f57f70aaSWolfgang Denk
445f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
446213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
447213bf8c8SGerald Van Baren		concepts).
448213bf8c8SGerald Van Baren
449213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
450213bf8c8SGerald Van Baren		 * New libfdt-based support
451213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4523bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
453213bf8c8SGerald Van Baren
454b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
455b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
456b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
457b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
458f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
459c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
460f57f70aaSWolfgang Denk
46111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
46211ccc33fSMarcel Ziswiler		addresses
4633bb342fcSKim Phillips
4644e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4654e253137SKumar Gala
4664e253137SKumar Gala		Board code has addition modification that it wants to make
4674e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4686705d81eSwdenk
4690267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4700267768eSMatthew McClintock
47111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4720267768eSMatthew McClintock		param header, the default value is zero if undefined.
4730267768eSMatthew McClintock
4743887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4753887c3fbSHeiko Schocher
4763887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4773887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4783887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4793887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4803887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4813887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4823887c3fbSHeiko Schocher
4837eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
4847eb29398SIgor Grinberg
4857eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
4867eb29398SIgor Grinberg		machine type and must be used to specify the machine type
4877eb29398SIgor Grinberg		number as it appears in the ARM machine registry
4887eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
4897eb29398SIgor Grinberg		Only boards that have multiple machine types supported
4907eb29398SIgor Grinberg		in a single configuration file and the machine type is
4917eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
4927eb29398SIgor Grinberg
4930b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4940b2f4ecaSNiklaus Giger
4950b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4960b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4970b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4980b2f4ecaSNiklaus Giger
4990b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5000b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5010b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5020b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5030b2f4ecaSNiklaus Giger
5040b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5050b2f4ecaSNiklaus Giger
5060b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5070b2f4ecaSNiklaus Giger
5080b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5090b2f4ecaSNiklaus Giger		the defaults discussed just above.
5100b2f4ecaSNiklaus Giger
5112c451f78SAneesh V- Cache Configuration:
5122c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5132c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5142c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5152c451f78SAneesh V
51693bc2193SAneesh V- Cache Configuration for ARM:
51793bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
51893bc2193SAneesh V				      controller
51993bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
52093bc2193SAneesh V					controller register space
52193bc2193SAneesh V
5226705d81eSwdenk- Serial Ports:
52348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5246705d81eSwdenk
5256705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5266705d81eSwdenk
52748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5286705d81eSwdenk
5296705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5306705d81eSwdenk
5316705d81eSwdenk		CONFIG_PL011_CLOCK
5326705d81eSwdenk
5336705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5346705d81eSwdenk		the clock speed of the UARTs.
5356705d81eSwdenk
5366705d81eSwdenk		CONFIG_PL01x_PORTS
5376705d81eSwdenk
5386705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5396705d81eSwdenk		define this to a list of base addresses for each (supported)
5406705d81eSwdenk		port. See e.g. include/configs/versatile.h
5416705d81eSwdenk
542910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
543910f1ae3SJohn Rigby
544910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
545910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
546910f1ae3SJohn Rigby		this variable to initialize the extra register.
547910f1ae3SJohn Rigby
548910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
549910f1ae3SJohn Rigby
550910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
551910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
552910f1ae3SJohn Rigby		variable to flush the UART at init time.
553910f1ae3SJohn Rigby
5546705d81eSwdenk
555c609719bSwdenk- Console Interface:
556c609719bSwdenk		Depending on board, define exactly one serial port
557c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
558c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
559c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
560c609719bSwdenk
561c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
562c609719bSwdenk		port routines must be defined elsewhere
563c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
564c609719bSwdenk
565c609719bSwdenk		CONFIG_CFB_CONSOLE
566c609719bSwdenk		Enables console device for a color framebuffer. Needs following
567c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
568c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
569c609719bSwdenk						(default big endian)
570c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
571c609719bSwdenk						rectangle fill
572c609719bSwdenk						(cf. smiLynxEM)
573c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
574c609719bSwdenk						bit-blit (cf. smiLynxEM)
575c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
576c609719bSwdenk						(cols=pitch)
577c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
578c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
579c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
580c609719bSwdenk						(0-5, cf. cfb_console.c)
581c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
582c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
583c609719bSwdenk						(i.e. i8042_kbd_init())
584c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
585c609719bSwdenk						(i.e. i8042_tstc)
586c609719bSwdenk			VIDEO_GETC_FCT		get char fct
587c609719bSwdenk						(i.e. i8042_getc)
588c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
589c609719bSwdenk						(requires blink timer
590c609719bSwdenk						cf. i8042.c)
5916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
592c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
593c609719bSwdenk						upper right corner
594602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
595c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
596c609719bSwdenk						upper left corner
597a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
598a6c7ad2fSwdenk						linux_logo.h for logo.
599a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
600c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
60111ccc33fSMarcel Ziswiler						additional board info beside
602c609719bSwdenk						the logo
603c609719bSwdenk
604c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
605c609719bSwdenk		default i/o. Serial console can be forced with
606c609719bSwdenk		environment 'console=serial'.
607c609719bSwdenk
608a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
609a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
610a3ad8e26Swdenk		the "silent" environment variable. See
611a3ad8e26Swdenk		doc/README.silent for more information.
612a3ad8e26Swdenk
613c609719bSwdenk- Console Baudrate:
614c609719bSwdenk		CONFIG_BAUDRATE - in bps
615c609719bSwdenk		Select one of the baudrates listed in
6166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
618c609719bSwdenk
619c92fac91SHeiko Schocher- Console Rx buffer length
620c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
621c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6222b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
623c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
624c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
625c92fac91SHeiko Schocher		the SMC.
626c92fac91SHeiko Schocher
6279558b48aSGraeme Russ- Pre-Console Buffer:
6289558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6299558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6309558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6319558b48aSGraeme Russ		buffer any console messages prior to the console being
6329558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6339558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6349558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6359558b48aSGraeme Russ		bytes are output before the console is initialised, the
6369558b48aSGraeme Russ		earlier bytes are discarded.
6379558b48aSGraeme Russ
6389558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6399558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
6409558b48aSGraeme Russ
641c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
642c609719bSwdenk		Delay before automatically booting the default image;
643c609719bSwdenk		set to -1 to disable autoboot.
644c609719bSwdenk
645c609719bSwdenk		See doc/README.autoboot for these options that
646c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
647c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
648c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
649c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
650c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
651c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
652c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
653c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
654c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
655c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
656c609719bSwdenk		CONFIG_RESET_TO_RETRY
657c609719bSwdenk
658c609719bSwdenk- Autoboot Command:
659c609719bSwdenk		CONFIG_BOOTCOMMAND
660c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
661c609719bSwdenk		define a command string that is automatically executed
662c609719bSwdenk		when no character is read on the console interface
663c609719bSwdenk		within "Boot Delay" after reset.
664c609719bSwdenk
665c609719bSwdenk		CONFIG_BOOTARGS
666c609719bSwdenk		This can be used to pass arguments to the bootm
667c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
668c609719bSwdenk		environment value "bootargs".
669c609719bSwdenk
670c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
671c609719bSwdenk		The value of these goes into the environment as
672c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
673c609719bSwdenk		as a convenience, when switching between booting from
67411ccc33fSMarcel Ziswiler		RAM and NFS.
675c609719bSwdenk
676c609719bSwdenk- Pre-Boot Commands:
677c609719bSwdenk		CONFIG_PREBOOT
678c609719bSwdenk
679c609719bSwdenk		When this option is #defined, the existence of the
680c609719bSwdenk		environment variable "preboot" will be checked
681c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
682c609719bSwdenk		countdown and/or running the auto-boot command resp.
683c609719bSwdenk		entering interactive mode.
684c609719bSwdenk
685c609719bSwdenk		This feature is especially useful when "preboot" is
686c609719bSwdenk		automatically generated or modified. For an example
687c609719bSwdenk		see the LWMON board specific code: here "preboot" is
688c609719bSwdenk		modified when the user holds down a certain
689c609719bSwdenk		combination of keys on the (special) keyboard when
690c609719bSwdenk		booting the systems
691c609719bSwdenk
692c609719bSwdenk- Serial Download Echo Mode:
693c609719bSwdenk		CONFIG_LOADS_ECHO
694c609719bSwdenk		If defined to 1, all characters received during a
695c609719bSwdenk		serial download (using the "loads" command) are
696c609719bSwdenk		echoed back. This might be needed by some terminal
697c609719bSwdenk		emulations (like "cu"), but may as well just take
698c609719bSwdenk		time on others. This setting #define's the initial
699c609719bSwdenk		value of the "loads_echo" environment variable.
700c609719bSwdenk
701602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
702c609719bSwdenk		CONFIG_KGDB_BAUDRATE
703c609719bSwdenk		Select one of the baudrates listed in
7046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
705c609719bSwdenk
706c609719bSwdenk- Monitor Functions:
707602ad3b3SJon Loeliger		Monitor commands can be included or excluded
708602ad3b3SJon Loeliger		from the build by using the #include files
709602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
710602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
711602ad3b3SJon Loeliger		and augmenting with additional #define's
712602ad3b3SJon Loeliger		for wanted commands.
713c609719bSwdenk
714602ad3b3SJon Loeliger		The default command configuration includes all commands
715602ad3b3SJon Loeliger		except those marked below with a "*".
716602ad3b3SJon Loeliger
717602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
718602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
719602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
720602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
721602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
722602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
723602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
724602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
725710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
726602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
727602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
728602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
729a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
730a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
731a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
732a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
733602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
734602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
735246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
736602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
737602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7380c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
739bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
740602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
741602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
742602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
743602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
744602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
745a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
746a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
747602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
748602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
749602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
750602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
751602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
752602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7530c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
754602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
755602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
756602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
757602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7581ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
759602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
760602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
76102c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
76202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
763602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
76456523f12Swdenk					  loop, loopw, mtest
765602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
766602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
767602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
76868d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
769602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
770602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
771e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
772e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
773602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
774602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
775602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
776602ad3b3SJon Loeliger					  host
777602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
778602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
779602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
780602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
781602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
782602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
783602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
784602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
785602ad3b3SJon Loeliger					  (4xx only)
786c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
78702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
78874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
789602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
7907a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
7911fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
792ca366d0eSChe-liang Chiou		CONFIG_CMD_TIME		* run command and report execution time
793602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
794602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
795602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
796c609719bSwdenk
797c609719bSwdenk
798c609719bSwdenk		EXAMPLE: If you want all functions except of network
799c609719bSwdenk		support you can write:
800c609719bSwdenk
801602ad3b3SJon Loeliger		#include "config_cmd_all.h"
802602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
803c609719bSwdenk
804213bf8c8SGerald Van Baren	Other Commands:
805213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
806c609719bSwdenk
807c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
808602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
809c609719bSwdenk		what you (and your U-Boot users) are doing. Data
810c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
811c609719bSwdenk		8260 (where accesses to the IMMR region must be
812c609719bSwdenk		uncached), and it cannot be disabled on all other
813c609719bSwdenk		systems where we (mis-) use the data cache to hold an
814c609719bSwdenk		initial stack and some data.
815c609719bSwdenk
816c609719bSwdenk
817c609719bSwdenk		XXX - this list needs to get updated!
818c609719bSwdenk
81945ba8077SSimon Glass- Device tree:
82045ba8077SSimon Glass		CONFIG_OF_CONTROL
82145ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
82245ba8077SSimon Glass		to configure its devices, instead of relying on statically
82345ba8077SSimon Glass		compiled #defines in the board file. This option is
82445ba8077SSimon Glass		experimental and only available on a few boards. The device
82545ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
82645ba8077SSimon Glass
8272c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
8282c0f79e4SSimon Glass		be done using one of the two options below:
829bbb0b128SSimon Glass
830bbb0b128SSimon Glass		CONFIG_OF_EMBED
831bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
832bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
833bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
834bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
835bbb0b128SSimon Glass		the global data structure as gd->blob.
83645ba8077SSimon Glass
8372c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
8382c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
8392c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
8402c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
8412c0f79e4SSimon Glass
8422c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
8432c0f79e4SSimon Glass
8442c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
8452c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
8462c0f79e4SSimon Glass		still use the individual files if you need something more
8472c0f79e4SSimon Glass		exotic.
8482c0f79e4SSimon Glass
849c609719bSwdenk- Watchdog:
850c609719bSwdenk		CONFIG_WATCHDOG
851c609719bSwdenk		If this variable is defined, it enables watchdog
8526abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8536abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8546abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8556abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8566abe6fb6SDetlev Zundel		available, then no further board specific code should
8576abe6fb6SDetlev Zundel		be needed to use it.
8586abe6fb6SDetlev Zundel
8596abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8606abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8616abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8626abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
863c609719bSwdenk
864c1551ea8Sstroese- U-Boot Version:
865c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
866c1551ea8Sstroese		If this variable is defined, an environment variable
867c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
868c1551ea8Sstroese		version as printed by the "version" command.
869c1551ea8Sstroese		This variable is readonly.
870c1551ea8Sstroese
871c609719bSwdenk- Real-Time Clock:
872c609719bSwdenk
873602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
874c609719bSwdenk		has to be selected, too. Define exactly one of the
875c609719bSwdenk		following options:
876c609719bSwdenk
877c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
878c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
8797ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
880c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
8811cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
882c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
8837f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
8843bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
8859536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
8864c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
8876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
88871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
88971d19f30SHeiko Schocher					  RV3029 RTC.
890c609719bSwdenk
891b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
892b37c7e5eSwdenk		must also be configured. See I2C Support, below.
893b37c7e5eSwdenk
894e92739d3SPeter Tyser- GPIO Support:
895e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
896e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
897e92739d3SPeter Tyser
8985dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
8995dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9005dec49caSChris Packham		pins supported by a particular chip.
9015dec49caSChris Packham
902e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
903e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
904e92739d3SPeter Tyser
905c609719bSwdenk- Timestamp Support:
906c609719bSwdenk
907c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
908c609719bSwdenk		(date and time) of an image is printed by image
909c609719bSwdenk		commands like bootm or iminfo. This option is
910602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
911c609719bSwdenk
912c609719bSwdenk- Partition Support:
913c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
91407f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
915c609719bSwdenk
916602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
917218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
918218ca724SWolfgang Denk		least one partition type as well.
919c609719bSwdenk
920c609719bSwdenk- IDE Reset method:
9214d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9224d13cbadSwdenk		board configurations files but used nowhere!
923c609719bSwdenk
9244d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9254d13cbadSwdenk		be performed by calling the function
9264d13cbadSwdenk			ide_set_reset(int reset)
9274d13cbadSwdenk		which has to be defined in a board specific file
928c609719bSwdenk
929c609719bSwdenk- ATAPI Support:
930c609719bSwdenk		CONFIG_ATAPI
931c609719bSwdenk
932c609719bSwdenk		Set this to enable ATAPI support.
933c609719bSwdenk
934c40b2956Swdenk- LBA48 Support
935c40b2956Swdenk		CONFIG_LBA48
936c40b2956Swdenk
937c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9384b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
939c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
940c40b2956Swdenk		support disks up to 2.1TB.
941c40b2956Swdenk
9426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
943c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
944c40b2956Swdenk			Default is 32bit.
945c40b2956Swdenk
946c609719bSwdenk- SCSI Support:
947c609719bSwdenk		At the moment only there is only support for the
948c609719bSwdenk		SYM53C8XX SCSI controller; define
949c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
950c609719bSwdenk
9516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
954c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
955c609719bSwdenk		devices.
9566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
957c609719bSwdenk
958c609719bSwdenk- NETWORK Support (PCI):
959682011ffSwdenk		CONFIG_E1000
960682011ffSwdenk		Support for Intel 8254x gigabit chips.
961682011ffSwdenk
962ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
96311ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
964ac3315c2SAndre Schwarz
965c609719bSwdenk		CONFIG_EEPRO100
966c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
96711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
968c609719bSwdenk		write routine for first time initialisation.
969c609719bSwdenk
970c609719bSwdenk		CONFIG_TULIP
971c609719bSwdenk		Support for Digital 2114x chips.
972c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
973c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
974c609719bSwdenk
975c609719bSwdenk		CONFIG_NATSEMI
976c609719bSwdenk		Support for National dp83815 chips.
977c609719bSwdenk
978c609719bSwdenk		CONFIG_NS8382X
979c609719bSwdenk		Support for National dp8382[01] gigabit chips.
980c609719bSwdenk
98145219c46Swdenk- NETWORK Support (other):
98245219c46Swdenk
983c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
984c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
985c041e9d2SJens Scharsig
986c041e9d2SJens Scharsig			CONFIG_RMII
987c041e9d2SJens Scharsig			Define this to use reduced MII inteface
988c041e9d2SJens Scharsig
989c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
990c041e9d2SJens Scharsig			If this defined, the driver is quiet.
991c041e9d2SJens Scharsig			The driver doen't show link status messages.
992c041e9d2SJens Scharsig
99345219c46Swdenk		CONFIG_DRIVER_LAN91C96
99445219c46Swdenk		Support for SMSC's LAN91C96 chips.
99545219c46Swdenk
99645219c46Swdenk			CONFIG_LAN91C96_BASE
99745219c46Swdenk			Define this to hold the physical address
99845219c46Swdenk			of the LAN91C96's I/O space
99945219c46Swdenk
100045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
100145219c46Swdenk			Define this to enable 32 bit addressing
100245219c46Swdenk
1003f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1004f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1005f39748aeSwdenk
1006f39748aeSwdenk			CONFIG_SMC91111_BASE
1007f39748aeSwdenk			Define this to hold the physical address
1008f39748aeSwdenk			of the device (I/O space)
1009f39748aeSwdenk
1010f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1011f39748aeSwdenk			Define this if data bus is 32 bits
1012f39748aeSwdenk
1013f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1014f39748aeSwdenk			Define this to use i/o functions instead of macros
1015f39748aeSwdenk			(some hardware wont work with macros)
1016f39748aeSwdenk
1017b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1018b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1019b3dbf4a5SMacpaul Lin
1020b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1021b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1022b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1023b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1024b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1025b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1026b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1027b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1028b3dbf4a5SMacpaul Lin
1029c2fff331SMike Rapoport		CONFIG_SMC911X
1030557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1031557b377dSJens Gehrlein
1032c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1033557b377dSJens Gehrlein			Define this to hold the physical address
1034557b377dSJens Gehrlein			of the device (I/O space)
1035557b377dSJens Gehrlein
1036c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1037557b377dSJens Gehrlein			Define this if data bus is 32 bits
1038557b377dSJens Gehrlein
1039c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1040557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1041557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1042c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1043557b377dSJens Gehrlein
10443d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
10453d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
10463d0075faSYoshihiro Shimoda
10473d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
10483d0075faSYoshihiro Shimoda			Define the number of ports to be used
10493d0075faSYoshihiro Shimoda
10503d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
10513d0075faSYoshihiro Shimoda			Define the ETH PHY's address
10523d0075faSYoshihiro Shimoda
105368260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
105468260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
105568260aabSYoshihiro Shimoda
1056c609719bSwdenk- USB Support:
1057c609719bSwdenk		At the moment only the UHCI host controller is
10584d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1059c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1060c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
106130d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1062c609719bSwdenk		storage devices.
1063c609719bSwdenk		Note:
1064c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1065c609719bSwdenk		(TEAC FD-05PUB).
10664d13cbadSwdenk		MPC5200 USB requires additional defines:
10674d13cbadSwdenk			CONFIG_USB_CLOCK
10684d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1069307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1070307ecb6dSEric Millbrandt				for USB on PSC3
10714d13cbadSwdenk			CONFIG_USB_CONFIG
10724d13cbadSwdenk				for differential drivers: 0x00001000
10734d13cbadSwdenk				for single ended drivers: 0x00005000
1074307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1075307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
10766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1077fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1078fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
10794d13cbadSwdenk
108016c8d5e7SWolfgang Denk- USB Device:
108116c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
108216c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
108316c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
108411ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
108516c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
108616c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
108716c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
108816c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
108916c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
109016c8d5e7SWolfgang Denk		a Linux host by
109116c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
109216c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
109316c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
109416c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
109516c8d5e7SWolfgang Denk
109616c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
109716c8d5e7SWolfgang Denk			Define this to build a UDC device
109816c8d5e7SWolfgang Denk
109916c8d5e7SWolfgang Denk			CONFIG_USB_TTY
110016c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
110116c8d5e7SWolfgang Denk			talk to the UDC device
110216c8d5e7SWolfgang Denk
11036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
110416c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
110516c8d5e7SWolfgang Denk			be set to usbtty.
110616c8d5e7SWolfgang Denk
110716c8d5e7SWolfgang Denk			mpc8xx:
11086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
110916c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
11106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
111116c8d5e7SWolfgang Denk
11126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
111316c8d5e7SWolfgang Denk				Derive USB clock from brgclk
11146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
111516c8d5e7SWolfgang Denk
111616c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
111716c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
111816c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
111916c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
112016c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
112116c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
112216c8d5e7SWolfgang Denk
112316c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
112416c8d5e7SWolfgang Denk			Define this string as the name of your company for
112516c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
112616c8d5e7SWolfgang Denk
112716c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
112816c8d5e7SWolfgang Denk			Define this string as the name of your product
112916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
113016c8d5e7SWolfgang Denk
113116c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
113216c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
113316c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
113416c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
113516c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
113616c8d5e7SWolfgang Denk
113716c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
113816c8d5e7SWolfgang Denk			Define this as the unique Product ID
113916c8d5e7SWolfgang Denk			for your device
114016c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1141c609719bSwdenk
1142c609719bSwdenk
1143c609719bSwdenk- MMC Support:
1144c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1145c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1146c609719bSwdenk		accessed from the boot prompt by mapping the device
1147c609719bSwdenk		to physical memory similar to flash. Command line is
1148602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1149602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1150c609719bSwdenk
1151afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1152afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1153afb35666SYoshihiro Shimoda
1154afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1155afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1156afb35666SYoshihiro Shimoda
1157afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1158afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1159afb35666SYoshihiro Shimoda
11606705d81eSwdenk- Journaling Flash filesystem support:
11616705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
11626705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
11636705d81eSwdenk		Define these for a default partition on a NAND device
11646705d81eSwdenk
11656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
11666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
11676705d81eSwdenk		Define these for a default partition on a NOR device
11686705d81eSwdenk
11696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
11706705d81eSwdenk		Define this to create an own partition. You have to provide a
11716705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
11726705d81eSwdenk
11736705d81eSwdenk		If you define only one JFFS2 partition you may also want to
11746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
11756705d81eSwdenk		to disable the command chpart. This is the default when you
11766705d81eSwdenk		have not defined a custom partition
11776705d81eSwdenk
1178*c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1179*c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1180*c30a15e5SDonggeun Kim		Support for saving memory data as a file
1181*c30a15e5SDonggeun Kim		in FAT formatted partition
1182*c30a15e5SDonggeun Kim
1183c609719bSwdenk- Keyboard Support:
1184c609719bSwdenk		CONFIG_ISA_KEYBOARD
1185c609719bSwdenk
1186c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1187c609719bSwdenk		support
1188c609719bSwdenk
1189c609719bSwdenk		CONFIG_I8042_KBD
1190c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1191c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1192c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1193c609719bSwdenk		for cfb_console. Supports cursor blinking.
1194c609719bSwdenk
1195c609719bSwdenk- Video support:
1196c609719bSwdenk		CONFIG_VIDEO
1197c609719bSwdenk
1198c609719bSwdenk		Define this to enable video support (for output to
1199c609719bSwdenk		video).
1200c609719bSwdenk
1201c609719bSwdenk		CONFIG_VIDEO_CT69000
1202c609719bSwdenk
1203c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1204c609719bSwdenk
1205c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1206eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1207eeb1b77bSwdenk		video output is selected via environment 'videoout'
1208eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1209eeb1b77bSwdenk		assumed.
1210c609719bSwdenk
1211eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
121211ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1213eeb1b77bSwdenk		are possible:
1214eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1215eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1216eeb1b77bSwdenk
1217eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1218eeb1b77bSwdenk		-------------+---------------------------------------------
1219eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1220eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1221eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1222eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1223eeb1b77bSwdenk		-------------+---------------------------------------------
1224c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1225c609719bSwdenk
1226eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
12277817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1228eeb1b77bSwdenk
1229eeb1b77bSwdenk
1230a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1231a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1232a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1233a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1234a6c7ad2fSwdenk
12357d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
12367d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
12377d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
12387d3053fbSTimur Tabi		support, and should also define these other macros:
12397d3053fbSTimur Tabi
12407d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
12417d3053fbSTimur Tabi			CONFIG_VIDEO
12427d3053fbSTimur Tabi			CONFIG_CMD_BMP
12437d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
12447d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
12457d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
12467d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
12477d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
12487d3053fbSTimur Tabi
1249ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1250ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1251ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1252ba8e76bdSTimur Tabi		description of this variable.
12537d3053fbSTimur Tabi
1254682011ffSwdenk- Keyboard Support:
1255682011ffSwdenk		CONFIG_KEYBOARD
1256682011ffSwdenk
1257682011ffSwdenk		Define this to enable a custom keyboard support.
1258682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1259682011ffSwdenk		defined in your board-specific files.
1260682011ffSwdenk		The only board using this so far is RBC823.
1261a6c7ad2fSwdenk
1262c609719bSwdenk- LCD Support:	CONFIG_LCD
1263c609719bSwdenk
1264c609719bSwdenk		Define this to enable LCD support (for output to LCD
1265c609719bSwdenk		display); also select one of the supported displays
1266c609719bSwdenk		by defining one of these:
1267c609719bSwdenk
126839cf4804SStelian Pop		CONFIG_ATMEL_LCD:
126939cf4804SStelian Pop
127039cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
127139cf4804SStelian Pop
1272fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1273c609719bSwdenk
1274fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1275c609719bSwdenk
1276fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1277c609719bSwdenk
1278fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1279fd3103bbSwdenk			Active, color, single scan.
1280fd3103bbSwdenk
1281fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1282fd3103bbSwdenk
1283fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1284c609719bSwdenk			Active, color, single scan.
1285c609719bSwdenk
1286c609719bSwdenk		CONFIG_SHARP_16x9
1287c609719bSwdenk
1288c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1289c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1290c609719bSwdenk
1291c609719bSwdenk		CONFIG_SHARP_LQ64D341
1292c609719bSwdenk
1293c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1294c609719bSwdenk			Active, color, single scan.
1295c609719bSwdenk
1296c609719bSwdenk		CONFIG_HLD1045
1297c609719bSwdenk
1298c609719bSwdenk			HLD1045 display, 640x480.
1299c609719bSwdenk			Active, color, single scan.
1300c609719bSwdenk
1301c609719bSwdenk		CONFIG_OPTREX_BW
1302c609719bSwdenk
1303c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1304c609719bSwdenk			or
1305c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1306c609719bSwdenk			or
1307c609719bSwdenk			Hitachi	 SP14Q002
1308c609719bSwdenk
1309c609719bSwdenk			320x240. Black & white.
1310c609719bSwdenk
1311c609719bSwdenk		Normally display is black on white background; define
13126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1313c609719bSwdenk
13147152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1315d791b1dcSwdenk
1316d791b1dcSwdenk		If this option is set, the environment is checked for
1317d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1318d791b1dcSwdenk		of logo, copyright and system information on the LCD
1319e94d2cd9Swdenk		is suppressed and the BMP image at the address
1320d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1321d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1322d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1323d791b1dcSwdenk		loaded very quickly after power-on.
1324d791b1dcSwdenk
13251ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
13261ca298ceSMatthias Weisser
13271ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
13281ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
13291ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
13301ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
13311ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
13321ca298ceSMatthias Weisser		specify 'm' for centering the image.
13331ca298ceSMatthias Weisser
13341ca298ceSMatthias Weisser		Example:
13351ca298ceSMatthias Weisser		setenv splashpos m,m
13361ca298ceSMatthias Weisser			=> image at center of screen
13371ca298ceSMatthias Weisser
13381ca298ceSMatthias Weisser		setenv splashpos 30,20
13391ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
13401ca298ceSMatthias Weisser
13411ca298ceSMatthias Weisser		setenv splashpos -10,m
13421ca298ceSMatthias Weisser			=> vertically centered image
13431ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
13441ca298ceSMatthias Weisser
134598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
134698f4a3dfSStefan Roese
134798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
134898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
134998f4a3dfSStefan Roese		splashscreen support or the bmp command.
135098f4a3dfSStefan Roese
1351d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1352d5011762SAnatolij Gustschin
1353d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1354d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1355d5011762SAnatolij Gustschin		bmp command.
1356d5011762SAnatolij Gustschin
1357c29fdfc1Swdenk- Compression support:
1358c29fdfc1Swdenk		CONFIG_BZIP2
1359c29fdfc1Swdenk
1360c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1361c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1362c29fdfc1Swdenk		compressed images are supported.
1363c29fdfc1Swdenk
1364c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
13656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1366c29fdfc1Swdenk		be at least 4MB.
1367d791b1dcSwdenk
1368fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1369fc9c1727SLuigi 'Comio' Mantellini
1370fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1371fc9c1727SLuigi 'Comio' Mantellini		images is included.
1372fc9c1727SLuigi 'Comio' Mantellini
1373fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1374fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1375fc9c1727SLuigi 'Comio' Mantellini		formula:
1376fc9c1727SLuigi 'Comio' Mantellini
1377fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1378fc9c1727SLuigi 'Comio' Mantellini
1379fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1380fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1381fc9c1727SLuigi 'Comio' Mantellini
1382fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1383fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1384fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1385fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1386fc9c1727SLuigi 'Comio' Mantellini
1387fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1388fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
13896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1390fc9c1727SLuigi 'Comio' Mantellini
139117ea1177Swdenk- MII/PHY support:
139217ea1177Swdenk		CONFIG_PHY_ADDR
139317ea1177Swdenk
139417ea1177Swdenk		The address of PHY on MII bus.
139517ea1177Swdenk
139617ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
139717ea1177Swdenk
139817ea1177Swdenk		The clock frequency of the MII bus
139917ea1177Swdenk
140017ea1177Swdenk		CONFIG_PHY_GIGE
140117ea1177Swdenk
140217ea1177Swdenk		If this option is set, support for speed/duplex
140311ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
140417ea1177Swdenk
140517ea1177Swdenk		CONFIG_PHY_RESET_DELAY
140617ea1177Swdenk
140717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
140817ea1177Swdenk		reset before any MII register access is possible.
140917ea1177Swdenk		For such PHY, set this option to the usec delay
141017ea1177Swdenk		required. (minimum 300usec for LXT971A)
141117ea1177Swdenk
141217ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
141317ea1177Swdenk
141417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
141517ea1177Swdenk		command issued before MII status register can be read
141617ea1177Swdenk
1417c609719bSwdenk- Ethernet address:
1418c609719bSwdenk		CONFIG_ETHADDR
1419c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1420c609719bSwdenk		CONFIG_ETH2ADDR
1421c609719bSwdenk		CONFIG_ETH3ADDR
1422c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1423c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1424c609719bSwdenk
142511ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
142611ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1427c609719bSwdenk		is not determined automatically.
1428c609719bSwdenk
1429c609719bSwdenk- IP address:
1430c609719bSwdenk		CONFIG_IPADDR
1431c609719bSwdenk
1432c609719bSwdenk		Define a default value for the IP address to use for
143311ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1434c609719bSwdenk		determined through e.g. bootp.
1435c609719bSwdenk
1436c609719bSwdenk- Server IP address:
1437c609719bSwdenk		CONFIG_SERVERIP
1438c609719bSwdenk
1439c609719bSwdenk		Defines a default value for the IP address of a TFTP
1440c609719bSwdenk		server to contact when using the "tftboot" command.
1441c609719bSwdenk
144297cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
144397cfe861SRobin Getz
144497cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
144597cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
144697cfe861SRobin Getz
144753a5c424SDavid Updegraff- Multicast TFTP Mode:
144853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
144953a5c424SDavid Updegraff
145053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
145153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
145211ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
145353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
145453a5c424SDavid Updegraff		multicast group.
145553a5c424SDavid Updegraff
1456c609719bSwdenk- BOOTP Recovery Mode:
1457c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1458c609719bSwdenk
1459c609719bSwdenk		If you have many targets in a network that try to
1460c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1461c609719bSwdenk		systems send out BOOTP requests at precisely the same
1462c609719bSwdenk		moment (which would happen for instance at recovery
1463c609719bSwdenk		from a power failure, when all systems will try to
1464c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1465c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1466c609719bSwdenk		inserted before sending out BOOTP requests. The
14676c33c785SWolfgang Denk		following delays are inserted then:
1468c609719bSwdenk
1469c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1470c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1471c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1472c609719bSwdenk		4th and following
1473c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1474c609719bSwdenk
1475fe389a82Sstroese- DHCP Advanced Options:
14761fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
14771fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1478fe389a82Sstroese
14791fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
14801fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
14811fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
14821fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
14831fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
14841fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
14851fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
14861fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
14871fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
14881fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
14891fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
14901fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1491fe389a82Sstroese
14925d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
14935d110f0aSWilson Callan		environment variable, not the BOOTP server.
1494fe389a82Sstroese
1495fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1496fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1497fe389a82Sstroese		than one DNS serverip is offered to the client.
1498fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1499fe389a82Sstroese		serverip will be stored in the additional environment
1500fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1501fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
15021fe80d79SJon Loeliger		is defined.
1503fe389a82Sstroese
1504fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1505fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1506fe389a82Sstroese		need the hostname of the DHCP requester.
15075d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
15081fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
15091fe80d79SJon Loeliger		option 12 to the DHCP server.
1510fe389a82Sstroese
1511d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1512d9a2f416SAras Vaichas
1513d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1514d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1515d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1516d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1517d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1518d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1519d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1520d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1521d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1522d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1523d9a2f416SAras Vaichas		this delay.
1524d9a2f416SAras Vaichas
1525a3d991bdSwdenk - CDP Options:
1526a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1527a3d991bdSwdenk
1528a3d991bdSwdenk		The device id used in CDP trigger frames.
1529a3d991bdSwdenk
1530a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1531a3d991bdSwdenk
1532a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1533a3d991bdSwdenk		of the device.
1534a3d991bdSwdenk
1535a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1536a3d991bdSwdenk
1537a3d991bdSwdenk		A printf format string which contains the ascii name of
1538a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
153911ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1540a3d991bdSwdenk
1541a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1542a3d991bdSwdenk
1543a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1544a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1545a3d991bdSwdenk
1546a3d991bdSwdenk		CONFIG_CDP_VERSION
1547a3d991bdSwdenk
1548a3d991bdSwdenk		An ascii string containing the version of the software.
1549a3d991bdSwdenk
1550a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1551a3d991bdSwdenk
1552a3d991bdSwdenk		An ascii string containing the name of the platform.
1553a3d991bdSwdenk
1554a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1555a3d991bdSwdenk
1556a3d991bdSwdenk		A 32bit integer sent on the trigger.
1557a3d991bdSwdenk
1558a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1559a3d991bdSwdenk
1560a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1561a3d991bdSwdenk		device in .1 of milliwatts.
1562a3d991bdSwdenk
1563a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1564a3d991bdSwdenk
1565a3d991bdSwdenk		A byte containing the id of the VLAN.
1566a3d991bdSwdenk
1567c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1568c609719bSwdenk
1569c609719bSwdenk		Several configurations allow to display the current
1570c609719bSwdenk		status using a LED. For instance, the LED will blink
1571c609719bSwdenk		fast while running U-Boot code, stop blinking as
1572c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1573c609719bSwdenk		start blinking slow once the Linux kernel is running
1574c609719bSwdenk		(supported by a status LED driver in the Linux
1575c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1576c609719bSwdenk		feature in U-Boot.
1577c609719bSwdenk
1578c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1579c609719bSwdenk
1580c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1581c609719bSwdenk		on those systems that support this (optional)
1582c609719bSwdenk		feature, like the TQM8xxL modules.
1583c609719bSwdenk
1584c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1585c609719bSwdenk
1586b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1587b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
158811ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1589c609719bSwdenk
1590b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1591602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1592b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1593b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1594c609719bSwdenk		command line interface.
1595c609719bSwdenk
1596bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1597c609719bSwdenk
1598b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1599b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1600b37c7e5eSwdenk		support for I2C.
1601c609719bSwdenk
1602b37c7e5eSwdenk		There are several other quantities that must also be
1603b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1604c609719bSwdenk
16056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1606b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
16076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
160811ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1609c609719bSwdenk
16108d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1611a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
16128d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
16138d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
16148d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1615b37c7e5eSwdenk
16165da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
16175da71efaSEric Millbrandt
16185da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
16195da71efaSEric Millbrandt		chips might think that the current transfer is still
16205da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
16215da71efaSEric Millbrandt		commands until the slave device responds.
16225da71efaSEric Millbrandt
1623b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1624b37c7e5eSwdenk
1625b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1626b37c7e5eSwdenk		then the following macros need to be defined (examples are
1627b37c7e5eSwdenk		from include/configs/lwmon.h):
1628c609719bSwdenk
1629c609719bSwdenk		I2C_INIT
1630c609719bSwdenk
1631b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1632c609719bSwdenk		controller or configure ports.
1633c609719bSwdenk
1634b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1635b37c7e5eSwdenk
1636c609719bSwdenk		I2C_PORT
1637c609719bSwdenk
1638c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1639c609719bSwdenk		assumes both bits are on the same port). Valid values
1640c609719bSwdenk		are 0..3 for ports A..D.
1641c609719bSwdenk
1642c609719bSwdenk		I2C_ACTIVE
1643c609719bSwdenk
1644c609719bSwdenk		The code necessary to make the I2C data line active
1645c609719bSwdenk		(driven).  If the data line is open collector, this
1646c609719bSwdenk		define can be null.
1647c609719bSwdenk
1648b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1649b37c7e5eSwdenk
1650c609719bSwdenk		I2C_TRISTATE
1651c609719bSwdenk
1652c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1653c609719bSwdenk		(inactive).  If the data line is open collector, this
1654c609719bSwdenk		define can be null.
1655c609719bSwdenk
1656b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1657b37c7e5eSwdenk
1658c609719bSwdenk		I2C_READ
1659c609719bSwdenk
1660c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1661c609719bSwdenk		FALSE if it is low.
1662c609719bSwdenk
1663b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1664b37c7e5eSwdenk
1665c609719bSwdenk		I2C_SDA(bit)
1666c609719bSwdenk
1667c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1668c609719bSwdenk		is FALSE, it clears it (low).
1669c609719bSwdenk
1670b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1671b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1672b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1673b37c7e5eSwdenk
1674c609719bSwdenk		I2C_SCL(bit)
1675c609719bSwdenk
1676c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1677c609719bSwdenk		is FALSE, it clears it (low).
1678c609719bSwdenk
1679b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1680b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1681b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1682b37c7e5eSwdenk
1683c609719bSwdenk		I2C_DELAY
1684c609719bSwdenk
1685c609719bSwdenk		This delay is invoked four times per clock cycle so this
1686c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1687b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1688b37c7e5eSwdenk		like:
1689b37c7e5eSwdenk
1690b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1691c609719bSwdenk
1692793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1693793b5726SMike Frysinger
1694793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1695793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1696793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1697793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1698793b5726SMike Frysinger
1699793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1700793b5726SMike Frysinger		the generic GPIO functions.
1701793b5726SMike Frysinger
17026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
170347cd00faSwdenk
170447cd00faSwdenk		When a board is reset during an i2c bus transfer
170547cd00faSwdenk		chips might think that the current transfer is still
170647cd00faSwdenk		in progress. On some boards it is possible to access
170747cd00faSwdenk		the i2c SCLK line directly, either by using the
170847cd00faSwdenk		processor pin as a GPIO or by having a second pin
170947cd00faSwdenk		connected to the bus. If this option is defined a
171047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
171147cd00faSwdenk		is run early in the boot sequence.
171247cd00faSwdenk
171326a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
171426a33504SRichard Retanubun
171526a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
171626a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
171726a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
171826a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
171926a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
172026a33504SRichard Retanubun		controller provide such a method. It is called at the end of
172126a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
172226a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
172326a33504SRichard Retanubun
172417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
172517ea1177Swdenk
172617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
172717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
172817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
172917ea1177Swdenk
1730bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1731bb99ad6dSBen Warren
1732bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1733bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1734bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1735bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1736bb99ad6dSBen Warren
17376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1738bb99ad6dSBen Warren
1739bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
17400f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
17410f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
17420f89c54bSPeter Tyser		a 1D array of device addresses
1743bb99ad6dSBen Warren
1744bb99ad6dSBen Warren		e.g.
1745bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
17466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1747bb99ad6dSBen Warren
1748bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1749bb99ad6dSBen Warren
1750bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
17516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1752bb99ad6dSBen Warren
1753bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1754bb99ad6dSBen Warren
17556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1756be5e6181STimur Tabi
1757be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1758be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1759be5e6181STimur Tabi
17606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
17610dc018ecSStefan Roese
17620dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
17630dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
17640dc018ecSStefan Roese
17656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
17660dc018ecSStefan Roese
17670dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
17680dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
17690dc018ecSStefan Roese
17706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
17719ebbb54fSVictor Gallardo
17729ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
17739ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
17749ebbb54fSVictor Gallardo		specified DTT device.
17759ebbb54fSVictor Gallardo
1776be5e6181STimur Tabi		CONFIG_FSL_I2C
1777be5e6181STimur Tabi
1778be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
17797817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1780be5e6181STimur Tabi
178167b23a32SHeiko Schocher		CONFIG_I2C_MUX
178267b23a32SHeiko Schocher
178367b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
178467b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
178567b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
178667b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
178767b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
178867b23a32SHeiko Schocher		the muxes to activate this new "bus".
178967b23a32SHeiko Schocher
179067b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
179167b23a32SHeiko Schocher		feature!
179267b23a32SHeiko Schocher
179367b23a32SHeiko Schocher		Example:
179467b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
179567b23a32SHeiko Schocher			The First mux with address 70 and channel 6
179667b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
179767b23a32SHeiko Schocher
179867b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
179967b23a32SHeiko Schocher
180067b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
180167b23a32SHeiko Schocher		of I2C Busses with muxes:
180267b23a32SHeiko Schocher
180367b23a32SHeiko Schocher		=> i2c bus
180467b23a32SHeiko Schocher		Busses reached over muxes:
180567b23a32SHeiko Schocher		Bus ID: 2
180667b23a32SHeiko Schocher		  reached over Mux(es):
180767b23a32SHeiko Schocher		    pca9544a@70 ch: 4
180867b23a32SHeiko Schocher		Bus ID: 3
180967b23a32SHeiko Schocher		  reached over Mux(es):
181067b23a32SHeiko Schocher		    pca9544a@70 ch: 6
181167b23a32SHeiko Schocher		    pca9544a@71 ch: 4
181267b23a32SHeiko Schocher		=>
181367b23a32SHeiko Schocher
181467b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1815f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1816f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
181767b23a32SHeiko Schocher		the channel 4.
181867b23a32SHeiko Schocher
181967b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1820f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
182167b23a32SHeiko Schocher		the 2 muxes.
182267b23a32SHeiko Schocher
182367b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
182467b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
182567b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
182667b23a32SHeiko Schocher		to add this option to other architectures.
182767b23a32SHeiko Schocher
18282ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
18292ac6985aSAndrew Dyer
18302ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
18312ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
18322ac6985aSAndrew Dyer		between writing the address pointer and reading the
18332ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
18342ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
18352ac6985aSAndrew Dyer		devices can use either method, but some require one or
18362ac6985aSAndrew Dyer		the other.
1837be5e6181STimur Tabi
1838c609719bSwdenk- SPI Support:	CONFIG_SPI
1839c609719bSwdenk
1840c609719bSwdenk		Enables SPI driver (so far only tested with
1841c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1842c609719bSwdenk		D/As on the SACSng board)
1843c609719bSwdenk
18446639562eSYoshihiro Shimoda		CONFIG_SH_SPI
18456639562eSYoshihiro Shimoda
18466639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
18476639562eSYoshihiro Shimoda		only SH7757 is supported.
18486639562eSYoshihiro Shimoda
1849c609719bSwdenk		CONFIG_SPI_X
1850c609719bSwdenk
1851c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1852c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1853c609719bSwdenk
1854c609719bSwdenk		CONFIG_SOFT_SPI
1855c609719bSwdenk
1856c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1857c609719bSwdenk		using hardware support. This is a general purpose
1858c609719bSwdenk		driver that only requires three general I/O port pins
1859c609719bSwdenk		(two outputs, one input) to function. If this is
1860c609719bSwdenk		defined, the board configuration must define several
1861c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1862c609719bSwdenk		an example, see include/configs/sacsng.h.
1863c609719bSwdenk
186404a9e118SBen Warren		CONFIG_HARD_SPI
186504a9e118SBen Warren
186604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
186704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
186804a9e118SBen Warren		must define a list of chip-select function pointers.
186904a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
187004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
187104a9e118SBen Warren
187238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
187338254f45SGuennadi Liakhovetski
187438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
187538254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
187638254f45SGuennadi Liakhovetski
18770133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
18780133502eSMatthias Fuchs
18790133502eSMatthias Fuchs		Enables FPGA subsystem.
18800133502eSMatthias Fuchs
18810133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
18820133502eSMatthias Fuchs
18830133502eSMatthias Fuchs		Enables support for specific chip vendors.
18840133502eSMatthias Fuchs		(ALTERA, XILINX)
18850133502eSMatthias Fuchs
18860133502eSMatthias Fuchs		CONFIG_FPGA_<family>
18870133502eSMatthias Fuchs
18880133502eSMatthias Fuchs		Enables support for FPGA family.
18890133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
18900133502eSMatthias Fuchs
18910133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1892c609719bSwdenk
1893c609719bSwdenk		Specify the number of FPGA devices to support.
1894c609719bSwdenk
18956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1896c609719bSwdenk
1897c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1898c609719bSwdenk
18996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1900c609719bSwdenk
1901c609719bSwdenk		Enable checks on FPGA configuration interface busy
1902c609719bSwdenk		status by the configuration function. This option
1903c609719bSwdenk		will require a board or device specific function to
1904c609719bSwdenk		be written.
1905c609719bSwdenk
1906c609719bSwdenk		CONFIG_FPGA_DELAY
1907c609719bSwdenk
1908c609719bSwdenk		If defined, a function that provides delays in the FPGA
1909c609719bSwdenk		configuration driver.
1910c609719bSwdenk
19116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1912c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1913c609719bSwdenk
19146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1915c609719bSwdenk
1916c609719bSwdenk		Check for configuration errors during FPGA bitfile
1917c609719bSwdenk		loading. For example, abort during Virtex II
1918c609719bSwdenk		configuration if the INIT_B line goes low (which
1919c609719bSwdenk		indicated a CRC error).
1920c609719bSwdenk
19216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1922c609719bSwdenk
1923c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1924c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1925c609719bSwdenk		FPGA configuration sequence. The default time is 500
192611ccc33fSMarcel Ziswiler		ms.
1927c609719bSwdenk
19286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1929c609719bSwdenk
1930c609719bSwdenk		Maximum time to wait for BUSY to deassert during
193111ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1932c609719bSwdenk
19336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1934c609719bSwdenk
1935c609719bSwdenk		Time to wait after FPGA configuration. The default is
193611ccc33fSMarcel Ziswiler		200 ms.
1937c609719bSwdenk
1938c609719bSwdenk- Configuration Management:
1939c609719bSwdenk		CONFIG_IDENT_STRING
1940c609719bSwdenk
1941c609719bSwdenk		If defined, this string will be added to the U-Boot
1942c609719bSwdenk		version information (U_BOOT_VERSION)
1943c609719bSwdenk
1944c609719bSwdenk- Vendor Parameter Protection:
1945c609719bSwdenk
1946c609719bSwdenk		U-Boot considers the values of the environment
1947c609719bSwdenk		variables "serial#" (Board Serial Number) and
19487152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1949c609719bSwdenk		are set once by the board vendor / manufacturer, and
1950c609719bSwdenk		protects these variables from casual modification by
1951c609719bSwdenk		the user. Once set, these variables are read-only,
1952c609719bSwdenk		and write or delete attempts are rejected. You can
195311ccc33fSMarcel Ziswiler		change this behaviour:
1954c609719bSwdenk
1955c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1956c609719bSwdenk		file, the write protection for vendor parameters is
195747cd00faSwdenk		completely disabled. Anybody can change or delete
1958c609719bSwdenk		these parameters.
1959c609719bSwdenk
1960c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1961c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
196211ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1963c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1964c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1965c609719bSwdenk		read-only.]
1966c609719bSwdenk
1967c609719bSwdenk- Protected RAM:
1968c609719bSwdenk		CONFIG_PRAM
1969c609719bSwdenk
1970c609719bSwdenk		Define this variable to enable the reservation of
1971c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1972c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1973c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1974c609719bSwdenk		this default value by defining an environment
1975c609719bSwdenk		variable "pram" to the number of kB you want to
1976c609719bSwdenk		reserve. Note that the board info structure will
1977c609719bSwdenk		still show the full amount of RAM. If pRAM is
1978c609719bSwdenk		reserved, a new environment variable "mem" will
1979c609719bSwdenk		automatically be defined to hold the amount of
1980c609719bSwdenk		remaining RAM in a form that can be passed as boot
1981c609719bSwdenk		argument to Linux, for instance like that:
1982c609719bSwdenk
1983fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1984c609719bSwdenk			saveenv
1985c609719bSwdenk
1986c609719bSwdenk		This way you can tell Linux not to use this memory,
1987c609719bSwdenk		either, which results in a memory region that will
1988c609719bSwdenk		not be affected by reboots.
1989c609719bSwdenk
1990c609719bSwdenk		*WARNING* If your board configuration uses automatic
1991c609719bSwdenk		detection of the RAM size, you must make sure that
1992c609719bSwdenk		this memory test is non-destructive. So far, the
1993c609719bSwdenk		following board configurations are known to be
1994c609719bSwdenk		"pRAM-clean":
1995c609719bSwdenk
1996c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1997c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1998544d97e9SWolfgang Denk			FLAGADM, TQM8260
1999c609719bSwdenk
2000c609719bSwdenk- Error Recovery:
2001c609719bSwdenk		CONFIG_PANIC_HANG
2002c609719bSwdenk
2003c609719bSwdenk		Define this variable to stop the system in case of a
2004c609719bSwdenk		fatal error, so that you have to reset it manually.
2005c609719bSwdenk		This is probably NOT a good idea for an embedded
200611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2007c609719bSwdenk		automatically as fast as possible, but it may be
2008c609719bSwdenk		useful during development since you can try to debug
2009c609719bSwdenk		the conditions that lead to the situation.
2010c609719bSwdenk
2011c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2012c609719bSwdenk
2013c609719bSwdenk		This variable defines the number of retries for
2014c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2015c609719bSwdenk		before giving up the operation. If not defined, a
2016c609719bSwdenk		default value of 5 is used.
2017c609719bSwdenk
201840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
201940cb90eeSGuennadi Liakhovetski
202040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
202140cb90eeSGuennadi Liakhovetski
2022c609719bSwdenk- Command Interpreter:
20238078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
202404a85b3bSwdenk
202504a85b3bSwdenk		Enable auto completion of commands using TAB.
202604a85b3bSwdenk
20278078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
20288078f1a5SWolfgang Denk		for the "hush" shell.
20298078f1a5SWolfgang Denk
20308078f1a5SWolfgang Denk
20316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2032c609719bSwdenk
2033c609719bSwdenk		Define this variable to enable the "hush" shell (from
2034c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2035c609719bSwdenk		powerful command line syntax like
2036c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2037c609719bSwdenk		constructs ("shell scripts").
2038c609719bSwdenk
2039c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2040c609719bSwdenk		with a somewhat smaller memory footprint.
2041c609719bSwdenk
2042c609719bSwdenk
20436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2044c609719bSwdenk
2045c609719bSwdenk		This defines the secondary prompt string, which is
2046c609719bSwdenk		printed when the command interpreter needs more input
2047c609719bSwdenk		to complete a command. Usually "> ".
2048c609719bSwdenk
2049c609719bSwdenk	Note:
2050c609719bSwdenk
2051c609719bSwdenk		In the current implementation, the local variables
2052c609719bSwdenk		space and global environment variables space are
2053c609719bSwdenk		separated. Local variables are those you define by
20543b57fe0aSwdenk		simply typing `name=value'. To access a local
2055c609719bSwdenk		variable later on, you have write `$name' or
20563b57fe0aSwdenk		`${name}'; to execute the contents of a variable
20573b57fe0aSwdenk		directly type `$name' at the command prompt.
2058c609719bSwdenk
2059c609719bSwdenk		Global environment variables are those you use
2060c609719bSwdenk		setenv/printenv to work with. To run a command stored
2061c609719bSwdenk		in such a variable, you need to use the run command,
2062c609719bSwdenk		and you must not use the '$' sign to access them.
2063c609719bSwdenk
2064c609719bSwdenk		To store commands and special characters in a
2065c609719bSwdenk		variable, please use double quotation marks
2066c609719bSwdenk		surrounding the whole text of the variable, instead
2067c609719bSwdenk		of the backslashes before semicolons and special
2068c609719bSwdenk		symbols.
2069c609719bSwdenk
2070aa0c71acSWolfgang Denk- Commandline Editing and History:
2071aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2072aa0c71acSWolfgang Denk
207311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2074aa0c71acSWolfgang Denk		commandline input operations
2075aa0c71acSWolfgang Denk
2076a8c7c708Swdenk- Default Environment:
2077c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2078c609719bSwdenk
2079c609719bSwdenk		Define this to contain any number of null terminated
2080c609719bSwdenk		strings (variable = value pairs) that will be part of
20817152b1d0Swdenk		the default environment compiled into the boot image.
20822262cfeeSwdenk
2083c609719bSwdenk		For example, place something like this in your
2084c609719bSwdenk		board's config file:
2085c609719bSwdenk
2086c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2087c609719bSwdenk			"myvar1=value1\0" \
2088c609719bSwdenk			"myvar2=value2\0"
2089c609719bSwdenk
2090c609719bSwdenk		Warning: This method is based on knowledge about the
2091c609719bSwdenk		internal format how the environment is stored by the
20922262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2093c609719bSwdenk		interface! Although it is unlikely that this format
20947152b1d0Swdenk		will change soon, there is no guarantee either.
2095c609719bSwdenk		You better know what you are doing here.
2096c609719bSwdenk
2097c609719bSwdenk		Note: overly (ab)use of the default environment is
2098c609719bSwdenk		discouraged. Make sure to check other ways to preset
209974de7aefSWolfgang Denk		the environment like the "source" command or the
2100c609719bSwdenk		boot command first.
2101c609719bSwdenk
2102a8c7c708Swdenk- DataFlash Support:
21032abbe075Swdenk		CONFIG_HAS_DATAFLASH
21042abbe075Swdenk
21052abbe075Swdenk		Defining this option enables DataFlash features and
21062abbe075Swdenk		allows to read/write in Dataflash via the standard
21072abbe075Swdenk		commands cp, md...
21082abbe075Swdenk
21093f85ce27Swdenk- SystemACE Support:
21103f85ce27Swdenk		CONFIG_SYSTEMACE
21113f85ce27Swdenk
21123f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
21133f85ce27Swdenk		chips attached via some sort of local bus. The address
211411ccc33fSMarcel Ziswiler		of the chip must also be defined in the
21156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
21163f85ce27Swdenk
21173f85ce27Swdenk		#define CONFIG_SYSTEMACE
21186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
21193f85ce27Swdenk
21203f85ce27Swdenk		When SystemACE support is added, the "ace" device type
21213f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
21223f85ce27Swdenk
2123ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2124ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2125ecb0ccd9SWolfgang Denk
212628cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2127ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
212828cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2129ecb0ccd9SWolfgang Denk		number generator is used.
2130ecb0ccd9SWolfgang Denk
213128cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
213228cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
213328cb9375SWolfgang Denk		defined, the normal port 69 is used.
213428cb9375SWolfgang Denk
213528cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2136ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2137ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2138ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2139ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2140ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2141ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2142ecb0ccd9SWolfgang Denk
2143a8c7c708Swdenk- Show boot progress:
2144c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2145c609719bSwdenk
2146c609719bSwdenk		Defining this option allows to add some board-
2147c609719bSwdenk		specific code (calling a user-provided function
2148c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2149c609719bSwdenk		the system's boot progress on some display (for
2150c609719bSwdenk		example, some LED's) on your board. At the moment,
2151c609719bSwdenk		the following checkpoints are implemented:
2152c609719bSwdenk
21531372cce2SMarian BalakowiczLegacy uImage format:
21541372cce2SMarian Balakowicz
2155c609719bSwdenk  Arg	Where			When
2156c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2157c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2158c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2159c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2160c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2161c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2162c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2163c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2164c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
21651372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2166c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2167c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2168c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2169c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
21701372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2171c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
21721372cce2SMarian Balakowicz
21731372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
21741372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
21751372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
21761372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
21771372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
21781372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
21791372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
218011ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
21811372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
21821372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
21831372cce2SMarian Balakowicz
2184ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2185c609719bSwdenk
2186a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
218763e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
218863e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
218963e73c9aSwdenk
2190566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2191566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2192566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2193566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2194566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2195566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2196566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2197566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2198566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2199566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2200566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2201566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2202566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2203566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2204566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2205566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2206566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2207566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2208566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2209566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2210566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2211566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2212566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2213566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2214566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2215566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2216566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2217566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2218566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2219566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2220566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2221566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2222566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2223566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2224566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2225566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2226566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2227566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2228566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2229566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2230566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2231566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2232566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2233566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2234566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2235566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2236566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2237c609719bSwdenk
2238566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2239c609719bSwdenk
2240566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2241566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2242566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2243206c60cbSwdenk
2244566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2245566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
224611ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2247566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2248566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2249566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
225074de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
225174de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2252566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2253c609719bSwdenk
22541372cce2SMarian BalakowiczFIT uImage format:
22551372cce2SMarian Balakowicz
22561372cce2SMarian Balakowicz  Arg	Where			When
22571372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
22581372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
22591372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
22601372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
22611372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
22621372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2263f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
22641372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
22651372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
22661372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
22671372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
22681372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
226911ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
227011ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
22711372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
22721372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
22731372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
22741372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
22751372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
22761372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
22771372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
22781372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
22791372cce2SMarian Balakowicz
22801372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
22811372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
22821372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
228311ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
22841372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
22851372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
22861372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
22871372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
22881372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
22891372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
22901372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
22911372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
22921372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
22931372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
22941372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
22951372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
22961372cce2SMarian Balakowicz
229711ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
22981372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
22991372cce2SMarian Balakowicz
230011ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
23011372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
23021372cce2SMarian Balakowicz
230311ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
23041372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
23051372cce2SMarian Balakowicz
23064cf2609bSWolfgang Denk- Standalone program support:
23074cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
23084cf2609bSWolfgang Denk
23096feff899SWolfgang Denk		This option defines a board specific value for the
23106feff899SWolfgang Denk		address where standalone program gets loaded, thus
23116feff899SWolfgang Denk		overwriting the architecture dependent default
23124cf2609bSWolfgang Denk		settings.
23134cf2609bSWolfgang Denk
23144cf2609bSWolfgang Denk- Frame Buffer Address:
23154cf2609bSWolfgang Denk		CONFIG_FB_ADDR
23164cf2609bSWolfgang Denk
23174cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
23184cf2609bSWolfgang Denk		address for frame buffer.
23194cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
23204cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
23216feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
23224cf2609bSWolfgang Denk
23234cf2609bSWolfgang Denk		Please see board_init_f function.
23244cf2609bSWolfgang Denk
2325cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2326cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2327cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2328cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2329cccfc2abSDetlev Zundel
2330cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2331cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2332cccfc2abSDetlev Zundel
2333cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2334cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2335cccfc2abSDetlev Zundel
2336cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2337cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2338cccfc2abSDetlev Zundel
2339cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2340cccfc2abSDetlev Zundel
2341cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2342cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2343cccfc2abSDetlev Zundel
23446a11cf48SDaniel Schwierzeck- SPL framework
23456a11cf48SDaniel Schwierzeck		CONFIG_SPL
23466a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
23476a11cf48SDaniel Schwierzeck
23486a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
23496a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
23506a11cf48SDaniel Schwierzeck
23516a11cf48SDaniel Schwierzeck		CONFIG_SPL_LDSCRIPT
23526a11cf48SDaniel Schwierzeck		LDSCRIPT for linking the SPL binary.
23536a11cf48SDaniel Schwierzeck
23546a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
23556a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
23566a11cf48SDaniel Schwierzeck
23576a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
23586a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
23596a11cf48SDaniel Schwierzeck
23606a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
23616a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
23626a11cf48SDaniel Schwierzeck
23636a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
23646a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
23656a11cf48SDaniel Schwierzeck
23666a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
23676a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
23686a11cf48SDaniel Schwierzeck
23696a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
23706a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
23716a11cf48SDaniel Schwierzeck
23726a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
23736a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
23746a11cf48SDaniel Schwierzeck
23756a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
23766a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
23776a11cf48SDaniel Schwierzeck
23786a11cf48SDaniel Schwierzeck		CONFIG_SPL_FAT_SUPPORT
23796a11cf48SDaniel Schwierzeck		Support for fs/fat/libfat.o in SPL binary
23806a11cf48SDaniel Schwierzeck
23816a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
23826a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
23831372cce2SMarian Balakowicz
2384c609719bSwdenkModem Support:
2385c609719bSwdenk--------------
2386c609719bSwdenk
2387566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2388c609719bSwdenk
238911ccc33fSMarcel Ziswiler- Modem support enable:
2390c609719bSwdenk		CONFIG_MODEM_SUPPORT
2391c609719bSwdenk
2392c609719bSwdenk- RTS/CTS Flow control enable:
2393c609719bSwdenk		CONFIG_HWFLOW
2394c609719bSwdenk
2395c609719bSwdenk- Modem debug support:
2396c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2397c609719bSwdenk
2398c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2399c609719bSwdenk		for modem support. Useful only with BDI2000.
2400c609719bSwdenk
2401a8c7c708Swdenk- Interrupt support (PPC):
2402a8c7c708Swdenk
2403a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2404a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
240511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2406a8c7c708Swdenk		should set decrementer_count to appropriate value. If
240711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2408a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
240911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2410a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2411a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2412a8c7c708Swdenk		general timer_interrupt().
2413a8c7c708Swdenk
2414c609719bSwdenk- General:
2415c609719bSwdenk
2416c609719bSwdenk		In the target system modem support is enabled when a
2417c609719bSwdenk		specific key (key combination) is pressed during
2418c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
241911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2420c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2421c609719bSwdenk		function, returning 1 and thus enabling modem
2422c609719bSwdenk		initialization.
2423c609719bSwdenk
2424c609719bSwdenk		If there are no modem init strings in the
2425c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2426c609719bSwdenk		previous output (banner, info printfs) will be
242711ccc33fSMarcel Ziswiler		suppressed, though.
2428c609719bSwdenk
2429c609719bSwdenk		See also: doc/README.Modem
2430c609719bSwdenk
2431c609719bSwdenk
2432c609719bSwdenkConfiguration Settings:
2433c609719bSwdenk-----------------------
2434c609719bSwdenk
24356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2436c609719bSwdenk		undefine this when you're short of memory.
2437c609719bSwdenk
24382fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
24392fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
24402fb2604dSPeter Tyser
24416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2442c609719bSwdenk		prompt for user input.
2443c609719bSwdenk
24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2445c609719bSwdenk
24466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2447c609719bSwdenk
24486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2449c609719bSwdenk
24506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2451c609719bSwdenk		the application (usually a Linux kernel) when it is
2452c609719bSwdenk		booted
2453c609719bSwdenk
24546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2455c609719bSwdenk		List of legal baudrate settings for this board.
2456c609719bSwdenk
24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2458c609719bSwdenk		Suppress display of console information at boot.
2459c609719bSwdenk
24606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2461c609719bSwdenk		If the board specific function
2462c609719bSwdenk			extern int overwrite_console (void);
2463c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2464c609719bSwdenk		serial port, else the settings in the environment are used.
2465c609719bSwdenk
24666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2467c609719bSwdenk		Enable the call to overwrite_console().
2468c609719bSwdenk
24696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2470c609719bSwdenk		Enable overwrite of previous console environment settings.
2471c609719bSwdenk
24726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2473c609719bSwdenk		Begin and End addresses of the area used by the
2474c609719bSwdenk		simple memory test.
2475c609719bSwdenk
24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2477c609719bSwdenk		Enable an alternate, more extensive memory test.
2478c609719bSwdenk
24796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
24805f535fe1Swdenk		Scratch address used by the alternate memory test
24815f535fe1Swdenk		You only need to set this if address zero isn't writeable
24825f535fe1Swdenk
24836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
24846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
248514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
248611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
248714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
248814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
248914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
24905e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
249114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
24925e12e75dSStefan Roese		will have to get fixed in Linux additionally.
249314f73ca6SStefan Roese
249414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
249514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
249614f73ca6SStefan Roese		be touched.
249714f73ca6SStefan Roese
249814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
249914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
250014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
250114f73ca6SStefan Roese		non page size aligned address and this could cause major
250214f73ca6SStefan Roese		problems.
250314f73ca6SStefan Roese
25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2505c609719bSwdenk		Default load address for network file downloads
2506c609719bSwdenk
25076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2508c609719bSwdenk		Enable temporary baudrate change while serial download
2509c609719bSwdenk
25106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2511c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2512c609719bSwdenk
25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2514c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2515c609719bSwdenk		Cogent motherboard)
2516c609719bSwdenk
25176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2518c609719bSwdenk		Physical start address of Flash memory.
2519c609719bSwdenk
25206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2521c609719bSwdenk		Physical start address of boot monitor code (set by
2522c609719bSwdenk		make config files to be same as the text base address
252314d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
25246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2525c609719bSwdenk
25266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
25273b57fe0aSwdenk		Size of memory reserved for monitor code, used to
25283b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
25293b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
25303b57fe0aSwdenk		flash sector.
2531c609719bSwdenk
25326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2533c609719bSwdenk		Size of DRAM reserved for malloc() use.
2534c609719bSwdenk
25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
253615940c9aSStefan Roese		Normally compressed uImages are limited to an
253715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
25386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
253915940c9aSStefan Roese		to adjust this setting to your needs.
2540c609719bSwdenk
25416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2542c609719bSwdenk		Maximum size of memory mapped by the startup code of
2543c609719bSwdenk		the Linux kernel; all data that must be processed by
25447d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
25457d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
25467d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
25477d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2548c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2549c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2550c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2551c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2552c609719bSwdenk
2553fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2554fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2555fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2556fca43cc8SJohn Rigby		is enabled.
2557fca43cc8SJohn Rigby
2558fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2559fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2560fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2561fca43cc8SJohn Rigby
2562fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2563fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2564fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2565fca43cc8SJohn Rigby
25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2567c609719bSwdenk		Max number of Flash memory banks
2568c609719bSwdenk
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2570c609719bSwdenk		Max number of sectors on a Flash chip
2571c609719bSwdenk
25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2573c609719bSwdenk		Timeout for Flash erase operations (in ms)
2574c609719bSwdenk
25756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2576c609719bSwdenk		Timeout for Flash write operations (in ms)
2577c609719bSwdenk
25786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
25798564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
25808564acf9Swdenk
25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
25828564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
25838564acf9Swdenk
25846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
25858564acf9Swdenk		If defined, hardware flash sectors protection is used
25868564acf9Swdenk		instead of U-Boot software protection.
25878564acf9Swdenk
25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2589c609719bSwdenk
2590c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2591c609719bSwdenk		without this option such a download has to be
2592c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2593c609719bSwdenk		copy from RAM to flash.
2594c609719bSwdenk
2595c609719bSwdenk		The two-step approach is usually more reliable, since
2596c609719bSwdenk		you can check if the download worked before you erase
259711ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
259811ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2599c609719bSwdenk		downloaded image) this option may be very useful.
2600c609719bSwdenk
26016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2602c609719bSwdenk		Define if the flash driver uses extra elements in the
26035653fc33Swdenk		common flash structure for storing flash geometry.
26045653fc33Swdenk
260500b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
26065653fc33Swdenk		This option also enables the building of the cfi_flash driver
26075653fc33Swdenk		in the drivers directory
260853cf9435Sstroese
260991809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
261091809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
261191809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
261291809ed5SPiotr Ziecik		to the MTD layer.
261391809ed5SPiotr Ziecik
26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
261596ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
261696ef831fSGuennadi Liakhovetski
261796ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
261896ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
261996ef831fSGuennadi Liakhovetski		write commands.
262096ef831fSGuennadi Liakhovetski
26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
26225568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
26235568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
26245568e613SStefan Roese		is useful, if some of the configured banks are only
26255568e613SStefan Roese		optionally available.
26265568e613SStefan Roese
26279a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
26289a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
26299a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
26309a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
26319a042e9cSJerry Van Baren
26326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
263311ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
263411ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
263553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
263653cf9435Sstroese		buffers can be full shortly after enabling the interface
263711ccc33fSMarcel Ziswiler		on high Ethernet traffic.
263853cf9435Sstroese		Defaults to 4 if not defined.
2639c609719bSwdenk
2640ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2641ea882bafSWolfgang Denk
2642ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2643ea882bafSWolfgang Denk	internally to store the environment settings. The default
2644ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2645ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2646ea882bafSWolfgang Denk	lib/hashtable.c for details.
2647ea882bafSWolfgang Denk
2648c609719bSwdenkThe following definitions that deal with the placement and management
2649c609719bSwdenkof environment data (variable area); in general, we support the
2650c609719bSwdenkfollowing configurations:
2651c609719bSwdenk
2652c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2653c3eb3fe4SMike Frysinger
2654c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2655c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2656c3eb3fe4SMike Frysinger
26575a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2658c609719bSwdenk
2659c609719bSwdenk	Define this if the environment is in flash memory.
2660c609719bSwdenk
2661c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2662c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2663c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2664c609719bSwdenk	   sector" type flash chips, which have several smaller
2665c609719bSwdenk	   sectors at the start or the end. For instance, such a
2666c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2667c609719bSwdenk	   such a case you would place the environment in one of the
2668c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2669c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2670c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2671c609719bSwdenk	   between U-Boot and the environment.
2672c609719bSwdenk
26730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2674c609719bSwdenk
2675c609719bSwdenk	   Offset of environment data (variable area) to the
2676c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2677c609719bSwdenk	   type flash chips the second sector can be used: the offset
2678c609719bSwdenk	   for this sector is given here.
2679c609719bSwdenk
26806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2681c609719bSwdenk
26820e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2683c609719bSwdenk
2684c609719bSwdenk	   This is just another way to specify the start address of
2685c609719bSwdenk	   the flash sector containing the environment (instead of
26860e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2687c609719bSwdenk
26880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2689c609719bSwdenk
2690c609719bSwdenk	   Size of the sector containing the environment.
2691c609719bSwdenk
2692c609719bSwdenk
2693c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2694c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2695c609719bSwdenk	   the environment.
2696c609719bSwdenk
26970e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2698c609719bSwdenk
26995a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
27000e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2701c609719bSwdenk	   of this flash sector for the environment. This saves
2702c609719bSwdenk	   memory for the RAM copy of the environment.
2703c609719bSwdenk
2704c609719bSwdenk	   It may also save flash memory if you decide to use this
2705c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2706c609719bSwdenk	   since then the remainder of the flash sector could be used
2707c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2708c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2709c609719bSwdenk	   updating the environment in flash makes it always
2710c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2711c609719bSwdenk	   wrong before the contents has been restored from a copy in
2712c609719bSwdenk	   RAM, your target system will be dead.
2713c609719bSwdenk
27140e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
27150e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2716c609719bSwdenk
2717c609719bSwdenk	   These settings describe a second storage area used to hold
271811ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
27193e38691eSwdenk	   a valid backup copy in case there is a power failure during
2720c609719bSwdenk	   a "saveenv" operation.
2721c609719bSwdenk
2722c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2723c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2724c609719bSwdenkaccordingly!
2725c609719bSwdenk
2726c609719bSwdenk
27279314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2728c609719bSwdenk
2729c609719bSwdenk	Define this if you have some non-volatile memory device
2730c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2731c609719bSwdenk	environment.
2732c609719bSwdenk
27330e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
27340e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2735c609719bSwdenk
273611ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2737c609719bSwdenk	  want to use for environment. It is assumed that this memory
2738c609719bSwdenk	  can just be read and written to, without any special
2739c609719bSwdenk	  provision.
2740c609719bSwdenk
2741c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2742c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
274311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2744c609719bSwdenkU-Boot will hang.
2745c609719bSwdenk
2746c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2747c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2748c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2749c609719bSwdenkto save the current settings.
2750c609719bSwdenk
2751c609719bSwdenk
2752bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2753c609719bSwdenk
2754c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2755c609719bSwdenk	device and a driver for it.
2756c609719bSwdenk
27570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27580e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2759c609719bSwdenk
2760c609719bSwdenk	  These two #defines specify the offset and size of the
2761c609719bSwdenk	  environment area within the total memory of your EEPROM.
2762c609719bSwdenk
27636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2764c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2765c609719bSwdenk	  The default address is zero.
2766c609719bSwdenk
27676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2768c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2769c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2770c609719bSwdenk	  would require six bits.
2771c609719bSwdenk
27726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2773c609719bSwdenk	  If defined, the number of milliseconds to delay between
2774c609719bSwdenk	  page writes.	The default is zero milliseconds.
2775c609719bSwdenk
27766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2777c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2778c609719bSwdenk	  that this is NOT the chip address length!
2779c609719bSwdenk
27806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
27815cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
27825cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
27835cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
27845cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
27855cf91d6bSwdenk	  byte chips.
27865cf91d6bSwdenk
27875cf91d6bSwdenk	  Note that we consider the length of the address field to
27885cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
27895cf91d6bSwdenk	  in the chip address.
27905cf91d6bSwdenk
27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2792c609719bSwdenk	  The size in bytes of the EEPROM device.
2793c609719bSwdenk
2794548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2795548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2796548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2797548738b4SHeiko Schocher
2798548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2799548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2800548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2801548738b4SHeiko Schocher	  EEPROM. For example:
2802548738b4SHeiko Schocher
2803548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2804548738b4SHeiko Schocher
2805548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2806548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2807c609719bSwdenk
2808057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
28095779d8d9Swdenk
28105779d8d9Swdenk	Define this if you have a DataFlash memory device which you
28115779d8d9Swdenk	want to use for the environment.
28125779d8d9Swdenk
28130e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
28140e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
28150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
28165779d8d9Swdenk
28175779d8d9Swdenk	  These three #defines specify the offset and size of the
28185779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
28195779d8d9Swdenk	  at the specified address.
28205779d8d9Swdenk
282151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
282213a5695bSwdenk
282313a5695bSwdenk	Define this if you have a NAND device which you want to use
282413a5695bSwdenk	for the environment.
282513a5695bSwdenk
28260e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
28270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
282813a5695bSwdenk
282913a5695bSwdenk	  These two #defines specify the offset and size of the environment
2830fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2831fdd813deSScott Wood	  aligned to an erase block boundary.
28325779d8d9Swdenk
2833fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2834e443c944SMarkus Klotzbuecher
28350e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2836fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2837fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2838fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2839fdd813deSScott Wood	  aligned to an erase block boundary.
2840e443c944SMarkus Klotzbuecher
2841fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2842fdd813deSScott Wood
2843fdd813deSScott Wood	  Specifies the length of the region in which the environment
2844fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2845fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2846fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2847fdd813deSScott Wood	  the range to be avoided.
2848fdd813deSScott Wood
2849fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2850fdd813deSScott Wood
2851fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2852fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2853fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2854fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2855fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2856e443c944SMarkus Klotzbuecher
2857b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2858b74ab737SGuennadi Liakhovetski
2859b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2860b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2861b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2862b74ab737SGuennadi Liakhovetski
28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2864c609719bSwdenk
2865c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2866c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2867c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2868c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2869c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2870c609719bSwdenk	to be a good choice since it makes it far enough from the
2871c609719bSwdenk	start of the data area as well as from the stack pointer.
2872c609719bSwdenk
2873e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2874c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2875cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2876c609719bSwdenkuntil then to read environment variables.
2877c609719bSwdenk
287885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
287985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
288085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
288185ec0bccSwdenknecessary, because the first environment variable we need is the
288285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
288385ec0bccSwdenkhave any device yet where we could complain.]
2884c609719bSwdenk
2885c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2886c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
288785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2888c609719bSwdenk
28896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2890fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2891fc3e2165Swdenk
28926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2893fc3e2165Swdenk		      also needs to be defined.
2894fc3e2165Swdenk
28956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2896fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2897c609719bSwdenk
2898f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2899f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2900f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2901f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2902f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2903f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2904f5675aa5SRon Madrid
2905c609719bSwdenkLow Level (hardware related) configuration options:
2906dc7c9a1aSwdenk---------------------------------------------------
2907c609719bSwdenk
29086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2909c609719bSwdenk		Cache Line Size of the CPU.
2910c609719bSwdenk
29116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2912c609719bSwdenk		Default address of the IMMR after system reset.
29132535d602Swdenk
29142535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
29152535d602Swdenk		and RPXsuper) to be able to adjust the position of
29162535d602Swdenk		the IMMR register after a reset.
2917c609719bSwdenk
2918e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
2919e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
2920e46fedfeSTimur Tabi		PowerPC SOCs.
2921e46fedfeSTimur Tabi
2922e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
2923e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
2924e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2925e46fedfeSTimur Tabi
2926e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2927e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
2928e46fedfeSTimur Tabi
2929e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
2930e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
2931e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
2932e46fedfeSTimur Tabi		be set to that address.  Otherwise, it should be set to the
2933e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2934e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
2935e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
2936e46fedfeSTimur Tabi
2937e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2938e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2939e46fedfeSTimur Tabi
2940e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2941e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
2942e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
2943e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2944e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2945e46fedfeSTimur Tabi
2946e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2947e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2948e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2949e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2950e46fedfeSTimur Tabi
2951e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2952e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2953e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
2954e46fedfeSTimur Tabi
29557f6c2cbcSwdenk- Floppy Disk Support:
29566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
29577f6c2cbcSwdenk
29587f6c2cbcSwdenk		the default drive number (default value 0)
29597f6c2cbcSwdenk
29606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
29617f6c2cbcSwdenk
296211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
29637f6c2cbcSwdenk		(default value 1)
29647f6c2cbcSwdenk
29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
29667f6c2cbcSwdenk
29677f6c2cbcSwdenk		defines the offset of register from address. It
29687f6c2cbcSwdenk		depends on which part of the data bus is connected to
296911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
29707f6c2cbcSwdenk
29716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
29726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
29737f6c2cbcSwdenk		default value.
29747f6c2cbcSwdenk
29756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
29767f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
29777f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
29787f6c2cbcSwdenk		source code. It is used to make hardware dependant
29797f6c2cbcSwdenk		initializations.
29807f6c2cbcSwdenk
29810abddf82SMacpaul Lin- CONFIG_IDE_AHB:
29820abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
29830abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
29840abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
29850abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
29860abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
29870abddf82SMacpaul Lin		is requierd.
29880abddf82SMacpaul Lin
29896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
299025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
299125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2992c609719bSwdenk
29936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2994c609719bSwdenk
29957152b1d0Swdenk		Start address of memory area that can be used for
2996c609719bSwdenk		initial data and stack; please note that this must be
2997c609719bSwdenk		writable memory that is working WITHOUT special
2998c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2999c609719bSwdenk		will become available only after programming the
3000c609719bSwdenk		memory controller and running certain initialization
3001c609719bSwdenk		sequences.
3002c609719bSwdenk
3003c609719bSwdenk		U-Boot uses the following memory types:
3004c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3005c609719bSwdenk		- MPC824X: data cache
3006c609719bSwdenk		- PPC4xx:  data cache
3007c609719bSwdenk
30086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3009c609719bSwdenk
3010c609719bSwdenk		Offset of the initial data structure in the memory
30116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
30126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3013c609719bSwdenk		data is located at the end of the available space
3014553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
30156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
30166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
30176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3018c609719bSwdenk
3019c609719bSwdenk	Note:
3020c609719bSwdenk		On the MPC824X (or other systems that use the data
3021c609719bSwdenk		cache for initial memory) the address chosen for
30226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3023c609719bSwdenk		point to an otherwise UNUSED address space between
3024c609719bSwdenk		the top of RAM and the start of the PCI space.
3025c609719bSwdenk
30266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3027c609719bSwdenk
30286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3029c609719bSwdenk
30306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3031c609719bSwdenk
30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3033c609719bSwdenk
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3035c609719bSwdenk
30366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3037c609719bSwdenk
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3039c609719bSwdenk		SDRAM timing
3040c609719bSwdenk
30416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3042c609719bSwdenk		periodic timer for refresh
3043c609719bSwdenk
30446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3045c609719bSwdenk
30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
30476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
30486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
30496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3050c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3051c609719bSwdenk
3052c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
30536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
30546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3055c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3056c609719bSwdenk
30576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
30586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3059c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3060c609719bSwdenk		Prescaler definitions (SDRAM timing)
3061c609719bSwdenk
30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3063c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3064c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3065c609719bSwdenk
30666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3067b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3068b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3069b423d055SHeiko Schocher
30706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3071c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3072c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3073c609719bSwdenk
30746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3075c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3076c609719bSwdenk		wrong setting might damage your board. Read
3077c609719bSwdenk		doc/README.MBX before setting this variable!
3078c609719bSwdenk
30796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3080ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3081ea909b76Swdenk		(Power On Self Tests). This definition overrides
3082ea909b76Swdenk		#define'd default value in commproc.h resp.
3083ea909b76Swdenk		cpm_8260.h.
3084ea909b76Swdenk
30856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
30866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
30876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
30886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
30896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
30916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
30926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3093a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
30945d232d0eSwdenk
30959cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
30969cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
30979cacf4fcSDirk Eibach		required.
30989cacf4fcSDirk Eibach
3099a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3100a09b9b68SKumar Gala		Chip has SRIO or not
3101a09b9b68SKumar Gala
3102a09b9b68SKumar Gala- CONFIG_SRIO1:
3103a09b9b68SKumar Gala		Board has SRIO 1 port available
3104a09b9b68SKumar Gala
3105a09b9b68SKumar Gala- CONFIG_SRIO2:
3106a09b9b68SKumar Gala		Board has SRIO 2 port available
3107a09b9b68SKumar Gala
3108a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3109a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3110a09b9b68SKumar Gala
3111a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3112a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3113a09b9b68SKumar Gala
3114a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3115a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3116a09b9b68SKumar Gala
3117eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3118eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3119eced4626SAlex Waterman		16 bit bus.
3120eced4626SAlex Waterman
3121eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3122eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3123eced4626SAlex Waterman		a default value will be used.
3124eced4626SAlex Waterman
3125bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3126218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3127218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3128218ca724SWolfgang Denk
3129bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3130bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3131bb99ad6dSBen Warren
31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3133218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3134218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3135218ca724SWolfgang Denk		to something your driver can deal with.
3136bb99ad6dSBen Warren
31371b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
31381b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
31391b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
31401b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
31411b3e3c4fSYork Sun		header files or board specific files.
31421b3e3c4fSYork Sun
31436f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
31446f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
31456f5e1dc5SYork Sun
31466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3147218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3148218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
31492ad6b513STimur Tabi
3150c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3151c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3152c26e454dSwdenk
3153c26e454dSwdenk- CONFIG_FEC[12]_PHY
3154c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
31556e592385Swdenk		to the given FEC; i. e.
3156c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3157c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3158c26e454dSwdenk
3159c26e454dSwdenk		When set to -1, means to probe for first available.
3160c26e454dSwdenk
3161c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3162c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3163c26e454dSwdenk		(so program the FEC to ignore it).
3164c26e454dSwdenk
3165c26e454dSwdenk- CONFIG_RMII
3166c26e454dSwdenk		Enable RMII mode for all FECs.
3167c26e454dSwdenk		Note that this is a global option, we can't
3168c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3169c26e454dSwdenk
31705cf91d6bSwdenk- CONFIG_CRC32_VERIFY
31715cf91d6bSwdenk		Add a verify option to the crc32 command.
31725cf91d6bSwdenk		The syntax is:
31735cf91d6bSwdenk
31745cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
31755cf91d6bSwdenk
31765cf91d6bSwdenk		Where address/count indicate a memory area
31775cf91d6bSwdenk		and crc32 is the correct crc32 which the
31785cf91d6bSwdenk		area should have.
31795cf91d6bSwdenk
318056523f12Swdenk- CONFIG_LOOPW
318156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3182602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
318356523f12Swdenk
31847b466641Sstroese- CONFIG_MX_CYCLIC
31857b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
31867b466641Sstroese		"md/mw" commands.
31877b466641Sstroese		Examples:
31887b466641Sstroese
31897b466641Sstroese		=> mdc.b 10 4 500
31907b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
31917b466641Sstroese
31927b466641Sstroese		=> mwc.l 100 12345678 10
31937b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
31947b466641Sstroese
31957b466641Sstroese		This only takes effect if the memory commands are activated
3196602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
31977b466641Sstroese
31988aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3199afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3200e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3201e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3202e03f3169SWolfgang Denk		relocate itself into RAM.
32038aa1a2d1Swdenk
3204e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3205e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3206e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3207e03f3169SWolfgang Denk		these initializations itself.
32088aa1a2d1Swdenk
3209401bb30bSAneesh V- CONFIG_SPL_BUILD
3210df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3211df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3212df81238bSMagnus Lilja		compiling a NAND SPL.
3213400558b5Swdenk
3214d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3215d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3216d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3217d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3218d8834a13SMatthias Weisser		conditions but may increase the binary size.
3219d8834a13SMatthias Weisser
3220c609719bSwdenkBuilding the Software:
3221c609719bSwdenk======================
3222c609719bSwdenk
3223218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3224218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3225218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3226218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3227218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3228218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3229c609719bSwdenk
3230218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3231218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3232218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3233218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3234218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3235c609719bSwdenk
3236218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3237218ca724SWolfgang Denk	$ export CROSS_COMPILE
3238c609719bSwdenk
32392f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
32402f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
32412f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
32422f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
32432f8d396bSPeter Tyser
32442f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
32452f8d396bSPeter Tyser
32462f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
32472f8d396bSPeter Tyser      be executed on computers running Windows.
32482f8d396bSPeter Tyser
3249c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3250c609719bSwdenksources you must configure U-Boot for one specific board type. This
3251c609719bSwdenkis done by typing:
3252c609719bSwdenk
3253c609719bSwdenk	make NAME_config
3254c609719bSwdenk
3255218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3256218ca724SWolfgang Denkrations; see the main Makefile for supported names.
325754387ac9Swdenk
3258c609719bSwdenkNote: for some board special configuration names may exist; check if
3259c609719bSwdenk      additional information is available from the board vendor; for
32602729af9dSwdenk      instance, the TQM823L systems are available without (standard)
32612729af9dSwdenk      or with LCD support. You can select such additional "features"
326211ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3263c609719bSwdenk
32642729af9dSwdenk      make TQM823L_config
32652729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3266c609719bSwdenk
3267c609719bSwdenk      make TQM823L_LCD_config
3268c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3269c609719bSwdenk
3270c609719bSwdenk      etc.
3271c609719bSwdenk
3272c609719bSwdenk
3273c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
32747152b1d0Swdenkimages ready for download to / installation on your system:
3275c609719bSwdenk
3276c609719bSwdenk- "u-boot.bin" is a raw binary image
3277c609719bSwdenk- "u-boot" is an image in ELF binary format
3278c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3279c609719bSwdenk
3280baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3281baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3282baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3283baf31249SMarian Balakowicz
3284baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3285baf31249SMarian Balakowicz
3286baf31249SMarian Balakowicz	make O=/tmp/build distclean
3287baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3288baf31249SMarian Balakowicz	make O=/tmp/build all
3289baf31249SMarian Balakowicz
3290baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3291baf31249SMarian Balakowicz
3292baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3293baf31249SMarian Balakowicz	make distclean
3294baf31249SMarian Balakowicz	make NAME_config
3295baf31249SMarian Balakowicz	make all
3296baf31249SMarian Balakowicz
3297baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3298baf31249SMarian Balakowiczvariable.
3299baf31249SMarian Balakowicz
3300c609719bSwdenk
3301c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3302c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3303c609719bSwdenknative "make".
3304c609719bSwdenk
3305c609719bSwdenk
3306c609719bSwdenkIf the system board that you have is not listed, then you will need
3307c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3308c609719bSwdenksteps:
3309c609719bSwdenk
3310c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
331185ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
331285ec0bccSwdenk    entries as examples. Note that here and at many other places
33137152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
331485ec0bccSwdenk    keep this order.
3315c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
331685ec0bccSwdenk    files you need. In your board directory, you will need at least
331785ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
331885ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
331985ec0bccSwdenk    your board
3320c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3321c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
332285ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3323c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3324c609719bSwdenk    to be installed on your target system.
332585ec0bccSwdenk6.  Debug and solve any problems that might arise.
3326c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3327c609719bSwdenk
3328c609719bSwdenk
3329c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3330c609719bSwdenk==============================================================
3331c609719bSwdenk
3332c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3333c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3334c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3335c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3336218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3337c609719bSwdenk
3338c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3339c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3340c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3341c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3342c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
33437152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3344218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3345218ca724SWolfgang Denkyou can type
3346c609719bSwdenk
3347c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3348c609719bSwdenk
3349c609719bSwdenkor to build on a native PowerPC system you can type
3350c609719bSwdenk
3351c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3352c609719bSwdenk
3353218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3354218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3355218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3356218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3357218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3358218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3359218ca724SWolfgang Denkvariable. For example:
3360baf31249SMarian Balakowicz
3361baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3362baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3363baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3364baf31249SMarian Balakowicz
3365218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3366218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3367218ca724SWolfgang Denkduring the whole build process.
3368baf31249SMarian Balakowicz
3369baf31249SMarian Balakowicz
3370c609719bSwdenkSee also "U-Boot Porting Guide" below.
3371c609719bSwdenk
3372c609719bSwdenk
3373c609719bSwdenkMonitor Commands - Overview:
3374c609719bSwdenk============================
3375c609719bSwdenk
3376c609719bSwdenkgo	- start application at address 'addr'
3377c609719bSwdenkrun	- run commands in an environment variable
3378c609719bSwdenkbootm	- boot application image from memory
3379c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3380c609719bSwdenktftpboot- boot image via network using TFTP protocol
3381c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3382c609719bSwdenk	       (and eventually "gatewayip")
33831fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3384c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3385c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3386c609719bSwdenkloads	- load S-Record file over serial line
3387c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3388c609719bSwdenkmd	- memory display
3389c609719bSwdenkmm	- memory modify (auto-incrementing)
3390c609719bSwdenknm	- memory modify (constant address)
3391c609719bSwdenkmw	- memory write (fill)
3392c609719bSwdenkcp	- memory copy
3393c609719bSwdenkcmp	- memory compare
3394c609719bSwdenkcrc32	- checksum calculation
33950f89c54bSPeter Tyseri2c	- I2C sub-system
3396c609719bSwdenksspi	- SPI utility commands
3397c609719bSwdenkbase	- print or set address offset
3398c609719bSwdenkprintenv- print environment variables
3399c609719bSwdenksetenv	- set environment variables
3400c609719bSwdenksaveenv - save environment variables to persistent storage
3401c609719bSwdenkprotect - enable or disable FLASH write protection
3402c609719bSwdenkerase	- erase FLASH memory
3403c609719bSwdenkflinfo	- print FLASH memory information
3404c609719bSwdenkbdinfo	- print Board Info structure
3405c609719bSwdenkiminfo	- print header information for application image
3406c609719bSwdenkconinfo - print console devices and informations
3407c609719bSwdenkide	- IDE sub-system
3408c609719bSwdenkloop	- infinite loop on address range
340956523f12Swdenkloopw	- infinite write loop on address range
3410c609719bSwdenkmtest	- simple RAM test
3411c609719bSwdenkicache	- enable or disable instruction cache
3412c609719bSwdenkdcache	- enable or disable data cache
3413c609719bSwdenkreset	- Perform RESET of the CPU
3414c609719bSwdenkecho	- echo args to console
3415c609719bSwdenkversion - print monitor version
3416c609719bSwdenkhelp	- print online help
3417c609719bSwdenk?	- alias for 'help'
3418c609719bSwdenk
3419c609719bSwdenk
3420c609719bSwdenkMonitor Commands - Detailed Description:
3421c609719bSwdenk========================================
3422c609719bSwdenk
3423c609719bSwdenkTODO.
3424c609719bSwdenk
3425c609719bSwdenkFor now: just type "help <command>".
3426c609719bSwdenk
3427c609719bSwdenk
3428c609719bSwdenkEnvironment Variables:
3429c609719bSwdenk======================
3430c609719bSwdenk
3431c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3432c609719bSwdenkcan be made persistent by saving to Flash memory.
3433c609719bSwdenk
3434c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3435c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3436c609719bSwdenkwithout a value can be used to delete a variable from the
3437c609719bSwdenkenvironment. As long as you don't save the environment you are
3438c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3439c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3440c609719bSwdenk
3441c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3442c96f86eeSWolfgang Denk
3443c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3444c609719bSwdenk
3445c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3446c609719bSwdenk
3447c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3448c609719bSwdenk
3449c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3450c609719bSwdenk
3451c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3452c609719bSwdenk
3453c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3454c609719bSwdenk
34557d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
34567d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34577d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
34587d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
34597d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
34607d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3461c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3462c3624e6eSGrant Likely		  bootm_mapsize.
3463c3624e6eSGrant Likely
3464c3624e6eSGrant Likely  bootm_mapsize	- Size of the initial memory mapping for the Linux kernel.
3465c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3466c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3467c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3468c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3469c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3470c3624e6eSGrant Likely		  used otherwise.
34717d721e34SBartlomiej Sieka
34727d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
34737d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34747d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
34757d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
34767d721e34SBartlomiej Sieka		  environment variable.
34777d721e34SBartlomiej Sieka
34784bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
34794bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
34804bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
34814bae9090SBartlomiej Sieka
3482c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3483c609719bSwdenk		  "bootp" will just load perform a lookup of the
3484c609719bSwdenk		  configuration from the BOOTP server, but not try to
3485c609719bSwdenk		  load any image using TFTP
3486c609719bSwdenk
3487c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3488c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3489c609719bSwdenk		  be automatically started (by internally calling
3490c609719bSwdenk		  "bootm")
3491c609719bSwdenk
34924a6fd34bSwdenk		  If set to "no", a standalone image passed to the
34934a6fd34bSwdenk		  "bootm" command will be copied to the load address
34944a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
34954a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
34964a6fd34bSwdenk		  data.
34974a6fd34bSwdenk
3498a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3499a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3500a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3501a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3502a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3503a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3504a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3505a28afca5SDavid A. Long		  must be accessible by the kernel.
3506a28afca5SDavid A. Long
3507eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3508eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3509eea63e05SSimon Glass		  defined.
3510eea63e05SSimon Glass
351117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
351217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
351317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
351417ea1177Swdenk		  initialization code. So, for changes to be effective
351517ea1177Swdenk		  it must be saved and board must be reset.
351617ea1177Swdenk
3517c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3518c609719bSwdenk		  If this variable is not set, initrd images will be
3519c609719bSwdenk		  copied to the highest possible address in RAM; this
3520c609719bSwdenk		  is usually what you want since it allows for
3521c609719bSwdenk		  maximum initrd size. If for some reason you want to
3522c609719bSwdenk		  make sure that the initrd image is loaded below the
35236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3524c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3525c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3526c609719bSwdenk		  address to use (U-Boot will still check that it
3527c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3528c609719bSwdenk
3529c609719bSwdenk		  For instance, when you have a system with 16 MB
35307152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3531c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3532c609719bSwdenk		  the "bootargs" variable. However, now you must make
35337152b1d0Swdenk		  sure that the initrd image is placed in the first
3534c609719bSwdenk		  12 MB as well - this can be done with
3535c609719bSwdenk
3536c609719bSwdenk		  setenv initrd_high 00c00000
3537c609719bSwdenk
353838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
353938b99261Swdenk		  indication to U-Boot that all addresses are legal
354038b99261Swdenk		  for the Linux kernel, including addresses in flash
354138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
354238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
354338b99261Swdenk		  boot time on your system, but requires that this
354438b99261Swdenk		  feature is supported by your Linux kernel.
354538b99261Swdenk
3546c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3547c609719bSwdenk
3548c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3549dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3550c609719bSwdenk
3551c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3552c609719bSwdenk
3553c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3554c609719bSwdenk
3555c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3556c609719bSwdenk
3557c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3558c609719bSwdenk
3559c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3560c609719bSwdenk
3561e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3562a3d991bdSwdenk
3563e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3564e2a53458SMike Frysinger		  For example you can do the following
3565a3d991bdSwdenk
356648690d80SHeiko Schocher		  => setenv ethact FEC
356748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
356848690d80SHeiko Schocher		  => setenv ethact SCC
356948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3570a3d991bdSwdenk
3571e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3572e1692577SMatthias Fuchs		  available network interfaces.
3573e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3574e1692577SMatthias Fuchs
3575a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3576a3d991bdSwdenk		  either succeed or fail without retrying.
35776e592385Swdenk		  When set to "once" the network operation will
35786e592385Swdenk		  fail when all the available network interfaces
35796e592385Swdenk		  are tried once without success.
3580a3d991bdSwdenk		  Useful on scripts which control the retry operation
3581a3d991bdSwdenk		  themselves.
3582a3d991bdSwdenk
3583b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3584a1cf027aSJean-Christophe PLAGNIOL-VILLARD
358528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3586ecb0ccd9SWolfgang Denk		  UDP source port.
3587ecb0ccd9SWolfgang Denk
358828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
358928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
359028cb9375SWolfgang Denk
3591c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3592c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3593c96f86eeSWolfgang Denk
3594c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3595c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3596c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3597c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3598c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3599c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3600c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3601c96f86eeSWolfgang Denk
3602a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
360311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3604a3d991bdSwdenk		  VLAN tagged frames.
3605c609719bSwdenk
3606dc0b7b0eSJason HobbsThe following image location variables contain the location of images
3607dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
3608dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
3609dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
3610dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
3611dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
3612dc0b7b0eSJason Hobbsflash or offset in NAND flash.
3613dc0b7b0eSJason Hobbs
3614dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
3615dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
3616dc0b7b0eSJason Hobbsboards use these variables for other purposes.
3617dc0b7b0eSJason Hobbs
3618dc0b7b0eSJason HobbsImage               File Name        RAM Address       Flash Location
3619dc0b7b0eSJason Hobbs-----               ---------        -----------       --------------
3620dc0b7b0eSJason Hobbsu-boot              u-boot           u-boot_addr_r     u-boot_addr
3621dc0b7b0eSJason HobbsLinux kernel        bootfile         kernel_addr_r     kernel_addr
3622dc0b7b0eSJason Hobbsdevice tree blob    fdtfile          fdt_addr_r        fdt_addr
3623dc0b7b0eSJason Hobbsramdisk             ramdiskfile      ramdisk_addr_r    ramdisk_addr
3624dc0b7b0eSJason Hobbs
3625c609719bSwdenkThe following environment variables may be used and automatically
3626c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3627c609719bSwdenkdepending the information provided by your boot server:
3628c609719bSwdenk
3629c609719bSwdenk  bootfile	- see above
3630c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3631fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3632c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3633c609719bSwdenk  hostname	- Target hostname
3634c609719bSwdenk  ipaddr	- see above
3635c609719bSwdenk  netmask	- Subnet Mask
3636c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3637c609719bSwdenk  serverip	- see above
3638c609719bSwdenk
3639c609719bSwdenk
3640c609719bSwdenkThere are two special Environment Variables:
3641c609719bSwdenk
3642c609719bSwdenk  serial#	- contains hardware identification information such
3643c609719bSwdenk		  as type string and/or serial number
3644c609719bSwdenk  ethaddr	- Ethernet address
3645c609719bSwdenk
3646c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3647c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3648c609719bSwdenkonce they have been set once.
3649c609719bSwdenk
3650c609719bSwdenk
3651c1551ea8SstroeseFurther special Environment Variables:
3652c1551ea8Sstroese
3653c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3654c1551ea8Sstroese		  with the "version" command. This variable is
3655c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3656c1551ea8Sstroese
3657c1551ea8Sstroese
3658c609719bSwdenkPlease note that changes to some configuration parameters may take
3659c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3660c609719bSwdenk
3661c609719bSwdenk
3662f07771ccSwdenkCommand Line Parsing:
3663f07771ccSwdenk=====================
3664f07771ccSwdenk
3665f07771ccSwdenkThere are two different command line parsers available with U-Boot:
36667152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3667f07771ccSwdenk
3668f07771ccSwdenkOld, simple command line parser:
3669f07771ccSwdenk--------------------------------
3670f07771ccSwdenk
3671f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3672f07771ccSwdenk- several commands on one line, separated by ';'
3673fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3674f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3675f07771ccSwdenk  for example:
3676fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3677f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3678f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3679f07771ccSwdenk
3680f07771ccSwdenkHush shell:
3681f07771ccSwdenk-----------
3682f07771ccSwdenk
3683f07771ccSwdenk- similar to Bourne shell, with control structures like
3684f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3685f07771ccSwdenk  until...do...done, ...
3686f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3687f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3688f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3689f07771ccSwdenk  command
3690f07771ccSwdenk
3691f07771ccSwdenkGeneral rules:
3692f07771ccSwdenk--------------
3693f07771ccSwdenk
3694f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3695f07771ccSwdenk    command) contains several commands separated by semicolon, and
3696f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3697f07771ccSwdenk    executed anyway.
3698f07771ccSwdenk
3699f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
370011ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3701f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3702f07771ccSwdenk    variables are not executed.
3703f07771ccSwdenk
3704c609719bSwdenkNote for Redundant Ethernet Interfaces:
3705c609719bSwdenk=======================================
3706c609719bSwdenk
370711ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3708c609719bSwdenksuch configurations and is capable of automatic selection of a
37097152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3710c609719bSwdenk
3711c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3712c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3713c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3714c609719bSwdenk
3715c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3716c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3717c609719bSwdenkding setting in the environment; if the corresponding environment
3718c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3719c609719bSwdenk
3720c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3721c609719bSwdenk  environment, the SROM's address is used.
3722c609719bSwdenk
3723c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3724c609719bSwdenk  environment exists, then the value from the environment variable is
3725c609719bSwdenk  used.
3726c609719bSwdenk
3727c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3728c609719bSwdenk  both addresses are the same, this MAC address is used.
3729c609719bSwdenk
3730c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3731c609719bSwdenk  addresses differ, the value from the environment is used and a
3732c609719bSwdenk  warning is printed.
3733c609719bSwdenk
3734c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3735c609719bSwdenk  is raised.
3736c609719bSwdenk
3737ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3738ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3739ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3740ecee9324SBen WarrenThe naming convention is as follows:
3741ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3742c609719bSwdenk
3743c609719bSwdenkImage Formats:
3744c609719bSwdenk==============
3745c609719bSwdenk
37463310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
37473310c549SMarian Balakowiczimages in two formats:
37483310c549SMarian Balakowicz
37493310c549SMarian BalakowiczNew uImage format (FIT)
37503310c549SMarian Balakowicz-----------------------
37513310c549SMarian Balakowicz
37523310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
37533310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
37543310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
37553310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
37563310c549SMarian Balakowicz
37573310c549SMarian Balakowicz
37583310c549SMarian BalakowiczOld uImage format
37593310c549SMarian Balakowicz-----------------
37603310c549SMarian Balakowicz
37613310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
37623310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
37633310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3764c609719bSwdenk
3765c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3766c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3767f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3768f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3769f5ed9e39SPeter Tyser  INTEGRITY).
37707b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3771afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3772afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3773c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3774c609719bSwdenk* Load Address
3775c609719bSwdenk* Entry Point
3776c609719bSwdenk* Image Name
3777c609719bSwdenk* Image Timestamp
3778c609719bSwdenk
3779c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3780c609719bSwdenkand the data portions of the image are secured against corruption by
3781c609719bSwdenkCRC32 checksums.
3782c609719bSwdenk
3783c609719bSwdenk
3784c609719bSwdenkLinux Support:
3785c609719bSwdenk==============
3786c609719bSwdenk
3787c609719bSwdenkAlthough U-Boot should support any OS or standalone application
37887152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3789c609719bSwdenkU-Boot.
3790c609719bSwdenk
3791c609719bSwdenkU-Boot includes many features that so far have been part of some
3792c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3793c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3794c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
37957152b1d0Swdenkserves several purposes:
3796c609719bSwdenk
3797c609719bSwdenk- the same features can be used for other OS or standalone
3798c609719bSwdenk  applications (for instance: using compressed images to reduce the
3799c609719bSwdenk  Flash memory footprint)
3800c609719bSwdenk
3801c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
38027152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3803c609719bSwdenk
3804c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3805c609719bSwdenk  images; of course this also means that different kernel images can
3806c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3807c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3808c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3809c609719bSwdenk  software is easier now.
3810c609719bSwdenk
3811c609719bSwdenk
3812c609719bSwdenkLinux HOWTO:
3813c609719bSwdenk============
3814c609719bSwdenk
3815c609719bSwdenkPorting Linux to U-Boot based systems:
3816c609719bSwdenk---------------------------------------
3817c609719bSwdenk
3818c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3819c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3820c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3821c609719bSwdenkLinux :-).
3822c609719bSwdenk
3823a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3824c609719bSwdenk
3825c609719bSwdenkJust make sure your machine specific header file (for instance
3826c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
38271dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
38281dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
38296d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3830c609719bSwdenk
3831c609719bSwdenk
3832c609719bSwdenkConfiguring the Linux kernel:
3833c609719bSwdenk-----------------------------
3834c609719bSwdenk
3835c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3836c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3837c609719bSwdenk
3838c609719bSwdenk
3839c609719bSwdenkBuilding a Linux Image:
3840c609719bSwdenk-----------------------
3841c609719bSwdenk
384224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
384324ee89b9Swdenknot used. If you use recent kernel source, a new build target
384424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
384524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
384624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
384724ee89b9Swdenk100% compatible format.
3848c609719bSwdenk
3849c609719bSwdenkExample:
3850c609719bSwdenk
3851c609719bSwdenk	make TQM850L_config
3852c609719bSwdenk	make oldconfig
3853c609719bSwdenk	make dep
385424ee89b9Swdenk	make uImage
3855c609719bSwdenk
385624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
385724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
385824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3859c609719bSwdenk
386024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
386124ee89b9Swdenk
386224ee89b9Swdenk* convert the kernel into a raw binary image:
386324ee89b9Swdenk
386424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
386524ee89b9Swdenk				 -R .note -R .comment \
386624ee89b9Swdenk				 -S vmlinux linux.bin
386724ee89b9Swdenk
386824ee89b9Swdenk* compress the binary image:
386924ee89b9Swdenk
387024ee89b9Swdenk	gzip -9 linux.bin
387124ee89b9Swdenk
387224ee89b9Swdenk* package compressed binary image for U-Boot:
387324ee89b9Swdenk
387424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
387524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
387624ee89b9Swdenk		-d linux.bin.gz uImage
387724ee89b9Swdenk
387824ee89b9Swdenk
387924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
388024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
388124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
388224ee89b9Swdenkbyte header containing information about target architecture,
388324ee89b9Swdenkoperating system, image type, compression method, entry points, time
388424ee89b9Swdenkstamp, CRC32 checksums, etc.
388524ee89b9Swdenk
388624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
388724ee89b9Swdenkprint the header information, or to build new images.
3888c609719bSwdenk
3889c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3890c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3891c609719bSwdenkchecksum verification:
3892c609719bSwdenk
3893c609719bSwdenk	tools/mkimage -l image
3894c609719bSwdenk	  -l ==> list image header information
3895c609719bSwdenk
3896c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3897c609719bSwdenkfrom a "data file" which is used as image payload:
3898c609719bSwdenk
3899c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3900c609719bSwdenk		      -n name -d data_file image
3901c609719bSwdenk	  -A ==> set architecture to 'arch'
3902c609719bSwdenk	  -O ==> set operating system to 'os'
3903c609719bSwdenk	  -T ==> set image type to 'type'
3904c609719bSwdenk	  -C ==> set compression type 'comp'
3905c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3906c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3907c609719bSwdenk	  -n ==> set image name to 'name'
3908c609719bSwdenk	  -d ==> use image data from 'datafile'
3909c609719bSwdenk
391069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
391169459791Swdenkaddress (0x00000000), but the entry point address depends on the
391269459791Swdenkkernel version:
3913c609719bSwdenk
3914c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
391524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3916c609719bSwdenk
3917c609719bSwdenkSo a typical call to build a U-Boot image would read:
3918c609719bSwdenk
391924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
392024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3921a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
392224ee89b9Swdenk	> examples/uImage.TQM850L
392324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3924c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3925c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3926c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3927c609719bSwdenk	Load Address: 0x00000000
392824ee89b9Swdenk	Entry Point:  0x00000000
3929c609719bSwdenk
3930c609719bSwdenkTo verify the contents of the image (or check for corruption):
3931c609719bSwdenk
393224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
393324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3934c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3935c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3936c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3937c609719bSwdenk	Load Address: 0x00000000
393824ee89b9Swdenk	Entry Point:  0x00000000
3939c609719bSwdenk
3940c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3941c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3942c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3943c609719bSwdenkneed to be uncompressed:
3944c609719bSwdenk
3945a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
394624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
394724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3948a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
394924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
395024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3951c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3952c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3953c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3954c609719bSwdenk	Load Address: 0x00000000
395524ee89b9Swdenk	Entry Point:  0x00000000
3956c609719bSwdenk
3957c609719bSwdenk
3958c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3959c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3960c609719bSwdenk
3961c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3962c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3963c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3964c609719bSwdenk	Image Name:   Simple Ramdisk Image
3965c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3966c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3967c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3968c609719bSwdenk	Load Address: 0x00000000
3969c609719bSwdenk	Entry Point:  0x00000000
3970c609719bSwdenk
3971c609719bSwdenk
3972c609719bSwdenkInstalling a Linux Image:
3973c609719bSwdenk-------------------------
3974c609719bSwdenk
3975c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3976c609719bSwdenkyou must convert the image to S-Record format:
3977c609719bSwdenk
3978c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3979c609719bSwdenk
3980c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3981c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3982c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3983c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3984c609719bSwdenkcommand.
3985c609719bSwdenk
3986c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3987c609719bSwdenkTQM8xxL is in the first Flash bank):
3988c609719bSwdenk
3989c609719bSwdenk	=> erase 40100000 401FFFFF
3990c609719bSwdenk
3991c609719bSwdenk	.......... done
3992c609719bSwdenk	Erased 8 sectors
3993c609719bSwdenk
3994c609719bSwdenk	=> loads 40100000
3995c609719bSwdenk	## Ready for S-Record download ...
3996c609719bSwdenk	~>examples/image.srec
3997c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3998c609719bSwdenk	...
3999c609719bSwdenk	15989 15990 15991 15992
4000c609719bSwdenk	[file transfer complete]
4001c609719bSwdenk	[connected]
4002c609719bSwdenk	## Start Addr = 0x00000000
4003c609719bSwdenk
4004c609719bSwdenk
4005c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4006c609719bSwdenkthis includes a checksum verification so you can be sure no data
4007c609719bSwdenkcorruption happened:
4008c609719bSwdenk
4009c609719bSwdenk	=> imi 40100000
4010c609719bSwdenk
4011c609719bSwdenk	## Checking Image at 40100000 ...
4012c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4013c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4014c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4015c609719bSwdenk	   Load Address: 00000000
4016c609719bSwdenk	   Entry Point:	 0000000c
4017c609719bSwdenk	   Verifying Checksum ... OK
4018c609719bSwdenk
4019c609719bSwdenk
4020c609719bSwdenkBoot Linux:
4021c609719bSwdenk-----------
4022c609719bSwdenk
4023c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4024c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4025c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4026c609719bSwdenkparameters. You can check and modify this variable using the
4027c609719bSwdenk"printenv" and "setenv" commands:
4028c609719bSwdenk
4029c609719bSwdenk
4030c609719bSwdenk	=> printenv bootargs
4031c609719bSwdenk	bootargs=root=/dev/ram
4032c609719bSwdenk
4033c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4034c609719bSwdenk
4035c609719bSwdenk	=> printenv bootargs
4036c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4037c609719bSwdenk
4038c609719bSwdenk	=> bootm 40020000
4039c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4040c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4041c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4042c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4043c609719bSwdenk	   Load Address: 00000000
4044c609719bSwdenk	   Entry Point:	 0000000c
4045c609719bSwdenk	   Verifying Checksum ... OK
4046c609719bSwdenk	   Uncompressing Kernel Image ... OK
4047c609719bSwdenk	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
4048c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4049c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4050c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4051c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4052c609719bSwdenk	...
4053c609719bSwdenk
405411ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
40557152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4056c609719bSwdenkformat!) to the "bootm" command:
4057c609719bSwdenk
4058c609719bSwdenk	=> imi 40100000 40200000
4059c609719bSwdenk
4060c609719bSwdenk	## Checking Image at 40100000 ...
4061c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4062c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4063c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4064c609719bSwdenk	   Load Address: 00000000
4065c609719bSwdenk	   Entry Point:	 0000000c
4066c609719bSwdenk	   Verifying Checksum ... OK
4067c609719bSwdenk
4068c609719bSwdenk	## Checking Image at 40200000 ...
4069c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4070c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4071c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4072c609719bSwdenk	   Load Address: 00000000
4073c609719bSwdenk	   Entry Point:	 00000000
4074c609719bSwdenk	   Verifying Checksum ... OK
4075c609719bSwdenk
4076c609719bSwdenk	=> bootm 40100000 40200000
4077c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4078c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4079c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4080c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4081c609719bSwdenk	   Load Address: 00000000
4082c609719bSwdenk	   Entry Point:	 0000000c
4083c609719bSwdenk	   Verifying Checksum ... OK
4084c609719bSwdenk	   Uncompressing Kernel Image ... OK
4085c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4086c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4087c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4088c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4089c609719bSwdenk	   Load Address: 00000000
4090c609719bSwdenk	   Entry Point:	 00000000
4091c609719bSwdenk	   Verifying Checksum ... OK
4092c609719bSwdenk	   Loading Ramdisk ... OK
4093c609719bSwdenk	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
4094c609719bSwdenk	Boot arguments: root=/dev/ram
4095c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4096c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4097c609719bSwdenk	...
4098c609719bSwdenk	RAMDISK: Compressed image found at block 0
4099c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4100c609719bSwdenk
4101c609719bSwdenk	bash#
4102c609719bSwdenk
41030267768eSMatthew McClintockBoot Linux and pass a flat device tree:
41040267768eSMatthew McClintock-----------
41050267768eSMatthew McClintock
41060267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
41070267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
41080267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
41090267768eSMatthew McClintockflat device tree:
41100267768eSMatthew McClintock
41110267768eSMatthew McClintock=> print oftaddr
41120267768eSMatthew McClintockoftaddr=0x300000
41130267768eSMatthew McClintock=> print oft
41140267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
41150267768eSMatthew McClintock=> tftp $oftaddr $oft
41160267768eSMatthew McClintockSpeed: 1000, full duplex
41170267768eSMatthew McClintockUsing TSEC0 device
41180267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
41190267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
41200267768eSMatthew McClintockLoad address: 0x300000
41210267768eSMatthew McClintockLoading: #
41220267768eSMatthew McClintockdone
41230267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
41240267768eSMatthew McClintock=> tftp $loadaddr $bootfile
41250267768eSMatthew McClintockSpeed: 1000, full duplex
41260267768eSMatthew McClintockUsing TSEC0 device
41270267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
41280267768eSMatthew McClintockFilename 'uImage'.
41290267768eSMatthew McClintockLoad address: 0x200000
41300267768eSMatthew McClintockLoading:############
41310267768eSMatthew McClintockdone
41320267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
41330267768eSMatthew McClintock=> print loadaddr
41340267768eSMatthew McClintockloadaddr=200000
41350267768eSMatthew McClintock=> print oftaddr
41360267768eSMatthew McClintockoftaddr=0x300000
41370267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
41380267768eSMatthew McClintock## Booting image at 00200000 ...
41390267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
41400267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
41410267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
41420267768eSMatthew McClintock   Load Address: 00000000
41430267768eSMatthew McClintock   Entry Point:	 00000000
41440267768eSMatthew McClintock   Verifying Checksum ... OK
41450267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
41460267768eSMatthew McClintockBooting using flat device tree at 0x300000
41470267768eSMatthew McClintockUsing MPC85xx ADS machine description
41480267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
41490267768eSMatthew McClintock[snip]
41500267768eSMatthew McClintock
41510267768eSMatthew McClintock
41526069ff26SwdenkMore About U-Boot Image Types:
41536069ff26Swdenk------------------------------
41546069ff26Swdenk
41556069ff26SwdenkU-Boot supports the following image types:
41566069ff26Swdenk
41576069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
41586069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
41596069ff26Swdenk	well) you can continue to work in U-Boot after return from
41606069ff26Swdenk	the Standalone Program.
41616069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
41626069ff26Swdenk	will take over control completely. Usually these programs
41636069ff26Swdenk	will install their own set of exception handlers, device
41646069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
41656069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
41666069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
41676069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
41686069ff26Swdenk	being started.
41696069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
41706069ff26Swdenk	(Linux) kernel image and one or more data images like
41716069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
41726069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
41736069ff26Swdenk	server provides just a single image file, but you want to get
41746069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
41756069ff26Swdenk
41766069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
41776069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
41786069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
41796069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
41806069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
41816069ff26Swdenk	a multiple of 4 bytes).
41826069ff26Swdenk
41836069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
41846069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
41856069ff26Swdenk	flash memory.
41866069ff26Swdenk
41876069ff26Swdenk   "Script files" are command sequences that will be executed by
41886069ff26Swdenk	U-Boot's command interpreter; this feature is especially
41896069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
41906069ff26Swdenk	as command interpreter.
41916069ff26Swdenk
4192c609719bSwdenk
4193c609719bSwdenkStandalone HOWTO:
4194c609719bSwdenk=================
4195c609719bSwdenk
4196c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4197c609719bSwdenkrun "standalone" applications, which can use some resources of
4198c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4199c609719bSwdenk
4200c609719bSwdenkTwo simple examples are included with the sources:
4201c609719bSwdenk
4202c609719bSwdenk"Hello World" Demo:
4203c609719bSwdenk-------------------
4204c609719bSwdenk
4205c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4206c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4207c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4208c609719bSwdenklike that:
4209c609719bSwdenk
4210c609719bSwdenk	=> loads
4211c609719bSwdenk	## Ready for S-Record download ...
4212c609719bSwdenk	~>examples/hello_world.srec
4213c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4214c609719bSwdenk	[file transfer complete]
4215c609719bSwdenk	[connected]
4216c609719bSwdenk	## Start Addr = 0x00040004
4217c609719bSwdenk
4218c609719bSwdenk	=> go 40004 Hello World! This is a test.
4219c609719bSwdenk	## Starting application at 0x00040004 ...
4220c609719bSwdenk	Hello World
4221c609719bSwdenk	argc = 7
4222c609719bSwdenk	argv[0] = "40004"
4223c609719bSwdenk	argv[1] = "Hello"
4224c609719bSwdenk	argv[2] = "World!"
4225c609719bSwdenk	argv[3] = "This"
4226c609719bSwdenk	argv[4] = "is"
4227c609719bSwdenk	argv[5] = "a"
4228c609719bSwdenk	argv[6] = "test."
4229c609719bSwdenk	argv[7] = "<NULL>"
4230c609719bSwdenk	Hit any key to exit ...
4231c609719bSwdenk
4232c609719bSwdenk	## Application terminated, rc = 0x0
4233c609719bSwdenk
4234c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4235c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4236c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4237c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4238c609719bSwdenkcharacter, but this is just a demo program. The application can be
4239c609719bSwdenkcontrolled by the following keys:
4240c609719bSwdenk
4241c609719bSwdenk	? - print current values og the CPM Timer registers
4242c609719bSwdenk	b - enable interrupts and start timer
4243c609719bSwdenk	e - stop timer and disable interrupts
4244c609719bSwdenk	q - quit application
4245c609719bSwdenk
4246c609719bSwdenk	=> loads
4247c609719bSwdenk	## Ready for S-Record download ...
4248c609719bSwdenk	~>examples/timer.srec
4249c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4250c609719bSwdenk	[file transfer complete]
4251c609719bSwdenk	[connected]
4252c609719bSwdenk	## Start Addr = 0x00040004
4253c609719bSwdenk
4254c609719bSwdenk	=> go 40004
4255c609719bSwdenk	## Starting application at 0x00040004 ...
4256c609719bSwdenk	TIMERS=0xfff00980
4257c609719bSwdenk	Using timer 1
4258c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4259c609719bSwdenk
4260c609719bSwdenkHit 'b':
4261c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4262c609719bSwdenk	Enabling timer
4263c609719bSwdenkHit '?':
4264c609719bSwdenk	[q, b, e, ?] ........
4265c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4266c609719bSwdenkHit '?':
4267c609719bSwdenk	[q, b, e, ?] .
4268c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4269c609719bSwdenkHit '?':
4270c609719bSwdenk	[q, b, e, ?] .
4271c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4272c609719bSwdenkHit '?':
4273c609719bSwdenk	[q, b, e, ?] .
4274c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4275c609719bSwdenkHit 'e':
4276c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4277c609719bSwdenkHit 'q':
4278c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4279c609719bSwdenk
4280c609719bSwdenk
428185ec0bccSwdenkMinicom warning:
428285ec0bccSwdenk================
428385ec0bccSwdenk
42847152b1d0SwdenkOver time, many people have reported problems when trying to use the
428585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
428685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4287f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
428885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
428985ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
429085ec0bccSwdenk
429152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
429252f52c14Swdenkconfiguration to your "File transfer protocols" section:
429352f52c14Swdenk
429452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
429552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
429652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
429752f52c14Swdenk
429852f52c14Swdenk
4299c609719bSwdenkNetBSD Notes:
4300c609719bSwdenk=============
4301c609719bSwdenk
4302c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4303c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4304c609719bSwdenk
4305c609719bSwdenkBuilding requires a cross environment; it is known to work on
4306c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4307c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4308c609719bSwdenkNote that the cross-powerpc package does not install include files;
4309c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4310c609719bSwdenkmissing.  This file has to be installed and patched manually:
4311c609719bSwdenk
4312c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4313c609719bSwdenk	# mkdir powerpc
4314c609719bSwdenk	# ln -s powerpc machine
4315c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4316c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4317c609719bSwdenk
4318c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4319c609719bSwdenkand U-Boot include files.
4320c609719bSwdenk
4321c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4322c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4323c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4324c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
43252a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4326c609719bSwdenk
4327c609719bSwdenk
4328c609719bSwdenkImplementation Internals:
4329c609719bSwdenk=========================
4330c609719bSwdenk
4331c609719bSwdenkThe following is not intended to be a complete description of every
4332c609719bSwdenkimplementation detail. However, it should help to understand the
4333c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4334c609719bSwdenkhardware.
4335c609719bSwdenk
4336c609719bSwdenk
4337c609719bSwdenkInitial Stack, Global Data:
4338c609719bSwdenk---------------------------
4339c609719bSwdenk
4340c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4341c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4342c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4343c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4344c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4345c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4346c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4347c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4348c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4349c609719bSwdenklocked as (mis-) used as memory, etc.
4350c609719bSwdenk
43517152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
43520668236bSWolfgang Denk	U-Boot mailing list:
435343d9616cSwdenk
435443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
435543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
435643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
435743d9616cSwdenk	...
435843d9616cSwdenk
435943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
436043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
436143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
436243d9616cSwdenk	is that the cache is being used as a temporary supply of
436343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
436411ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
436543d9616cSwdenk	can see how this works by studying the cache architecture and
436643d9616cSwdenk	operation in the architecture and processor-specific manuals.
436743d9616cSwdenk
436843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
436943d9616cSwdenk	is another option for the system designer to use as an
437011ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
437143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
437243d9616cSwdenk	board designers haven't used it for something that would
437343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
437443d9616cSwdenk	used.
437543d9616cSwdenk
43766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
437743d9616cSwdenk	with your processor/board/system design. The default value
437843d9616cSwdenk	you will find in any recent u-boot distribution in
43798a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
438043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
438143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
438243d9616cSwdenk	that are supposed to respond to that address! That code in
438343d9616cSwdenk	start.S has been around a while and should work as is when
438443d9616cSwdenk	you get the config right.
438543d9616cSwdenk
438643d9616cSwdenk	-Chris Hallinan
438743d9616cSwdenk	DS4.COM, Inc.
438843d9616cSwdenk
4389c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4390c609719bSwdenkcode for the initialization procedures:
4391c609719bSwdenk
4392c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4393c609719bSwdenk  to write it.
4394c609719bSwdenk
439511ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4396c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
43977152b1d0Swdenk  zation is performed later (when relocating to RAM).
4398c609719bSwdenk
4399c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4400c609719bSwdenk  that.
4401c609719bSwdenk
4402c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4403c609719bSwdenknormal global data to share information beween the code. But it
4404c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4405c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4406c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4407c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4408c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4409c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4410c609719bSwdenkreserve for this purpose.
4411c609719bSwdenk
44127152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4413c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4414c609719bSwdenkGCC's implementation.
4415c609719bSwdenk
4416c609719bSwdenkFor PowerPC, the following registers have specific use:
4417c609719bSwdenk	R1:	stack pointer
4418e7670f6cSWolfgang Denk	R2:	reserved for system use
4419c609719bSwdenk	R3-R4:	parameter passing and return values
4420c609719bSwdenk	R5-R10: parameter passing
4421c609719bSwdenk	R13:	small data area pointer
4422c609719bSwdenk	R30:	GOT pointer
4423c609719bSwdenk	R31:	frame pointer
4424c609719bSwdenk
4425e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4426e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4427e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4428c609719bSwdenk
4429e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4430c609719bSwdenk
4431c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4432c609719bSwdenk    address of the global data structure is known at compile time),
4433c609719bSwdenk    but it turned out that reserving a register results in somewhat
4434c609719bSwdenk    smaller code - although the code savings are not that big (on
4435c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4436c609719bSwdenk    624 text + 127 data).
4437c609719bSwdenk
4438c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
44394c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
44404c58eb55SMike Frysinger
4441c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
44424c58eb55SMike Frysinger
4443c609719bSwdenkOn ARM, the following registers are used:
4444c609719bSwdenk
4445c609719bSwdenk	R0:	function argument word/integer result
4446c609719bSwdenk	R1-R3:	function argument word
4447c609719bSwdenk	R9:	GOT pointer
4448c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4449c609719bSwdenk	R11:	argument (frame) pointer
4450c609719bSwdenk	R12:	temporary workspace
4451c609719bSwdenk	R13:	stack pointer
4452c609719bSwdenk	R14:	link register
4453c609719bSwdenk	R15:	program counter
4454c609719bSwdenk
4455c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4456c609719bSwdenk
44570df01fd3SThomas ChouOn Nios II, the ABI is documented here:
44580df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
44590df01fd3SThomas Chou
44600df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
44610df01fd3SThomas Chou
44620df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
44630df01fd3SThomas Chou    to access small data sections, so gp is free.
44640df01fd3SThomas Chou
4465afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4466afc1ce82SMacpaul Lin
4467afc1ce82SMacpaul Lin	R0-R1:	argument/return
4468afc1ce82SMacpaul Lin	R2-R5:	argument
4469afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4470afc1ce82SMacpaul Lin	R16:	trampoline register
4471afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4472afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4473afc1ce82SMacpaul Lin	R30:	link register (LP)
4474afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4475afc1ce82SMacpaul Lin	PC:	program counter (PC)
4476afc1ce82SMacpaul Lin
4477afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4478afc1ce82SMacpaul Lin
4479d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4480d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4481c609719bSwdenk
4482c609719bSwdenkMemory Management:
4483c609719bSwdenk------------------
4484c609719bSwdenk
4485c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4486c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4487c609719bSwdenk
4488c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4489c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4490c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4491c609719bSwdenkphysical memory banks.
4492c609719bSwdenk
4493c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4494c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4495c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4496c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
44976d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4498c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4499c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4500c609719bSwdenk
4501c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4502c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4503c609719bSwdenk
4504c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4505c609719bSwdenkthis:
4506c609719bSwdenk
4507c609719bSwdenk	0x0000 0000	Exception Vector code
4508c609719bSwdenk	      :
4509c609719bSwdenk	0x0000 1FFF
4510c609719bSwdenk	0x0000 2000	Free for Application Use
4511c609719bSwdenk	      :
4512c609719bSwdenk	      :
4513c609719bSwdenk
4514c609719bSwdenk	      :
4515c609719bSwdenk	      :
4516c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4517c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4518c609719bSwdenk	0x00FC 0000	Malloc Arena
4519c609719bSwdenk	      :
4520c609719bSwdenk	0x00FD FFFF
4521c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4522c609719bSwdenk	...		eventually: LCD or video framebuffer
4523c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4524c609719bSwdenk	0x00FF FFFF	[End of RAM]
4525c609719bSwdenk
4526c609719bSwdenk
4527c609719bSwdenkSystem Initialization:
4528c609719bSwdenk----------------------
4529c609719bSwdenk
4530c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
453111ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4532c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
45337152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4534c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4535c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4536c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4537c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4538c609719bSwdenkthe caches and the SIU.
4539c609719bSwdenk
4540c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4541c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4542c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4543c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4544c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4545c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4546c609719bSwdenkbanks.
4547c609719bSwdenk
4548c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
45497152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4550c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4551c609719bSwdenk0x00000000, with any additional banks following immediately to create
4552c609719bSwdenkcontiguous memory starting from 0.
4553c609719bSwdenk
4554c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4555c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4556c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4557c609719bSwdenkpages, and the final stack is set up.
4558c609719bSwdenk
4559c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4560c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4561c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4562c609719bSwdenknew address in RAM.
4563c609719bSwdenk
4564c609719bSwdenk
4565c609719bSwdenkU-Boot Porting Guide:
4566c609719bSwdenk----------------------
4567c609719bSwdenk
4568c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
45696aff3115Swdenklist, October 2002]
4570c609719bSwdenk
4571c609719bSwdenk
4572c609719bSwdenkint main(int argc, char *argv[])
4573c609719bSwdenk{
4574c609719bSwdenk	sighandler_t no_more_time;
4575c609719bSwdenk
4576c609719bSwdenk	signal(SIGALRM, no_more_time);
4577c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4578c609719bSwdenk
4579c609719bSwdenk	if (available_money > available_manpower) {
45806c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4581c609719bSwdenk		return 0;
4582c609719bSwdenk	}
4583c609719bSwdenk
4584c609719bSwdenk	Download latest U-Boot source;
4585c609719bSwdenk
45860668236bSWolfgang Denk	Subscribe to u-boot mailing list;
45876aff3115Swdenk
45886c3fef28SJerry Van Baren	if (clueless)
4589c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4590c609719bSwdenk
4591c609719bSwdenk	while (learning) {
4592c609719bSwdenk		Read the README file in the top level directory;
45937cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
45946c3fef28SJerry Van Baren		Read applicable doc/*.README;
4595c609719bSwdenk		Read the source, Luke;
45966c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4597c609719bSwdenk	}
4598c609719bSwdenk
45996c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
46006c3fef28SJerry Van Baren		Buy a BDI3000;
46016c3fef28SJerry Van Baren	else
4602c609719bSwdenk		Add a lot of aggravation and time;
4603c609719bSwdenk
46046c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
46056c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
46066c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
46076c3fef28SJerry Van Baren	} else {
4608c609719bSwdenk		Create your own board support subdirectory;
46096c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
46106c3fef28SJerry Van Baren	}
46116c3fef28SJerry Van Baren	Edit new board/<myboard> files
46126c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4613c609719bSwdenk
46146c3fef28SJerry Van Baren	while (!accepted) {
4615c609719bSwdenk		while (!running) {
4616c609719bSwdenk			do {
4617c609719bSwdenk				Add / modify source code;
4618c609719bSwdenk			} until (compiles);
4619c609719bSwdenk			Debug;
4620c609719bSwdenk			if (clueless)
4621c609719bSwdenk				email("Hi, I am having problems...");
4622c609719bSwdenk		}
46236c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
46246c3fef28SJerry Van Baren		if (reasonable critiques)
46256c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
46266c3fef28SJerry Van Baren		else
46276c3fef28SJerry Van Baren			Defend code as written;
46286c3fef28SJerry Van Baren	}
4629c609719bSwdenk
4630c609719bSwdenk	return 0;
4631c609719bSwdenk}
4632c609719bSwdenk
4633c609719bSwdenkvoid no_more_time (int sig)
4634c609719bSwdenk{
4635c609719bSwdenk      hire_a_guru();
4636c609719bSwdenk}
4637c609719bSwdenk
4638c609719bSwdenk
4639c609719bSwdenkCoding Standards:
4640c609719bSwdenk-----------------
4641c609719bSwdenk
4642c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
46432c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
46447ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4645c609719bSwdenk
46462c051651SDetlev ZundelSource files originating from a different project (for example the
46472c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
46482c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
46492c051651SDetlev Zundelsources.
46502c051651SDetlev Zundel
46512c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
46522c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
46532c051651SDetlev Zundelin your code.
4654c609719bSwdenk
4655c178d3daSwdenkPlease also stick to the following formatting rules:
4656180d3f74Swdenk- remove any trailing white space
46577ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4658180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
46597ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4660180d3f74Swdenk- do not add trailing empty lines to source files
4661180d3f74Swdenk
4662c609719bSwdenkSubmissions which do not conform to the standards may be returned
4663c609719bSwdenkwith a request to reformat the changes.
4664c609719bSwdenk
4665c609719bSwdenk
4666c609719bSwdenkSubmitting Patches:
4667c609719bSwdenk-------------------
4668c609719bSwdenk
4669c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4670c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4671c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4672c609719bSwdenk
46730d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4674218ca724SWolfgang Denk
46750668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
46760668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
46770668236bSWolfgang Denk
4678c609719bSwdenkWhen you send a patch, please include the following information with
4679c609719bSwdenkit:
4680c609719bSwdenk
4681c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4682c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4683c609719bSwdenk  patch actually fixes something.
4684c609719bSwdenk
4685c609719bSwdenk* For new features: a description of the feature and your
4686c609719bSwdenk  implementation.
4687c609719bSwdenk
4688c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4689c609719bSwdenk
4690c609719bSwdenk* For major contributions, your entry to the CREDITS file
4691c609719bSwdenk
4692c609719bSwdenk* When you add support for a new board, don't forget to add this
46937ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
4694c609719bSwdenk
4695c609719bSwdenk* If your patch adds new configuration options, don't forget to
4696c609719bSwdenk  document these in the README file.
4697c609719bSwdenk
4698218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4699218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
47007ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
4701218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4702218ca724SWolfgang Denk  with some other mail clients.
4703c609719bSwdenk
4704218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4705218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4706218ca724SWolfgang Denk  GNU diff.
47076dff5529Swdenk
4708218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4709218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4710218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4711218ca724SWolfgang Denk  affected files).
4712218ca724SWolfgang Denk
4713218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4714218ca724SWolfgang Denk  and compressed attachments must not be used.
4715c609719bSwdenk
471652f52c14Swdenk* If one logical set of modifications affects or creates several
471752f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
471852f52c14Swdenk
471952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
472052f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
472152f52c14Swdenk
472252f52c14Swdenk
4723c609719bSwdenkNotes:
4724c609719bSwdenk
4725c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4726c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4727c609719bSwdenk  for any of the boards.
4728c609719bSwdenk
4729c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4730c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4731c609719bSwdenk  returned with a request to re-formatting / split it.
4732c609719bSwdenk
4733c609719bSwdenk* If you modify existing code, make sure that your new code does not
4734c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4735c609719bSwdenk  When adding new features, these should compile conditionally only
4736c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4737c609719bSwdenk  disabled must not need more memory than the old code without your
4738c609719bSwdenk  modification.
473990dc6704Swdenk
47400668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
47410668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
47420668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
47430668236bSWolfgang Denk  bigger than the size limit should be avoided.
4744