xref: /openbmc/u-boot/README (revision c3eb3fe4)
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
1508d321b81SPeter Tyser	/at91rm9200	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
1838d321b81SPeter Tyser    /lib		Architecture specific library files
1848d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1858d321b81SPeter Tyser    /cpu		CPU specific files
1868d321b81SPeter Tyser    /lib		Architecture specific library files
187a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1888d321b81SPeter Tyser    /cpu		CPU specific files
1898d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1908d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1918d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1928d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1938d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1948d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1958d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1968d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1978d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1988d321b81SPeter Tyser    /lib		Architecture specific library files
1998d321b81SPeter Tyser  /sh			Files generic to SH architecture
2008d321b81SPeter Tyser    /cpu		CPU specific files
2018d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2028d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2038d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2088d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2098d321b81SPeter Tyser    /lib		Architecture specific library files
2108d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2118d321b81SPeter Tyser/board			Board dependent files
2128d321b81SPeter Tyser/common			Misc architecture independent functions
2138d321b81SPeter Tyser/disk			Code for disk drive partition handling
2148d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2158d321b81SPeter Tyser/drivers		Commonly used device drivers
2168d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2178d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2188d321b81SPeter Tyser/include		Header Files
2198d321b81SPeter Tyser/lib			Files generic to all architectures
2208d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2218d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2228d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2238d321b81SPeter Tyser/net			Networking code
2248d321b81SPeter Tyser/post			Power On Self Test
2258d321b81SPeter Tyser/rtc			Real Time Clock drivers
2268d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
227c609719bSwdenk
228c609719bSwdenkSoftware Configuration:
229c609719bSwdenk=======================
230c609719bSwdenk
231c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
232c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
233c609719bSwdenk
234c609719bSwdenkThere are two classes of configuration variables:
235c609719bSwdenk
236c609719bSwdenk* Configuration _OPTIONS_:
237c609719bSwdenk  These are selectable by the user and have names beginning with
238c609719bSwdenk  "CONFIG_".
239c609719bSwdenk
240c609719bSwdenk* Configuration _SETTINGS_:
241c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
242c609719bSwdenk  you don't know what you're doing; they have names beginning with
2436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
244c609719bSwdenk
245c609719bSwdenkLater we will add a configuration tool - probably similar to or even
246c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
247c609719bSwdenkdo the configuration by hand, which means creating some symbolic
248c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
249c609719bSwdenkas an example here.
250c609719bSwdenk
251c609719bSwdenk
252c609719bSwdenkSelection of Processor Architecture and Board Type:
253c609719bSwdenk---------------------------------------------------
254c609719bSwdenk
255c609719bSwdenkFor all supported boards there are ready-to-use default
256c609719bSwdenkconfigurations available; just type "make <board_name>_config".
257c609719bSwdenk
258c609719bSwdenkExample: For a TQM823L module type:
259c609719bSwdenk
260c609719bSwdenk	cd u-boot
261c609719bSwdenk	make TQM823L_config
262c609719bSwdenk
26311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
264c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
265c609719bSwdenkdirectory according to the instructions in cogent/README.
266c609719bSwdenk
267c609719bSwdenk
268c609719bSwdenkConfiguration Options:
269c609719bSwdenk----------------------
270c609719bSwdenk
271c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
272c609719bSwdenksuch information is kept in a configuration file
273c609719bSwdenk"include/configs/<board_name>.h".
274c609719bSwdenk
275c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
276c609719bSwdenk"include/configs/TQM823L.h".
277c609719bSwdenk
278c609719bSwdenk
2797f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2807f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2817f6c2cbcSwdenkbuild a config tool - later.
2827f6c2cbcSwdenk
2837f6c2cbcSwdenk
284c609719bSwdenkThe following options need to be configured:
285c609719bSwdenk
2862628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
287c609719bSwdenk
2882628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2896ccec449SWolfgang Denk
2906ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
292c609719bSwdenk
293c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
294c609719bSwdenk		Define exactly one of
295c609719bSwdenk		CONFIG_CMA286_60_OLD
296c609719bSwdenk--- FIXME --- not tested yet:
297c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
298c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
299c609719bSwdenk
300c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
301c609719bSwdenk		Define exactly one of
302c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
303c609719bSwdenk
304c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
305c609719bSwdenk		Define one or more of
306c609719bSwdenk		CONFIG_CMA302
307c609719bSwdenk
308c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
309c609719bSwdenk		Define one or more of
310c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31111ccc33fSMarcel Ziswiler					  the LCD display every second with
312c609719bSwdenk					  a "rotator" |\-/|\-/
313c609719bSwdenk
3142535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3152535d602Swdenk		CONFIG_ADSTYPE
3162535d602Swdenk		Possible values are:
3176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3212535d602Swdenk
322cf946c6dSLei Wen- Marvell Family Member
323cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
324cf946c6dSLei Wen					  multiple fs option at one time
325cf946c6dSLei Wen					  for marvell soc family
326cf946c6dSLei Wen
327c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
328c609719bSwdenk		Define exactly one of
329c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
330c609719bSwdenk
33111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33266ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33366ca92a5Swdenk					  get_gclk_freq() cannot work
3345da627a4Swdenk					  e.g. if there is no 32KHz
3355da627a4Swdenk					  reference PIT/RTC clock
33666ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33766ca92a5Swdenk					  or XTAL/EXTAL)
338c609719bSwdenk
33966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34266ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34375d1ea7fSwdenk			See doc/README.MPC866
34475d1ea7fSwdenk
3456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34675d1ea7fSwdenk
34775d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34875d1ea7fSwdenk		of relying on the correctness of the configured
34975d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35075d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35175d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35375d1ea7fSwdenk
354506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
355506f3918SHeiko Schocher
356506f3918SHeiko Schocher		Define this option if you want to enable the
357506f3918SHeiko Schocher		ICache only when Code runs from RAM.
358506f3918SHeiko Schocher
35966412c63SKumar Gala- 85xx CPU Options:
36066412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36166412c63SKumar Gala
36266412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36366412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36466412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36566412c63SKumar Gala
3668f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3678f29084aSKumar Gala
3688f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3698f29084aSKumar Gala		tree nodes for the given platform.
3708f29084aSKumar Gala
3710b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3730b953ffcSMarkus Klotzbuecher
3740b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3750b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3760b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3770b953ffcSMarkus Klotzbuecher
3786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3790b953ffcSMarkus Klotzbuecher
3800b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3810b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3820b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3830b953ffcSMarkus Klotzbuecher		by this value.
3840b953ffcSMarkus Klotzbuecher
3855da627a4Swdenk- Linux Kernel Interface:
386c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
387c609719bSwdenk
388c609719bSwdenk		U-Boot stores all clock information in Hz
389c609719bSwdenk		internally. For binary compatibility with older Linux
390c609719bSwdenk		kernels (which expect the clocks passed in the
391c609719bSwdenk		bd_info data to be in MHz) the environment variable
392c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
393c609719bSwdenk		converts clock data to MHZ before passing it to the
394c609719bSwdenk		Linux kernel.
395c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
396c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
397c609719bSwdenk		default environment.
398c609719bSwdenk
3995da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4005da627a4Swdenk
40111ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4025da627a4Swdenk		expect it to be in bytes, others in MB.
4035da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4045da627a4Swdenk
405fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
406f57f70aaSWolfgang Denk
407f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
408213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
409213bf8c8SGerald Van Baren		concepts).
410213bf8c8SGerald Van Baren
411213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
412213bf8c8SGerald Van Baren		 * New libfdt-based support
413213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4143bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
415213bf8c8SGerald Van Baren
416b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
417b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
418b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
419b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
420f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
421c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
422f57f70aaSWolfgang Denk
42311ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
42411ccc33fSMarcel Ziswiler		addresses
4253bb342fcSKim Phillips
4264e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4274e253137SKumar Gala
4284e253137SKumar Gala		Board code has addition modification that it wants to make
4294e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4306705d81eSwdenk
4310267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4320267768eSMatthew McClintock
43311ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4340267768eSMatthew McClintock		param header, the default value is zero if undefined.
4350267768eSMatthew McClintock
4363887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4373887c3fbSHeiko Schocher
4383887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4393887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4403887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4413887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4423887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4433887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4443887c3fbSHeiko Schocher
4457eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
4467eb29398SIgor Grinberg
4477eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
4487eb29398SIgor Grinberg		machine type and must be used to specify the machine type
4497eb29398SIgor Grinberg		number as it appears in the ARM machine registry
4507eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
4517eb29398SIgor Grinberg		Only boards that have multiple machine types supported
4527eb29398SIgor Grinberg		in a single configuration file and the machine type is
4537eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
4547eb29398SIgor Grinberg
4550b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4560b2f4ecaSNiklaus Giger
4570b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4580b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4590b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4600b2f4ecaSNiklaus Giger
4610b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4620b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4630b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4640b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4650b2f4ecaSNiklaus Giger
4660b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4670b2f4ecaSNiklaus Giger
4680b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4690b2f4ecaSNiklaus Giger
4700b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4710b2f4ecaSNiklaus Giger		the defaults discussed just above.
4720b2f4ecaSNiklaus Giger
4732c451f78SAneesh V- Cache Configuration:
4742c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
4752c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
4762c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
4772c451f78SAneesh V
47893bc2193SAneesh V- Cache Configuration for ARM:
47993bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
48093bc2193SAneesh V				      controller
48193bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
48293bc2193SAneesh V					controller register space
48393bc2193SAneesh V
4846705d81eSwdenk- Serial Ports:
48548d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4866705d81eSwdenk
4876705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4886705d81eSwdenk
48948d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4906705d81eSwdenk
4916705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4926705d81eSwdenk
4936705d81eSwdenk		CONFIG_PL011_CLOCK
4946705d81eSwdenk
4956705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4966705d81eSwdenk		the clock speed of the UARTs.
4976705d81eSwdenk
4986705d81eSwdenk		CONFIG_PL01x_PORTS
4996705d81eSwdenk
5006705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5016705d81eSwdenk		define this to a list of base addresses for each (supported)
5026705d81eSwdenk		port. See e.g. include/configs/versatile.h
5036705d81eSwdenk
504910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
505910f1ae3SJohn Rigby
506910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
507910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
508910f1ae3SJohn Rigby		this variable to initialize the extra register.
509910f1ae3SJohn Rigby
510910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
511910f1ae3SJohn Rigby
512910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
513910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
514910f1ae3SJohn Rigby		variable to flush the UART at init time.
515910f1ae3SJohn Rigby
5166705d81eSwdenk
517c609719bSwdenk- Console Interface:
518c609719bSwdenk		Depending on board, define exactly one serial port
519c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
520c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
521c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
522c609719bSwdenk
523c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
524c609719bSwdenk		port routines must be defined elsewhere
525c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
526c609719bSwdenk
527c609719bSwdenk		CONFIG_CFB_CONSOLE
528c609719bSwdenk		Enables console device for a color framebuffer. Needs following
529c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
530c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
531c609719bSwdenk						(default big endian)
532c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
533c609719bSwdenk						rectangle fill
534c609719bSwdenk						(cf. smiLynxEM)
535c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
536c609719bSwdenk						bit-blit (cf. smiLynxEM)
537c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
538c609719bSwdenk						(cols=pitch)
539c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
540c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
541c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
542c609719bSwdenk						(0-5, cf. cfb_console.c)
543c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
544c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
545c609719bSwdenk						(i.e. i8042_kbd_init())
546c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
547c609719bSwdenk						(i.e. i8042_tstc)
548c609719bSwdenk			VIDEO_GETC_FCT		get char fct
549c609719bSwdenk						(i.e. i8042_getc)
550c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
551c609719bSwdenk						(requires blink timer
552c609719bSwdenk						cf. i8042.c)
5536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
554c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
555c609719bSwdenk						upper right corner
556602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
557c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
558c609719bSwdenk						upper left corner
559a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
560a6c7ad2fSwdenk						linux_logo.h for logo.
561a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
562c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
56311ccc33fSMarcel Ziswiler						additional board info beside
564c609719bSwdenk						the logo
565c609719bSwdenk
566c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
567c609719bSwdenk		default i/o. Serial console can be forced with
568c609719bSwdenk		environment 'console=serial'.
569c609719bSwdenk
570a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
571a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
572a3ad8e26Swdenk		the "silent" environment variable. See
573a3ad8e26Swdenk		doc/README.silent for more information.
574a3ad8e26Swdenk
575c609719bSwdenk- Console Baudrate:
576c609719bSwdenk		CONFIG_BAUDRATE - in bps
577c609719bSwdenk		Select one of the baudrates listed in
5786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
580c609719bSwdenk
581c92fac91SHeiko Schocher- Console Rx buffer length
582c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
583c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5842b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
585c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
586c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
587c92fac91SHeiko Schocher		the SMC.
588c92fac91SHeiko Schocher
589c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
590c609719bSwdenk		Delay before automatically booting the default image;
591c609719bSwdenk		set to -1 to disable autoboot.
592c609719bSwdenk
593c609719bSwdenk		See doc/README.autoboot for these options that
594c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
595c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
596c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
597c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
598c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
599c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
600c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
601c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
602c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
603c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
604c609719bSwdenk		CONFIG_RESET_TO_RETRY
605c609719bSwdenk
606c609719bSwdenk- Autoboot Command:
607c609719bSwdenk		CONFIG_BOOTCOMMAND
608c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
609c609719bSwdenk		define a command string that is automatically executed
610c609719bSwdenk		when no character is read on the console interface
611c609719bSwdenk		within "Boot Delay" after reset.
612c609719bSwdenk
613c609719bSwdenk		CONFIG_BOOTARGS
614c609719bSwdenk		This can be used to pass arguments to the bootm
615c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
616c609719bSwdenk		environment value "bootargs".
617c609719bSwdenk
618c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
619c609719bSwdenk		The value of these goes into the environment as
620c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
621c609719bSwdenk		as a convenience, when switching between booting from
62211ccc33fSMarcel Ziswiler		RAM and NFS.
623c609719bSwdenk
624c609719bSwdenk- Pre-Boot Commands:
625c609719bSwdenk		CONFIG_PREBOOT
626c609719bSwdenk
627c609719bSwdenk		When this option is #defined, the existence of the
628c609719bSwdenk		environment variable "preboot" will be checked
629c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
630c609719bSwdenk		countdown and/or running the auto-boot command resp.
631c609719bSwdenk		entering interactive mode.
632c609719bSwdenk
633c609719bSwdenk		This feature is especially useful when "preboot" is
634c609719bSwdenk		automatically generated or modified. For an example
635c609719bSwdenk		see the LWMON board specific code: here "preboot" is
636c609719bSwdenk		modified when the user holds down a certain
637c609719bSwdenk		combination of keys on the (special) keyboard when
638c609719bSwdenk		booting the systems
639c609719bSwdenk
640c609719bSwdenk- Serial Download Echo Mode:
641c609719bSwdenk		CONFIG_LOADS_ECHO
642c609719bSwdenk		If defined to 1, all characters received during a
643c609719bSwdenk		serial download (using the "loads" command) are
644c609719bSwdenk		echoed back. This might be needed by some terminal
645c609719bSwdenk		emulations (like "cu"), but may as well just take
646c609719bSwdenk		time on others. This setting #define's the initial
647c609719bSwdenk		value of the "loads_echo" environment variable.
648c609719bSwdenk
649602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
650c609719bSwdenk		CONFIG_KGDB_BAUDRATE
651c609719bSwdenk		Select one of the baudrates listed in
6526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
653c609719bSwdenk
654c609719bSwdenk- Monitor Functions:
655602ad3b3SJon Loeliger		Monitor commands can be included or excluded
656602ad3b3SJon Loeliger		from the build by using the #include files
657602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
658602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
659602ad3b3SJon Loeliger		and augmenting with additional #define's
660602ad3b3SJon Loeliger		for wanted commands.
661c609719bSwdenk
662602ad3b3SJon Loeliger		The default command configuration includes all commands
663602ad3b3SJon Loeliger		except those marked below with a "*".
664602ad3b3SJon Loeliger
665602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
666602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
667602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
668602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
669602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
670602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
671602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
672602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
673710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
674602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
675602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
676602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
677a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
678a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
679a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
680a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
681602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
682602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
683246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
684602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
685602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
6860c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
687bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
688602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
689602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
690602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
691602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
692602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
693a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
694a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
695602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
696602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
697602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
698602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
699602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
700602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7010c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
702602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
703602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
704602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
705602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7061ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
707602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
708602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
70902c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
71002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
711602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
71256523f12Swdenk					  loop, loopw, mtest
713602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
714602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
715602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
71668d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
717602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
718602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
719e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
720e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
721602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
722602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
723602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
724602ad3b3SJon Loeliger					  host
725602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
726602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
727602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
728602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
729602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
730602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
731602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
732602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
733602ad3b3SJon Loeliger					  (4xx only)
734c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
73502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
73674de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
737602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
7387a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
739602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
740602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
741602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
742c609719bSwdenk
743c609719bSwdenk
744c609719bSwdenk		EXAMPLE: If you want all functions except of network
745c609719bSwdenk		support you can write:
746c609719bSwdenk
747602ad3b3SJon Loeliger		#include "config_cmd_all.h"
748602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
749c609719bSwdenk
750213bf8c8SGerald Van Baren	Other Commands:
751213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
752c609719bSwdenk
753c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
754602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
755c609719bSwdenk		what you (and your U-Boot users) are doing. Data
756c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
757c609719bSwdenk		8260 (where accesses to the IMMR region must be
758c609719bSwdenk		uncached), and it cannot be disabled on all other
759c609719bSwdenk		systems where we (mis-) use the data cache to hold an
760c609719bSwdenk		initial stack and some data.
761c609719bSwdenk
762c609719bSwdenk
763c609719bSwdenk		XXX - this list needs to get updated!
764c609719bSwdenk
765c609719bSwdenk- Watchdog:
766c609719bSwdenk		CONFIG_WATCHDOG
767c609719bSwdenk		If this variable is defined, it enables watchdog
7686abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
7696abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
7706abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
7716abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
7726abe6fb6SDetlev Zundel		available, then no further board specific code should
7736abe6fb6SDetlev Zundel		be needed to use it.
7746abe6fb6SDetlev Zundel
7756abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
7766abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
7776abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
7786abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
779c609719bSwdenk
780c1551ea8Sstroese- U-Boot Version:
781c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
782c1551ea8Sstroese		If this variable is defined, an environment variable
783c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
784c1551ea8Sstroese		version as printed by the "version" command.
785c1551ea8Sstroese		This variable is readonly.
786c1551ea8Sstroese
787c609719bSwdenk- Real-Time Clock:
788c609719bSwdenk
789602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
790c609719bSwdenk		has to be selected, too. Define exactly one of the
791c609719bSwdenk		following options:
792c609719bSwdenk
793c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
794c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7957ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
796c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7971cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
798c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7997f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
8003bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
8019536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
8024c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
8036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
80471d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
80571d19f30SHeiko Schocher					  RV3029 RTC.
806c609719bSwdenk
807b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
808b37c7e5eSwdenk		must also be configured. See I2C Support, below.
809b37c7e5eSwdenk
810e92739d3SPeter Tyser- GPIO Support:
811e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
812e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
813e92739d3SPeter Tyser
8145dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
8155dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
8165dec49caSChris Packham		pins supported by a particular chip.
8175dec49caSChris Packham
818e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
819e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
820e92739d3SPeter Tyser
821c609719bSwdenk- Timestamp Support:
822c609719bSwdenk
823c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
824c609719bSwdenk		(date and time) of an image is printed by image
825c609719bSwdenk		commands like bootm or iminfo. This option is
826602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
827c609719bSwdenk
828c609719bSwdenk- Partition Support:
829c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
83007f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
831c609719bSwdenk
832602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
833218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
834218ca724SWolfgang Denk		least one partition type as well.
835c609719bSwdenk
836c609719bSwdenk- IDE Reset method:
8374d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8384d13cbadSwdenk		board configurations files but used nowhere!
839c609719bSwdenk
8404d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8414d13cbadSwdenk		be performed by calling the function
8424d13cbadSwdenk			ide_set_reset(int reset)
8434d13cbadSwdenk		which has to be defined in a board specific file
844c609719bSwdenk
845c609719bSwdenk- ATAPI Support:
846c609719bSwdenk		CONFIG_ATAPI
847c609719bSwdenk
848c609719bSwdenk		Set this to enable ATAPI support.
849c609719bSwdenk
850c40b2956Swdenk- LBA48 Support
851c40b2956Swdenk		CONFIG_LBA48
852c40b2956Swdenk
853c40b2956Swdenk		Set this to enable support for disks larger than 137GB
8544b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
855c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
856c40b2956Swdenk		support disks up to 2.1TB.
857c40b2956Swdenk
8586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
859c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
860c40b2956Swdenk			Default is 32bit.
861c40b2956Swdenk
862c609719bSwdenk- SCSI Support:
863c609719bSwdenk		At the moment only there is only support for the
864c609719bSwdenk		SYM53C8XX SCSI controller; define
865c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
866c609719bSwdenk
8676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
8686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
8696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
870c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
871c609719bSwdenk		devices.
8726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
873c609719bSwdenk
874c609719bSwdenk- NETWORK Support (PCI):
875682011ffSwdenk		CONFIG_E1000
876682011ffSwdenk		Support for Intel 8254x gigabit chips.
877682011ffSwdenk
878ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
87911ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
880ac3315c2SAndre Schwarz
881c609719bSwdenk		CONFIG_EEPRO100
882c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
88311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
884c609719bSwdenk		write routine for first time initialisation.
885c609719bSwdenk
886c609719bSwdenk		CONFIG_TULIP
887c609719bSwdenk		Support for Digital 2114x chips.
888c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
889c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
890c609719bSwdenk
891c609719bSwdenk		CONFIG_NATSEMI
892c609719bSwdenk		Support for National dp83815 chips.
893c609719bSwdenk
894c609719bSwdenk		CONFIG_NS8382X
895c609719bSwdenk		Support for National dp8382[01] gigabit chips.
896c609719bSwdenk
89745219c46Swdenk- NETWORK Support (other):
89845219c46Swdenk
899c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
900c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
901c041e9d2SJens Scharsig
902c041e9d2SJens Scharsig			CONFIG_RMII
903c041e9d2SJens Scharsig			Define this to use reduced MII inteface
904c041e9d2SJens Scharsig
905c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
906c041e9d2SJens Scharsig			If this defined, the driver is quiet.
907c041e9d2SJens Scharsig			The driver doen't show link status messages.
908c041e9d2SJens Scharsig
90945219c46Swdenk		CONFIG_DRIVER_LAN91C96
91045219c46Swdenk		Support for SMSC's LAN91C96 chips.
91145219c46Swdenk
91245219c46Swdenk			CONFIG_LAN91C96_BASE
91345219c46Swdenk			Define this to hold the physical address
91445219c46Swdenk			of the LAN91C96's I/O space
91545219c46Swdenk
91645219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
91745219c46Swdenk			Define this to enable 32 bit addressing
91845219c46Swdenk
919f39748aeSwdenk		CONFIG_DRIVER_SMC91111
920f39748aeSwdenk		Support for SMSC's LAN91C111 chip
921f39748aeSwdenk
922f39748aeSwdenk			CONFIG_SMC91111_BASE
923f39748aeSwdenk			Define this to hold the physical address
924f39748aeSwdenk			of the device (I/O space)
925f39748aeSwdenk
926f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
927f39748aeSwdenk			Define this if data bus is 32 bits
928f39748aeSwdenk
929f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
930f39748aeSwdenk			Define this to use i/o functions instead of macros
931f39748aeSwdenk			(some hardware wont work with macros)
932f39748aeSwdenk
933b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
934b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
935b3dbf4a5SMacpaul Lin
936b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
937b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
938b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
939b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
940b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
941b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
942b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
943b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
944b3dbf4a5SMacpaul Lin
945c2fff331SMike Rapoport		CONFIG_SMC911X
946557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
947557b377dSJens Gehrlein
948c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
949557b377dSJens Gehrlein			Define this to hold the physical address
950557b377dSJens Gehrlein			of the device (I/O space)
951557b377dSJens Gehrlein
952c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
953557b377dSJens Gehrlein			Define this if data bus is 32 bits
954557b377dSJens Gehrlein
955c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
956557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
957557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
958c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
959557b377dSJens Gehrlein
9603d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
9613d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
9623d0075faSYoshihiro Shimoda
9633d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
9643d0075faSYoshihiro Shimoda			Define the number of ports to be used
9653d0075faSYoshihiro Shimoda
9663d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
9673d0075faSYoshihiro Shimoda			Define the ETH PHY's address
9683d0075faSYoshihiro Shimoda
96968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
97068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
97168260aabSYoshihiro Shimoda
972c609719bSwdenk- USB Support:
973c609719bSwdenk		At the moment only the UHCI host controller is
9744d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
975c609719bSwdenk		CONFIG_USB_UHCI to enable it.
976c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
97730d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
978c609719bSwdenk		storage devices.
979c609719bSwdenk		Note:
980c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
981c609719bSwdenk		(TEAC FD-05PUB).
9824d13cbadSwdenk		MPC5200 USB requires additional defines:
9834d13cbadSwdenk			CONFIG_USB_CLOCK
9844d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
985307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
986307ecb6dSEric Millbrandt				for USB on PSC3
9874d13cbadSwdenk			CONFIG_USB_CONFIG
9884d13cbadSwdenk				for differential drivers: 0x00001000
9894d13cbadSwdenk				for single ended drivers: 0x00005000
990307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
991307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
9926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
993fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
994fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9954d13cbadSwdenk
99616c8d5e7SWolfgang Denk- USB Device:
99716c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
99816c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
99916c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
100011ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
100116c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
100216c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
100316c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
100416c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
100516c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
100616c8d5e7SWolfgang Denk		a Linux host by
100716c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
100816c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
100916c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
101016c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
101116c8d5e7SWolfgang Denk
101216c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
101316c8d5e7SWolfgang Denk			Define this to build a UDC device
101416c8d5e7SWolfgang Denk
101516c8d5e7SWolfgang Denk			CONFIG_USB_TTY
101616c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
101716c8d5e7SWolfgang Denk			talk to the UDC device
101816c8d5e7SWolfgang Denk
10196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
102016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
102116c8d5e7SWolfgang Denk			be set to usbtty.
102216c8d5e7SWolfgang Denk
102316c8d5e7SWolfgang Denk			mpc8xx:
10246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
102516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
10266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
102716c8d5e7SWolfgang Denk
10286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
102916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
10306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
103116c8d5e7SWolfgang Denk
103216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
103316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
103416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
103516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
103616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
103716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
103816c8d5e7SWolfgang Denk
103916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
104016c8d5e7SWolfgang Denk			Define this string as the name of your company for
104116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
104216c8d5e7SWolfgang Denk
104316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
104416c8d5e7SWolfgang Denk			Define this string as the name of your product
104516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
104616c8d5e7SWolfgang Denk
104716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
104816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
104916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
105016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
105116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
105216c8d5e7SWolfgang Denk
105316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
105416c8d5e7SWolfgang Denk			Define this as the unique Product ID
105516c8d5e7SWolfgang Denk			for your device
105616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1057c609719bSwdenk
1058c609719bSwdenk
1059c609719bSwdenk- MMC Support:
1060c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1061c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1062c609719bSwdenk		accessed from the boot prompt by mapping the device
1063c609719bSwdenk		to physical memory similar to flash. Command line is
1064602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1065602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1066c609719bSwdenk
1067afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1068afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1069afb35666SYoshihiro Shimoda
1070afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1071afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1072afb35666SYoshihiro Shimoda
1073afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1074afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1075afb35666SYoshihiro Shimoda
10766705d81eSwdenk- Journaling Flash filesystem support:
10776705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
10786705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
10796705d81eSwdenk		Define these for a default partition on a NAND device
10806705d81eSwdenk
10816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
10836705d81eSwdenk		Define these for a default partition on a NOR device
10846705d81eSwdenk
10856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
10866705d81eSwdenk		Define this to create an own partition. You have to provide a
10876705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
10886705d81eSwdenk
10896705d81eSwdenk		If you define only one JFFS2 partition you may also want to
10906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
10916705d81eSwdenk		to disable the command chpart. This is the default when you
10926705d81eSwdenk		have not defined a custom partition
10936705d81eSwdenk
1094c609719bSwdenk- Keyboard Support:
1095c609719bSwdenk		CONFIG_ISA_KEYBOARD
1096c609719bSwdenk
1097c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1098c609719bSwdenk		support
1099c609719bSwdenk
1100c609719bSwdenk		CONFIG_I8042_KBD
1101c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1102c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1103c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1104c609719bSwdenk		for cfb_console. Supports cursor blinking.
1105c609719bSwdenk
1106c609719bSwdenk- Video support:
1107c609719bSwdenk		CONFIG_VIDEO
1108c609719bSwdenk
1109c609719bSwdenk		Define this to enable video support (for output to
1110c609719bSwdenk		video).
1111c609719bSwdenk
1112c609719bSwdenk		CONFIG_VIDEO_CT69000
1113c609719bSwdenk
1114c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1115c609719bSwdenk
1116c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1117eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1118eeb1b77bSwdenk		video output is selected via environment 'videoout'
1119eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1120eeb1b77bSwdenk		assumed.
1121c609719bSwdenk
1122eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
112311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1124eeb1b77bSwdenk		are possible:
1125eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1126eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1127eeb1b77bSwdenk
1128eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1129eeb1b77bSwdenk		-------------+---------------------------------------------
1130eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1131eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1132eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1133eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1134eeb1b77bSwdenk		-------------+---------------------------------------------
1135c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1136c609719bSwdenk
1137eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
11387817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1139eeb1b77bSwdenk
1140eeb1b77bSwdenk
1141a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1142a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1143a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1144a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1145a6c7ad2fSwdenk
11467d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
11477d3053fbSTimur Tabi		Enable the Freescale DIU video driver.  Reference boards for
11487d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
11497d3053fbSTimur Tabi		support, and should also define these other macros:
11507d3053fbSTimur Tabi
11517d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
11527d3053fbSTimur Tabi			CONFIG_VIDEO
11537d3053fbSTimur Tabi			CONFIG_CMD_BMP
11547d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
11557d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
11567d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
11577d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
11587d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
11597d3053fbSTimur Tabi
1160ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1161ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1162ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1163ba8e76bdSTimur Tabi		description of this variable.
11647d3053fbSTimur Tabi
1165682011ffSwdenk- Keyboard Support:
1166682011ffSwdenk		CONFIG_KEYBOARD
1167682011ffSwdenk
1168682011ffSwdenk		Define this to enable a custom keyboard support.
1169682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1170682011ffSwdenk		defined in your board-specific files.
1171682011ffSwdenk		The only board using this so far is RBC823.
1172a6c7ad2fSwdenk
1173c609719bSwdenk- LCD Support:	CONFIG_LCD
1174c609719bSwdenk
1175c609719bSwdenk		Define this to enable LCD support (for output to LCD
1176c609719bSwdenk		display); also select one of the supported displays
1177c609719bSwdenk		by defining one of these:
1178c609719bSwdenk
117939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
118039cf4804SStelian Pop
118139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
118239cf4804SStelian Pop
1183fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1184c609719bSwdenk
1185fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1186c609719bSwdenk
1187fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1188c609719bSwdenk
1189fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1190fd3103bbSwdenk			Active, color, single scan.
1191fd3103bbSwdenk
1192fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1193fd3103bbSwdenk
1194fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1195c609719bSwdenk			Active, color, single scan.
1196c609719bSwdenk
1197c609719bSwdenk		CONFIG_SHARP_16x9
1198c609719bSwdenk
1199c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1200c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1201c609719bSwdenk
1202c609719bSwdenk		CONFIG_SHARP_LQ64D341
1203c609719bSwdenk
1204c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1205c609719bSwdenk			Active, color, single scan.
1206c609719bSwdenk
1207c609719bSwdenk		CONFIG_HLD1045
1208c609719bSwdenk
1209c609719bSwdenk			HLD1045 display, 640x480.
1210c609719bSwdenk			Active, color, single scan.
1211c609719bSwdenk
1212c609719bSwdenk		CONFIG_OPTREX_BW
1213c609719bSwdenk
1214c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1215c609719bSwdenk			or
1216c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1217c609719bSwdenk			or
1218c609719bSwdenk			Hitachi	 SP14Q002
1219c609719bSwdenk
1220c609719bSwdenk			320x240. Black & white.
1221c609719bSwdenk
1222c609719bSwdenk		Normally display is black on white background; define
12236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1224c609719bSwdenk
12257152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1226d791b1dcSwdenk
1227d791b1dcSwdenk		If this option is set, the environment is checked for
1228d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1229d791b1dcSwdenk		of logo, copyright and system information on the LCD
1230e94d2cd9Swdenk		is suppressed and the BMP image at the address
1231d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1232d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1233d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1234d791b1dcSwdenk		loaded very quickly after power-on.
1235d791b1dcSwdenk
12361ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
12371ca298ceSMatthias Weisser
12381ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
12391ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
12401ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
12411ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
12421ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
12431ca298ceSMatthias Weisser		specify 'm' for centering the image.
12441ca298ceSMatthias Weisser
12451ca298ceSMatthias Weisser		Example:
12461ca298ceSMatthias Weisser		setenv splashpos m,m
12471ca298ceSMatthias Weisser			=> image at center of screen
12481ca298ceSMatthias Weisser
12491ca298ceSMatthias Weisser		setenv splashpos 30,20
12501ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
12511ca298ceSMatthias Weisser
12521ca298ceSMatthias Weisser		setenv splashpos -10,m
12531ca298ceSMatthias Weisser			=> vertically centered image
12541ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
12551ca298ceSMatthias Weisser
125698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
125798f4a3dfSStefan Roese
125898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
125998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
126098f4a3dfSStefan Roese		splashscreen support or the bmp command.
126198f4a3dfSStefan Roese
1262d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1263d5011762SAnatolij Gustschin
1264d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1265d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1266d5011762SAnatolij Gustschin		bmp command.
1267d5011762SAnatolij Gustschin
1268c29fdfc1Swdenk- Compression support:
1269c29fdfc1Swdenk		CONFIG_BZIP2
1270c29fdfc1Swdenk
1271c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1272c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1273c29fdfc1Swdenk		compressed images are supported.
1274c29fdfc1Swdenk
1275c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
12766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1277c29fdfc1Swdenk		be at least 4MB.
1278d791b1dcSwdenk
1279fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1280fc9c1727SLuigi 'Comio' Mantellini
1281fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1282fc9c1727SLuigi 'Comio' Mantellini		images is included.
1283fc9c1727SLuigi 'Comio' Mantellini
1284fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1285fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1286fc9c1727SLuigi 'Comio' Mantellini		formula:
1287fc9c1727SLuigi 'Comio' Mantellini
1288fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1289fc9c1727SLuigi 'Comio' Mantellini
1290fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1291fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1292fc9c1727SLuigi 'Comio' Mantellini
1293fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1294fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1295fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1296fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1297fc9c1727SLuigi 'Comio' Mantellini
1298fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1299fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
13006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1301fc9c1727SLuigi 'Comio' Mantellini
130217ea1177Swdenk- MII/PHY support:
130317ea1177Swdenk		CONFIG_PHY_ADDR
130417ea1177Swdenk
130517ea1177Swdenk		The address of PHY on MII bus.
130617ea1177Swdenk
130717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
130817ea1177Swdenk
130917ea1177Swdenk		The clock frequency of the MII bus
131017ea1177Swdenk
131117ea1177Swdenk		CONFIG_PHY_GIGE
131217ea1177Swdenk
131317ea1177Swdenk		If this option is set, support for speed/duplex
131411ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
131517ea1177Swdenk
131617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
131717ea1177Swdenk
131817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
131917ea1177Swdenk		reset before any MII register access is possible.
132017ea1177Swdenk		For such PHY, set this option to the usec delay
132117ea1177Swdenk		required. (minimum 300usec for LXT971A)
132217ea1177Swdenk
132317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
132417ea1177Swdenk
132517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
132617ea1177Swdenk		command issued before MII status register can be read
132717ea1177Swdenk
1328c609719bSwdenk- Ethernet address:
1329c609719bSwdenk		CONFIG_ETHADDR
1330c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1331c609719bSwdenk		CONFIG_ETH2ADDR
1332c609719bSwdenk		CONFIG_ETH3ADDR
1333c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1334c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1335c609719bSwdenk
133611ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
133711ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1338c609719bSwdenk		is not determined automatically.
1339c609719bSwdenk
1340c609719bSwdenk- IP address:
1341c609719bSwdenk		CONFIG_IPADDR
1342c609719bSwdenk
1343c609719bSwdenk		Define a default value for the IP address to use for
134411ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1345c609719bSwdenk		determined through e.g. bootp.
1346c609719bSwdenk
1347c609719bSwdenk- Server IP address:
1348c609719bSwdenk		CONFIG_SERVERIP
1349c609719bSwdenk
1350c609719bSwdenk		Defines a default value for the IP address of a TFTP
1351c609719bSwdenk		server to contact when using the "tftboot" command.
1352c609719bSwdenk
135397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
135497cfe861SRobin Getz
135597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
135697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
135797cfe861SRobin Getz
135853a5c424SDavid Updegraff- Multicast TFTP Mode:
135953a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
136053a5c424SDavid Updegraff
136153a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
136253a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
136311ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
136453a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
136553a5c424SDavid Updegraff		multicast group.
136653a5c424SDavid Updegraff
1367c609719bSwdenk- BOOTP Recovery Mode:
1368c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1369c609719bSwdenk
1370c609719bSwdenk		If you have many targets in a network that try to
1371c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1372c609719bSwdenk		systems send out BOOTP requests at precisely the same
1373c609719bSwdenk		moment (which would happen for instance at recovery
1374c609719bSwdenk		from a power failure, when all systems will try to
1375c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1376c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1377c609719bSwdenk		inserted before sending out BOOTP requests. The
13786c33c785SWolfgang Denk		following delays are inserted then:
1379c609719bSwdenk
1380c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1381c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1382c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1383c609719bSwdenk		4th and following
1384c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1385c609719bSwdenk
1386fe389a82Sstroese- DHCP Advanced Options:
13871fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
13881fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1389fe389a82Sstroese
13901fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
13911fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
13921fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
13931fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
13941fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
13951fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
13961fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
13971fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
13981fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
13991fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
14001fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
14011fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1402fe389a82Sstroese
14035d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
14045d110f0aSWilson Callan		environment variable, not the BOOTP server.
1405fe389a82Sstroese
1406fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1407fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1408fe389a82Sstroese		than one DNS serverip is offered to the client.
1409fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1410fe389a82Sstroese		serverip will be stored in the additional environment
1411fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1412fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
14131fe80d79SJon Loeliger		is defined.
1414fe389a82Sstroese
1415fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1416fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1417fe389a82Sstroese		need the hostname of the DHCP requester.
14185d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
14191fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
14201fe80d79SJon Loeliger		option 12 to the DHCP server.
1421fe389a82Sstroese
1422d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1423d9a2f416SAras Vaichas
1424d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1425d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1426d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1427d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1428d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1429d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1430d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1431d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1432d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1433d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1434d9a2f416SAras Vaichas		this delay.
1435d9a2f416SAras Vaichas
1436a3d991bdSwdenk - CDP Options:
1437a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1438a3d991bdSwdenk
1439a3d991bdSwdenk		The device id used in CDP trigger frames.
1440a3d991bdSwdenk
1441a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1442a3d991bdSwdenk
1443a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1444a3d991bdSwdenk		of the device.
1445a3d991bdSwdenk
1446a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1447a3d991bdSwdenk
1448a3d991bdSwdenk		A printf format string which contains the ascii name of
1449a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
145011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1451a3d991bdSwdenk
1452a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1453a3d991bdSwdenk
1454a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1455a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1456a3d991bdSwdenk
1457a3d991bdSwdenk		CONFIG_CDP_VERSION
1458a3d991bdSwdenk
1459a3d991bdSwdenk		An ascii string containing the version of the software.
1460a3d991bdSwdenk
1461a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1462a3d991bdSwdenk
1463a3d991bdSwdenk		An ascii string containing the name of the platform.
1464a3d991bdSwdenk
1465a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1466a3d991bdSwdenk
1467a3d991bdSwdenk		A 32bit integer sent on the trigger.
1468a3d991bdSwdenk
1469a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1470a3d991bdSwdenk
1471a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1472a3d991bdSwdenk		device in .1 of milliwatts.
1473a3d991bdSwdenk
1474a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1475a3d991bdSwdenk
1476a3d991bdSwdenk		A byte containing the id of the VLAN.
1477a3d991bdSwdenk
1478c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1479c609719bSwdenk
1480c609719bSwdenk		Several configurations allow to display the current
1481c609719bSwdenk		status using a LED. For instance, the LED will blink
1482c609719bSwdenk		fast while running U-Boot code, stop blinking as
1483c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1484c609719bSwdenk		start blinking slow once the Linux kernel is running
1485c609719bSwdenk		(supported by a status LED driver in the Linux
1486c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1487c609719bSwdenk		feature in U-Boot.
1488c609719bSwdenk
1489c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1490c609719bSwdenk
1491c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1492c609719bSwdenk		on those systems that support this (optional)
1493c609719bSwdenk		feature, like the TQM8xxL modules.
1494c609719bSwdenk
1495c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1496c609719bSwdenk
1497b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1498b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
149911ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1500c609719bSwdenk
1501b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1502602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1503b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1504b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1505c609719bSwdenk		command line interface.
1506c609719bSwdenk
1507bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1508c609719bSwdenk
1509b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1510b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1511b37c7e5eSwdenk		support for I2C.
1512c609719bSwdenk
1513b37c7e5eSwdenk		There are several other quantities that must also be
1514b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1515c609719bSwdenk
15166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1517b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
15186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
151911ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1520c609719bSwdenk
15218d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1522a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
15238d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
15248d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
15258d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1526b37c7e5eSwdenk
15275da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
15285da71efaSEric Millbrandt
15295da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
15305da71efaSEric Millbrandt		chips might think that the current transfer is still
15315da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
15325da71efaSEric Millbrandt		commands until the slave device responds.
15335da71efaSEric Millbrandt
1534b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1535b37c7e5eSwdenk
1536b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1537b37c7e5eSwdenk		then the following macros need to be defined (examples are
1538b37c7e5eSwdenk		from include/configs/lwmon.h):
1539c609719bSwdenk
1540c609719bSwdenk		I2C_INIT
1541c609719bSwdenk
1542b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1543c609719bSwdenk		controller or configure ports.
1544c609719bSwdenk
1545b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1546b37c7e5eSwdenk
1547c609719bSwdenk		I2C_PORT
1548c609719bSwdenk
1549c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1550c609719bSwdenk		assumes both bits are on the same port). Valid values
1551c609719bSwdenk		are 0..3 for ports A..D.
1552c609719bSwdenk
1553c609719bSwdenk		I2C_ACTIVE
1554c609719bSwdenk
1555c609719bSwdenk		The code necessary to make the I2C data line active
1556c609719bSwdenk		(driven).  If the data line is open collector, this
1557c609719bSwdenk		define can be null.
1558c609719bSwdenk
1559b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1560b37c7e5eSwdenk
1561c609719bSwdenk		I2C_TRISTATE
1562c609719bSwdenk
1563c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1564c609719bSwdenk		(inactive).  If the data line is open collector, this
1565c609719bSwdenk		define can be null.
1566c609719bSwdenk
1567b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1568b37c7e5eSwdenk
1569c609719bSwdenk		I2C_READ
1570c609719bSwdenk
1571c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1572c609719bSwdenk		FALSE if it is low.
1573c609719bSwdenk
1574b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1575b37c7e5eSwdenk
1576c609719bSwdenk		I2C_SDA(bit)
1577c609719bSwdenk
1578c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1579c609719bSwdenk		is FALSE, it clears it (low).
1580c609719bSwdenk
1581b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1582b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1583b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1584b37c7e5eSwdenk
1585c609719bSwdenk		I2C_SCL(bit)
1586c609719bSwdenk
1587c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1588c609719bSwdenk		is FALSE, it clears it (low).
1589c609719bSwdenk
1590b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1591b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1592b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1593b37c7e5eSwdenk
1594c609719bSwdenk		I2C_DELAY
1595c609719bSwdenk
1596c609719bSwdenk		This delay is invoked four times per clock cycle so this
1597c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1598b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1599b37c7e5eSwdenk		like:
1600b37c7e5eSwdenk
1601b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1602c609719bSwdenk
1603793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1604793b5726SMike Frysinger
1605793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1606793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1607793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1608793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1609793b5726SMike Frysinger
1610793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1611793b5726SMike Frysinger		the generic GPIO functions.
1612793b5726SMike Frysinger
16136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
161447cd00faSwdenk
161547cd00faSwdenk		When a board is reset during an i2c bus transfer
161647cd00faSwdenk		chips might think that the current transfer is still
161747cd00faSwdenk		in progress. On some boards it is possible to access
161847cd00faSwdenk		the i2c SCLK line directly, either by using the
161947cd00faSwdenk		processor pin as a GPIO or by having a second pin
162047cd00faSwdenk		connected to the bus. If this option is defined a
162147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
162247cd00faSwdenk		is run early in the boot sequence.
162347cd00faSwdenk
162426a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
162526a33504SRichard Retanubun
162626a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
162726a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
162826a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
162926a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
163026a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
163126a33504SRichard Retanubun		controller provide such a method. It is called at the end of
163226a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
163326a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
163426a33504SRichard Retanubun
163517ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
163617ea1177Swdenk
163717ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
163817ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
163917ea1177Swdenk		variable "i2cfast". (see also i2cfast)
164017ea1177Swdenk
1641bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1642bb99ad6dSBen Warren
1643bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1644bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1645bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1646bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1647bb99ad6dSBen Warren
16486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1649bb99ad6dSBen Warren
1650bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
16510f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
16520f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
16530f89c54bSPeter Tyser		a 1D array of device addresses
1654bb99ad6dSBen Warren
1655bb99ad6dSBen Warren		e.g.
1656bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
16576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1658bb99ad6dSBen Warren
1659bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1660bb99ad6dSBen Warren
1661bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
16626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1663bb99ad6dSBen Warren
1664bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1665bb99ad6dSBen Warren
16666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1667be5e6181STimur Tabi
1668be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1669be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1670be5e6181STimur Tabi
16716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
16720dc018ecSStefan Roese
16730dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
16740dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
16750dc018ecSStefan Roese
16766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
16770dc018ecSStefan Roese
16780dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
16790dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
16800dc018ecSStefan Roese
16816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
16829ebbb54fSVictor Gallardo
16839ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
16849ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
16859ebbb54fSVictor Gallardo		specified DTT device.
16869ebbb54fSVictor Gallardo
1687be5e6181STimur Tabi		CONFIG_FSL_I2C
1688be5e6181STimur Tabi
1689be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
16907817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1691be5e6181STimur Tabi
169267b23a32SHeiko Schocher		CONFIG_I2C_MUX
169367b23a32SHeiko Schocher
169467b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
169567b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
169667b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
169767b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
169867b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
169967b23a32SHeiko Schocher		the muxes to activate this new "bus".
170067b23a32SHeiko Schocher
170167b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
170267b23a32SHeiko Schocher		feature!
170367b23a32SHeiko Schocher
170467b23a32SHeiko Schocher		Example:
170567b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
170667b23a32SHeiko Schocher			The First mux with address 70 and channel 6
170767b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
170867b23a32SHeiko Schocher
170967b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
171067b23a32SHeiko Schocher
171167b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
171267b23a32SHeiko Schocher		of I2C Busses with muxes:
171367b23a32SHeiko Schocher
171467b23a32SHeiko Schocher		=> i2c bus
171567b23a32SHeiko Schocher		Busses reached over muxes:
171667b23a32SHeiko Schocher		Bus ID: 2
171767b23a32SHeiko Schocher		  reached over Mux(es):
171867b23a32SHeiko Schocher		    pca9544a@70 ch: 4
171967b23a32SHeiko Schocher		Bus ID: 3
172067b23a32SHeiko Schocher		  reached over Mux(es):
172167b23a32SHeiko Schocher		    pca9544a@70 ch: 6
172267b23a32SHeiko Schocher		    pca9544a@71 ch: 4
172367b23a32SHeiko Schocher		=>
172467b23a32SHeiko Schocher
172567b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
172667b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
172767b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
172867b23a32SHeiko Schocher		the channel 4.
172967b23a32SHeiko Schocher
173067b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
173167b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
173267b23a32SHeiko Schocher		the 2 muxes.
173367b23a32SHeiko Schocher
173467b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
173567b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
173667b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
173767b23a32SHeiko Schocher		to add this option to other architectures.
173867b23a32SHeiko Schocher
17392ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
17402ac6985aSAndrew Dyer
17412ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
17422ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
17432ac6985aSAndrew Dyer		between writing the address pointer and reading the
17442ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
17452ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
17462ac6985aSAndrew Dyer		devices can use either method, but some require one or
17472ac6985aSAndrew Dyer		the other.
1748be5e6181STimur Tabi
1749c609719bSwdenk- SPI Support:	CONFIG_SPI
1750c609719bSwdenk
1751c609719bSwdenk		Enables SPI driver (so far only tested with
1752c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1753c609719bSwdenk		D/As on the SACSng board)
1754c609719bSwdenk
17556639562eSYoshihiro Shimoda		CONFIG_SH_SPI
17566639562eSYoshihiro Shimoda
17576639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
17586639562eSYoshihiro Shimoda		only SH7757 is supported.
17596639562eSYoshihiro Shimoda
1760c609719bSwdenk		CONFIG_SPI_X
1761c609719bSwdenk
1762c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1763c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1764c609719bSwdenk
1765c609719bSwdenk		CONFIG_SOFT_SPI
1766c609719bSwdenk
1767c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1768c609719bSwdenk		using hardware support. This is a general purpose
1769c609719bSwdenk		driver that only requires three general I/O port pins
1770c609719bSwdenk		(two outputs, one input) to function. If this is
1771c609719bSwdenk		defined, the board configuration must define several
1772c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1773c609719bSwdenk		an example, see include/configs/sacsng.h.
1774c609719bSwdenk
177504a9e118SBen Warren		CONFIG_HARD_SPI
177604a9e118SBen Warren
177704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
177804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
177904a9e118SBen Warren		must define a list of chip-select function pointers.
178004a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
178104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
178204a9e118SBen Warren
178338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
178438254f45SGuennadi Liakhovetski
178538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
178638254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
178738254f45SGuennadi Liakhovetski
17880133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
17890133502eSMatthias Fuchs
17900133502eSMatthias Fuchs		Enables FPGA subsystem.
17910133502eSMatthias Fuchs
17920133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
17930133502eSMatthias Fuchs
17940133502eSMatthias Fuchs		Enables support for specific chip vendors.
17950133502eSMatthias Fuchs		(ALTERA, XILINX)
17960133502eSMatthias Fuchs
17970133502eSMatthias Fuchs		CONFIG_FPGA_<family>
17980133502eSMatthias Fuchs
17990133502eSMatthias Fuchs		Enables support for FPGA family.
18000133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
18010133502eSMatthias Fuchs
18020133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1803c609719bSwdenk
1804c609719bSwdenk		Specify the number of FPGA devices to support.
1805c609719bSwdenk
18066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1807c609719bSwdenk
1808c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1809c609719bSwdenk
18106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1811c609719bSwdenk
1812c609719bSwdenk		Enable checks on FPGA configuration interface busy
1813c609719bSwdenk		status by the configuration function. This option
1814c609719bSwdenk		will require a board or device specific function to
1815c609719bSwdenk		be written.
1816c609719bSwdenk
1817c609719bSwdenk		CONFIG_FPGA_DELAY
1818c609719bSwdenk
1819c609719bSwdenk		If defined, a function that provides delays in the FPGA
1820c609719bSwdenk		configuration driver.
1821c609719bSwdenk
18226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1823c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1824c609719bSwdenk
18256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1826c609719bSwdenk
1827c609719bSwdenk		Check for configuration errors during FPGA bitfile
1828c609719bSwdenk		loading. For example, abort during Virtex II
1829c609719bSwdenk		configuration if the INIT_B line goes low (which
1830c609719bSwdenk		indicated a CRC error).
1831c609719bSwdenk
18326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1833c609719bSwdenk
1834c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1835c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1836c609719bSwdenk		FPGA configuration sequence. The default time is 500
183711ccc33fSMarcel Ziswiler		ms.
1838c609719bSwdenk
18396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1840c609719bSwdenk
1841c609719bSwdenk		Maximum time to wait for BUSY to deassert during
184211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1843c609719bSwdenk
18446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1845c609719bSwdenk
1846c609719bSwdenk		Time to wait after FPGA configuration. The default is
184711ccc33fSMarcel Ziswiler		200 ms.
1848c609719bSwdenk
1849c609719bSwdenk- Configuration Management:
1850c609719bSwdenk		CONFIG_IDENT_STRING
1851c609719bSwdenk
1852c609719bSwdenk		If defined, this string will be added to the U-Boot
1853c609719bSwdenk		version information (U_BOOT_VERSION)
1854c609719bSwdenk
1855c609719bSwdenk- Vendor Parameter Protection:
1856c609719bSwdenk
1857c609719bSwdenk		U-Boot considers the values of the environment
1858c609719bSwdenk		variables "serial#" (Board Serial Number) and
18597152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1860c609719bSwdenk		are set once by the board vendor / manufacturer, and
1861c609719bSwdenk		protects these variables from casual modification by
1862c609719bSwdenk		the user. Once set, these variables are read-only,
1863c609719bSwdenk		and write or delete attempts are rejected. You can
186411ccc33fSMarcel Ziswiler		change this behaviour:
1865c609719bSwdenk
1866c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1867c609719bSwdenk		file, the write protection for vendor parameters is
186847cd00faSwdenk		completely disabled. Anybody can change or delete
1869c609719bSwdenk		these parameters.
1870c609719bSwdenk
1871c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1872c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
187311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1874c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1875c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1876c609719bSwdenk		read-only.]
1877c609719bSwdenk
1878c609719bSwdenk- Protected RAM:
1879c609719bSwdenk		CONFIG_PRAM
1880c609719bSwdenk
1881c609719bSwdenk		Define this variable to enable the reservation of
1882c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1883c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1884c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1885c609719bSwdenk		this default value by defining an environment
1886c609719bSwdenk		variable "pram" to the number of kB you want to
1887c609719bSwdenk		reserve. Note that the board info structure will
1888c609719bSwdenk		still show the full amount of RAM. If pRAM is
1889c609719bSwdenk		reserved, a new environment variable "mem" will
1890c609719bSwdenk		automatically be defined to hold the amount of
1891c609719bSwdenk		remaining RAM in a form that can be passed as boot
1892c609719bSwdenk		argument to Linux, for instance like that:
1893c609719bSwdenk
1894fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1895c609719bSwdenk			saveenv
1896c609719bSwdenk
1897c609719bSwdenk		This way you can tell Linux not to use this memory,
1898c609719bSwdenk		either, which results in a memory region that will
1899c609719bSwdenk		not be affected by reboots.
1900c609719bSwdenk
1901c609719bSwdenk		*WARNING* If your board configuration uses automatic
1902c609719bSwdenk		detection of the RAM size, you must make sure that
1903c609719bSwdenk		this memory test is non-destructive. So far, the
1904c609719bSwdenk		following board configurations are known to be
1905c609719bSwdenk		"pRAM-clean":
1906c609719bSwdenk
1907c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1908c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1909544d97e9SWolfgang Denk			FLAGADM, TQM8260
1910c609719bSwdenk
1911c609719bSwdenk- Error Recovery:
1912c609719bSwdenk		CONFIG_PANIC_HANG
1913c609719bSwdenk
1914c609719bSwdenk		Define this variable to stop the system in case of a
1915c609719bSwdenk		fatal error, so that you have to reset it manually.
1916c609719bSwdenk		This is probably NOT a good idea for an embedded
191711ccc33fSMarcel Ziswiler		system where you want the system to reboot
1918c609719bSwdenk		automatically as fast as possible, but it may be
1919c609719bSwdenk		useful during development since you can try to debug
1920c609719bSwdenk		the conditions that lead to the situation.
1921c609719bSwdenk
1922c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1923c609719bSwdenk
1924c609719bSwdenk		This variable defines the number of retries for
1925c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1926c609719bSwdenk		before giving up the operation. If not defined, a
1927c609719bSwdenk		default value of 5 is used.
1928c609719bSwdenk
192940cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
193040cb90eeSGuennadi Liakhovetski
193140cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
193240cb90eeSGuennadi Liakhovetski
1933c609719bSwdenk- Command Interpreter:
19348078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
193504a85b3bSwdenk
193604a85b3bSwdenk		Enable auto completion of commands using TAB.
193704a85b3bSwdenk
19388078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
19398078f1a5SWolfgang Denk		for the "hush" shell.
19408078f1a5SWolfgang Denk
19418078f1a5SWolfgang Denk
19426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1943c609719bSwdenk
1944c609719bSwdenk		Define this variable to enable the "hush" shell (from
1945c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1946c609719bSwdenk		powerful command line syntax like
1947c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1948c609719bSwdenk		constructs ("shell scripts").
1949c609719bSwdenk
1950c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1951c609719bSwdenk		with a somewhat smaller memory footprint.
1952c609719bSwdenk
1953c609719bSwdenk
19546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1955c609719bSwdenk
1956c609719bSwdenk		This defines the secondary prompt string, which is
1957c609719bSwdenk		printed when the command interpreter needs more input
1958c609719bSwdenk		to complete a command. Usually "> ".
1959c609719bSwdenk
1960c609719bSwdenk	Note:
1961c609719bSwdenk
1962c609719bSwdenk		In the current implementation, the local variables
1963c609719bSwdenk		space and global environment variables space are
1964c609719bSwdenk		separated. Local variables are those you define by
19653b57fe0aSwdenk		simply typing `name=value'. To access a local
1966c609719bSwdenk		variable later on, you have write `$name' or
19673b57fe0aSwdenk		`${name}'; to execute the contents of a variable
19683b57fe0aSwdenk		directly type `$name' at the command prompt.
1969c609719bSwdenk
1970c609719bSwdenk		Global environment variables are those you use
1971c609719bSwdenk		setenv/printenv to work with. To run a command stored
1972c609719bSwdenk		in such a variable, you need to use the run command,
1973c609719bSwdenk		and you must not use the '$' sign to access them.
1974c609719bSwdenk
1975c609719bSwdenk		To store commands and special characters in a
1976c609719bSwdenk		variable, please use double quotation marks
1977c609719bSwdenk		surrounding the whole text of the variable, instead
1978c609719bSwdenk		of the backslashes before semicolons and special
1979c609719bSwdenk		symbols.
1980c609719bSwdenk
1981aa0c71acSWolfgang Denk- Commandline Editing and History:
1982aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1983aa0c71acSWolfgang Denk
198411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1985aa0c71acSWolfgang Denk		commandline input operations
1986aa0c71acSWolfgang Denk
1987a8c7c708Swdenk- Default Environment:
1988c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1989c609719bSwdenk
1990c609719bSwdenk		Define this to contain any number of null terminated
1991c609719bSwdenk		strings (variable = value pairs) that will be part of
19927152b1d0Swdenk		the default environment compiled into the boot image.
19932262cfeeSwdenk
1994c609719bSwdenk		For example, place something like this in your
1995c609719bSwdenk		board's config file:
1996c609719bSwdenk
1997c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1998c609719bSwdenk			"myvar1=value1\0" \
1999c609719bSwdenk			"myvar2=value2\0"
2000c609719bSwdenk
2001c609719bSwdenk		Warning: This method is based on knowledge about the
2002c609719bSwdenk		internal format how the environment is stored by the
20032262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2004c609719bSwdenk		interface! Although it is unlikely that this format
20057152b1d0Swdenk		will change soon, there is no guarantee either.
2006c609719bSwdenk		You better know what you are doing here.
2007c609719bSwdenk
2008c609719bSwdenk		Note: overly (ab)use of the default environment is
2009c609719bSwdenk		discouraged. Make sure to check other ways to preset
201074de7aefSWolfgang Denk		the environment like the "source" command or the
2011c609719bSwdenk		boot command first.
2012c609719bSwdenk
2013a8c7c708Swdenk- DataFlash Support:
20142abbe075Swdenk		CONFIG_HAS_DATAFLASH
20152abbe075Swdenk
20162abbe075Swdenk		Defining this option enables DataFlash features and
20172abbe075Swdenk		allows to read/write in Dataflash via the standard
20182abbe075Swdenk		commands cp, md...
20192abbe075Swdenk
20203f85ce27Swdenk- SystemACE Support:
20213f85ce27Swdenk		CONFIG_SYSTEMACE
20223f85ce27Swdenk
20233f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
20243f85ce27Swdenk		chips attached via some sort of local bus. The address
202511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
20266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
20273f85ce27Swdenk
20283f85ce27Swdenk		#define CONFIG_SYSTEMACE
20296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
20303f85ce27Swdenk
20313f85ce27Swdenk		When SystemACE support is added, the "ace" device type
20323f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
20333f85ce27Swdenk
2034ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2035ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2036ecb0ccd9SWolfgang Denk
203728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2038ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
203928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2040ecb0ccd9SWolfgang Denk		number generator is used.
2041ecb0ccd9SWolfgang Denk
204228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
204328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
204428cb9375SWolfgang Denk		defined, the normal port 69 is used.
204528cb9375SWolfgang Denk
204628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2047ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2048ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2049ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2050ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2051ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2052ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2053ecb0ccd9SWolfgang Denk
2054a8c7c708Swdenk- Show boot progress:
2055c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2056c609719bSwdenk
2057c609719bSwdenk		Defining this option allows to add some board-
2058c609719bSwdenk		specific code (calling a user-provided function
2059c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2060c609719bSwdenk		the system's boot progress on some display (for
2061c609719bSwdenk		example, some LED's) on your board. At the moment,
2062c609719bSwdenk		the following checkpoints are implemented:
2063c609719bSwdenk
20648ae86b76SWolfgang Denk- Standalone program support:
20658ae86b76SWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
20668ae86b76SWolfgang Denk
20678ae86b76SWolfgang Denk		This option allows to define board specific values
20688ae86b76SWolfgang Denk		for the address where standalone program gets loaded,
20698ae86b76SWolfgang Denk		thus overwriting the architecutre dependent default
20708ae86b76SWolfgang Denk		settings.
20718ae86b76SWolfgang Denk
2072d32a1a4cSMinkyu Kang- Frame Buffer Address:
2073d32a1a4cSMinkyu Kang	CONFIG_FB_ADDR
2074d32a1a4cSMinkyu Kang
2075d32a1a4cSMinkyu Kang	Define CONFIG_FB_ADDR if you want to use specific address for
2076d32a1a4cSMinkyu Kang	frame buffer.
2077d32a1a4cSMinkyu Kang	Then system will reserve the frame buffer address to defined address
2078d32a1a4cSMinkyu Kang	instead of lcd_setmem (this function grab the memory for frame buffer
2079d32a1a4cSMinkyu Kang	by panel's size).
2080d32a1a4cSMinkyu Kang
2081d32a1a4cSMinkyu Kang	Please see board_init_f function.
2082d32a1a4cSMinkyu Kang
2083d32a1a4cSMinkyu Kang	If you want this config option then,
2084d32a1a4cSMinkyu Kang	please define it at your board config file
2085d32a1a4cSMinkyu Kang
20861372cce2SMarian BalakowiczLegacy uImage format:
20871372cce2SMarian Balakowicz
2088c609719bSwdenk  Arg	Where			When
2089c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2090c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2091c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2092c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2093c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2094c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2095c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2096c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2097c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
20981372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2099c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2100c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2101c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2102c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
21031372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2104c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
21051372cce2SMarian Balakowicz
21061372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
21071372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
21081372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
21091372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
21101372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
21111372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
21121372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
211311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
21141372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
21151372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
21161372cce2SMarian Balakowicz
2117ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2118c609719bSwdenk
2119a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
212063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
212163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
212263e73c9aSwdenk
2123566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2124566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2125566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2126566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2127566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2128566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2129566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2130566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2131566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2132566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2133566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2134566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2135566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2136566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2137566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2138566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2139566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2140566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2141566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2142566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2143566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2144566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2145566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2146566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2147566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2148566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2149566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2150566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2151566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2152566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2153566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2154566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2155566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2156566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2157566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2158566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2159566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2160566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2161566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2162566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2163566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2164566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2165566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2166566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2167566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2168566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2169566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2170c609719bSwdenk
2171566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2172c609719bSwdenk
2173566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2174566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2175566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2176206c60cbSwdenk
2177566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2178566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
217911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2180566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2181566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2182566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
218374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
218474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2185566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2186c609719bSwdenk
21871372cce2SMarian BalakowiczFIT uImage format:
21881372cce2SMarian Balakowicz
21891372cce2SMarian Balakowicz  Arg	Where			When
21901372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
21911372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
21921372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
21931372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
21941372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
21951372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2196f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
21971372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
21981372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
21991372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
22001372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
22011372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
220211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
220311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
22041372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
22051372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
22061372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
22071372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
22081372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
22091372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
22101372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
22111372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
22121372cce2SMarian Balakowicz
22131372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
22141372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
22151372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
221611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
22171372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
22181372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
22191372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
22201372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
22211372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
22221372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
22231372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
22241372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
22251372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
22261372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
22271372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
22281372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
22291372cce2SMarian Balakowicz
223011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
22311372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
22321372cce2SMarian Balakowicz
223311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
22341372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
22351372cce2SMarian Balakowicz
223611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
22371372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
22381372cce2SMarian Balakowicz
2239cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2240cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2241cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2242cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2243cccfc2abSDetlev Zundel
2244cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2245cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2246cccfc2abSDetlev Zundel
2247cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2248cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2249cccfc2abSDetlev Zundel
2250cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2251cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2252cccfc2abSDetlev Zundel
2253cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2254cccfc2abSDetlev Zundel
2255cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2256cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2257cccfc2abSDetlev Zundel
22586a11cf48SDaniel Schwierzeck- SPL framework
22596a11cf48SDaniel Schwierzeck                CONFIG_SPL
22606a11cf48SDaniel Schwierzeck                Enable building of SPL globally.
22616a11cf48SDaniel Schwierzeck
22626a11cf48SDaniel Schwierzeck                CONFIG_SPL_TEXT_BASE
22636a11cf48SDaniel Schwierzeck                TEXT_BASE for linking the SPL binary.
22646a11cf48SDaniel Schwierzeck
22656a11cf48SDaniel Schwierzeck                CONFIG_SPL_LDSCRIPT
22666a11cf48SDaniel Schwierzeck                LDSCRIPT for linking the SPL binary.
22676a11cf48SDaniel Schwierzeck
22686a11cf48SDaniel Schwierzeck                CONFIG_SPL_LIBCOMMON_SUPPORT
22696a11cf48SDaniel Schwierzeck                Support for common/libcommon.o in SPL binary
22706a11cf48SDaniel Schwierzeck
22716a11cf48SDaniel Schwierzeck                CONFIG_SPL_LIBDISK_SUPPORT
22726a11cf48SDaniel Schwierzeck                Support for disk/libdisk.o in SPL binary
22736a11cf48SDaniel Schwierzeck
22746a11cf48SDaniel Schwierzeck                CONFIG_SPL_I2C_SUPPORT
22756a11cf48SDaniel Schwierzeck                Support for drivers/i2c/libi2c.o in SPL binary
22766a11cf48SDaniel Schwierzeck
22776a11cf48SDaniel Schwierzeck                CONFIG_SPL_GPIO_SUPPORT
22786a11cf48SDaniel Schwierzeck                Support for drivers/gpio/libgpio.o in SPL binary
22796a11cf48SDaniel Schwierzeck
22806a11cf48SDaniel Schwierzeck                CONFIG_SPL_MMC_SUPPORT
22816a11cf48SDaniel Schwierzeck                Support for drivers/mmc/libmmc.o in SPL binary
22826a11cf48SDaniel Schwierzeck
22836a11cf48SDaniel Schwierzeck                CONFIG_SPL_SERIAL_SUPPORT
22846a11cf48SDaniel Schwierzeck                Support for drivers/serial/libserial.o in SPL binary
22856a11cf48SDaniel Schwierzeck
22866a11cf48SDaniel Schwierzeck                CONFIG_SPL_SPI_FLASH_SUPPORT
22876a11cf48SDaniel Schwierzeck                Support for drivers/mtd/spi/libspi_flash.o in SPL binary
22886a11cf48SDaniel Schwierzeck
22896a11cf48SDaniel Schwierzeck                CONFIG_SPL_SPI_SUPPORT
22906a11cf48SDaniel Schwierzeck                Support for drivers/spi/libspi.o in SPL binary
22916a11cf48SDaniel Schwierzeck
22926a11cf48SDaniel Schwierzeck                CONFIG_SPL_FAT_SUPPORT
22936a11cf48SDaniel Schwierzeck                Support for fs/fat/libfat.o in SPL binary
22946a11cf48SDaniel Schwierzeck
22956a11cf48SDaniel Schwierzeck                CONFIG_SPL_LIBGENERIC_SUPPORT
22966a11cf48SDaniel Schwierzeck                Support for lib/libgeneric.o in SPL binary
22971372cce2SMarian Balakowicz
2298c609719bSwdenkModem Support:
2299c609719bSwdenk--------------
2300c609719bSwdenk
2301566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2302c609719bSwdenk
230311ccc33fSMarcel Ziswiler- Modem support enable:
2304c609719bSwdenk		CONFIG_MODEM_SUPPORT
2305c609719bSwdenk
2306c609719bSwdenk- RTS/CTS Flow control enable:
2307c609719bSwdenk		CONFIG_HWFLOW
2308c609719bSwdenk
2309c609719bSwdenk- Modem debug support:
2310c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2311c609719bSwdenk
2312c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2313c609719bSwdenk		for modem support. Useful only with BDI2000.
2314c609719bSwdenk
2315a8c7c708Swdenk- Interrupt support (PPC):
2316a8c7c708Swdenk
2317a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2318a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
231911ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2320a8c7c708Swdenk		should set decrementer_count to appropriate value. If
232111ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2322a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
232311ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2324a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2325a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2326a8c7c708Swdenk		general timer_interrupt().
2327a8c7c708Swdenk
2328c609719bSwdenk- General:
2329c609719bSwdenk
2330c609719bSwdenk		In the target system modem support is enabled when a
2331c609719bSwdenk		specific key (key combination) is pressed during
2332c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
233311ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2334c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2335c609719bSwdenk		function, returning 1 and thus enabling modem
2336c609719bSwdenk		initialization.
2337c609719bSwdenk
2338c609719bSwdenk		If there are no modem init strings in the
2339c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2340c609719bSwdenk		previous output (banner, info printfs) will be
234111ccc33fSMarcel Ziswiler		suppressed, though.
2342c609719bSwdenk
2343c609719bSwdenk		See also: doc/README.Modem
2344c609719bSwdenk
2345c609719bSwdenk
2346c609719bSwdenkConfiguration Settings:
2347c609719bSwdenk-----------------------
2348c609719bSwdenk
23496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2350c609719bSwdenk		undefine this when you're short of memory.
2351c609719bSwdenk
23522fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
23532fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
23542fb2604dSPeter Tyser
23556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2356c609719bSwdenk		prompt for user input.
2357c609719bSwdenk
23586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2359c609719bSwdenk
23606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2361c609719bSwdenk
23626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2363c609719bSwdenk
23646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2365c609719bSwdenk		the application (usually a Linux kernel) when it is
2366c609719bSwdenk		booted
2367c609719bSwdenk
23686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2369c609719bSwdenk		List of legal baudrate settings for this board.
2370c609719bSwdenk
23716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2372c609719bSwdenk		Suppress display of console information at boot.
2373c609719bSwdenk
23746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2375c609719bSwdenk		If the board specific function
2376c609719bSwdenk			extern int overwrite_console (void);
2377c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2378c609719bSwdenk		serial port, else the settings in the environment are used.
2379c609719bSwdenk
23806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2381c609719bSwdenk		Enable the call to overwrite_console().
2382c609719bSwdenk
23836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2384c609719bSwdenk		Enable overwrite of previous console environment settings.
2385c609719bSwdenk
23866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2387c609719bSwdenk		Begin and End addresses of the area used by the
2388c609719bSwdenk		simple memory test.
2389c609719bSwdenk
23906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2391c609719bSwdenk		Enable an alternate, more extensive memory test.
2392c609719bSwdenk
23936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
23945f535fe1Swdenk		Scratch address used by the alternate memory test
23955f535fe1Swdenk		You only need to set this if address zero isn't writeable
23965f535fe1Swdenk
23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
23986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
239914f73ca6SStefan Roese		this specified memory area will get subtracted from the top
240011ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
240114f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
240214f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
240314f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
24045e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
240514f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
24065e12e75dSStefan Roese		will have to get fixed in Linux additionally.
240714f73ca6SStefan Roese
240814f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
240914f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
241014f73ca6SStefan Roese		be touched.
241114f73ca6SStefan Roese
241214f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
241314f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
241414f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
241514f73ca6SStefan Roese		non page size aligned address and this could cause major
241614f73ca6SStefan Roese		problems.
241714f73ca6SStefan Roese
24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2419c609719bSwdenk		Default load address for network file downloads
2420c609719bSwdenk
24216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2422c609719bSwdenk		Enable temporary baudrate change while serial download
2423c609719bSwdenk
24246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2425c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2426c609719bSwdenk
24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2428c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2429c609719bSwdenk		Cogent motherboard)
2430c609719bSwdenk
24316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2432c609719bSwdenk		Physical start address of Flash memory.
2433c609719bSwdenk
24346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2435c609719bSwdenk		Physical start address of boot monitor code (set by
2436c609719bSwdenk		make config files to be same as the text base address
243714d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
24386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2439c609719bSwdenk
24406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
24413b57fe0aSwdenk		Size of memory reserved for monitor code, used to
24423b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
24433b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
24443b57fe0aSwdenk		flash sector.
2445c609719bSwdenk
24466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2447c609719bSwdenk		Size of DRAM reserved for malloc() use.
2448c609719bSwdenk
24496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
245015940c9aSStefan Roese		Normally compressed uImages are limited to an
245115940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
24526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
245315940c9aSStefan Roese		to adjust this setting to your needs.
2454c609719bSwdenk
24556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2456c609719bSwdenk		Maximum size of memory mapped by the startup code of
2457c609719bSwdenk		the Linux kernel; all data that must be processed by
24587d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
24597d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
24607d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
24617d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2462c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2463c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2464c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2465c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2466c609719bSwdenk
2467fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2468fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2469fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2470fca43cc8SJohn Rigby		is enabled.
2471fca43cc8SJohn Rigby
2472fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2473fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2474fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2475fca43cc8SJohn Rigby
2476fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2477fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2478fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2479fca43cc8SJohn Rigby
24806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2481c609719bSwdenk		Max number of Flash memory banks
2482c609719bSwdenk
24836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2484c609719bSwdenk		Max number of sectors on a Flash chip
2485c609719bSwdenk
24866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2487c609719bSwdenk		Timeout for Flash erase operations (in ms)
2488c609719bSwdenk
24896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2490c609719bSwdenk		Timeout for Flash write operations (in ms)
2491c609719bSwdenk
24926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
24938564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
24948564acf9Swdenk
24956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
24968564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
24978564acf9Swdenk
24986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
24998564acf9Swdenk		If defined, hardware flash sectors protection is used
25008564acf9Swdenk		instead of U-Boot software protection.
25018564acf9Swdenk
25026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2503c609719bSwdenk
2504c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2505c609719bSwdenk		without this option such a download has to be
2506c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2507c609719bSwdenk		copy from RAM to flash.
2508c609719bSwdenk
2509c609719bSwdenk		The two-step approach is usually more reliable, since
2510c609719bSwdenk		you can check if the download worked before you erase
251111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
251211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2513c609719bSwdenk		downloaded image) this option may be very useful.
2514c609719bSwdenk
25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2516c609719bSwdenk		Define if the flash driver uses extra elements in the
25175653fc33Swdenk		common flash structure for storing flash geometry.
25185653fc33Swdenk
251900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
25205653fc33Swdenk		This option also enables the building of the cfi_flash driver
25215653fc33Swdenk		in the drivers directory
252253cf9435Sstroese
252391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
252491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
252591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
252691809ed5SPiotr Ziecik		to the MTD layer.
252791809ed5SPiotr Ziecik
25286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
252996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
253096ef831fSGuennadi Liakhovetski
253196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
253296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
253396ef831fSGuennadi Liakhovetski		write commands.
253496ef831fSGuennadi Liakhovetski
25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
25365568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
25375568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
25385568e613SStefan Roese		is useful, if some of the configured banks are only
25395568e613SStefan Roese		optionally available.
25405568e613SStefan Roese
25419a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
25429a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
25439a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
25449a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
25459a042e9cSJerry Van Baren
25466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
254711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
254811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
254953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
255053cf9435Sstroese		buffers can be full shortly after enabling the interface
255111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
255253cf9435Sstroese		Defaults to 4 if not defined.
2553c609719bSwdenk
2554ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2555ea882bafSWolfgang Denk
2556ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2557ea882bafSWolfgang Denk	internally to store the environment settings. The default
2558ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2559ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2560ea882bafSWolfgang Denk	lib/hashtable.c for details.
2561ea882bafSWolfgang Denk
2562c609719bSwdenkThe following definitions that deal with the placement and management
2563c609719bSwdenkof environment data (variable area); in general, we support the
2564c609719bSwdenkfollowing configurations:
2565c609719bSwdenk
2566*c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2567*c3eb3fe4SMike Frysinger
2568*c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2569*c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2570*c3eb3fe4SMike Frysinger
25715a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2572c609719bSwdenk
2573c609719bSwdenk	Define this if the environment is in flash memory.
2574c609719bSwdenk
2575c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2576c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2577c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2578c609719bSwdenk	   sector" type flash chips, which have several smaller
2579c609719bSwdenk	   sectors at the start or the end. For instance, such a
2580c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2581c609719bSwdenk	   such a case you would place the environment in one of the
2582c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2583c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2584c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2585c609719bSwdenk	   between U-Boot and the environment.
2586c609719bSwdenk
25870e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2588c609719bSwdenk
2589c609719bSwdenk	   Offset of environment data (variable area) to the
2590c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2591c609719bSwdenk	   type flash chips the second sector can be used: the offset
2592c609719bSwdenk	   for this sector is given here.
2593c609719bSwdenk
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2595c609719bSwdenk
25960e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2597c609719bSwdenk
2598c609719bSwdenk	   This is just another way to specify the start address of
2599c609719bSwdenk	   the flash sector containing the environment (instead of
26000e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2601c609719bSwdenk
26020e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2603c609719bSwdenk
2604c609719bSwdenk	   Size of the sector containing the environment.
2605c609719bSwdenk
2606c609719bSwdenk
2607c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2608c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2609c609719bSwdenk	   the environment.
2610c609719bSwdenk
26110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2612c609719bSwdenk
26135a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
26140e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2615c609719bSwdenk	   of this flash sector for the environment. This saves
2616c609719bSwdenk	   memory for the RAM copy of the environment.
2617c609719bSwdenk
2618c609719bSwdenk	   It may also save flash memory if you decide to use this
2619c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2620c609719bSwdenk	   since then the remainder of the flash sector could be used
2621c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2622c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2623c609719bSwdenk	   updating the environment in flash makes it always
2624c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2625c609719bSwdenk	   wrong before the contents has been restored from a copy in
2626c609719bSwdenk	   RAM, your target system will be dead.
2627c609719bSwdenk
26280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
26290e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2630c609719bSwdenk
2631c609719bSwdenk	   These settings describe a second storage area used to hold
263211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
26333e38691eSwdenk	   a valid backup copy in case there is a power failure during
2634c609719bSwdenk	   a "saveenv" operation.
2635c609719bSwdenk
2636c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2637c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2638c609719bSwdenkaccordingly!
2639c609719bSwdenk
2640c609719bSwdenk
26419314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2642c609719bSwdenk
2643c609719bSwdenk	Define this if you have some non-volatile memory device
2644c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2645c609719bSwdenk	environment.
2646c609719bSwdenk
26470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
26480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2649c609719bSwdenk
265011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2651c609719bSwdenk	  want to use for environment. It is assumed that this memory
2652c609719bSwdenk	  can just be read and written to, without any special
2653c609719bSwdenk	  provision.
2654c609719bSwdenk
2655c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2656c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
265711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2658c609719bSwdenkU-Boot will hang.
2659c609719bSwdenk
2660c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2661c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2662c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2663c609719bSwdenkto save the current settings.
2664c609719bSwdenk
2665c609719bSwdenk
2666bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2667c609719bSwdenk
2668c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2669c609719bSwdenk	device and a driver for it.
2670c609719bSwdenk
26710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
26720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2673c609719bSwdenk
2674c609719bSwdenk	  These two #defines specify the offset and size of the
2675c609719bSwdenk	  environment area within the total memory of your EEPROM.
2676c609719bSwdenk
26776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2678c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2679c609719bSwdenk	  The default address is zero.
2680c609719bSwdenk
26816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2682c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2683c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2684c609719bSwdenk	  would require six bits.
2685c609719bSwdenk
26866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2687c609719bSwdenk	  If defined, the number of milliseconds to delay between
2688c609719bSwdenk	  page writes.	The default is zero milliseconds.
2689c609719bSwdenk
26906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2691c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2692c609719bSwdenk	  that this is NOT the chip address length!
2693c609719bSwdenk
26946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
26955cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
26965cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
26975cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
26985cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
26995cf91d6bSwdenk	  byte chips.
27005cf91d6bSwdenk
27015cf91d6bSwdenk	  Note that we consider the length of the address field to
27025cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
27035cf91d6bSwdenk	  in the chip address.
27045cf91d6bSwdenk
27056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2706c609719bSwdenk	  The size in bytes of the EEPROM device.
2707c609719bSwdenk
2708548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2709548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2710548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2711548738b4SHeiko Schocher
2712548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2713548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2714548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2715548738b4SHeiko Schocher	  EEPROM. For example:
2716548738b4SHeiko Schocher
2717548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2718548738b4SHeiko Schocher
2719548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2720548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2721c609719bSwdenk
2722057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
27235779d8d9Swdenk
27245779d8d9Swdenk	Define this if you have a DataFlash memory device which you
27255779d8d9Swdenk	want to use for the environment.
27265779d8d9Swdenk
27270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
27290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
27305779d8d9Swdenk
27315779d8d9Swdenk	  These three #defines specify the offset and size of the
27325779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
27335779d8d9Swdenk	  at the specified address.
27345779d8d9Swdenk
273551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
273613a5695bSwdenk
273713a5695bSwdenk	Define this if you have a NAND device which you want to use
273813a5695bSwdenk	for the environment.
273913a5695bSwdenk
27400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27410e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
274213a5695bSwdenk
274313a5695bSwdenk	  These two #defines specify the offset and size of the environment
2744fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2745fdd813deSScott Wood	  aligned to an erase block boundary.
27465779d8d9Swdenk
2747fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2748e443c944SMarkus Klotzbuecher
27490e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2750fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2751fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2752fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2753fdd813deSScott Wood	  aligned to an erase block boundary.
2754e443c944SMarkus Klotzbuecher
2755fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2756fdd813deSScott Wood
2757fdd813deSScott Wood	  Specifies the length of the region in which the environment
2758fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2759fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2760fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2761fdd813deSScott Wood	  the range to be avoided.
2762fdd813deSScott Wood
2763fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2764fdd813deSScott Wood
2765fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2766fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2767fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2768fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2769fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2770e443c944SMarkus Klotzbuecher
2771b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2772b74ab737SGuennadi Liakhovetski
2773b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2774b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2775b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2776b74ab737SGuennadi Liakhovetski
27776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2778c609719bSwdenk
2779c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2780c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2781c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2782c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2783c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2784c609719bSwdenk	to be a good choice since it makes it far enough from the
2785c609719bSwdenk	start of the data area as well as from the stack pointer.
2786c609719bSwdenk
2787e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2788c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2789cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2790c609719bSwdenkuntil then to read environment variables.
2791c609719bSwdenk
279285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
279385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
279485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
279585ec0bccSwdenknecessary, because the first environment variable we need is the
279685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
279785ec0bccSwdenkhave any device yet where we could complain.]
2798c609719bSwdenk
2799c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2800c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
280185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2802c609719bSwdenk
28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2804fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2805fc3e2165Swdenk
28066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2807fc3e2165Swdenk		      also needs to be defined.
2808fc3e2165Swdenk
28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2810fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2811c609719bSwdenk
2812f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2813f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2814f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2815f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2816f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2817f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2818f5675aa5SRon Madrid
2819c609719bSwdenkLow Level (hardware related) configuration options:
2820dc7c9a1aSwdenk---------------------------------------------------
2821c609719bSwdenk
28226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2823c609719bSwdenk		Cache Line Size of the CPU.
2824c609719bSwdenk
28256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2826c609719bSwdenk		Default address of the IMMR after system reset.
28272535d602Swdenk
28282535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
28292535d602Swdenk		and RPXsuper) to be able to adjust the position of
28302535d602Swdenk		the IMMR register after a reset.
2831c609719bSwdenk
28327f6c2cbcSwdenk- Floppy Disk Support:
28336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
28347f6c2cbcSwdenk
28357f6c2cbcSwdenk		the default drive number (default value 0)
28367f6c2cbcSwdenk
28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
28387f6c2cbcSwdenk
283911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
28407f6c2cbcSwdenk		(default value 1)
28417f6c2cbcSwdenk
28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
28437f6c2cbcSwdenk
28447f6c2cbcSwdenk		defines the offset of register from address. It
28457f6c2cbcSwdenk		depends on which part of the data bus is connected to
284611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
28477f6c2cbcSwdenk
28486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
28496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
28507f6c2cbcSwdenk		default value.
28517f6c2cbcSwdenk
28526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
28537f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
28547f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
28557f6c2cbcSwdenk		source code. It is used to make hardware dependant
28567f6c2cbcSwdenk		initializations.
28577f6c2cbcSwdenk
28580abddf82SMacpaul Lin- CONFIG_IDE_AHB:
28590abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
28600abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
28610abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
28620abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
28630abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
28640abddf82SMacpaul Lin		is requierd.
28650abddf82SMacpaul Lin
28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
286725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
286825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2869c609719bSwdenk
28706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2871c609719bSwdenk
28727152b1d0Swdenk		Start address of memory area that can be used for
2873c609719bSwdenk		initial data and stack; please note that this must be
2874c609719bSwdenk		writable memory that is working WITHOUT special
2875c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2876c609719bSwdenk		will become available only after programming the
2877c609719bSwdenk		memory controller and running certain initialization
2878c609719bSwdenk		sequences.
2879c609719bSwdenk
2880c609719bSwdenk		U-Boot uses the following memory types:
2881c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2882c609719bSwdenk		- MPC824X: data cache
2883c609719bSwdenk		- PPC4xx:  data cache
2884c609719bSwdenk
28856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2886c609719bSwdenk
2887c609719bSwdenk		Offset of the initial data structure in the memory
28886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
28896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2890c609719bSwdenk		data is located at the end of the available space
2891553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
28926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
28936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
28946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2895c609719bSwdenk
2896c609719bSwdenk	Note:
2897c609719bSwdenk		On the MPC824X (or other systems that use the data
2898c609719bSwdenk		cache for initial memory) the address chosen for
28996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2900c609719bSwdenk		point to an otherwise UNUSED address space between
2901c609719bSwdenk		the top of RAM and the start of the PCI space.
2902c609719bSwdenk
29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2904c609719bSwdenk
29056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2906c609719bSwdenk
29076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2908c609719bSwdenk
29096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2910c609719bSwdenk
29116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2912c609719bSwdenk
29136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2914c609719bSwdenk
29156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2916c609719bSwdenk		SDRAM timing
2917c609719bSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2919c609719bSwdenk		periodic timer for refresh
2920c609719bSwdenk
29216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2922c609719bSwdenk
29236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
29246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
29256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
29266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2927c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2928c609719bSwdenk
2929c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
29316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2932c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2933c609719bSwdenk
29346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
29356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2936c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2937c609719bSwdenk		Prescaler definitions (SDRAM timing)
2938c609719bSwdenk
29396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2940c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2941c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2942c609719bSwdenk
29436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2944b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2945b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2946b423d055SHeiko Schocher
29476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2948c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2949c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2950c609719bSwdenk
29516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2952c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2953c609719bSwdenk		wrong setting might damage your board. Read
2954c609719bSwdenk		doc/README.MBX before setting this variable!
2955c609719bSwdenk
29566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2957ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2958ea909b76Swdenk		(Power On Self Tests). This definition overrides
2959ea909b76Swdenk		#define'd default value in commproc.h resp.
2960ea909b76Swdenk		cpm_8260.h.
2961ea909b76Swdenk
29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
29636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
29646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
29656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
29666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
29676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
29686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
29696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
2970a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
29715d232d0eSwdenk
29729cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
29739cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
29749cacf4fcSDirk Eibach		required.
29759cacf4fcSDirk Eibach
2976a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
2977a09b9b68SKumar Gala		Chip has SRIO or not
2978a09b9b68SKumar Gala
2979a09b9b68SKumar Gala- CONFIG_SRIO1:
2980a09b9b68SKumar Gala		Board has SRIO 1 port available
2981a09b9b68SKumar Gala
2982a09b9b68SKumar Gala- CONFIG_SRIO2:
2983a09b9b68SKumar Gala		Board has SRIO 2 port available
2984a09b9b68SKumar Gala
2985a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
2986a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
2987a09b9b68SKumar Gala
2988a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
2989a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
2990a09b9b68SKumar Gala
2991a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
2992a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
2993a09b9b68SKumar Gala
2994eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
2995eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
2996eced4626SAlex Waterman		16 bit bus.
2997eced4626SAlex Waterman
2998eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
2999eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3000eced4626SAlex Waterman		a default value will be used.
3001eced4626SAlex Waterman
3002bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3003218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3004218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3005218ca724SWolfgang Denk
3006bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3007bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3008bb99ad6dSBen Warren
30096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3010218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3011218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3012218ca724SWolfgang Denk		to something your driver can deal with.
3013bb99ad6dSBen Warren
30141b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
30151b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
30161b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
30171b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
30181b3e3c4fSYork Sun		header files or board specific files.
30191b3e3c4fSYork Sun
30206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3021218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3022218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
30232ad6b513STimur Tabi
3024c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3025c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3026c26e454dSwdenk
3027c26e454dSwdenk- CONFIG_FEC[12]_PHY
3028c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
30296e592385Swdenk		to the given FEC; i. e.
3030c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3031c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3032c26e454dSwdenk
3033c26e454dSwdenk		When set to -1, means to probe for first available.
3034c26e454dSwdenk
3035c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3036c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3037c26e454dSwdenk		(so program the FEC to ignore it).
3038c26e454dSwdenk
3039c26e454dSwdenk- CONFIG_RMII
3040c26e454dSwdenk		Enable RMII mode for all FECs.
3041c26e454dSwdenk		Note that this is a global option, we can't
3042c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3043c26e454dSwdenk
30445cf91d6bSwdenk- CONFIG_CRC32_VERIFY
30455cf91d6bSwdenk		Add a verify option to the crc32 command.
30465cf91d6bSwdenk		The syntax is:
30475cf91d6bSwdenk
30485cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
30495cf91d6bSwdenk
30505cf91d6bSwdenk		Where address/count indicate a memory area
30515cf91d6bSwdenk		and crc32 is the correct crc32 which the
30525cf91d6bSwdenk		area should have.
30535cf91d6bSwdenk
305456523f12Swdenk- CONFIG_LOOPW
305556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3056602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
305756523f12Swdenk
30587b466641Sstroese- CONFIG_MX_CYCLIC
30597b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
30607b466641Sstroese		"md/mw" commands.
30617b466641Sstroese		Examples:
30627b466641Sstroese
30637b466641Sstroese		=> mdc.b 10 4 500
30647b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
30657b466641Sstroese
30667b466641Sstroese		=> mwc.l 100 12345678 10
30677b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
30687b466641Sstroese
30697b466641Sstroese		This only takes effect if the memory commands are activated
3070602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
30717b466641Sstroese
30728aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3073e03f3169SWolfgang Denk		[ARM only] If this variable is defined, then certain
3074e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3075e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3076e03f3169SWolfgang Denk		relocate itself into RAM.
30778aa1a2d1Swdenk
3078e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3079e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3080e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3081e03f3169SWolfgang Denk		these initializations itself.
30828aa1a2d1Swdenk
3083401bb30bSAneesh V- CONFIG_SPL_BUILD
3084df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3085df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3086df81238bSMagnus Lilja		compiling a NAND SPL.
3087400558b5Swdenk
3088d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3089d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3090d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3091d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3092d8834a13SMatthias Weisser		conditions but may increase the binary size.
3093d8834a13SMatthias Weisser
3094c609719bSwdenkBuilding the Software:
3095c609719bSwdenk======================
3096c609719bSwdenk
3097218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3098218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3099218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3100218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3101218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3102218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3103c609719bSwdenk
3104218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3105218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3106218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3107218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3108218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3109c609719bSwdenk
3110218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3111218ca724SWolfgang Denk	$ export CROSS_COMPILE
3112c609719bSwdenk
31132f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
31142f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
31152f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
31162f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
31172f8d396bSPeter Tyser
31182f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
31192f8d396bSPeter Tyser
31202f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
31212f8d396bSPeter Tyser      be executed on computers running Windows.
31222f8d396bSPeter Tyser
3123c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3124c609719bSwdenksources you must configure U-Boot for one specific board type. This
3125c609719bSwdenkis done by typing:
3126c609719bSwdenk
3127c609719bSwdenk	make NAME_config
3128c609719bSwdenk
3129218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3130218ca724SWolfgang Denkrations; see the main Makefile for supported names.
313154387ac9Swdenk
3132c609719bSwdenkNote: for some board special configuration names may exist; check if
3133c609719bSwdenk      additional information is available from the board vendor; for
31342729af9dSwdenk      instance, the TQM823L systems are available without (standard)
31352729af9dSwdenk      or with LCD support. You can select such additional "features"
313611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3137c609719bSwdenk
31382729af9dSwdenk      make TQM823L_config
31392729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3140c609719bSwdenk
3141c609719bSwdenk      make TQM823L_LCD_config
3142c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3143c609719bSwdenk
3144c609719bSwdenk      etc.
3145c609719bSwdenk
3146c609719bSwdenk
3147c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
31487152b1d0Swdenkimages ready for download to / installation on your system:
3149c609719bSwdenk
3150c609719bSwdenk- "u-boot.bin" is a raw binary image
3151c609719bSwdenk- "u-boot" is an image in ELF binary format
3152c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3153c609719bSwdenk
3154baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3155baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3156baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3157baf31249SMarian Balakowicz
3158baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3159baf31249SMarian Balakowicz
3160baf31249SMarian Balakowicz	make O=/tmp/build distclean
3161baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3162baf31249SMarian Balakowicz	make O=/tmp/build all
3163baf31249SMarian Balakowicz
3164baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3165baf31249SMarian Balakowicz
3166baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3167baf31249SMarian Balakowicz	make distclean
3168baf31249SMarian Balakowicz	make NAME_config
3169baf31249SMarian Balakowicz	make all
3170baf31249SMarian Balakowicz
3171baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3172baf31249SMarian Balakowiczvariable.
3173baf31249SMarian Balakowicz
3174c609719bSwdenk
3175c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3176c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3177c609719bSwdenknative "make".
3178c609719bSwdenk
3179c609719bSwdenk
3180c609719bSwdenkIf the system board that you have is not listed, then you will need
3181c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3182c609719bSwdenksteps:
3183c609719bSwdenk
3184c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
318585ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
318685ec0bccSwdenk    entries as examples. Note that here and at many other places
31877152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
318885ec0bccSwdenk    keep this order.
3189c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
319085ec0bccSwdenk    files you need. In your board directory, you will need at least
319185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
319285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
319385ec0bccSwdenk    your board
3194c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3195c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
319685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3197c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3198c609719bSwdenk    to be installed on your target system.
319985ec0bccSwdenk6.  Debug and solve any problems that might arise.
3200c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3201c609719bSwdenk
3202c609719bSwdenk
3203c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3204c609719bSwdenk==============================================================
3205c609719bSwdenk
3206c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3207c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3208c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3209c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3210218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3211c609719bSwdenk
3212c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3213c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3214c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3215c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3216c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
32177152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3218218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3219218ca724SWolfgang Denkyou can type
3220c609719bSwdenk
3221c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3222c609719bSwdenk
3223c609719bSwdenkor to build on a native PowerPC system you can type
3224c609719bSwdenk
3225c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3226c609719bSwdenk
3227218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3228218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3229218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3230218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3231218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3232218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3233218ca724SWolfgang Denkvariable. For example:
3234baf31249SMarian Balakowicz
3235baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3236baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3237baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3238baf31249SMarian Balakowicz
3239218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3240218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3241218ca724SWolfgang Denkduring the whole build process.
3242baf31249SMarian Balakowicz
3243baf31249SMarian Balakowicz
3244c609719bSwdenkSee also "U-Boot Porting Guide" below.
3245c609719bSwdenk
3246c609719bSwdenk
3247c609719bSwdenkMonitor Commands - Overview:
3248c609719bSwdenk============================
3249c609719bSwdenk
3250c609719bSwdenkgo	- start application at address 'addr'
3251c609719bSwdenkrun	- run commands in an environment variable
3252c609719bSwdenkbootm	- boot application image from memory
3253c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3254c609719bSwdenktftpboot- boot image via network using TFTP protocol
3255c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3256c609719bSwdenk	       (and eventually "gatewayip")
3257c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3258c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3259c609719bSwdenkloads	- load S-Record file over serial line
3260c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3261c609719bSwdenkmd	- memory display
3262c609719bSwdenkmm	- memory modify (auto-incrementing)
3263c609719bSwdenknm	- memory modify (constant address)
3264c609719bSwdenkmw	- memory write (fill)
3265c609719bSwdenkcp	- memory copy
3266c609719bSwdenkcmp	- memory compare
3267c609719bSwdenkcrc32	- checksum calculation
32680f89c54bSPeter Tyseri2c	- I2C sub-system
3269c609719bSwdenksspi	- SPI utility commands
3270c609719bSwdenkbase	- print or set address offset
3271c609719bSwdenkprintenv- print environment variables
3272c609719bSwdenksetenv	- set environment variables
3273c609719bSwdenksaveenv - save environment variables to persistent storage
3274c609719bSwdenkprotect - enable or disable FLASH write protection
3275c609719bSwdenkerase	- erase FLASH memory
3276c609719bSwdenkflinfo	- print FLASH memory information
3277c609719bSwdenkbdinfo	- print Board Info structure
3278c609719bSwdenkiminfo	- print header information for application image
3279c609719bSwdenkconinfo - print console devices and informations
3280c609719bSwdenkide	- IDE sub-system
3281c609719bSwdenkloop	- infinite loop on address range
328256523f12Swdenkloopw	- infinite write loop on address range
3283c609719bSwdenkmtest	- simple RAM test
3284c609719bSwdenkicache	- enable or disable instruction cache
3285c609719bSwdenkdcache	- enable or disable data cache
3286c609719bSwdenkreset	- Perform RESET of the CPU
3287c609719bSwdenkecho	- echo args to console
3288c609719bSwdenkversion - print monitor version
3289c609719bSwdenkhelp	- print online help
3290c609719bSwdenk?	- alias for 'help'
3291c609719bSwdenk
3292c609719bSwdenk
3293c609719bSwdenkMonitor Commands - Detailed Description:
3294c609719bSwdenk========================================
3295c609719bSwdenk
3296c609719bSwdenkTODO.
3297c609719bSwdenk
3298c609719bSwdenkFor now: just type "help <command>".
3299c609719bSwdenk
3300c609719bSwdenk
3301c609719bSwdenkEnvironment Variables:
3302c609719bSwdenk======================
3303c609719bSwdenk
3304c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3305c609719bSwdenkcan be made persistent by saving to Flash memory.
3306c609719bSwdenk
3307c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3308c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3309c609719bSwdenkwithout a value can be used to delete a variable from the
3310c609719bSwdenkenvironment. As long as you don't save the environment you are
3311c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3312c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3313c609719bSwdenk
3314c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3315c96f86eeSWolfgang Denk
3316c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3317c609719bSwdenk
3318c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3319c609719bSwdenk
3320c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3321c609719bSwdenk
3322c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3323c609719bSwdenk
3324c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3325c609719bSwdenk
3326c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3327c609719bSwdenk
33287d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
33297d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
33307d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
33317d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
33327d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
33337d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3334c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3335c3624e6eSGrant Likely		  bootm_mapsize.
3336c3624e6eSGrant Likely
3337c3624e6eSGrant Likely  bootm_mapsize	- Size of the initial memory mapping for the Linux kernel.
3338c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3339c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3340c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3341c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3342c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3343c3624e6eSGrant Likely		  used otherwise.
33447d721e34SBartlomiej Sieka
33457d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
33467d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
33477d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
33487d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
33497d721e34SBartlomiej Sieka		  environment variable.
33507d721e34SBartlomiej Sieka
33514bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
33524bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
33534bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
33544bae9090SBartlomiej Sieka
3355c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3356c609719bSwdenk		  "bootp" will just load perform a lookup of the
3357c609719bSwdenk		  configuration from the BOOTP server, but not try to
3358c609719bSwdenk		  load any image using TFTP
3359c609719bSwdenk
3360c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3361c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3362c609719bSwdenk		  be automatically started (by internally calling
3363c609719bSwdenk		  "bootm")
3364c609719bSwdenk
33654a6fd34bSwdenk		  If set to "no", a standalone image passed to the
33664a6fd34bSwdenk		  "bootm" command will be copied to the load address
33674a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
33684a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
33694a6fd34bSwdenk		  data.
33704a6fd34bSwdenk
3371a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3372a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3373a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3374a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3375a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3376a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3377a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3378a28afca5SDavid A. Long		  must be accessible by the kernel.
3379a28afca5SDavid A. Long
338017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
338117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
338217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
338317ea1177Swdenk		  initialization code. So, for changes to be effective
338417ea1177Swdenk		  it must be saved and board must be reset.
338517ea1177Swdenk
3386c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3387c609719bSwdenk		  If this variable is not set, initrd images will be
3388c609719bSwdenk		  copied to the highest possible address in RAM; this
3389c609719bSwdenk		  is usually what you want since it allows for
3390c609719bSwdenk		  maximum initrd size. If for some reason you want to
3391c609719bSwdenk		  make sure that the initrd image is loaded below the
33926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3393c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3394c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3395c609719bSwdenk		  address to use (U-Boot will still check that it
3396c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3397c609719bSwdenk
3398c609719bSwdenk		  For instance, when you have a system with 16 MB
33997152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3400c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3401c609719bSwdenk		  the "bootargs" variable. However, now you must make
34027152b1d0Swdenk		  sure that the initrd image is placed in the first
3403c609719bSwdenk		  12 MB as well - this can be done with
3404c609719bSwdenk
3405c609719bSwdenk		  setenv initrd_high 00c00000
3406c609719bSwdenk
340738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
340838b99261Swdenk		  indication to U-Boot that all addresses are legal
340938b99261Swdenk		  for the Linux kernel, including addresses in flash
341038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
341138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
341238b99261Swdenk		  boot time on your system, but requires that this
341338b99261Swdenk		  feature is supported by your Linux kernel.
341438b99261Swdenk
3415c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3416c609719bSwdenk
3417c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3418dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3419c609719bSwdenk
3420c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3421c609719bSwdenk
3422c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3423c609719bSwdenk
3424c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3425c609719bSwdenk
3426c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3427c609719bSwdenk
3428c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3429c609719bSwdenk
3430a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3431a3d991bdSwdenk		  interface is used first.
3432a3d991bdSwdenk
3433a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3434a3d991bdSwdenk		  interface is currently active. For example you
3435a3d991bdSwdenk		  can do the following
3436a3d991bdSwdenk
343748690d80SHeiko Schocher		  => setenv ethact FEC
343848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
343948690d80SHeiko Schocher		  => setenv ethact SCC
344048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3441a3d991bdSwdenk
3442e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3443e1692577SMatthias Fuchs		  available network interfaces.
3444e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3445e1692577SMatthias Fuchs
3446a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3447a3d991bdSwdenk		  either succeed or fail without retrying.
34486e592385Swdenk		  When set to "once" the network operation will
34496e592385Swdenk		  fail when all the available network interfaces
34506e592385Swdenk		  are tried once without success.
3451a3d991bdSwdenk		  Useful on scripts which control the retry operation
3452a3d991bdSwdenk		  themselves.
3453a3d991bdSwdenk
3454b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3455a1cf027aSJean-Christophe PLAGNIOL-VILLARD
345628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3457ecb0ccd9SWolfgang Denk		  UDP source port.
3458ecb0ccd9SWolfgang Denk
345928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
346028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
346128cb9375SWolfgang Denk
3462c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3463c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3464c96f86eeSWolfgang Denk
3465c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3466c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3467c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3468c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3469c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3470c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3471c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3472c96f86eeSWolfgang Denk
3473a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
347411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3475a3d991bdSwdenk		  VLAN tagged frames.
3476c609719bSwdenk
3477c609719bSwdenkThe following environment variables may be used and automatically
3478c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3479c609719bSwdenkdepending the information provided by your boot server:
3480c609719bSwdenk
3481c609719bSwdenk  bootfile	- see above
3482c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3483fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3484c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3485c609719bSwdenk  hostname	- Target hostname
3486c609719bSwdenk  ipaddr	- see above
3487c609719bSwdenk  netmask	- Subnet Mask
3488c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3489c609719bSwdenk  serverip	- see above
3490c609719bSwdenk
3491c609719bSwdenk
3492c609719bSwdenkThere are two special Environment Variables:
3493c609719bSwdenk
3494c609719bSwdenk  serial#	- contains hardware identification information such
3495c609719bSwdenk		  as type string and/or serial number
3496c609719bSwdenk  ethaddr	- Ethernet address
3497c609719bSwdenk
3498c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3499c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3500c609719bSwdenkonce they have been set once.
3501c609719bSwdenk
3502c609719bSwdenk
3503c1551ea8SstroeseFurther special Environment Variables:
3504c1551ea8Sstroese
3505c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3506c1551ea8Sstroese		  with the "version" command. This variable is
3507c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3508c1551ea8Sstroese
3509c1551ea8Sstroese
3510c609719bSwdenkPlease note that changes to some configuration parameters may take
3511c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3512c609719bSwdenk
3513c609719bSwdenk
3514f07771ccSwdenkCommand Line Parsing:
3515f07771ccSwdenk=====================
3516f07771ccSwdenk
3517f07771ccSwdenkThere are two different command line parsers available with U-Boot:
35187152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3519f07771ccSwdenk
3520f07771ccSwdenkOld, simple command line parser:
3521f07771ccSwdenk--------------------------------
3522f07771ccSwdenk
3523f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3524f07771ccSwdenk- several commands on one line, separated by ';'
3525fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3526f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3527f07771ccSwdenk  for example:
3528fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3529f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3530f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3531f07771ccSwdenk
3532f07771ccSwdenkHush shell:
3533f07771ccSwdenk-----------
3534f07771ccSwdenk
3535f07771ccSwdenk- similar to Bourne shell, with control structures like
3536f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3537f07771ccSwdenk  until...do...done, ...
3538f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3539f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3540f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3541f07771ccSwdenk  command
3542f07771ccSwdenk
3543f07771ccSwdenkGeneral rules:
3544f07771ccSwdenk--------------
3545f07771ccSwdenk
3546f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3547f07771ccSwdenk    command) contains several commands separated by semicolon, and
3548f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3549f07771ccSwdenk    executed anyway.
3550f07771ccSwdenk
3551f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
355211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3553f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3554f07771ccSwdenk    variables are not executed.
3555f07771ccSwdenk
3556c609719bSwdenkNote for Redundant Ethernet Interfaces:
3557c609719bSwdenk=======================================
3558c609719bSwdenk
355911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3560c609719bSwdenksuch configurations and is capable of automatic selection of a
35617152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3562c609719bSwdenk
3563c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3564c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3565c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3566c609719bSwdenk
3567c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3568c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3569c609719bSwdenkding setting in the environment; if the corresponding environment
3570c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3571c609719bSwdenk
3572c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3573c609719bSwdenk  environment, the SROM's address is used.
3574c609719bSwdenk
3575c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3576c609719bSwdenk  environment exists, then the value from the environment variable is
3577c609719bSwdenk  used.
3578c609719bSwdenk
3579c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3580c609719bSwdenk  both addresses are the same, this MAC address is used.
3581c609719bSwdenk
3582c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3583c609719bSwdenk  addresses differ, the value from the environment is used and a
3584c609719bSwdenk  warning is printed.
3585c609719bSwdenk
3586c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3587c609719bSwdenk  is raised.
3588c609719bSwdenk
3589ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3590ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3591ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3592ecee9324SBen WarrenThe naming convention is as follows:
3593ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3594c609719bSwdenk
3595c609719bSwdenkImage Formats:
3596c609719bSwdenk==============
3597c609719bSwdenk
35983310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
35993310c549SMarian Balakowiczimages in two formats:
36003310c549SMarian Balakowicz
36013310c549SMarian BalakowiczNew uImage format (FIT)
36023310c549SMarian Balakowicz-----------------------
36033310c549SMarian Balakowicz
36043310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
36053310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
36063310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
36073310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
36083310c549SMarian Balakowicz
36093310c549SMarian Balakowicz
36103310c549SMarian BalakowiczOld uImage format
36113310c549SMarian Balakowicz-----------------
36123310c549SMarian Balakowicz
36133310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
36143310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
36153310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3616c609719bSwdenk
3617c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3618c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3619f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3620f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3621f5ed9e39SPeter Tyser  INTEGRITY).
36227b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
36231117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
36241117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3625c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3626c609719bSwdenk* Load Address
3627c609719bSwdenk* Entry Point
3628c609719bSwdenk* Image Name
3629c609719bSwdenk* Image Timestamp
3630c609719bSwdenk
3631c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3632c609719bSwdenkand the data portions of the image are secured against corruption by
3633c609719bSwdenkCRC32 checksums.
3634c609719bSwdenk
3635c609719bSwdenk
3636c609719bSwdenkLinux Support:
3637c609719bSwdenk==============
3638c609719bSwdenk
3639c609719bSwdenkAlthough U-Boot should support any OS or standalone application
36407152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3641c609719bSwdenkU-Boot.
3642c609719bSwdenk
3643c609719bSwdenkU-Boot includes many features that so far have been part of some
3644c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3645c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3646c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
36477152b1d0Swdenkserves several purposes:
3648c609719bSwdenk
3649c609719bSwdenk- the same features can be used for other OS or standalone
3650c609719bSwdenk  applications (for instance: using compressed images to reduce the
3651c609719bSwdenk  Flash memory footprint)
3652c609719bSwdenk
3653c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
36547152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3655c609719bSwdenk
3656c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3657c609719bSwdenk  images; of course this also means that different kernel images can
3658c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3659c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3660c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3661c609719bSwdenk  software is easier now.
3662c609719bSwdenk
3663c609719bSwdenk
3664c609719bSwdenkLinux HOWTO:
3665c609719bSwdenk============
3666c609719bSwdenk
3667c609719bSwdenkPorting Linux to U-Boot based systems:
3668c609719bSwdenk---------------------------------------
3669c609719bSwdenk
3670c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3671c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3672c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3673c609719bSwdenkLinux :-).
3674c609719bSwdenk
3675a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3676c609719bSwdenk
3677c609719bSwdenkJust make sure your machine specific header file (for instance
3678c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
36791dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
36801dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
36816d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3682c609719bSwdenk
3683c609719bSwdenk
3684c609719bSwdenkConfiguring the Linux kernel:
3685c609719bSwdenk-----------------------------
3686c609719bSwdenk
3687c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3688c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3689c609719bSwdenk
3690c609719bSwdenk
3691c609719bSwdenkBuilding a Linux Image:
3692c609719bSwdenk-----------------------
3693c609719bSwdenk
369424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
369524ee89b9Swdenknot used. If you use recent kernel source, a new build target
369624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
369724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
369824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
369924ee89b9Swdenk100% compatible format.
3700c609719bSwdenk
3701c609719bSwdenkExample:
3702c609719bSwdenk
3703c609719bSwdenk	make TQM850L_config
3704c609719bSwdenk	make oldconfig
3705c609719bSwdenk	make dep
370624ee89b9Swdenk	make uImage
3707c609719bSwdenk
370824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
370924ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
371024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3711c609719bSwdenk
371224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
371324ee89b9Swdenk
371424ee89b9Swdenk* convert the kernel into a raw binary image:
371524ee89b9Swdenk
371624ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
371724ee89b9Swdenk				 -R .note -R .comment \
371824ee89b9Swdenk				 -S vmlinux linux.bin
371924ee89b9Swdenk
372024ee89b9Swdenk* compress the binary image:
372124ee89b9Swdenk
372224ee89b9Swdenk	gzip -9 linux.bin
372324ee89b9Swdenk
372424ee89b9Swdenk* package compressed binary image for U-Boot:
372524ee89b9Swdenk
372624ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
372724ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
372824ee89b9Swdenk		-d linux.bin.gz uImage
372924ee89b9Swdenk
373024ee89b9Swdenk
373124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
373224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
373324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
373424ee89b9Swdenkbyte header containing information about target architecture,
373524ee89b9Swdenkoperating system, image type, compression method, entry points, time
373624ee89b9Swdenkstamp, CRC32 checksums, etc.
373724ee89b9Swdenk
373824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
373924ee89b9Swdenkprint the header information, or to build new images.
3740c609719bSwdenk
3741c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3742c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3743c609719bSwdenkchecksum verification:
3744c609719bSwdenk
3745c609719bSwdenk	tools/mkimage -l image
3746c609719bSwdenk	  -l ==> list image header information
3747c609719bSwdenk
3748c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3749c609719bSwdenkfrom a "data file" which is used as image payload:
3750c609719bSwdenk
3751c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3752c609719bSwdenk		      -n name -d data_file image
3753c609719bSwdenk	  -A ==> set architecture to 'arch'
3754c609719bSwdenk	  -O ==> set operating system to 'os'
3755c609719bSwdenk	  -T ==> set image type to 'type'
3756c609719bSwdenk	  -C ==> set compression type 'comp'
3757c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3758c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3759c609719bSwdenk	  -n ==> set image name to 'name'
3760c609719bSwdenk	  -d ==> use image data from 'datafile'
3761c609719bSwdenk
376269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
376369459791Swdenkaddress (0x00000000), but the entry point address depends on the
376469459791Swdenkkernel version:
3765c609719bSwdenk
3766c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
376724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3768c609719bSwdenk
3769c609719bSwdenkSo a typical call to build a U-Boot image would read:
3770c609719bSwdenk
377124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
377224ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3773a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
377424ee89b9Swdenk	> examples/uImage.TQM850L
377524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3776c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3777c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3778c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3779c609719bSwdenk	Load Address: 0x00000000
378024ee89b9Swdenk	Entry Point:  0x00000000
3781c609719bSwdenk
3782c609719bSwdenkTo verify the contents of the image (or check for corruption):
3783c609719bSwdenk
378424ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
378524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3786c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3787c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3788c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3789c609719bSwdenk	Load Address: 0x00000000
379024ee89b9Swdenk	Entry Point:  0x00000000
3791c609719bSwdenk
3792c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3793c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3794c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3795c609719bSwdenkneed to be uncompressed:
3796c609719bSwdenk
3797a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
379824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
379924ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3800a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
380124ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
380224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3803c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3804c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3805c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3806c609719bSwdenk	Load Address: 0x00000000
380724ee89b9Swdenk	Entry Point:  0x00000000
3808c609719bSwdenk
3809c609719bSwdenk
3810c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3811c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3812c609719bSwdenk
3813c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3814c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3815c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3816c609719bSwdenk	Image Name:   Simple Ramdisk Image
3817c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3818c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3819c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3820c609719bSwdenk	Load Address: 0x00000000
3821c609719bSwdenk	Entry Point:  0x00000000
3822c609719bSwdenk
3823c609719bSwdenk
3824c609719bSwdenkInstalling a Linux Image:
3825c609719bSwdenk-------------------------
3826c609719bSwdenk
3827c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3828c609719bSwdenkyou must convert the image to S-Record format:
3829c609719bSwdenk
3830c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3831c609719bSwdenk
3832c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3833c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3834c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3835c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3836c609719bSwdenkcommand.
3837c609719bSwdenk
3838c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3839c609719bSwdenkTQM8xxL is in the first Flash bank):
3840c609719bSwdenk
3841c609719bSwdenk	=> erase 40100000 401FFFFF
3842c609719bSwdenk
3843c609719bSwdenk	.......... done
3844c609719bSwdenk	Erased 8 sectors
3845c609719bSwdenk
3846c609719bSwdenk	=> loads 40100000
3847c609719bSwdenk	## Ready for S-Record download ...
3848c609719bSwdenk	~>examples/image.srec
3849c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3850c609719bSwdenk	...
3851c609719bSwdenk	15989 15990 15991 15992
3852c609719bSwdenk	[file transfer complete]
3853c609719bSwdenk	[connected]
3854c609719bSwdenk	## Start Addr = 0x00000000
3855c609719bSwdenk
3856c609719bSwdenk
3857c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3858c609719bSwdenkthis includes a checksum verification so you can be sure no data
3859c609719bSwdenkcorruption happened:
3860c609719bSwdenk
3861c609719bSwdenk	=> imi 40100000
3862c609719bSwdenk
3863c609719bSwdenk	## Checking Image at 40100000 ...
3864c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3865c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3866c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3867c609719bSwdenk	   Load Address: 00000000
3868c609719bSwdenk	   Entry Point:	 0000000c
3869c609719bSwdenk	   Verifying Checksum ... OK
3870c609719bSwdenk
3871c609719bSwdenk
3872c609719bSwdenkBoot Linux:
3873c609719bSwdenk-----------
3874c609719bSwdenk
3875c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3876c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3877c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3878c609719bSwdenkparameters. You can check and modify this variable using the
3879c609719bSwdenk"printenv" and "setenv" commands:
3880c609719bSwdenk
3881c609719bSwdenk
3882c609719bSwdenk	=> printenv bootargs
3883c609719bSwdenk	bootargs=root=/dev/ram
3884c609719bSwdenk
3885c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3886c609719bSwdenk
3887c609719bSwdenk	=> printenv bootargs
3888c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3889c609719bSwdenk
3890c609719bSwdenk	=> bootm 40020000
3891c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3892c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3893c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3894c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3895c609719bSwdenk	   Load Address: 00000000
3896c609719bSwdenk	   Entry Point:	 0000000c
3897c609719bSwdenk	   Verifying Checksum ... OK
3898c609719bSwdenk	   Uncompressing Kernel Image ... OK
3899c609719bSwdenk	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
3900c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3901c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3902c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3903c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3904c609719bSwdenk	...
3905c609719bSwdenk
390611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
39077152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3908c609719bSwdenkformat!) to the "bootm" command:
3909c609719bSwdenk
3910c609719bSwdenk	=> imi 40100000 40200000
3911c609719bSwdenk
3912c609719bSwdenk	## Checking Image at 40100000 ...
3913c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3914c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3915c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3916c609719bSwdenk	   Load Address: 00000000
3917c609719bSwdenk	   Entry Point:	 0000000c
3918c609719bSwdenk	   Verifying Checksum ... OK
3919c609719bSwdenk
3920c609719bSwdenk	## Checking Image at 40200000 ...
3921c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3922c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3923c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3924c609719bSwdenk	   Load Address: 00000000
3925c609719bSwdenk	   Entry Point:	 00000000
3926c609719bSwdenk	   Verifying Checksum ... OK
3927c609719bSwdenk
3928c609719bSwdenk	=> bootm 40100000 40200000
3929c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3930c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3931c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3932c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3933c609719bSwdenk	   Load Address: 00000000
3934c609719bSwdenk	   Entry Point:	 0000000c
3935c609719bSwdenk	   Verifying Checksum ... OK
3936c609719bSwdenk	   Uncompressing Kernel Image ... OK
3937c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3938c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3939c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3940c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3941c609719bSwdenk	   Load Address: 00000000
3942c609719bSwdenk	   Entry Point:	 00000000
3943c609719bSwdenk	   Verifying Checksum ... OK
3944c609719bSwdenk	   Loading Ramdisk ... OK
3945c609719bSwdenk	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
3946c609719bSwdenk	Boot arguments: root=/dev/ram
3947c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3948c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3949c609719bSwdenk	...
3950c609719bSwdenk	RAMDISK: Compressed image found at block 0
3951c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3952c609719bSwdenk
3953c609719bSwdenk	bash#
3954c609719bSwdenk
39550267768eSMatthew McClintockBoot Linux and pass a flat device tree:
39560267768eSMatthew McClintock-----------
39570267768eSMatthew McClintock
39580267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
39590267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
39600267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
39610267768eSMatthew McClintockflat device tree:
39620267768eSMatthew McClintock
39630267768eSMatthew McClintock=> print oftaddr
39640267768eSMatthew McClintockoftaddr=0x300000
39650267768eSMatthew McClintock=> print oft
39660267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
39670267768eSMatthew McClintock=> tftp $oftaddr $oft
39680267768eSMatthew McClintockSpeed: 1000, full duplex
39690267768eSMatthew McClintockUsing TSEC0 device
39700267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
39710267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
39720267768eSMatthew McClintockLoad address: 0x300000
39730267768eSMatthew McClintockLoading: #
39740267768eSMatthew McClintockdone
39750267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
39760267768eSMatthew McClintock=> tftp $loadaddr $bootfile
39770267768eSMatthew McClintockSpeed: 1000, full duplex
39780267768eSMatthew McClintockUsing TSEC0 device
39790267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
39800267768eSMatthew McClintockFilename 'uImage'.
39810267768eSMatthew McClintockLoad address: 0x200000
39820267768eSMatthew McClintockLoading:############
39830267768eSMatthew McClintockdone
39840267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
39850267768eSMatthew McClintock=> print loadaddr
39860267768eSMatthew McClintockloadaddr=200000
39870267768eSMatthew McClintock=> print oftaddr
39880267768eSMatthew McClintockoftaddr=0x300000
39890267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
39900267768eSMatthew McClintock## Booting image at 00200000 ...
39910267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
39920267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
39930267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
39940267768eSMatthew McClintock   Load Address: 00000000
39950267768eSMatthew McClintock   Entry Point:	 00000000
39960267768eSMatthew McClintock   Verifying Checksum ... OK
39970267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
39980267768eSMatthew McClintockBooting using flat device tree at 0x300000
39990267768eSMatthew McClintockUsing MPC85xx ADS machine description
40000267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
40010267768eSMatthew McClintock[snip]
40020267768eSMatthew McClintock
40030267768eSMatthew McClintock
40046069ff26SwdenkMore About U-Boot Image Types:
40056069ff26Swdenk------------------------------
40066069ff26Swdenk
40076069ff26SwdenkU-Boot supports the following image types:
40086069ff26Swdenk
40096069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
40106069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
40116069ff26Swdenk	well) you can continue to work in U-Boot after return from
40126069ff26Swdenk	the Standalone Program.
40136069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
40146069ff26Swdenk	will take over control completely. Usually these programs
40156069ff26Swdenk	will install their own set of exception handlers, device
40166069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
40176069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
40186069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
40196069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
40206069ff26Swdenk	being started.
40216069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
40226069ff26Swdenk	(Linux) kernel image and one or more data images like
40236069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
40246069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
40256069ff26Swdenk	server provides just a single image file, but you want to get
40266069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
40276069ff26Swdenk
40286069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
40296069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
40306069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
40316069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
40326069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
40336069ff26Swdenk	a multiple of 4 bytes).
40346069ff26Swdenk
40356069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
40366069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
40376069ff26Swdenk	flash memory.
40386069ff26Swdenk
40396069ff26Swdenk   "Script files" are command sequences that will be executed by
40406069ff26Swdenk	U-Boot's command interpreter; this feature is especially
40416069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
40426069ff26Swdenk	as command interpreter.
40436069ff26Swdenk
4044c609719bSwdenk
4045c609719bSwdenkStandalone HOWTO:
4046c609719bSwdenk=================
4047c609719bSwdenk
4048c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4049c609719bSwdenkrun "standalone" applications, which can use some resources of
4050c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4051c609719bSwdenk
4052c609719bSwdenkTwo simple examples are included with the sources:
4053c609719bSwdenk
4054c609719bSwdenk"Hello World" Demo:
4055c609719bSwdenk-------------------
4056c609719bSwdenk
4057c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4058c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4059c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4060c609719bSwdenklike that:
4061c609719bSwdenk
4062c609719bSwdenk	=> loads
4063c609719bSwdenk	## Ready for S-Record download ...
4064c609719bSwdenk	~>examples/hello_world.srec
4065c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4066c609719bSwdenk	[file transfer complete]
4067c609719bSwdenk	[connected]
4068c609719bSwdenk	## Start Addr = 0x00040004
4069c609719bSwdenk
4070c609719bSwdenk	=> go 40004 Hello World! This is a test.
4071c609719bSwdenk	## Starting application at 0x00040004 ...
4072c609719bSwdenk	Hello World
4073c609719bSwdenk	argc = 7
4074c609719bSwdenk	argv[0] = "40004"
4075c609719bSwdenk	argv[1] = "Hello"
4076c609719bSwdenk	argv[2] = "World!"
4077c609719bSwdenk	argv[3] = "This"
4078c609719bSwdenk	argv[4] = "is"
4079c609719bSwdenk	argv[5] = "a"
4080c609719bSwdenk	argv[6] = "test."
4081c609719bSwdenk	argv[7] = "<NULL>"
4082c609719bSwdenk	Hit any key to exit ...
4083c609719bSwdenk
4084c609719bSwdenk	## Application terminated, rc = 0x0
4085c609719bSwdenk
4086c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4087c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4088c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4089c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4090c609719bSwdenkcharacter, but this is just a demo program. The application can be
4091c609719bSwdenkcontrolled by the following keys:
4092c609719bSwdenk
4093c609719bSwdenk	? - print current values og the CPM Timer registers
4094c609719bSwdenk	b - enable interrupts and start timer
4095c609719bSwdenk	e - stop timer and disable interrupts
4096c609719bSwdenk	q - quit application
4097c609719bSwdenk
4098c609719bSwdenk	=> loads
4099c609719bSwdenk	## Ready for S-Record download ...
4100c609719bSwdenk	~>examples/timer.srec
4101c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4102c609719bSwdenk	[file transfer complete]
4103c609719bSwdenk	[connected]
4104c609719bSwdenk	## Start Addr = 0x00040004
4105c609719bSwdenk
4106c609719bSwdenk	=> go 40004
4107c609719bSwdenk	## Starting application at 0x00040004 ...
4108c609719bSwdenk	TIMERS=0xfff00980
4109c609719bSwdenk	Using timer 1
4110c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4111c609719bSwdenk
4112c609719bSwdenkHit 'b':
4113c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4114c609719bSwdenk	Enabling timer
4115c609719bSwdenkHit '?':
4116c609719bSwdenk	[q, b, e, ?] ........
4117c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4118c609719bSwdenkHit '?':
4119c609719bSwdenk	[q, b, e, ?] .
4120c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4121c609719bSwdenkHit '?':
4122c609719bSwdenk	[q, b, e, ?] .
4123c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4124c609719bSwdenkHit '?':
4125c609719bSwdenk	[q, b, e, ?] .
4126c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4127c609719bSwdenkHit 'e':
4128c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4129c609719bSwdenkHit 'q':
4130c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4131c609719bSwdenk
4132c609719bSwdenk
413385ec0bccSwdenkMinicom warning:
413485ec0bccSwdenk================
413585ec0bccSwdenk
41367152b1d0SwdenkOver time, many people have reported problems when trying to use the
413785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
413885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4139f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
414085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
414185ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
414285ec0bccSwdenk
414352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
414452f52c14Swdenkconfiguration to your "File transfer protocols" section:
414552f52c14Swdenk
414652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
414752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
414852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
414952f52c14Swdenk
415052f52c14Swdenk
4151c609719bSwdenkNetBSD Notes:
4152c609719bSwdenk=============
4153c609719bSwdenk
4154c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4155c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4156c609719bSwdenk
4157c609719bSwdenkBuilding requires a cross environment; it is known to work on
4158c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4159c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4160c609719bSwdenkNote that the cross-powerpc package does not install include files;
4161c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4162c609719bSwdenkmissing.  This file has to be installed and patched manually:
4163c609719bSwdenk
4164c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4165c609719bSwdenk	# mkdir powerpc
4166c609719bSwdenk	# ln -s powerpc machine
4167c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4168c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4169c609719bSwdenk
4170c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4171c609719bSwdenkand U-Boot include files.
4172c609719bSwdenk
4173c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4174c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4175c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4176c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
41772a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4178c609719bSwdenk
4179c609719bSwdenk
4180c609719bSwdenkImplementation Internals:
4181c609719bSwdenk=========================
4182c609719bSwdenk
4183c609719bSwdenkThe following is not intended to be a complete description of every
4184c609719bSwdenkimplementation detail. However, it should help to understand the
4185c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4186c609719bSwdenkhardware.
4187c609719bSwdenk
4188c609719bSwdenk
4189c609719bSwdenkInitial Stack, Global Data:
4190c609719bSwdenk---------------------------
4191c609719bSwdenk
4192c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4193c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4194c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4195c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4196c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4197c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4198c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4199c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4200c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4201c609719bSwdenklocked as (mis-) used as memory, etc.
4202c609719bSwdenk
42037152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
42040668236bSWolfgang Denk	U-Boot mailing list:
420543d9616cSwdenk
420643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
420743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
420843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
420943d9616cSwdenk	...
421043d9616cSwdenk
421143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
421243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
421343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
421443d9616cSwdenk	is that the cache is being used as a temporary supply of
421543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
421611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
421743d9616cSwdenk	can see how this works by studying the cache architecture and
421843d9616cSwdenk	operation in the architecture and processor-specific manuals.
421943d9616cSwdenk
422043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
422143d9616cSwdenk	is another option for the system designer to use as an
422211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
422343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
422443d9616cSwdenk	board designers haven't used it for something that would
422543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
422643d9616cSwdenk	used.
422743d9616cSwdenk
42286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
422943d9616cSwdenk	with your processor/board/system design. The default value
423043d9616cSwdenk	you will find in any recent u-boot distribution in
42318a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
423243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
423343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
423443d9616cSwdenk	that are supposed to respond to that address! That code in
423543d9616cSwdenk	start.S has been around a while and should work as is when
423643d9616cSwdenk	you get the config right.
423743d9616cSwdenk
423843d9616cSwdenk	-Chris Hallinan
423943d9616cSwdenk	DS4.COM, Inc.
424043d9616cSwdenk
4241c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4242c609719bSwdenkcode for the initialization procedures:
4243c609719bSwdenk
4244c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4245c609719bSwdenk  to write it.
4246c609719bSwdenk
424711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4248c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
42497152b1d0Swdenk  zation is performed later (when relocating to RAM).
4250c609719bSwdenk
4251c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4252c609719bSwdenk  that.
4253c609719bSwdenk
4254c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4255c609719bSwdenknormal global data to share information beween the code. But it
4256c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4257c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4258c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4259c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4260c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4261c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4262c609719bSwdenkreserve for this purpose.
4263c609719bSwdenk
42647152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4265c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4266c609719bSwdenkGCC's implementation.
4267c609719bSwdenk
4268c609719bSwdenkFor PowerPC, the following registers have specific use:
4269c609719bSwdenk	R1:	stack pointer
4270e7670f6cSWolfgang Denk	R2:	reserved for system use
4271c609719bSwdenk	R3-R4:	parameter passing and return values
4272c609719bSwdenk	R5-R10: parameter passing
4273c609719bSwdenk	R13:	small data area pointer
4274c609719bSwdenk	R30:	GOT pointer
4275c609719bSwdenk	R31:	frame pointer
4276c609719bSwdenk
4277e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4278e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4279e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4280c609719bSwdenk
4281e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4282c609719bSwdenk
4283c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4284c609719bSwdenk    address of the global data structure is known at compile time),
4285c609719bSwdenk    but it turned out that reserving a register results in somewhat
4286c609719bSwdenk    smaller code - although the code savings are not that big (on
4287c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4288c609719bSwdenk    624 text + 127 data).
4289c609719bSwdenk
4290c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
42914c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
42924c58eb55SMike Frysinger
4293c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
42944c58eb55SMike Frysinger
4295c609719bSwdenkOn ARM, the following registers are used:
4296c609719bSwdenk
4297c609719bSwdenk	R0:	function argument word/integer result
4298c609719bSwdenk	R1-R3:	function argument word
4299c609719bSwdenk	R9:	GOT pointer
4300c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4301c609719bSwdenk	R11:	argument (frame) pointer
4302c609719bSwdenk	R12:	temporary workspace
4303c609719bSwdenk	R13:	stack pointer
4304c609719bSwdenk	R14:	link register
4305c609719bSwdenk	R15:	program counter
4306c609719bSwdenk
4307c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4308c609719bSwdenk
43090df01fd3SThomas ChouOn Nios II, the ABI is documented here:
43100df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
43110df01fd3SThomas Chou
43120df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
43130df01fd3SThomas Chou
43140df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
43150df01fd3SThomas Chou    to access small data sections, so gp is free.
43160df01fd3SThomas Chou
4317d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4318d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4319c609719bSwdenk
4320c609719bSwdenkMemory Management:
4321c609719bSwdenk------------------
4322c609719bSwdenk
4323c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4324c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4325c609719bSwdenk
4326c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4327c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4328c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4329c609719bSwdenkphysical memory banks.
4330c609719bSwdenk
4331c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4332c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4333c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4334c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
43356d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4336c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4337c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4338c609719bSwdenk
4339c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4340c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4341c609719bSwdenk
4342c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4343c609719bSwdenkthis:
4344c609719bSwdenk
4345c609719bSwdenk	0x0000 0000	Exception Vector code
4346c609719bSwdenk	      :
4347c609719bSwdenk	0x0000 1FFF
4348c609719bSwdenk	0x0000 2000	Free for Application Use
4349c609719bSwdenk	      :
4350c609719bSwdenk	      :
4351c609719bSwdenk
4352c609719bSwdenk	      :
4353c609719bSwdenk	      :
4354c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4355c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4356c609719bSwdenk	0x00FC 0000	Malloc Arena
4357c609719bSwdenk	      :
4358c609719bSwdenk	0x00FD FFFF
4359c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4360c609719bSwdenk	...		eventually: LCD or video framebuffer
4361c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4362c609719bSwdenk	0x00FF FFFF	[End of RAM]
4363c609719bSwdenk
4364c609719bSwdenk
4365c609719bSwdenkSystem Initialization:
4366c609719bSwdenk----------------------
4367c609719bSwdenk
4368c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
436911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4370c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
43717152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4372c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4373c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4374c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4375c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4376c609719bSwdenkthe caches and the SIU.
4377c609719bSwdenk
4378c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4379c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4380c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4381c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4382c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4383c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4384c609719bSwdenkbanks.
4385c609719bSwdenk
4386c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
43877152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4388c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4389c609719bSwdenk0x00000000, with any additional banks following immediately to create
4390c609719bSwdenkcontiguous memory starting from 0.
4391c609719bSwdenk
4392c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4393c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4394c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4395c609719bSwdenkpages, and the final stack is set up.
4396c609719bSwdenk
4397c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4398c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4399c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4400c609719bSwdenknew address in RAM.
4401c609719bSwdenk
4402c609719bSwdenk
4403c609719bSwdenkU-Boot Porting Guide:
4404c609719bSwdenk----------------------
4405c609719bSwdenk
4406c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
44076aff3115Swdenklist, October 2002]
4408c609719bSwdenk
4409c609719bSwdenk
4410c609719bSwdenkint main(int argc, char *argv[])
4411c609719bSwdenk{
4412c609719bSwdenk	sighandler_t no_more_time;
4413c609719bSwdenk
4414c609719bSwdenk	signal(SIGALRM, no_more_time);
4415c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4416c609719bSwdenk
4417c609719bSwdenk	if (available_money > available_manpower) {
44186c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4419c609719bSwdenk		return 0;
4420c609719bSwdenk	}
4421c609719bSwdenk
4422c609719bSwdenk	Download latest U-Boot source;
4423c609719bSwdenk
44240668236bSWolfgang Denk	Subscribe to u-boot mailing list;
44256aff3115Swdenk
44266c3fef28SJerry Van Baren	if (clueless)
4427c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4428c609719bSwdenk
4429c609719bSwdenk	while (learning) {
4430c609719bSwdenk		Read the README file in the top level directory;
44317cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
44326c3fef28SJerry Van Baren		Read applicable doc/*.README;
4433c609719bSwdenk		Read the source, Luke;
44346c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4435c609719bSwdenk	}
4436c609719bSwdenk
44376c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
44386c3fef28SJerry Van Baren		Buy a BDI3000;
44396c3fef28SJerry Van Baren	else
4440c609719bSwdenk		Add a lot of aggravation and time;
4441c609719bSwdenk
44426c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
44436c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
44446c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
44456c3fef28SJerry Van Baren	} else {
4446c609719bSwdenk		Create your own board support subdirectory;
44476c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
44486c3fef28SJerry Van Baren	}
44496c3fef28SJerry Van Baren	Edit new board/<myboard> files
44506c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4451c609719bSwdenk
44526c3fef28SJerry Van Baren	while (!accepted) {
4453c609719bSwdenk		while (!running) {
4454c609719bSwdenk			do {
4455c609719bSwdenk				Add / modify source code;
4456c609719bSwdenk			} until (compiles);
4457c609719bSwdenk			Debug;
4458c609719bSwdenk			if (clueless)
4459c609719bSwdenk				email("Hi, I am having problems...");
4460c609719bSwdenk		}
44616c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
44626c3fef28SJerry Van Baren		if (reasonable critiques)
44636c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
44646c3fef28SJerry Van Baren		else
44656c3fef28SJerry Van Baren			Defend code as written;
44666c3fef28SJerry Van Baren	}
4467c609719bSwdenk
4468c609719bSwdenk	return 0;
4469c609719bSwdenk}
4470c609719bSwdenk
4471c609719bSwdenkvoid no_more_time (int sig)
4472c609719bSwdenk{
4473c609719bSwdenk      hire_a_guru();
4474c609719bSwdenk}
4475c609719bSwdenk
4476c609719bSwdenk
4477c609719bSwdenkCoding Standards:
4478c609719bSwdenk-----------------
4479c609719bSwdenk
4480c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
44812c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
44822c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
44832c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
44842c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4485c609719bSwdenk
44862c051651SDetlev ZundelSource files originating from a different project (for example the
44872c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
44882c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
44892c051651SDetlev Zundelsources.
44902c051651SDetlev Zundel
44912c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
44922c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
44932c051651SDetlev Zundelin your code.
4494c609719bSwdenk
4495c178d3daSwdenkPlease also stick to the following formatting rules:
4496180d3f74Swdenk- remove any trailing white space
4497180d3f74Swdenk- use TAB characters for indentation, not spaces
4498180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4499180d3f74Swdenk- do not add more than 2 empty lines to source files
4500180d3f74Swdenk- do not add trailing empty lines to source files
4501180d3f74Swdenk
4502c609719bSwdenkSubmissions which do not conform to the standards may be returned
4503c609719bSwdenkwith a request to reformat the changes.
4504c609719bSwdenk
4505c609719bSwdenk
4506c609719bSwdenkSubmitting Patches:
4507c609719bSwdenk-------------------
4508c609719bSwdenk
4509c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4510c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4511c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4512c609719bSwdenk
45130d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4514218ca724SWolfgang Denk
45150668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
45160668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
45170668236bSWolfgang Denk
4518c609719bSwdenkWhen you send a patch, please include the following information with
4519c609719bSwdenkit:
4520c609719bSwdenk
4521c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4522c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4523c609719bSwdenk  patch actually fixes something.
4524c609719bSwdenk
4525c609719bSwdenk* For new features: a description of the feature and your
4526c609719bSwdenk  implementation.
4527c609719bSwdenk
4528c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4529c609719bSwdenk
4530c609719bSwdenk* For major contributions, your entry to the CREDITS file
4531c609719bSwdenk
4532c609719bSwdenk* When you add support for a new board, don't forget to add this
4533c609719bSwdenk  board to the MAKEALL script, too.
4534c609719bSwdenk
4535c609719bSwdenk* If your patch adds new configuration options, don't forget to
4536c609719bSwdenk  document these in the README file.
4537c609719bSwdenk
4538218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4539218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4540218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4541218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4542218ca724SWolfgang Denk  with some other mail clients.
4543c609719bSwdenk
4544218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4545218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4546218ca724SWolfgang Denk  GNU diff.
45476dff5529Swdenk
4548218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4549218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4550218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4551218ca724SWolfgang Denk  affected files).
4552218ca724SWolfgang Denk
4553218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4554218ca724SWolfgang Denk  and compressed attachments must not be used.
4555c609719bSwdenk
455652f52c14Swdenk* If one logical set of modifications affects or creates several
455752f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
455852f52c14Swdenk
455952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
456052f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
456152f52c14Swdenk
456252f52c14Swdenk
4563c609719bSwdenkNotes:
4564c609719bSwdenk
4565c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4566c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4567c609719bSwdenk  for any of the boards.
4568c609719bSwdenk
4569c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4570c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4571c609719bSwdenk  returned with a request to re-formatting / split it.
4572c609719bSwdenk
4573c609719bSwdenk* If you modify existing code, make sure that your new code does not
4574c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4575c609719bSwdenk  When adding new features, these should compile conditionally only
4576c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4577c609719bSwdenk  disabled must not need more memory than the old code without your
4578c609719bSwdenk  modification.
457990dc6704Swdenk
45800668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
45810668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
45820668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
45830668236bSWolfgang Denk  bigger than the size limit should be avoided.
4584