xref: /openbmc/u-boot/README (revision 6feff899)
1c609719bSwdenk#
26abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11     - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1506eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
167fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
18392bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
1848d321b81SPeter Tyser    /lib		Architecture specific library files
1858d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1868d321b81SPeter Tyser    /cpu		CPU specific files
1878d321b81SPeter Tyser    /lib		Architecture specific library files
188a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1898d321b81SPeter Tyser    /cpu		CPU specific files
1908d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1918d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1928d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1938d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1948d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1958d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1968d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1978d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1988d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sh			Files generic to SH architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2038d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2048d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2058d321b81SPeter Tyser    /lib		Architecture specific library files
2068d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2078d321b81SPeter Tyser    /cpu		CPU specific files
2088d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2098d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2108d321b81SPeter Tyser    /lib		Architecture specific library files
2118d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2128d321b81SPeter Tyser/board			Board dependent files
2138d321b81SPeter Tyser/common			Misc architecture independent functions
2148d321b81SPeter Tyser/disk			Code for disk drive partition handling
2158d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2168d321b81SPeter Tyser/drivers		Commonly used device drivers
2178d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2188d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2198d321b81SPeter Tyser/include		Header Files
2208d321b81SPeter Tyser/lib			Files generic to all architectures
2218d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2228d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2238d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2248d321b81SPeter Tyser/net			Networking code
2258d321b81SPeter Tyser/post			Power On Self Test
2268d321b81SPeter Tyser/rtc			Real Time Clock drivers
2278d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
228c609719bSwdenk
229c609719bSwdenkSoftware Configuration:
230c609719bSwdenk=======================
231c609719bSwdenk
232c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
233c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
234c609719bSwdenk
235c609719bSwdenkThere are two classes of configuration variables:
236c609719bSwdenk
237c609719bSwdenk* Configuration _OPTIONS_:
238c609719bSwdenk  These are selectable by the user and have names beginning with
239c609719bSwdenk  "CONFIG_".
240c609719bSwdenk
241c609719bSwdenk* Configuration _SETTINGS_:
242c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
243c609719bSwdenk  you don't know what you're doing; they have names beginning with
2446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
245c609719bSwdenk
246c609719bSwdenkLater we will add a configuration tool - probably similar to or even
247c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
248c609719bSwdenkdo the configuration by hand, which means creating some symbolic
249c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
250c609719bSwdenkas an example here.
251c609719bSwdenk
252c609719bSwdenk
253c609719bSwdenkSelection of Processor Architecture and Board Type:
254c609719bSwdenk---------------------------------------------------
255c609719bSwdenk
256c609719bSwdenkFor all supported boards there are ready-to-use default
257c609719bSwdenkconfigurations available; just type "make <board_name>_config".
258c609719bSwdenk
259c609719bSwdenkExample: For a TQM823L module type:
260c609719bSwdenk
261c609719bSwdenk	cd u-boot
262c609719bSwdenk	make TQM823L_config
263c609719bSwdenk
26411ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
265c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
266c609719bSwdenkdirectory according to the instructions in cogent/README.
267c609719bSwdenk
268c609719bSwdenk
269c609719bSwdenkConfiguration Options:
270c609719bSwdenk----------------------
271c609719bSwdenk
272c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
273c609719bSwdenksuch information is kept in a configuration file
274c609719bSwdenk"include/configs/<board_name>.h".
275c609719bSwdenk
276c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
277c609719bSwdenk"include/configs/TQM823L.h".
278c609719bSwdenk
279c609719bSwdenk
2807f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2817f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2827f6c2cbcSwdenkbuild a config tool - later.
2837f6c2cbcSwdenk
2847f6c2cbcSwdenk
285c609719bSwdenkThe following options need to be configured:
286c609719bSwdenk
2872628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
288c609719bSwdenk
2892628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2906ccec449SWolfgang Denk
2916ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29209ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
293c609719bSwdenk
294c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
295c609719bSwdenk		Define exactly one of
296c609719bSwdenk		CONFIG_CMA286_60_OLD
297c609719bSwdenk--- FIXME --- not tested yet:
298c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
299c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
300c609719bSwdenk
301c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
302c609719bSwdenk		Define exactly one of
303c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
304c609719bSwdenk
305c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
306c609719bSwdenk		Define one or more of
307c609719bSwdenk		CONFIG_CMA302
308c609719bSwdenk
309c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
310c609719bSwdenk		Define one or more of
311c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31211ccc33fSMarcel Ziswiler					  the LCD display every second with
313c609719bSwdenk					  a "rotator" |\-/|\-/
314c609719bSwdenk
3152535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3162535d602Swdenk		CONFIG_ADSTYPE
3172535d602Swdenk		Possible values are:
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3222535d602Swdenk
323cf946c6dSLei Wen- Marvell Family Member
324cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
325cf946c6dSLei Wen					  multiple fs option at one time
326cf946c6dSLei Wen					  for marvell soc family
327cf946c6dSLei Wen
328c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
329c609719bSwdenk		Define exactly one of
330c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
331c609719bSwdenk
33211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33466ca92a5Swdenk					  get_gclk_freq() cannot work
3355da627a4Swdenk					  e.g. if there is no 32KHz
3365da627a4Swdenk					  reference PIT/RTC clock
33766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33866ca92a5Swdenk					  or XTAL/EXTAL)
339c609719bSwdenk
34066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34475d1ea7fSwdenk			See doc/README.MPC866
34575d1ea7fSwdenk
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34775d1ea7fSwdenk
34875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34975d1ea7fSwdenk		of relying on the correctness of the configured
35075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35475d1ea7fSwdenk
355506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
356506f3918SHeiko Schocher
357506f3918SHeiko Schocher		Define this option if you want to enable the
358506f3918SHeiko Schocher		ICache only when Code runs from RAM.
359506f3918SHeiko Schocher
36066412c63SKumar Gala- 85xx CPU Options:
36166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36266412c63SKumar Gala
36366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36666412c63SKumar Gala
3678f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3688f29084aSKumar Gala
3698f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3708f29084aSKumar Gala		tree nodes for the given platform.
3718f29084aSKumar Gala
3720b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3740b953ffcSMarkus Klotzbuecher
3750b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3760b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3770b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3780b953ffcSMarkus Klotzbuecher
3796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3800b953ffcSMarkus Klotzbuecher
3810b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3820b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3830b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3840b953ffcSMarkus Klotzbuecher		by this value.
3850b953ffcSMarkus Klotzbuecher
38692bbd64eSDaniel Schwierzeck- MIPS CPU options:
38792bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
38892bbd64eSDaniel Schwierzeck
38992bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
39092bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
39192bbd64eSDaniel Schwierzeck		relocation.
39292bbd64eSDaniel Schwierzeck
39392bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
39492bbd64eSDaniel Schwierzeck
39592bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
39692bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
39792bbd64eSDaniel Schwierzeck		Possible values are:
39892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
39992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
40092bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
40192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
40292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
40392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
40492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
40592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
40692bbd64eSDaniel Schwierzeck
40792bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
40892bbd64eSDaniel Schwierzeck
40992bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
41092bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
41192bbd64eSDaniel Schwierzeck
41292bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
41392bbd64eSDaniel Schwierzeck
41492bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
41592bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
41692bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
41792bbd64eSDaniel Schwierzeck
4185da627a4Swdenk- Linux Kernel Interface:
419c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
420c609719bSwdenk
421c609719bSwdenk		U-Boot stores all clock information in Hz
422c609719bSwdenk		internally. For binary compatibility with older Linux
423c609719bSwdenk		kernels (which expect the clocks passed in the
424c609719bSwdenk		bd_info data to be in MHz) the environment variable
425c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
426c609719bSwdenk		converts clock data to MHZ before passing it to the
427c609719bSwdenk		Linux kernel.
428c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
429c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
430c609719bSwdenk		default environment.
431c609719bSwdenk
4325da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4335da627a4Swdenk
43411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4355da627a4Swdenk		expect it to be in bytes, others in MB.
4365da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4375da627a4Swdenk
438fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
439f57f70aaSWolfgang Denk
440f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
441213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
442213bf8c8SGerald Van Baren		concepts).
443213bf8c8SGerald Van Baren
444213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
445213bf8c8SGerald Van Baren		 * New libfdt-based support
446213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4473bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
448213bf8c8SGerald Van Baren
449b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
450b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
451b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
452b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
453f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
454c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
455f57f70aaSWolfgang Denk
45611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
45711ccc33fSMarcel Ziswiler		addresses
4583bb342fcSKim Phillips
4594e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4604e253137SKumar Gala
4614e253137SKumar Gala		Board code has addition modification that it wants to make
4624e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4636705d81eSwdenk
4640267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4650267768eSMatthew McClintock
46611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4670267768eSMatthew McClintock		param header, the default value is zero if undefined.
4680267768eSMatthew McClintock
4693887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4703887c3fbSHeiko Schocher
4713887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4723887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4733887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4743887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4753887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4763887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4773887c3fbSHeiko Schocher
4787eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
4797eb29398SIgor Grinberg
4807eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
4817eb29398SIgor Grinberg		machine type and must be used to specify the machine type
4827eb29398SIgor Grinberg		number as it appears in the ARM machine registry
4837eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
4847eb29398SIgor Grinberg		Only boards that have multiple machine types supported
4857eb29398SIgor Grinberg		in a single configuration file and the machine type is
4867eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
4877eb29398SIgor Grinberg
4880b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4890b2f4ecaSNiklaus Giger
4900b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4910b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4920b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4930b2f4ecaSNiklaus Giger
4940b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4960b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4970b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4980b2f4ecaSNiklaus Giger
4990b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5000b2f4ecaSNiklaus Giger
5010b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5020b2f4ecaSNiklaus Giger
5030b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5040b2f4ecaSNiklaus Giger		the defaults discussed just above.
5050b2f4ecaSNiklaus Giger
5062c451f78SAneesh V- Cache Configuration:
5072c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5082c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5092c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5102c451f78SAneesh V
51193bc2193SAneesh V- Cache Configuration for ARM:
51293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
51393bc2193SAneesh V				      controller
51493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
51593bc2193SAneesh V					controller register space
51693bc2193SAneesh V
5176705d81eSwdenk- Serial Ports:
51848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5196705d81eSwdenk
5206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5216705d81eSwdenk
52248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5236705d81eSwdenk
5246705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5256705d81eSwdenk
5266705d81eSwdenk		CONFIG_PL011_CLOCK
5276705d81eSwdenk
5286705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5296705d81eSwdenk		the clock speed of the UARTs.
5306705d81eSwdenk
5316705d81eSwdenk		CONFIG_PL01x_PORTS
5326705d81eSwdenk
5336705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5346705d81eSwdenk		define this to a list of base addresses for each (supported)
5356705d81eSwdenk		port. See e.g. include/configs/versatile.h
5366705d81eSwdenk
537910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
538910f1ae3SJohn Rigby
539910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
540910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
541910f1ae3SJohn Rigby		this variable to initialize the extra register.
542910f1ae3SJohn Rigby
543910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
544910f1ae3SJohn Rigby
545910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
546910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
547910f1ae3SJohn Rigby		variable to flush the UART at init time.
548910f1ae3SJohn Rigby
5496705d81eSwdenk
550c609719bSwdenk- Console Interface:
551c609719bSwdenk		Depending on board, define exactly one serial port
552c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
553c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
554c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
555c609719bSwdenk
556c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
557c609719bSwdenk		port routines must be defined elsewhere
558c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
559c609719bSwdenk
560c609719bSwdenk		CONFIG_CFB_CONSOLE
561c609719bSwdenk		Enables console device for a color framebuffer. Needs following
562c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
563c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
564c609719bSwdenk						(default big endian)
565c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
566c609719bSwdenk						rectangle fill
567c609719bSwdenk						(cf. smiLynxEM)
568c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
569c609719bSwdenk						bit-blit (cf. smiLynxEM)
570c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
571c609719bSwdenk						(cols=pitch)
572c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
573c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
574c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
575c609719bSwdenk						(0-5, cf. cfb_console.c)
576c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
577c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
578c609719bSwdenk						(i.e. i8042_kbd_init())
579c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
580c609719bSwdenk						(i.e. i8042_tstc)
581c609719bSwdenk			VIDEO_GETC_FCT		get char fct
582c609719bSwdenk						(i.e. i8042_getc)
583c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
584c609719bSwdenk						(requires blink timer
585c609719bSwdenk						cf. i8042.c)
5866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
587c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
588c609719bSwdenk						upper right corner
589602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
590c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
591c609719bSwdenk						upper left corner
592a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
593a6c7ad2fSwdenk						linux_logo.h for logo.
594a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
595c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
59611ccc33fSMarcel Ziswiler						additional board info beside
597c609719bSwdenk						the logo
598c609719bSwdenk
599c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
600c609719bSwdenk		default i/o. Serial console can be forced with
601c609719bSwdenk		environment 'console=serial'.
602c609719bSwdenk
603a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
604a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
605a3ad8e26Swdenk		the "silent" environment variable. See
606a3ad8e26Swdenk		doc/README.silent for more information.
607a3ad8e26Swdenk
608c609719bSwdenk- Console Baudrate:
609c609719bSwdenk		CONFIG_BAUDRATE - in bps
610c609719bSwdenk		Select one of the baudrates listed in
6116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
613c609719bSwdenk
614c92fac91SHeiko Schocher- Console Rx buffer length
615c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
616c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6172b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
618c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
619c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
620c92fac91SHeiko Schocher		the SMC.
621c92fac91SHeiko Schocher
6229558b48aSGraeme Russ- Pre-Console Buffer:
6239558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6249558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6259558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6269558b48aSGraeme Russ		buffer any console messages prior to the console being
6279558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6289558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6299558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6309558b48aSGraeme Russ		bytes are output before the console is initialised, the
6319558b48aSGraeme Russ		earlier bytes are discarded.
6329558b48aSGraeme Russ
6339558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6349558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
6359558b48aSGraeme Russ
636c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
637c609719bSwdenk		Delay before automatically booting the default image;
638c609719bSwdenk		set to -1 to disable autoboot.
639c609719bSwdenk
640c609719bSwdenk		See doc/README.autoboot for these options that
641c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
642c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
643c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
644c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
645c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
646c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
647c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
648c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
649c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
650c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
651c609719bSwdenk		CONFIG_RESET_TO_RETRY
652c609719bSwdenk
653c609719bSwdenk- Autoboot Command:
654c609719bSwdenk		CONFIG_BOOTCOMMAND
655c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
656c609719bSwdenk		define a command string that is automatically executed
657c609719bSwdenk		when no character is read on the console interface
658c609719bSwdenk		within "Boot Delay" after reset.
659c609719bSwdenk
660c609719bSwdenk		CONFIG_BOOTARGS
661c609719bSwdenk		This can be used to pass arguments to the bootm
662c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
663c609719bSwdenk		environment value "bootargs".
664c609719bSwdenk
665c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
666c609719bSwdenk		The value of these goes into the environment as
667c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
668c609719bSwdenk		as a convenience, when switching between booting from
66911ccc33fSMarcel Ziswiler		RAM and NFS.
670c609719bSwdenk
671c609719bSwdenk- Pre-Boot Commands:
672c609719bSwdenk		CONFIG_PREBOOT
673c609719bSwdenk
674c609719bSwdenk		When this option is #defined, the existence of the
675c609719bSwdenk		environment variable "preboot" will be checked
676c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
677c609719bSwdenk		countdown and/or running the auto-boot command resp.
678c609719bSwdenk		entering interactive mode.
679c609719bSwdenk
680c609719bSwdenk		This feature is especially useful when "preboot" is
681c609719bSwdenk		automatically generated or modified. For an example
682c609719bSwdenk		see the LWMON board specific code: here "preboot" is
683c609719bSwdenk		modified when the user holds down a certain
684c609719bSwdenk		combination of keys on the (special) keyboard when
685c609719bSwdenk		booting the systems
686c609719bSwdenk
687c609719bSwdenk- Serial Download Echo Mode:
688c609719bSwdenk		CONFIG_LOADS_ECHO
689c609719bSwdenk		If defined to 1, all characters received during a
690c609719bSwdenk		serial download (using the "loads" command) are
691c609719bSwdenk		echoed back. This might be needed by some terminal
692c609719bSwdenk		emulations (like "cu"), but may as well just take
693c609719bSwdenk		time on others. This setting #define's the initial
694c609719bSwdenk		value of the "loads_echo" environment variable.
695c609719bSwdenk
696602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
697c609719bSwdenk		CONFIG_KGDB_BAUDRATE
698c609719bSwdenk		Select one of the baudrates listed in
6996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
700c609719bSwdenk
701c609719bSwdenk- Monitor Functions:
702602ad3b3SJon Loeliger		Monitor commands can be included or excluded
703602ad3b3SJon Loeliger		from the build by using the #include files
704602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
705602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
706602ad3b3SJon Loeliger		and augmenting with additional #define's
707602ad3b3SJon Loeliger		for wanted commands.
708c609719bSwdenk
709602ad3b3SJon Loeliger		The default command configuration includes all commands
710602ad3b3SJon Loeliger		except those marked below with a "*".
711602ad3b3SJon Loeliger
712602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
713602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
714602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
715602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
716602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
717602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
718602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
719602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
720710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
721602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
722602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
723602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
724a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
725a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
726a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
727a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
728602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
729602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
730246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
731602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
732602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7330c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
734bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
735602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
736602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
737602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
738602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
739602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
740a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
741a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
742602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
743602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
744602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
745602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
746602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
747602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7480c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
749602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
750602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
751602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
752602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7531ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
754602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
755602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
75602c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
75702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
758602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
75956523f12Swdenk					  loop, loopw, mtest
760602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
761602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
762602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
76368d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
764602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
765602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
766e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
767e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
768602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
769602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
770602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
771602ad3b3SJon Loeliger					  host
772602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
773602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
774602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
775602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
776602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
777602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
778602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
779602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
780602ad3b3SJon Loeliger					  (4xx only)
781c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
78202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
78374de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
784602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
7857a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
786602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
787602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
788602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
789c609719bSwdenk
790c609719bSwdenk
791c609719bSwdenk		EXAMPLE: If you want all functions except of network
792c609719bSwdenk		support you can write:
793c609719bSwdenk
794602ad3b3SJon Loeliger		#include "config_cmd_all.h"
795602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
796c609719bSwdenk
797213bf8c8SGerald Van Baren	Other Commands:
798213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
799c609719bSwdenk
800c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
801602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
802c609719bSwdenk		what you (and your U-Boot users) are doing. Data
803c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
804c609719bSwdenk		8260 (where accesses to the IMMR region must be
805c609719bSwdenk		uncached), and it cannot be disabled on all other
806c609719bSwdenk		systems where we (mis-) use the data cache to hold an
807c609719bSwdenk		initial stack and some data.
808c609719bSwdenk
809c609719bSwdenk
810c609719bSwdenk		XXX - this list needs to get updated!
811c609719bSwdenk
812c609719bSwdenk- Watchdog:
813c609719bSwdenk		CONFIG_WATCHDOG
814c609719bSwdenk		If this variable is defined, it enables watchdog
8156abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8166abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8176abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8186abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8196abe6fb6SDetlev Zundel		available, then no further board specific code should
8206abe6fb6SDetlev Zundel		be needed to use it.
8216abe6fb6SDetlev Zundel
8226abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8236abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8246abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8256abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
826c609719bSwdenk
827c1551ea8Sstroese- U-Boot Version:
828c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
829c1551ea8Sstroese		If this variable is defined, an environment variable
830c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
831c1551ea8Sstroese		version as printed by the "version" command.
832c1551ea8Sstroese		This variable is readonly.
833c1551ea8Sstroese
834c609719bSwdenk- Real-Time Clock:
835c609719bSwdenk
836602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
837c609719bSwdenk		has to be selected, too. Define exactly one of the
838c609719bSwdenk		following options:
839c609719bSwdenk
840c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
841c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
8427ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
843c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
8441cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
845c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
8467f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
8473bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
8489536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
8494c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
8506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
85171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
85271d19f30SHeiko Schocher					  RV3029 RTC.
853c609719bSwdenk
854b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
855b37c7e5eSwdenk		must also be configured. See I2C Support, below.
856b37c7e5eSwdenk
857e92739d3SPeter Tyser- GPIO Support:
858e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
859e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
860e92739d3SPeter Tyser
8615dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
8625dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
8635dec49caSChris Packham		pins supported by a particular chip.
8645dec49caSChris Packham
865e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
866e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
867e92739d3SPeter Tyser
868c609719bSwdenk- Timestamp Support:
869c609719bSwdenk
870c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
871c609719bSwdenk		(date and time) of an image is printed by image
872c609719bSwdenk		commands like bootm or iminfo. This option is
873602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
874c609719bSwdenk
875c609719bSwdenk- Partition Support:
876c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
87707f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
878c609719bSwdenk
879602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
880218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
881218ca724SWolfgang Denk		least one partition type as well.
882c609719bSwdenk
883c609719bSwdenk- IDE Reset method:
8844d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8854d13cbadSwdenk		board configurations files but used nowhere!
886c609719bSwdenk
8874d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8884d13cbadSwdenk		be performed by calling the function
8894d13cbadSwdenk			ide_set_reset(int reset)
8904d13cbadSwdenk		which has to be defined in a board specific file
891c609719bSwdenk
892c609719bSwdenk- ATAPI Support:
893c609719bSwdenk		CONFIG_ATAPI
894c609719bSwdenk
895c609719bSwdenk		Set this to enable ATAPI support.
896c609719bSwdenk
897c40b2956Swdenk- LBA48 Support
898c40b2956Swdenk		CONFIG_LBA48
899c40b2956Swdenk
900c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9014b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
902c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
903c40b2956Swdenk		support disks up to 2.1TB.
904c40b2956Swdenk
9056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
906c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
907c40b2956Swdenk			Default is 32bit.
908c40b2956Swdenk
909c609719bSwdenk- SCSI Support:
910c609719bSwdenk		At the moment only there is only support for the
911c609719bSwdenk		SYM53C8XX SCSI controller; define
912c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
913c609719bSwdenk
9146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
917c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
918c609719bSwdenk		devices.
9196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
920c609719bSwdenk
921c609719bSwdenk- NETWORK Support (PCI):
922682011ffSwdenk		CONFIG_E1000
923682011ffSwdenk		Support for Intel 8254x gigabit chips.
924682011ffSwdenk
925ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
92611ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
927ac3315c2SAndre Schwarz
928c609719bSwdenk		CONFIG_EEPRO100
929c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
93011ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
931c609719bSwdenk		write routine for first time initialisation.
932c609719bSwdenk
933c609719bSwdenk		CONFIG_TULIP
934c609719bSwdenk		Support for Digital 2114x chips.
935c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
936c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
937c609719bSwdenk
938c609719bSwdenk		CONFIG_NATSEMI
939c609719bSwdenk		Support for National dp83815 chips.
940c609719bSwdenk
941c609719bSwdenk		CONFIG_NS8382X
942c609719bSwdenk		Support for National dp8382[01] gigabit chips.
943c609719bSwdenk
94445219c46Swdenk- NETWORK Support (other):
94545219c46Swdenk
946c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
947c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
948c041e9d2SJens Scharsig
949c041e9d2SJens Scharsig			CONFIG_RMII
950c041e9d2SJens Scharsig			Define this to use reduced MII inteface
951c041e9d2SJens Scharsig
952c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
953c041e9d2SJens Scharsig			If this defined, the driver is quiet.
954c041e9d2SJens Scharsig			The driver doen't show link status messages.
955c041e9d2SJens Scharsig
95645219c46Swdenk		CONFIG_DRIVER_LAN91C96
95745219c46Swdenk		Support for SMSC's LAN91C96 chips.
95845219c46Swdenk
95945219c46Swdenk			CONFIG_LAN91C96_BASE
96045219c46Swdenk			Define this to hold the physical address
96145219c46Swdenk			of the LAN91C96's I/O space
96245219c46Swdenk
96345219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
96445219c46Swdenk			Define this to enable 32 bit addressing
96545219c46Swdenk
966f39748aeSwdenk		CONFIG_DRIVER_SMC91111
967f39748aeSwdenk		Support for SMSC's LAN91C111 chip
968f39748aeSwdenk
969f39748aeSwdenk			CONFIG_SMC91111_BASE
970f39748aeSwdenk			Define this to hold the physical address
971f39748aeSwdenk			of the device (I/O space)
972f39748aeSwdenk
973f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
974f39748aeSwdenk			Define this if data bus is 32 bits
975f39748aeSwdenk
976f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
977f39748aeSwdenk			Define this to use i/o functions instead of macros
978f39748aeSwdenk			(some hardware wont work with macros)
979f39748aeSwdenk
980b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
981b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
982b3dbf4a5SMacpaul Lin
983b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
984b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
985b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
986b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
987b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
988b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
989b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
990b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
991b3dbf4a5SMacpaul Lin
992c2fff331SMike Rapoport		CONFIG_SMC911X
993557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
994557b377dSJens Gehrlein
995c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
996557b377dSJens Gehrlein			Define this to hold the physical address
997557b377dSJens Gehrlein			of the device (I/O space)
998557b377dSJens Gehrlein
999c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1000557b377dSJens Gehrlein			Define this if data bus is 32 bits
1001557b377dSJens Gehrlein
1002c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1003557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1004557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1005c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1006557b377dSJens Gehrlein
10073d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
10083d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
10093d0075faSYoshihiro Shimoda
10103d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
10113d0075faSYoshihiro Shimoda			Define the number of ports to be used
10123d0075faSYoshihiro Shimoda
10133d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
10143d0075faSYoshihiro Shimoda			Define the ETH PHY's address
10153d0075faSYoshihiro Shimoda
101668260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
101768260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
101868260aabSYoshihiro Shimoda
1019c609719bSwdenk- USB Support:
1020c609719bSwdenk		At the moment only the UHCI host controller is
10214d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1022c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1023c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
102430d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1025c609719bSwdenk		storage devices.
1026c609719bSwdenk		Note:
1027c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1028c609719bSwdenk		(TEAC FD-05PUB).
10294d13cbadSwdenk		MPC5200 USB requires additional defines:
10304d13cbadSwdenk			CONFIG_USB_CLOCK
10314d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1032307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1033307ecb6dSEric Millbrandt				for USB on PSC3
10344d13cbadSwdenk			CONFIG_USB_CONFIG
10354d13cbadSwdenk				for differential drivers: 0x00001000
10364d13cbadSwdenk				for single ended drivers: 0x00005000
1037307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1038307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
10396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1040fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1041fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
10424d13cbadSwdenk
104316c8d5e7SWolfgang Denk- USB Device:
104416c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
104516c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
104616c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
104711ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
104816c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
104916c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
105016c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
105116c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
105216c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
105316c8d5e7SWolfgang Denk		a Linux host by
105416c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
105516c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
105616c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
105716c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
105816c8d5e7SWolfgang Denk
105916c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
106016c8d5e7SWolfgang Denk			Define this to build a UDC device
106116c8d5e7SWolfgang Denk
106216c8d5e7SWolfgang Denk			CONFIG_USB_TTY
106316c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
106416c8d5e7SWolfgang Denk			talk to the UDC device
106516c8d5e7SWolfgang Denk
10666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
106716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
106816c8d5e7SWolfgang Denk			be set to usbtty.
106916c8d5e7SWolfgang Denk
107016c8d5e7SWolfgang Denk			mpc8xx:
10716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
107216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
107416c8d5e7SWolfgang Denk
10756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
107616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
10776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
107816c8d5e7SWolfgang Denk
107916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
108016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
108116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
108216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
108316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
108416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
108516c8d5e7SWolfgang Denk
108616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
108716c8d5e7SWolfgang Denk			Define this string as the name of your company for
108816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
108916c8d5e7SWolfgang Denk
109016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
109116c8d5e7SWolfgang Denk			Define this string as the name of your product
109216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
109316c8d5e7SWolfgang Denk
109416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
109516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
109616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
109716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
109816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
109916c8d5e7SWolfgang Denk
110016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
110116c8d5e7SWolfgang Denk			Define this as the unique Product ID
110216c8d5e7SWolfgang Denk			for your device
110316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1104c609719bSwdenk
1105c609719bSwdenk
1106c609719bSwdenk- MMC Support:
1107c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1108c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1109c609719bSwdenk		accessed from the boot prompt by mapping the device
1110c609719bSwdenk		to physical memory similar to flash. Command line is
1111602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1112602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1113c609719bSwdenk
1114afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1115afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1116afb35666SYoshihiro Shimoda
1117afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1118afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1119afb35666SYoshihiro Shimoda
1120afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1121afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1122afb35666SYoshihiro Shimoda
11236705d81eSwdenk- Journaling Flash filesystem support:
11246705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
11256705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
11266705d81eSwdenk		Define these for a default partition on a NAND device
11276705d81eSwdenk
11286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
11296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
11306705d81eSwdenk		Define these for a default partition on a NOR device
11316705d81eSwdenk
11326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
11336705d81eSwdenk		Define this to create an own partition. You have to provide a
11346705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
11356705d81eSwdenk
11366705d81eSwdenk		If you define only one JFFS2 partition you may also want to
11376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
11386705d81eSwdenk		to disable the command chpart. This is the default when you
11396705d81eSwdenk		have not defined a custom partition
11406705d81eSwdenk
1141c609719bSwdenk- Keyboard Support:
1142c609719bSwdenk		CONFIG_ISA_KEYBOARD
1143c609719bSwdenk
1144c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1145c609719bSwdenk		support
1146c609719bSwdenk
1147c609719bSwdenk		CONFIG_I8042_KBD
1148c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1149c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1150c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1151c609719bSwdenk		for cfb_console. Supports cursor blinking.
1152c609719bSwdenk
1153c609719bSwdenk- Video support:
1154c609719bSwdenk		CONFIG_VIDEO
1155c609719bSwdenk
1156c609719bSwdenk		Define this to enable video support (for output to
1157c609719bSwdenk		video).
1158c609719bSwdenk
1159c609719bSwdenk		CONFIG_VIDEO_CT69000
1160c609719bSwdenk
1161c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1162c609719bSwdenk
1163c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1164eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1165eeb1b77bSwdenk		video output is selected via environment 'videoout'
1166eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1167eeb1b77bSwdenk		assumed.
1168c609719bSwdenk
1169eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
117011ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1171eeb1b77bSwdenk		are possible:
1172eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1173eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1174eeb1b77bSwdenk
1175eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1176eeb1b77bSwdenk		-------------+---------------------------------------------
1177eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1178eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1179eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1180eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1181eeb1b77bSwdenk		-------------+---------------------------------------------
1182c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1183c609719bSwdenk
1184eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
11857817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1186eeb1b77bSwdenk
1187eeb1b77bSwdenk
1188a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1189a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1190a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1191a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1192a6c7ad2fSwdenk
11937d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
11947d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
11957d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
11967d3053fbSTimur Tabi		support, and should also define these other macros:
11977d3053fbSTimur Tabi
11987d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
11997d3053fbSTimur Tabi			CONFIG_VIDEO
12007d3053fbSTimur Tabi			CONFIG_CMD_BMP
12017d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
12027d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
12037d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
12047d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
12057d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
12067d3053fbSTimur Tabi
1207ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1208ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1209ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1210ba8e76bdSTimur Tabi		description of this variable.
12117d3053fbSTimur Tabi
1212682011ffSwdenk- Keyboard Support:
1213682011ffSwdenk		CONFIG_KEYBOARD
1214682011ffSwdenk
1215682011ffSwdenk		Define this to enable a custom keyboard support.
1216682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1217682011ffSwdenk		defined in your board-specific files.
1218682011ffSwdenk		The only board using this so far is RBC823.
1219a6c7ad2fSwdenk
1220c609719bSwdenk- LCD Support:	CONFIG_LCD
1221c609719bSwdenk
1222c609719bSwdenk		Define this to enable LCD support (for output to LCD
1223c609719bSwdenk		display); also select one of the supported displays
1224c609719bSwdenk		by defining one of these:
1225c609719bSwdenk
122639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
122739cf4804SStelian Pop
122839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
122939cf4804SStelian Pop
1230fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1231c609719bSwdenk
1232fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1233c609719bSwdenk
1234fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1235c609719bSwdenk
1236fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1237fd3103bbSwdenk			Active, color, single scan.
1238fd3103bbSwdenk
1239fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1240fd3103bbSwdenk
1241fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1242c609719bSwdenk			Active, color, single scan.
1243c609719bSwdenk
1244c609719bSwdenk		CONFIG_SHARP_16x9
1245c609719bSwdenk
1246c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1247c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1248c609719bSwdenk
1249c609719bSwdenk		CONFIG_SHARP_LQ64D341
1250c609719bSwdenk
1251c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1252c609719bSwdenk			Active, color, single scan.
1253c609719bSwdenk
1254c609719bSwdenk		CONFIG_HLD1045
1255c609719bSwdenk
1256c609719bSwdenk			HLD1045 display, 640x480.
1257c609719bSwdenk			Active, color, single scan.
1258c609719bSwdenk
1259c609719bSwdenk		CONFIG_OPTREX_BW
1260c609719bSwdenk
1261c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1262c609719bSwdenk			or
1263c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1264c609719bSwdenk			or
1265c609719bSwdenk			Hitachi	 SP14Q002
1266c609719bSwdenk
1267c609719bSwdenk			320x240. Black & white.
1268c609719bSwdenk
1269c609719bSwdenk		Normally display is black on white background; define
12706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1271c609719bSwdenk
12727152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1273d791b1dcSwdenk
1274d791b1dcSwdenk		If this option is set, the environment is checked for
1275d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1276d791b1dcSwdenk		of logo, copyright and system information on the LCD
1277e94d2cd9Swdenk		is suppressed and the BMP image at the address
1278d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1279d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1280d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1281d791b1dcSwdenk		loaded very quickly after power-on.
1282d791b1dcSwdenk
12831ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
12841ca298ceSMatthias Weisser
12851ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
12861ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
12871ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
12881ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
12891ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
12901ca298ceSMatthias Weisser		specify 'm' for centering the image.
12911ca298ceSMatthias Weisser
12921ca298ceSMatthias Weisser		Example:
12931ca298ceSMatthias Weisser		setenv splashpos m,m
12941ca298ceSMatthias Weisser			=> image at center of screen
12951ca298ceSMatthias Weisser
12961ca298ceSMatthias Weisser		setenv splashpos 30,20
12971ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
12981ca298ceSMatthias Weisser
12991ca298ceSMatthias Weisser		setenv splashpos -10,m
13001ca298ceSMatthias Weisser			=> vertically centered image
13011ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
13021ca298ceSMatthias Weisser
130398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
130498f4a3dfSStefan Roese
130598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
130698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
130798f4a3dfSStefan Roese		splashscreen support or the bmp command.
130898f4a3dfSStefan Roese
1309d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1310d5011762SAnatolij Gustschin
1311d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1312d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1313d5011762SAnatolij Gustschin		bmp command.
1314d5011762SAnatolij Gustschin
1315c29fdfc1Swdenk- Compression support:
1316c29fdfc1Swdenk		CONFIG_BZIP2
1317c29fdfc1Swdenk
1318c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1319c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1320c29fdfc1Swdenk		compressed images are supported.
1321c29fdfc1Swdenk
1322c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
13236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1324c29fdfc1Swdenk		be at least 4MB.
1325d791b1dcSwdenk
1326fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1327fc9c1727SLuigi 'Comio' Mantellini
1328fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1329fc9c1727SLuigi 'Comio' Mantellini		images is included.
1330fc9c1727SLuigi 'Comio' Mantellini
1331fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1332fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1333fc9c1727SLuigi 'Comio' Mantellini		formula:
1334fc9c1727SLuigi 'Comio' Mantellini
1335fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1336fc9c1727SLuigi 'Comio' Mantellini
1337fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1338fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1339fc9c1727SLuigi 'Comio' Mantellini
1340fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1341fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1342fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1343fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1344fc9c1727SLuigi 'Comio' Mantellini
1345fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1346fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
13476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1348fc9c1727SLuigi 'Comio' Mantellini
134917ea1177Swdenk- MII/PHY support:
135017ea1177Swdenk		CONFIG_PHY_ADDR
135117ea1177Swdenk
135217ea1177Swdenk		The address of PHY on MII bus.
135317ea1177Swdenk
135417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
135517ea1177Swdenk
135617ea1177Swdenk		The clock frequency of the MII bus
135717ea1177Swdenk
135817ea1177Swdenk		CONFIG_PHY_GIGE
135917ea1177Swdenk
136017ea1177Swdenk		If this option is set, support for speed/duplex
136111ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
136217ea1177Swdenk
136317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
136417ea1177Swdenk
136517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
136617ea1177Swdenk		reset before any MII register access is possible.
136717ea1177Swdenk		For such PHY, set this option to the usec delay
136817ea1177Swdenk		required. (minimum 300usec for LXT971A)
136917ea1177Swdenk
137017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
137117ea1177Swdenk
137217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
137317ea1177Swdenk		command issued before MII status register can be read
137417ea1177Swdenk
1375c609719bSwdenk- Ethernet address:
1376c609719bSwdenk		CONFIG_ETHADDR
1377c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1378c609719bSwdenk		CONFIG_ETH2ADDR
1379c609719bSwdenk		CONFIG_ETH3ADDR
1380c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1381c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1382c609719bSwdenk
138311ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
138411ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1385c609719bSwdenk		is not determined automatically.
1386c609719bSwdenk
1387c609719bSwdenk- IP address:
1388c609719bSwdenk		CONFIG_IPADDR
1389c609719bSwdenk
1390c609719bSwdenk		Define a default value for the IP address to use for
139111ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1392c609719bSwdenk		determined through e.g. bootp.
1393c609719bSwdenk
1394c609719bSwdenk- Server IP address:
1395c609719bSwdenk		CONFIG_SERVERIP
1396c609719bSwdenk
1397c609719bSwdenk		Defines a default value for the IP address of a TFTP
1398c609719bSwdenk		server to contact when using the "tftboot" command.
1399c609719bSwdenk
140097cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
140197cfe861SRobin Getz
140297cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
140397cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
140497cfe861SRobin Getz
140553a5c424SDavid Updegraff- Multicast TFTP Mode:
140653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
140753a5c424SDavid Updegraff
140853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
140953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
141011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
141153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
141253a5c424SDavid Updegraff		multicast group.
141353a5c424SDavid Updegraff
1414c609719bSwdenk- BOOTP Recovery Mode:
1415c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1416c609719bSwdenk
1417c609719bSwdenk		If you have many targets in a network that try to
1418c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1419c609719bSwdenk		systems send out BOOTP requests at precisely the same
1420c609719bSwdenk		moment (which would happen for instance at recovery
1421c609719bSwdenk		from a power failure, when all systems will try to
1422c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1423c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1424c609719bSwdenk		inserted before sending out BOOTP requests. The
14256c33c785SWolfgang Denk		following delays are inserted then:
1426c609719bSwdenk
1427c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1428c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1429c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1430c609719bSwdenk		4th and following
1431c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1432c609719bSwdenk
1433fe389a82Sstroese- DHCP Advanced Options:
14341fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
14351fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1436fe389a82Sstroese
14371fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
14381fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
14391fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
14401fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
14411fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
14421fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
14431fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
14441fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
14451fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
14461fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
14471fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
14481fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1449fe389a82Sstroese
14505d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
14515d110f0aSWilson Callan		environment variable, not the BOOTP server.
1452fe389a82Sstroese
1453fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1454fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1455fe389a82Sstroese		than one DNS serverip is offered to the client.
1456fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1457fe389a82Sstroese		serverip will be stored in the additional environment
1458fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1459fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
14601fe80d79SJon Loeliger		is defined.
1461fe389a82Sstroese
1462fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1463fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1464fe389a82Sstroese		need the hostname of the DHCP requester.
14655d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
14661fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
14671fe80d79SJon Loeliger		option 12 to the DHCP server.
1468fe389a82Sstroese
1469d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1470d9a2f416SAras Vaichas
1471d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1472d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1473d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1474d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1475d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1476d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1477d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1478d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1479d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1480d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1481d9a2f416SAras Vaichas		this delay.
1482d9a2f416SAras Vaichas
1483a3d991bdSwdenk - CDP Options:
1484a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1485a3d991bdSwdenk
1486a3d991bdSwdenk		The device id used in CDP trigger frames.
1487a3d991bdSwdenk
1488a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1489a3d991bdSwdenk
1490a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1491a3d991bdSwdenk		of the device.
1492a3d991bdSwdenk
1493a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1494a3d991bdSwdenk
1495a3d991bdSwdenk		A printf format string which contains the ascii name of
1496a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
149711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1498a3d991bdSwdenk
1499a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1500a3d991bdSwdenk
1501a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1502a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1503a3d991bdSwdenk
1504a3d991bdSwdenk		CONFIG_CDP_VERSION
1505a3d991bdSwdenk
1506a3d991bdSwdenk		An ascii string containing the version of the software.
1507a3d991bdSwdenk
1508a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1509a3d991bdSwdenk
1510a3d991bdSwdenk		An ascii string containing the name of the platform.
1511a3d991bdSwdenk
1512a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1513a3d991bdSwdenk
1514a3d991bdSwdenk		A 32bit integer sent on the trigger.
1515a3d991bdSwdenk
1516a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1517a3d991bdSwdenk
1518a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1519a3d991bdSwdenk		device in .1 of milliwatts.
1520a3d991bdSwdenk
1521a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1522a3d991bdSwdenk
1523a3d991bdSwdenk		A byte containing the id of the VLAN.
1524a3d991bdSwdenk
1525c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1526c609719bSwdenk
1527c609719bSwdenk		Several configurations allow to display the current
1528c609719bSwdenk		status using a LED. For instance, the LED will blink
1529c609719bSwdenk		fast while running U-Boot code, stop blinking as
1530c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1531c609719bSwdenk		start blinking slow once the Linux kernel is running
1532c609719bSwdenk		(supported by a status LED driver in the Linux
1533c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1534c609719bSwdenk		feature in U-Boot.
1535c609719bSwdenk
1536c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1537c609719bSwdenk
1538c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1539c609719bSwdenk		on those systems that support this (optional)
1540c609719bSwdenk		feature, like the TQM8xxL modules.
1541c609719bSwdenk
1542c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1543c609719bSwdenk
1544b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1545b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
154611ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1547c609719bSwdenk
1548b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1549602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1550b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1551b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1552c609719bSwdenk		command line interface.
1553c609719bSwdenk
1554bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1555c609719bSwdenk
1556b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1557b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1558b37c7e5eSwdenk		support for I2C.
1559c609719bSwdenk
1560b37c7e5eSwdenk		There are several other quantities that must also be
1561b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1562c609719bSwdenk
15636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1564b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
15656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
156611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1567c609719bSwdenk
15688d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1569a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
15708d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
15718d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
15728d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1573b37c7e5eSwdenk
15745da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
15755da71efaSEric Millbrandt
15765da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
15775da71efaSEric Millbrandt		chips might think that the current transfer is still
15785da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
15795da71efaSEric Millbrandt		commands until the slave device responds.
15805da71efaSEric Millbrandt
1581b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1582b37c7e5eSwdenk
1583b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1584b37c7e5eSwdenk		then the following macros need to be defined (examples are
1585b37c7e5eSwdenk		from include/configs/lwmon.h):
1586c609719bSwdenk
1587c609719bSwdenk		I2C_INIT
1588c609719bSwdenk
1589b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1590c609719bSwdenk		controller or configure ports.
1591c609719bSwdenk
1592b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1593b37c7e5eSwdenk
1594c609719bSwdenk		I2C_PORT
1595c609719bSwdenk
1596c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1597c609719bSwdenk		assumes both bits are on the same port). Valid values
1598c609719bSwdenk		are 0..3 for ports A..D.
1599c609719bSwdenk
1600c609719bSwdenk		I2C_ACTIVE
1601c609719bSwdenk
1602c609719bSwdenk		The code necessary to make the I2C data line active
1603c609719bSwdenk		(driven).  If the data line is open collector, this
1604c609719bSwdenk		define can be null.
1605c609719bSwdenk
1606b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1607b37c7e5eSwdenk
1608c609719bSwdenk		I2C_TRISTATE
1609c609719bSwdenk
1610c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1611c609719bSwdenk		(inactive).  If the data line is open collector, this
1612c609719bSwdenk		define can be null.
1613c609719bSwdenk
1614b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1615b37c7e5eSwdenk
1616c609719bSwdenk		I2C_READ
1617c609719bSwdenk
1618c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1619c609719bSwdenk		FALSE if it is low.
1620c609719bSwdenk
1621b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1622b37c7e5eSwdenk
1623c609719bSwdenk		I2C_SDA(bit)
1624c609719bSwdenk
1625c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1626c609719bSwdenk		is FALSE, it clears it (low).
1627c609719bSwdenk
1628b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1629b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1630b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1631b37c7e5eSwdenk
1632c609719bSwdenk		I2C_SCL(bit)
1633c609719bSwdenk
1634c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1635c609719bSwdenk		is FALSE, it clears it (low).
1636c609719bSwdenk
1637b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1638b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1639b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1640b37c7e5eSwdenk
1641c609719bSwdenk		I2C_DELAY
1642c609719bSwdenk
1643c609719bSwdenk		This delay is invoked four times per clock cycle so this
1644c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1645b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1646b37c7e5eSwdenk		like:
1647b37c7e5eSwdenk
1648b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1649c609719bSwdenk
1650793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1651793b5726SMike Frysinger
1652793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1653793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1654793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1655793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1656793b5726SMike Frysinger
1657793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1658793b5726SMike Frysinger		the generic GPIO functions.
1659793b5726SMike Frysinger
16606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
166147cd00faSwdenk
166247cd00faSwdenk		When a board is reset during an i2c bus transfer
166347cd00faSwdenk		chips might think that the current transfer is still
166447cd00faSwdenk		in progress. On some boards it is possible to access
166547cd00faSwdenk		the i2c SCLK line directly, either by using the
166647cd00faSwdenk		processor pin as a GPIO or by having a second pin
166747cd00faSwdenk		connected to the bus. If this option is defined a
166847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
166947cd00faSwdenk		is run early in the boot sequence.
167047cd00faSwdenk
167126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
167226a33504SRichard Retanubun
167326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
167426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
167526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
167626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
167726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
167826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
167926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
168026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
168126a33504SRichard Retanubun
168217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
168317ea1177Swdenk
168417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
168517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
168617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
168717ea1177Swdenk
1688bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1689bb99ad6dSBen Warren
1690bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1691bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1692bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1693bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1694bb99ad6dSBen Warren
16956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1696bb99ad6dSBen Warren
1697bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
16980f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
16990f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
17000f89c54bSPeter Tyser		a 1D array of device addresses
1701bb99ad6dSBen Warren
1702bb99ad6dSBen Warren		e.g.
1703bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1705bb99ad6dSBen Warren
1706bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1707bb99ad6dSBen Warren
1708bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
17096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1710bb99ad6dSBen Warren
1711bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1712bb99ad6dSBen Warren
17136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1714be5e6181STimur Tabi
1715be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1716be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1717be5e6181STimur Tabi
17186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
17190dc018ecSStefan Roese
17200dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
17210dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
17220dc018ecSStefan Roese
17236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
17240dc018ecSStefan Roese
17250dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
17260dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
17270dc018ecSStefan Roese
17286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
17299ebbb54fSVictor Gallardo
17309ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
17319ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
17329ebbb54fSVictor Gallardo		specified DTT device.
17339ebbb54fSVictor Gallardo
1734be5e6181STimur Tabi		CONFIG_FSL_I2C
1735be5e6181STimur Tabi
1736be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
17377817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1738be5e6181STimur Tabi
173967b23a32SHeiko Schocher		CONFIG_I2C_MUX
174067b23a32SHeiko Schocher
174167b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
174267b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
174367b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
174467b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
174567b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
174667b23a32SHeiko Schocher		the muxes to activate this new "bus".
174767b23a32SHeiko Schocher
174867b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
174967b23a32SHeiko Schocher		feature!
175067b23a32SHeiko Schocher
175167b23a32SHeiko Schocher		Example:
175267b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
175367b23a32SHeiko Schocher			The First mux with address 70 and channel 6
175467b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
175567b23a32SHeiko Schocher
175667b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
175767b23a32SHeiko Schocher
175867b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
175967b23a32SHeiko Schocher		of I2C Busses with muxes:
176067b23a32SHeiko Schocher
176167b23a32SHeiko Schocher		=> i2c bus
176267b23a32SHeiko Schocher		Busses reached over muxes:
176367b23a32SHeiko Schocher		Bus ID: 2
176467b23a32SHeiko Schocher		  reached over Mux(es):
176567b23a32SHeiko Schocher		    pca9544a@70 ch: 4
176667b23a32SHeiko Schocher		Bus ID: 3
176767b23a32SHeiko Schocher		  reached over Mux(es):
176867b23a32SHeiko Schocher		    pca9544a@70 ch: 6
176967b23a32SHeiko Schocher		    pca9544a@71 ch: 4
177067b23a32SHeiko Schocher		=>
177167b23a32SHeiko Schocher
177267b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1773f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1774f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
177567b23a32SHeiko Schocher		the channel 4.
177667b23a32SHeiko Schocher
177767b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1778f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
177967b23a32SHeiko Schocher		the 2 muxes.
178067b23a32SHeiko Schocher
178167b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
178267b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
178367b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
178467b23a32SHeiko Schocher		to add this option to other architectures.
178567b23a32SHeiko Schocher
17862ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
17872ac6985aSAndrew Dyer
17882ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
17892ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
17902ac6985aSAndrew Dyer		between writing the address pointer and reading the
17912ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
17922ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
17932ac6985aSAndrew Dyer		devices can use either method, but some require one or
17942ac6985aSAndrew Dyer		the other.
1795be5e6181STimur Tabi
1796c609719bSwdenk- SPI Support:	CONFIG_SPI
1797c609719bSwdenk
1798c609719bSwdenk		Enables SPI driver (so far only tested with
1799c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1800c609719bSwdenk		D/As on the SACSng board)
1801c609719bSwdenk
18026639562eSYoshihiro Shimoda		CONFIG_SH_SPI
18036639562eSYoshihiro Shimoda
18046639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
18056639562eSYoshihiro Shimoda		only SH7757 is supported.
18066639562eSYoshihiro Shimoda
1807c609719bSwdenk		CONFIG_SPI_X
1808c609719bSwdenk
1809c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1810c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1811c609719bSwdenk
1812c609719bSwdenk		CONFIG_SOFT_SPI
1813c609719bSwdenk
1814c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1815c609719bSwdenk		using hardware support. This is a general purpose
1816c609719bSwdenk		driver that only requires three general I/O port pins
1817c609719bSwdenk		(two outputs, one input) to function. If this is
1818c609719bSwdenk		defined, the board configuration must define several
1819c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1820c609719bSwdenk		an example, see include/configs/sacsng.h.
1821c609719bSwdenk
182204a9e118SBen Warren		CONFIG_HARD_SPI
182304a9e118SBen Warren
182404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
182504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
182604a9e118SBen Warren		must define a list of chip-select function pointers.
182704a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
182804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
182904a9e118SBen Warren
183038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
183138254f45SGuennadi Liakhovetski
183238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
183338254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
183438254f45SGuennadi Liakhovetski
18350133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
18360133502eSMatthias Fuchs
18370133502eSMatthias Fuchs		Enables FPGA subsystem.
18380133502eSMatthias Fuchs
18390133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
18400133502eSMatthias Fuchs
18410133502eSMatthias Fuchs		Enables support for specific chip vendors.
18420133502eSMatthias Fuchs		(ALTERA, XILINX)
18430133502eSMatthias Fuchs
18440133502eSMatthias Fuchs		CONFIG_FPGA_<family>
18450133502eSMatthias Fuchs
18460133502eSMatthias Fuchs		Enables support for FPGA family.
18470133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
18480133502eSMatthias Fuchs
18490133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1850c609719bSwdenk
1851c609719bSwdenk		Specify the number of FPGA devices to support.
1852c609719bSwdenk
18536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1854c609719bSwdenk
1855c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1856c609719bSwdenk
18576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1858c609719bSwdenk
1859c609719bSwdenk		Enable checks on FPGA configuration interface busy
1860c609719bSwdenk		status by the configuration function. This option
1861c609719bSwdenk		will require a board or device specific function to
1862c609719bSwdenk		be written.
1863c609719bSwdenk
1864c609719bSwdenk		CONFIG_FPGA_DELAY
1865c609719bSwdenk
1866c609719bSwdenk		If defined, a function that provides delays in the FPGA
1867c609719bSwdenk		configuration driver.
1868c609719bSwdenk
18696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1870c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1871c609719bSwdenk
18726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1873c609719bSwdenk
1874c609719bSwdenk		Check for configuration errors during FPGA bitfile
1875c609719bSwdenk		loading. For example, abort during Virtex II
1876c609719bSwdenk		configuration if the INIT_B line goes low (which
1877c609719bSwdenk		indicated a CRC error).
1878c609719bSwdenk
18796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1880c609719bSwdenk
1881c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1882c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1883c609719bSwdenk		FPGA configuration sequence. The default time is 500
188411ccc33fSMarcel Ziswiler		ms.
1885c609719bSwdenk
18866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1887c609719bSwdenk
1888c609719bSwdenk		Maximum time to wait for BUSY to deassert during
188911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1890c609719bSwdenk
18916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1892c609719bSwdenk
1893c609719bSwdenk		Time to wait after FPGA configuration. The default is
189411ccc33fSMarcel Ziswiler		200 ms.
1895c609719bSwdenk
1896c609719bSwdenk- Configuration Management:
1897c609719bSwdenk		CONFIG_IDENT_STRING
1898c609719bSwdenk
1899c609719bSwdenk		If defined, this string will be added to the U-Boot
1900c609719bSwdenk		version information (U_BOOT_VERSION)
1901c609719bSwdenk
1902c609719bSwdenk- Vendor Parameter Protection:
1903c609719bSwdenk
1904c609719bSwdenk		U-Boot considers the values of the environment
1905c609719bSwdenk		variables "serial#" (Board Serial Number) and
19067152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1907c609719bSwdenk		are set once by the board vendor / manufacturer, and
1908c609719bSwdenk		protects these variables from casual modification by
1909c609719bSwdenk		the user. Once set, these variables are read-only,
1910c609719bSwdenk		and write or delete attempts are rejected. You can
191111ccc33fSMarcel Ziswiler		change this behaviour:
1912c609719bSwdenk
1913c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1914c609719bSwdenk		file, the write protection for vendor parameters is
191547cd00faSwdenk		completely disabled. Anybody can change or delete
1916c609719bSwdenk		these parameters.
1917c609719bSwdenk
1918c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1919c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
192011ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1921c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1922c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1923c609719bSwdenk		read-only.]
1924c609719bSwdenk
1925c609719bSwdenk- Protected RAM:
1926c609719bSwdenk		CONFIG_PRAM
1927c609719bSwdenk
1928c609719bSwdenk		Define this variable to enable the reservation of
1929c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1930c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1931c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1932c609719bSwdenk		this default value by defining an environment
1933c609719bSwdenk		variable "pram" to the number of kB you want to
1934c609719bSwdenk		reserve. Note that the board info structure will
1935c609719bSwdenk		still show the full amount of RAM. If pRAM is
1936c609719bSwdenk		reserved, a new environment variable "mem" will
1937c609719bSwdenk		automatically be defined to hold the amount of
1938c609719bSwdenk		remaining RAM in a form that can be passed as boot
1939c609719bSwdenk		argument to Linux, for instance like that:
1940c609719bSwdenk
1941fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1942c609719bSwdenk			saveenv
1943c609719bSwdenk
1944c609719bSwdenk		This way you can tell Linux not to use this memory,
1945c609719bSwdenk		either, which results in a memory region that will
1946c609719bSwdenk		not be affected by reboots.
1947c609719bSwdenk
1948c609719bSwdenk		*WARNING* If your board configuration uses automatic
1949c609719bSwdenk		detection of the RAM size, you must make sure that
1950c609719bSwdenk		this memory test is non-destructive. So far, the
1951c609719bSwdenk		following board configurations are known to be
1952c609719bSwdenk		"pRAM-clean":
1953c609719bSwdenk
1954c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1955c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1956544d97e9SWolfgang Denk			FLAGADM, TQM8260
1957c609719bSwdenk
1958c609719bSwdenk- Error Recovery:
1959c609719bSwdenk		CONFIG_PANIC_HANG
1960c609719bSwdenk
1961c609719bSwdenk		Define this variable to stop the system in case of a
1962c609719bSwdenk		fatal error, so that you have to reset it manually.
1963c609719bSwdenk		This is probably NOT a good idea for an embedded
196411ccc33fSMarcel Ziswiler		system where you want the system to reboot
1965c609719bSwdenk		automatically as fast as possible, but it may be
1966c609719bSwdenk		useful during development since you can try to debug
1967c609719bSwdenk		the conditions that lead to the situation.
1968c609719bSwdenk
1969c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1970c609719bSwdenk
1971c609719bSwdenk		This variable defines the number of retries for
1972c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1973c609719bSwdenk		before giving up the operation. If not defined, a
1974c609719bSwdenk		default value of 5 is used.
1975c609719bSwdenk
197640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
197740cb90eeSGuennadi Liakhovetski
197840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
197940cb90eeSGuennadi Liakhovetski
1980c609719bSwdenk- Command Interpreter:
19818078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
198204a85b3bSwdenk
198304a85b3bSwdenk		Enable auto completion of commands using TAB.
198404a85b3bSwdenk
19858078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
19868078f1a5SWolfgang Denk		for the "hush" shell.
19878078f1a5SWolfgang Denk
19888078f1a5SWolfgang Denk
19896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1990c609719bSwdenk
1991c609719bSwdenk		Define this variable to enable the "hush" shell (from
1992c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1993c609719bSwdenk		powerful command line syntax like
1994c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1995c609719bSwdenk		constructs ("shell scripts").
1996c609719bSwdenk
1997c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1998c609719bSwdenk		with a somewhat smaller memory footprint.
1999c609719bSwdenk
2000c609719bSwdenk
20016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2002c609719bSwdenk
2003c609719bSwdenk		This defines the secondary prompt string, which is
2004c609719bSwdenk		printed when the command interpreter needs more input
2005c609719bSwdenk		to complete a command. Usually "> ".
2006c609719bSwdenk
2007c609719bSwdenk	Note:
2008c609719bSwdenk
2009c609719bSwdenk		In the current implementation, the local variables
2010c609719bSwdenk		space and global environment variables space are
2011c609719bSwdenk		separated. Local variables are those you define by
20123b57fe0aSwdenk		simply typing `name=value'. To access a local
2013c609719bSwdenk		variable later on, you have write `$name' or
20143b57fe0aSwdenk		`${name}'; to execute the contents of a variable
20153b57fe0aSwdenk		directly type `$name' at the command prompt.
2016c609719bSwdenk
2017c609719bSwdenk		Global environment variables are those you use
2018c609719bSwdenk		setenv/printenv to work with. To run a command stored
2019c609719bSwdenk		in such a variable, you need to use the run command,
2020c609719bSwdenk		and you must not use the '$' sign to access them.
2021c609719bSwdenk
2022c609719bSwdenk		To store commands and special characters in a
2023c609719bSwdenk		variable, please use double quotation marks
2024c609719bSwdenk		surrounding the whole text of the variable, instead
2025c609719bSwdenk		of the backslashes before semicolons and special
2026c609719bSwdenk		symbols.
2027c609719bSwdenk
2028aa0c71acSWolfgang Denk- Commandline Editing and History:
2029aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2030aa0c71acSWolfgang Denk
203111ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2032aa0c71acSWolfgang Denk		commandline input operations
2033aa0c71acSWolfgang Denk
2034a8c7c708Swdenk- Default Environment:
2035c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2036c609719bSwdenk
2037c609719bSwdenk		Define this to contain any number of null terminated
2038c609719bSwdenk		strings (variable = value pairs) that will be part of
20397152b1d0Swdenk		the default environment compiled into the boot image.
20402262cfeeSwdenk
2041c609719bSwdenk		For example, place something like this in your
2042c609719bSwdenk		board's config file:
2043c609719bSwdenk
2044c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2045c609719bSwdenk			"myvar1=value1\0" \
2046c609719bSwdenk			"myvar2=value2\0"
2047c609719bSwdenk
2048c609719bSwdenk		Warning: This method is based on knowledge about the
2049c609719bSwdenk		internal format how the environment is stored by the
20502262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2051c609719bSwdenk		interface! Although it is unlikely that this format
20527152b1d0Swdenk		will change soon, there is no guarantee either.
2053c609719bSwdenk		You better know what you are doing here.
2054c609719bSwdenk
2055c609719bSwdenk		Note: overly (ab)use of the default environment is
2056c609719bSwdenk		discouraged. Make sure to check other ways to preset
205774de7aefSWolfgang Denk		the environment like the "source" command or the
2058c609719bSwdenk		boot command first.
2059c609719bSwdenk
2060a8c7c708Swdenk- DataFlash Support:
20612abbe075Swdenk		CONFIG_HAS_DATAFLASH
20622abbe075Swdenk
20632abbe075Swdenk		Defining this option enables DataFlash features and
20642abbe075Swdenk		allows to read/write in Dataflash via the standard
20652abbe075Swdenk		commands cp, md...
20662abbe075Swdenk
20673f85ce27Swdenk- SystemACE Support:
20683f85ce27Swdenk		CONFIG_SYSTEMACE
20693f85ce27Swdenk
20703f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
20713f85ce27Swdenk		chips attached via some sort of local bus. The address
207211ccc33fSMarcel Ziswiler		of the chip must also be defined in the
20736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
20743f85ce27Swdenk
20753f85ce27Swdenk		#define CONFIG_SYSTEMACE
20766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
20773f85ce27Swdenk
20783f85ce27Swdenk		When SystemACE support is added, the "ace" device type
20793f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
20803f85ce27Swdenk
2081ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2082ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2083ecb0ccd9SWolfgang Denk
208428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2085ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
208628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2087ecb0ccd9SWolfgang Denk		number generator is used.
2088ecb0ccd9SWolfgang Denk
208928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
209028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
209128cb9375SWolfgang Denk		defined, the normal port 69 is used.
209228cb9375SWolfgang Denk
209328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2094ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2095ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2096ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2097ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2098ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2099ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2100ecb0ccd9SWolfgang Denk
2101a8c7c708Swdenk- Show boot progress:
2102c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2103c609719bSwdenk
2104c609719bSwdenk		Defining this option allows to add some board-
2105c609719bSwdenk		specific code (calling a user-provided function
2106c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2107c609719bSwdenk		the system's boot progress on some display (for
2108c609719bSwdenk		example, some LED's) on your board. At the moment,
2109c609719bSwdenk		the following checkpoints are implemented:
2110c609719bSwdenk
21111372cce2SMarian BalakowiczLegacy uImage format:
21121372cce2SMarian Balakowicz
2113c609719bSwdenk  Arg	Where			When
2114c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2115c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2116c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2117c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2118c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2119c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2120c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2121c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2122c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
21231372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2124c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2125c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2126c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2127c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
21281372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2129c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
21301372cce2SMarian Balakowicz
21311372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
21321372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
21331372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
21341372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
21351372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
21361372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
21371372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
213811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
21391372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
21401372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
21411372cce2SMarian Balakowicz
2142ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2143c609719bSwdenk
2144a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
214563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
214663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
214763e73c9aSwdenk
2148566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2149566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2150566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2151566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2152566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2153566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2154566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2155566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2156566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2157566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2158566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2159566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2160566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2161566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2162566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2163566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2164566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2165566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2166566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2167566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2168566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2169566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2170566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2171566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2172566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2173566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2174566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2175566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2176566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2177566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2178566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2179566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2180566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2181566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2182566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2183566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2184566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2185566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2186566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2187566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2188566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2189566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2190566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2191566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2192566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2193566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2194566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2195c609719bSwdenk
2196566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2197c609719bSwdenk
2198566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2199566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2200566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2201206c60cbSwdenk
2202566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2203566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
220411ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2205566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2206566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2207566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
220874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
220974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2210566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2211c609719bSwdenk
22121372cce2SMarian BalakowiczFIT uImage format:
22131372cce2SMarian Balakowicz
22141372cce2SMarian Balakowicz  Arg	Where			When
22151372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
22161372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
22171372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
22181372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
22191372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
22201372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2221f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
22221372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
22231372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
22241372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
22251372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
22261372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
222711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
222811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
22291372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
22301372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
22311372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
22321372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
22331372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
22341372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
22351372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
22361372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
22371372cce2SMarian Balakowicz
22381372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
22391372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
22401372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
224111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
22421372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
22431372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
22441372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
22451372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
22461372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
22471372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
22481372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
22491372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
22501372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
22511372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
22521372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
22531372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
22541372cce2SMarian Balakowicz
225511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
22561372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
22571372cce2SMarian Balakowicz
225811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
22591372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
22601372cce2SMarian Balakowicz
226111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
22621372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
22631372cce2SMarian Balakowicz
22644cf2609bSWolfgang Denk- Standalone program support:
22654cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
22664cf2609bSWolfgang Denk
2267*6feff899SWolfgang Denk		This option defines a board specific value for the
2268*6feff899SWolfgang Denk		address where standalone program gets loaded, thus
2269*6feff899SWolfgang Denk		overwriting the architecture dependent default
22704cf2609bSWolfgang Denk		settings.
22714cf2609bSWolfgang Denk
22724cf2609bSWolfgang Denk- Frame Buffer Address:
22734cf2609bSWolfgang Denk		CONFIG_FB_ADDR
22744cf2609bSWolfgang Denk
22754cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
22764cf2609bSWolfgang Denk		address for frame buffer.
22774cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
22784cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
2279*6feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
22804cf2609bSWolfgang Denk
22814cf2609bSWolfgang Denk		Please see board_init_f function.
22824cf2609bSWolfgang Denk
2283cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2284cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2285cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2286cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2287cccfc2abSDetlev Zundel
2288cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2289cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2290cccfc2abSDetlev Zundel
2291cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2292cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2293cccfc2abSDetlev Zundel
2294cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2295cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2296cccfc2abSDetlev Zundel
2297cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2298cccfc2abSDetlev Zundel
2299cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2300cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2301cccfc2abSDetlev Zundel
23026a11cf48SDaniel Schwierzeck- SPL framework
23036a11cf48SDaniel Schwierzeck		CONFIG_SPL
23046a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
23056a11cf48SDaniel Schwierzeck
23066a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
23076a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
23086a11cf48SDaniel Schwierzeck
23096a11cf48SDaniel Schwierzeck		CONFIG_SPL_LDSCRIPT
23106a11cf48SDaniel Schwierzeck		LDSCRIPT for linking the SPL binary.
23116a11cf48SDaniel Schwierzeck
23126a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
23136a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
23146a11cf48SDaniel Schwierzeck
23156a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
23166a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
23176a11cf48SDaniel Schwierzeck
23186a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
23196a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
23206a11cf48SDaniel Schwierzeck
23216a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
23226a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
23236a11cf48SDaniel Schwierzeck
23246a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
23256a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
23266a11cf48SDaniel Schwierzeck
23276a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
23286a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
23296a11cf48SDaniel Schwierzeck
23306a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
23316a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
23326a11cf48SDaniel Schwierzeck
23336a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
23346a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
23356a11cf48SDaniel Schwierzeck
23366a11cf48SDaniel Schwierzeck		CONFIG_SPL_FAT_SUPPORT
23376a11cf48SDaniel Schwierzeck		Support for fs/fat/libfat.o in SPL binary
23386a11cf48SDaniel Schwierzeck
23396a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
23406a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
23411372cce2SMarian Balakowicz
2342c609719bSwdenkModem Support:
2343c609719bSwdenk--------------
2344c609719bSwdenk
2345566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2346c609719bSwdenk
234711ccc33fSMarcel Ziswiler- Modem support enable:
2348c609719bSwdenk		CONFIG_MODEM_SUPPORT
2349c609719bSwdenk
2350c609719bSwdenk- RTS/CTS Flow control enable:
2351c609719bSwdenk		CONFIG_HWFLOW
2352c609719bSwdenk
2353c609719bSwdenk- Modem debug support:
2354c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2355c609719bSwdenk
2356c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2357c609719bSwdenk		for modem support. Useful only with BDI2000.
2358c609719bSwdenk
2359a8c7c708Swdenk- Interrupt support (PPC):
2360a8c7c708Swdenk
2361a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2362a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
236311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2364a8c7c708Swdenk		should set decrementer_count to appropriate value. If
236511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2366a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
236711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2368a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2369a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2370a8c7c708Swdenk		general timer_interrupt().
2371a8c7c708Swdenk
2372c609719bSwdenk- General:
2373c609719bSwdenk
2374c609719bSwdenk		In the target system modem support is enabled when a
2375c609719bSwdenk		specific key (key combination) is pressed during
2376c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
237711ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2378c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2379c609719bSwdenk		function, returning 1 and thus enabling modem
2380c609719bSwdenk		initialization.
2381c609719bSwdenk
2382c609719bSwdenk		If there are no modem init strings in the
2383c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2384c609719bSwdenk		previous output (banner, info printfs) will be
238511ccc33fSMarcel Ziswiler		suppressed, though.
2386c609719bSwdenk
2387c609719bSwdenk		See also: doc/README.Modem
2388c609719bSwdenk
2389c609719bSwdenk
2390c609719bSwdenkConfiguration Settings:
2391c609719bSwdenk-----------------------
2392c609719bSwdenk
23936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2394c609719bSwdenk		undefine this when you're short of memory.
2395c609719bSwdenk
23962fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
23972fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
23982fb2604dSPeter Tyser
23996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2400c609719bSwdenk		prompt for user input.
2401c609719bSwdenk
24026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2403c609719bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2405c609719bSwdenk
24066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2407c609719bSwdenk
24086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2409c609719bSwdenk		the application (usually a Linux kernel) when it is
2410c609719bSwdenk		booted
2411c609719bSwdenk
24126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2413c609719bSwdenk		List of legal baudrate settings for this board.
2414c609719bSwdenk
24156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2416c609719bSwdenk		Suppress display of console information at boot.
2417c609719bSwdenk
24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2419c609719bSwdenk		If the board specific function
2420c609719bSwdenk			extern int overwrite_console (void);
2421c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2422c609719bSwdenk		serial port, else the settings in the environment are used.
2423c609719bSwdenk
24246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2425c609719bSwdenk		Enable the call to overwrite_console().
2426c609719bSwdenk
24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2428c609719bSwdenk		Enable overwrite of previous console environment settings.
2429c609719bSwdenk
24306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2431c609719bSwdenk		Begin and End addresses of the area used by the
2432c609719bSwdenk		simple memory test.
2433c609719bSwdenk
24346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2435c609719bSwdenk		Enable an alternate, more extensive memory test.
2436c609719bSwdenk
24376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
24385f535fe1Swdenk		Scratch address used by the alternate memory test
24395f535fe1Swdenk		You only need to set this if address zero isn't writeable
24405f535fe1Swdenk
24416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
24426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
244314f73ca6SStefan Roese		this specified memory area will get subtracted from the top
244411ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
244514f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
244614f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
244714f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
24485e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
244914f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
24505e12e75dSStefan Roese		will have to get fixed in Linux additionally.
245114f73ca6SStefan Roese
245214f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
245314f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
245414f73ca6SStefan Roese		be touched.
245514f73ca6SStefan Roese
245614f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
245714f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
245814f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
245914f73ca6SStefan Roese		non page size aligned address and this could cause major
246014f73ca6SStefan Roese		problems.
246114f73ca6SStefan Roese
24626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2463c609719bSwdenk		Default load address for network file downloads
2464c609719bSwdenk
24656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2466c609719bSwdenk		Enable temporary baudrate change while serial download
2467c609719bSwdenk
24686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2469c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2470c609719bSwdenk
24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2472c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2473c609719bSwdenk		Cogent motherboard)
2474c609719bSwdenk
24756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2476c609719bSwdenk		Physical start address of Flash memory.
2477c609719bSwdenk
24786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2479c609719bSwdenk		Physical start address of boot monitor code (set by
2480c609719bSwdenk		make config files to be same as the text base address
248114d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
24826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2483c609719bSwdenk
24846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
24853b57fe0aSwdenk		Size of memory reserved for monitor code, used to
24863b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
24873b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
24883b57fe0aSwdenk		flash sector.
2489c609719bSwdenk
24906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2491c609719bSwdenk		Size of DRAM reserved for malloc() use.
2492c609719bSwdenk
24936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
249415940c9aSStefan Roese		Normally compressed uImages are limited to an
249515940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
24966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
249715940c9aSStefan Roese		to adjust this setting to your needs.
2498c609719bSwdenk
24996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2500c609719bSwdenk		Maximum size of memory mapped by the startup code of
2501c609719bSwdenk		the Linux kernel; all data that must be processed by
25027d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
25037d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
25047d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
25057d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2506c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2507c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2508c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2509c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2510c609719bSwdenk
2511fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2512fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2513fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2514fca43cc8SJohn Rigby		is enabled.
2515fca43cc8SJohn Rigby
2516fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2517fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2518fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2519fca43cc8SJohn Rigby
2520fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2521fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2522fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2523fca43cc8SJohn Rigby
25246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2525c609719bSwdenk		Max number of Flash memory banks
2526c609719bSwdenk
25276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2528c609719bSwdenk		Max number of sectors on a Flash chip
2529c609719bSwdenk
25306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2531c609719bSwdenk		Timeout for Flash erase operations (in ms)
2532c609719bSwdenk
25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2534c609719bSwdenk		Timeout for Flash write operations (in ms)
2535c609719bSwdenk
25366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
25378564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
25388564acf9Swdenk
25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
25408564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
25418564acf9Swdenk
25426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
25438564acf9Swdenk		If defined, hardware flash sectors protection is used
25448564acf9Swdenk		instead of U-Boot software protection.
25458564acf9Swdenk
25466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2547c609719bSwdenk
2548c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2549c609719bSwdenk		without this option such a download has to be
2550c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2551c609719bSwdenk		copy from RAM to flash.
2552c609719bSwdenk
2553c609719bSwdenk		The two-step approach is usually more reliable, since
2554c609719bSwdenk		you can check if the download worked before you erase
255511ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
255611ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2557c609719bSwdenk		downloaded image) this option may be very useful.
2558c609719bSwdenk
25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2560c609719bSwdenk		Define if the flash driver uses extra elements in the
25615653fc33Swdenk		common flash structure for storing flash geometry.
25625653fc33Swdenk
256300b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
25645653fc33Swdenk		This option also enables the building of the cfi_flash driver
25655653fc33Swdenk		in the drivers directory
256653cf9435Sstroese
256791809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
256891809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
256991809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
257091809ed5SPiotr Ziecik		to the MTD layer.
257191809ed5SPiotr Ziecik
25726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
257396ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
257496ef831fSGuennadi Liakhovetski
257596ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
257696ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
257796ef831fSGuennadi Liakhovetski		write commands.
257896ef831fSGuennadi Liakhovetski
25796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
25805568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
25815568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
25825568e613SStefan Roese		is useful, if some of the configured banks are only
25835568e613SStefan Roese		optionally available.
25845568e613SStefan Roese
25859a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
25869a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
25879a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
25889a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
25899a042e9cSJerry Van Baren
25906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
259111ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
259211ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
259353cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
259453cf9435Sstroese		buffers can be full shortly after enabling the interface
259511ccc33fSMarcel Ziswiler		on high Ethernet traffic.
259653cf9435Sstroese		Defaults to 4 if not defined.
2597c609719bSwdenk
2598ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2599ea882bafSWolfgang Denk
2600ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2601ea882bafSWolfgang Denk	internally to store the environment settings. The default
2602ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2603ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2604ea882bafSWolfgang Denk	lib/hashtable.c for details.
2605ea882bafSWolfgang Denk
2606c609719bSwdenkThe following definitions that deal with the placement and management
2607c609719bSwdenkof environment data (variable area); in general, we support the
2608c609719bSwdenkfollowing configurations:
2609c609719bSwdenk
2610c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2611c3eb3fe4SMike Frysinger
2612c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2613c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2614c3eb3fe4SMike Frysinger
26155a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2616c609719bSwdenk
2617c609719bSwdenk	Define this if the environment is in flash memory.
2618c609719bSwdenk
2619c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2620c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2621c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2622c609719bSwdenk	   sector" type flash chips, which have several smaller
2623c609719bSwdenk	   sectors at the start or the end. For instance, such a
2624c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2625c609719bSwdenk	   such a case you would place the environment in one of the
2626c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2627c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2628c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2629c609719bSwdenk	   between U-Boot and the environment.
2630c609719bSwdenk
26310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2632c609719bSwdenk
2633c609719bSwdenk	   Offset of environment data (variable area) to the
2634c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2635c609719bSwdenk	   type flash chips the second sector can be used: the offset
2636c609719bSwdenk	   for this sector is given here.
2637c609719bSwdenk
26386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2639c609719bSwdenk
26400e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2641c609719bSwdenk
2642c609719bSwdenk	   This is just another way to specify the start address of
2643c609719bSwdenk	   the flash sector containing the environment (instead of
26440e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2645c609719bSwdenk
26460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2647c609719bSwdenk
2648c609719bSwdenk	   Size of the sector containing the environment.
2649c609719bSwdenk
2650c609719bSwdenk
2651c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2652c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2653c609719bSwdenk	   the environment.
2654c609719bSwdenk
26550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2656c609719bSwdenk
26575a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
26580e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2659c609719bSwdenk	   of this flash sector for the environment. This saves
2660c609719bSwdenk	   memory for the RAM copy of the environment.
2661c609719bSwdenk
2662c609719bSwdenk	   It may also save flash memory if you decide to use this
2663c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2664c609719bSwdenk	   since then the remainder of the flash sector could be used
2665c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2666c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2667c609719bSwdenk	   updating the environment in flash makes it always
2668c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2669c609719bSwdenk	   wrong before the contents has been restored from a copy in
2670c609719bSwdenk	   RAM, your target system will be dead.
2671c609719bSwdenk
26720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
26730e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2674c609719bSwdenk
2675c609719bSwdenk	   These settings describe a second storage area used to hold
267611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
26773e38691eSwdenk	   a valid backup copy in case there is a power failure during
2678c609719bSwdenk	   a "saveenv" operation.
2679c609719bSwdenk
2680c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2681c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2682c609719bSwdenkaccordingly!
2683c609719bSwdenk
2684c609719bSwdenk
26859314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2686c609719bSwdenk
2687c609719bSwdenk	Define this if you have some non-volatile memory device
2688c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2689c609719bSwdenk	environment.
2690c609719bSwdenk
26910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
26920e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2693c609719bSwdenk
269411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2695c609719bSwdenk	  want to use for environment. It is assumed that this memory
2696c609719bSwdenk	  can just be read and written to, without any special
2697c609719bSwdenk	  provision.
2698c609719bSwdenk
2699c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2700c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
270111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2702c609719bSwdenkU-Boot will hang.
2703c609719bSwdenk
2704c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2705c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2706c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2707c609719bSwdenkto save the current settings.
2708c609719bSwdenk
2709c609719bSwdenk
2710bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2711c609719bSwdenk
2712c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2713c609719bSwdenk	device and a driver for it.
2714c609719bSwdenk
27150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2717c609719bSwdenk
2718c609719bSwdenk	  These two #defines specify the offset and size of the
2719c609719bSwdenk	  environment area within the total memory of your EEPROM.
2720c609719bSwdenk
27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2722c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2723c609719bSwdenk	  The default address is zero.
2724c609719bSwdenk
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2726c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2727c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2728c609719bSwdenk	  would require six bits.
2729c609719bSwdenk
27306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2731c609719bSwdenk	  If defined, the number of milliseconds to delay between
2732c609719bSwdenk	  page writes.	The default is zero milliseconds.
2733c609719bSwdenk
27346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2735c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2736c609719bSwdenk	  that this is NOT the chip address length!
2737c609719bSwdenk
27386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
27395cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
27405cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
27415cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
27425cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
27435cf91d6bSwdenk	  byte chips.
27445cf91d6bSwdenk
27455cf91d6bSwdenk	  Note that we consider the length of the address field to
27465cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
27475cf91d6bSwdenk	  in the chip address.
27485cf91d6bSwdenk
27496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2750c609719bSwdenk	  The size in bytes of the EEPROM device.
2751c609719bSwdenk
2752548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2753548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2754548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2755548738b4SHeiko Schocher
2756548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2757548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2758548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2759548738b4SHeiko Schocher	  EEPROM. For example:
2760548738b4SHeiko Schocher
2761548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2762548738b4SHeiko Schocher
2763548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2764548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2765c609719bSwdenk
2766057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
27675779d8d9Swdenk
27685779d8d9Swdenk	Define this if you have a DataFlash memory device which you
27695779d8d9Swdenk	want to use for the environment.
27705779d8d9Swdenk
27710e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27720e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
27730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
27745779d8d9Swdenk
27755779d8d9Swdenk	  These three #defines specify the offset and size of the
27765779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
27775779d8d9Swdenk	  at the specified address.
27785779d8d9Swdenk
277951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
278013a5695bSwdenk
278113a5695bSwdenk	Define this if you have a NAND device which you want to use
278213a5695bSwdenk	for the environment.
278313a5695bSwdenk
27840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
278613a5695bSwdenk
278713a5695bSwdenk	  These two #defines specify the offset and size of the environment
2788fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2789fdd813deSScott Wood	  aligned to an erase block boundary.
27905779d8d9Swdenk
2791fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2792e443c944SMarkus Klotzbuecher
27930e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2794fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2795fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2796fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2797fdd813deSScott Wood	  aligned to an erase block boundary.
2798e443c944SMarkus Klotzbuecher
2799fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2800fdd813deSScott Wood
2801fdd813deSScott Wood	  Specifies the length of the region in which the environment
2802fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2803fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2804fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2805fdd813deSScott Wood	  the range to be avoided.
2806fdd813deSScott Wood
2807fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2808fdd813deSScott Wood
2809fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2810fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2811fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2812fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2813fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2814e443c944SMarkus Klotzbuecher
2815b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2816b74ab737SGuennadi Liakhovetski
2817b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2818b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2819b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2820b74ab737SGuennadi Liakhovetski
28216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2822c609719bSwdenk
2823c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2824c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2825c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2826c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2827c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2828c609719bSwdenk	to be a good choice since it makes it far enough from the
2829c609719bSwdenk	start of the data area as well as from the stack pointer.
2830c609719bSwdenk
2831e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2832c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2833cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2834c609719bSwdenkuntil then to read environment variables.
2835c609719bSwdenk
283685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
283785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
283885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
283985ec0bccSwdenknecessary, because the first environment variable we need is the
284085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
284185ec0bccSwdenkhave any device yet where we could complain.]
2842c609719bSwdenk
2843c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2844c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
284585ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2846c609719bSwdenk
28476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2848fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2849fc3e2165Swdenk
28506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2851fc3e2165Swdenk		      also needs to be defined.
2852fc3e2165Swdenk
28536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2854fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2855c609719bSwdenk
2856f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2857f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2858f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2859f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2860f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2861f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2862f5675aa5SRon Madrid
2863c609719bSwdenkLow Level (hardware related) configuration options:
2864dc7c9a1aSwdenk---------------------------------------------------
2865c609719bSwdenk
28666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2867c609719bSwdenk		Cache Line Size of the CPU.
2868c609719bSwdenk
28696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2870c609719bSwdenk		Default address of the IMMR after system reset.
28712535d602Swdenk
28722535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
28732535d602Swdenk		and RPXsuper) to be able to adjust the position of
28742535d602Swdenk		the IMMR register after a reset.
2875c609719bSwdenk
2876e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
2877e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
2878e46fedfeSTimur Tabi		PowerPC SOCs.
2879e46fedfeSTimur Tabi
2880e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
2881e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
2882e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2883e46fedfeSTimur Tabi
2884e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2885e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
2886e46fedfeSTimur Tabi
2887e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
2888e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
2889e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
2890e46fedfeSTimur Tabi		be set to that address.  Otherwise, it should be set to the
2891e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2892e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
2893e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
2894e46fedfeSTimur Tabi
2895e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2896e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2897e46fedfeSTimur Tabi
2898e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2899e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
2900e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
2901e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2902e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2903e46fedfeSTimur Tabi
2904e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2905e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2906e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2907e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2908e46fedfeSTimur Tabi
2909e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2910e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2911e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
2912e46fedfeSTimur Tabi
29137f6c2cbcSwdenk- Floppy Disk Support:
29146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
29157f6c2cbcSwdenk
29167f6c2cbcSwdenk		the default drive number (default value 0)
29177f6c2cbcSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
29197f6c2cbcSwdenk
292011ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
29217f6c2cbcSwdenk		(default value 1)
29227f6c2cbcSwdenk
29236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
29247f6c2cbcSwdenk
29257f6c2cbcSwdenk		defines the offset of register from address. It
29267f6c2cbcSwdenk		depends on which part of the data bus is connected to
292711ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
29287f6c2cbcSwdenk
29296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
29317f6c2cbcSwdenk		default value.
29327f6c2cbcSwdenk
29336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
29347f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
29357f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
29367f6c2cbcSwdenk		source code. It is used to make hardware dependant
29377f6c2cbcSwdenk		initializations.
29387f6c2cbcSwdenk
29390abddf82SMacpaul Lin- CONFIG_IDE_AHB:
29400abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
29410abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
29420abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
29430abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
29440abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
29450abddf82SMacpaul Lin		is requierd.
29460abddf82SMacpaul Lin
29476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
294825d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
294925d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2950c609719bSwdenk
29516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2952c609719bSwdenk
29537152b1d0Swdenk		Start address of memory area that can be used for
2954c609719bSwdenk		initial data and stack; please note that this must be
2955c609719bSwdenk		writable memory that is working WITHOUT special
2956c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2957c609719bSwdenk		will become available only after programming the
2958c609719bSwdenk		memory controller and running certain initialization
2959c609719bSwdenk		sequences.
2960c609719bSwdenk
2961c609719bSwdenk		U-Boot uses the following memory types:
2962c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2963c609719bSwdenk		- MPC824X: data cache
2964c609719bSwdenk		- PPC4xx:  data cache
2965c609719bSwdenk
29666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2967c609719bSwdenk
2968c609719bSwdenk		Offset of the initial data structure in the memory
29696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
29706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2971c609719bSwdenk		data is located at the end of the available space
2972553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
29736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
29746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
29756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2976c609719bSwdenk
2977c609719bSwdenk	Note:
2978c609719bSwdenk		On the MPC824X (or other systems that use the data
2979c609719bSwdenk		cache for initial memory) the address chosen for
29806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2981c609719bSwdenk		point to an otherwise UNUSED address space between
2982c609719bSwdenk		the top of RAM and the start of the PCI space.
2983c609719bSwdenk
29846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2985c609719bSwdenk
29866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2987c609719bSwdenk
29886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2989c609719bSwdenk
29906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2991c609719bSwdenk
29926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2993c609719bSwdenk
29946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2995c609719bSwdenk
29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2997c609719bSwdenk		SDRAM timing
2998c609719bSwdenk
29996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3000c609719bSwdenk		periodic timer for refresh
3001c609719bSwdenk
30026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3003c609719bSwdenk
30046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
30056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
30066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
30076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3008c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3009c609719bSwdenk
3010c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
30116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
30126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3013c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3014c609719bSwdenk
30156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
30166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3017c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3018c609719bSwdenk		Prescaler definitions (SDRAM timing)
3019c609719bSwdenk
30206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3021c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3022c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3023c609719bSwdenk
30246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3025b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3026b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3027b423d055SHeiko Schocher
30286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3029c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3030c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3031c609719bSwdenk
30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3033c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3034c609719bSwdenk		wrong setting might damage your board. Read
3035c609719bSwdenk		doc/README.MBX before setting this variable!
3036c609719bSwdenk
30376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3038ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3039ea909b76Swdenk		(Power On Self Tests). This definition overrides
3040ea909b76Swdenk		#define'd default value in commproc.h resp.
3041ea909b76Swdenk		cpm_8260.h.
3042ea909b76Swdenk
30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
30446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
30456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
30466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
30476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
30486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
30496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
30506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3051a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
30525d232d0eSwdenk
30539cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
30549cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
30559cacf4fcSDirk Eibach		required.
30569cacf4fcSDirk Eibach
3057a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3058a09b9b68SKumar Gala		Chip has SRIO or not
3059a09b9b68SKumar Gala
3060a09b9b68SKumar Gala- CONFIG_SRIO1:
3061a09b9b68SKumar Gala		Board has SRIO 1 port available
3062a09b9b68SKumar Gala
3063a09b9b68SKumar Gala- CONFIG_SRIO2:
3064a09b9b68SKumar Gala		Board has SRIO 2 port available
3065a09b9b68SKumar Gala
3066a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3067a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3068a09b9b68SKumar Gala
3069a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3070a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3071a09b9b68SKumar Gala
3072a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3073a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3074a09b9b68SKumar Gala
3075eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3076eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3077eced4626SAlex Waterman		16 bit bus.
3078eced4626SAlex Waterman
3079eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3080eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3081eced4626SAlex Waterman		a default value will be used.
3082eced4626SAlex Waterman
3083bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3084218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3085218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3086218ca724SWolfgang Denk
3087bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3088bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3089bb99ad6dSBen Warren
30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3091218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3092218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3093218ca724SWolfgang Denk		to something your driver can deal with.
3094bb99ad6dSBen Warren
30951b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
30961b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
30971b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
30981b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
30991b3e3c4fSYork Sun		header files or board specific files.
31001b3e3c4fSYork Sun
31016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3102218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3103218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
31042ad6b513STimur Tabi
3105c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3106c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3107c26e454dSwdenk
3108c26e454dSwdenk- CONFIG_FEC[12]_PHY
3109c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
31106e592385Swdenk		to the given FEC; i. e.
3111c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3112c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3113c26e454dSwdenk
3114c26e454dSwdenk		When set to -1, means to probe for first available.
3115c26e454dSwdenk
3116c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3117c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3118c26e454dSwdenk		(so program the FEC to ignore it).
3119c26e454dSwdenk
3120c26e454dSwdenk- CONFIG_RMII
3121c26e454dSwdenk		Enable RMII mode for all FECs.
3122c26e454dSwdenk		Note that this is a global option, we can't
3123c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3124c26e454dSwdenk
31255cf91d6bSwdenk- CONFIG_CRC32_VERIFY
31265cf91d6bSwdenk		Add a verify option to the crc32 command.
31275cf91d6bSwdenk		The syntax is:
31285cf91d6bSwdenk
31295cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
31305cf91d6bSwdenk
31315cf91d6bSwdenk		Where address/count indicate a memory area
31325cf91d6bSwdenk		and crc32 is the correct crc32 which the
31335cf91d6bSwdenk		area should have.
31345cf91d6bSwdenk
313556523f12Swdenk- CONFIG_LOOPW
313656523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3137602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
313856523f12Swdenk
31397b466641Sstroese- CONFIG_MX_CYCLIC
31407b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
31417b466641Sstroese		"md/mw" commands.
31427b466641Sstroese		Examples:
31437b466641Sstroese
31447b466641Sstroese		=> mdc.b 10 4 500
31457b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
31467b466641Sstroese
31477b466641Sstroese		=> mwc.l 100 12345678 10
31487b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
31497b466641Sstroese
31507b466641Sstroese		This only takes effect if the memory commands are activated
3151602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
31527b466641Sstroese
31538aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
315492bbd64eSDaniel Schwierzeck		[ARM, MIPS only] If this variable is defined, then certain
3155e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3156e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3157e03f3169SWolfgang Denk		relocate itself into RAM.
31588aa1a2d1Swdenk
3159e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3160e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3161e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3162e03f3169SWolfgang Denk		these initializations itself.
31638aa1a2d1Swdenk
3164401bb30bSAneesh V- CONFIG_SPL_BUILD
3165df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3166df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3167df81238bSMagnus Lilja		compiling a NAND SPL.
3168400558b5Swdenk
3169d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3170d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3171d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3172d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3173d8834a13SMatthias Weisser		conditions but may increase the binary size.
3174d8834a13SMatthias Weisser
3175c609719bSwdenkBuilding the Software:
3176c609719bSwdenk======================
3177c609719bSwdenk
3178218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3179218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3180218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3181218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3182218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3183218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3184c609719bSwdenk
3185218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3186218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3187218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3188218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3189218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3190c609719bSwdenk
3191218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3192218ca724SWolfgang Denk	$ export CROSS_COMPILE
3193c609719bSwdenk
31942f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
31952f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
31962f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
31972f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
31982f8d396bSPeter Tyser
31992f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
32002f8d396bSPeter Tyser
32012f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
32022f8d396bSPeter Tyser      be executed on computers running Windows.
32032f8d396bSPeter Tyser
3204c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3205c609719bSwdenksources you must configure U-Boot for one specific board type. This
3206c609719bSwdenkis done by typing:
3207c609719bSwdenk
3208c609719bSwdenk	make NAME_config
3209c609719bSwdenk
3210218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3211218ca724SWolfgang Denkrations; see the main Makefile for supported names.
321254387ac9Swdenk
3213c609719bSwdenkNote: for some board special configuration names may exist; check if
3214c609719bSwdenk      additional information is available from the board vendor; for
32152729af9dSwdenk      instance, the TQM823L systems are available without (standard)
32162729af9dSwdenk      or with LCD support. You can select such additional "features"
321711ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3218c609719bSwdenk
32192729af9dSwdenk      make TQM823L_config
32202729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3221c609719bSwdenk
3222c609719bSwdenk      make TQM823L_LCD_config
3223c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3224c609719bSwdenk
3225c609719bSwdenk      etc.
3226c609719bSwdenk
3227c609719bSwdenk
3228c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
32297152b1d0Swdenkimages ready for download to / installation on your system:
3230c609719bSwdenk
3231c609719bSwdenk- "u-boot.bin" is a raw binary image
3232c609719bSwdenk- "u-boot" is an image in ELF binary format
3233c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3234c609719bSwdenk
3235baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3236baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3237baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3238baf31249SMarian Balakowicz
3239baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3240baf31249SMarian Balakowicz
3241baf31249SMarian Balakowicz	make O=/tmp/build distclean
3242baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3243baf31249SMarian Balakowicz	make O=/tmp/build all
3244baf31249SMarian Balakowicz
3245baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3246baf31249SMarian Balakowicz
3247baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3248baf31249SMarian Balakowicz	make distclean
3249baf31249SMarian Balakowicz	make NAME_config
3250baf31249SMarian Balakowicz	make all
3251baf31249SMarian Balakowicz
3252baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3253baf31249SMarian Balakowiczvariable.
3254baf31249SMarian Balakowicz
3255c609719bSwdenk
3256c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3257c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3258c609719bSwdenknative "make".
3259c609719bSwdenk
3260c609719bSwdenk
3261c609719bSwdenkIf the system board that you have is not listed, then you will need
3262c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3263c609719bSwdenksteps:
3264c609719bSwdenk
3265c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
326685ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
326785ec0bccSwdenk    entries as examples. Note that here and at many other places
32687152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
326985ec0bccSwdenk    keep this order.
3270c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
327185ec0bccSwdenk    files you need. In your board directory, you will need at least
327285ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
327385ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
327485ec0bccSwdenk    your board
3275c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3276c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
327785ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3278c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3279c609719bSwdenk    to be installed on your target system.
328085ec0bccSwdenk6.  Debug and solve any problems that might arise.
3281c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3282c609719bSwdenk
3283c609719bSwdenk
3284c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3285c609719bSwdenk==============================================================
3286c609719bSwdenk
3287c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3288c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3289c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3290c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3291218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3292c609719bSwdenk
3293c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3294c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3295c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3296c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3297c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
32987152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3299218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3300218ca724SWolfgang Denkyou can type
3301c609719bSwdenk
3302c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3303c609719bSwdenk
3304c609719bSwdenkor to build on a native PowerPC system you can type
3305c609719bSwdenk
3306c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3307c609719bSwdenk
3308218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3309218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3310218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3311218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3312218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3313218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3314218ca724SWolfgang Denkvariable. For example:
3315baf31249SMarian Balakowicz
3316baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3317baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3318baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3319baf31249SMarian Balakowicz
3320218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3321218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3322218ca724SWolfgang Denkduring the whole build process.
3323baf31249SMarian Balakowicz
3324baf31249SMarian Balakowicz
3325c609719bSwdenkSee also "U-Boot Porting Guide" below.
3326c609719bSwdenk
3327c609719bSwdenk
3328c609719bSwdenkMonitor Commands - Overview:
3329c609719bSwdenk============================
3330c609719bSwdenk
3331c609719bSwdenkgo	- start application at address 'addr'
3332c609719bSwdenkrun	- run commands in an environment variable
3333c609719bSwdenkbootm	- boot application image from memory
3334c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3335c609719bSwdenktftpboot- boot image via network using TFTP protocol
3336c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3337c609719bSwdenk	       (and eventually "gatewayip")
3338c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3339c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3340c609719bSwdenkloads	- load S-Record file over serial line
3341c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3342c609719bSwdenkmd	- memory display
3343c609719bSwdenkmm	- memory modify (auto-incrementing)
3344c609719bSwdenknm	- memory modify (constant address)
3345c609719bSwdenkmw	- memory write (fill)
3346c609719bSwdenkcp	- memory copy
3347c609719bSwdenkcmp	- memory compare
3348c609719bSwdenkcrc32	- checksum calculation
33490f89c54bSPeter Tyseri2c	- I2C sub-system
3350c609719bSwdenksspi	- SPI utility commands
3351c609719bSwdenkbase	- print or set address offset
3352c609719bSwdenkprintenv- print environment variables
3353c609719bSwdenksetenv	- set environment variables
3354c609719bSwdenksaveenv - save environment variables to persistent storage
3355c609719bSwdenkprotect - enable or disable FLASH write protection
3356c609719bSwdenkerase	- erase FLASH memory
3357c609719bSwdenkflinfo	- print FLASH memory information
3358c609719bSwdenkbdinfo	- print Board Info structure
3359c609719bSwdenkiminfo	- print header information for application image
3360c609719bSwdenkconinfo - print console devices and informations
3361c609719bSwdenkide	- IDE sub-system
3362c609719bSwdenkloop	- infinite loop on address range
336356523f12Swdenkloopw	- infinite write loop on address range
3364c609719bSwdenkmtest	- simple RAM test
3365c609719bSwdenkicache	- enable or disable instruction cache
3366c609719bSwdenkdcache	- enable or disable data cache
3367c609719bSwdenkreset	- Perform RESET of the CPU
3368c609719bSwdenkecho	- echo args to console
3369c609719bSwdenkversion - print monitor version
3370c609719bSwdenkhelp	- print online help
3371c609719bSwdenk?	- alias for 'help'
3372c609719bSwdenk
3373c609719bSwdenk
3374c609719bSwdenkMonitor Commands - Detailed Description:
3375c609719bSwdenk========================================
3376c609719bSwdenk
3377c609719bSwdenkTODO.
3378c609719bSwdenk
3379c609719bSwdenkFor now: just type "help <command>".
3380c609719bSwdenk
3381c609719bSwdenk
3382c609719bSwdenkEnvironment Variables:
3383c609719bSwdenk======================
3384c609719bSwdenk
3385c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3386c609719bSwdenkcan be made persistent by saving to Flash memory.
3387c609719bSwdenk
3388c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3389c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3390c609719bSwdenkwithout a value can be used to delete a variable from the
3391c609719bSwdenkenvironment. As long as you don't save the environment you are
3392c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3393c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3394c609719bSwdenk
3395c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3396c96f86eeSWolfgang Denk
3397c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3398c609719bSwdenk
3399c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3400c609719bSwdenk
3401c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3402c609719bSwdenk
3403c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3404c609719bSwdenk
3405c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3406c609719bSwdenk
3407c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3408c609719bSwdenk
34097d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
34107d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34117d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
34127d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
34137d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
34147d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3415c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3416c3624e6eSGrant Likely		  bootm_mapsize.
3417c3624e6eSGrant Likely
3418c3624e6eSGrant Likely  bootm_mapsize	- Size of the initial memory mapping for the Linux kernel.
3419c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3420c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3421c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3422c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3423c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3424c3624e6eSGrant Likely		  used otherwise.
34257d721e34SBartlomiej Sieka
34267d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
34277d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34287d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
34297d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
34307d721e34SBartlomiej Sieka		  environment variable.
34317d721e34SBartlomiej Sieka
34324bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
34334bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
34344bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
34354bae9090SBartlomiej Sieka
3436c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3437c609719bSwdenk		  "bootp" will just load perform a lookup of the
3438c609719bSwdenk		  configuration from the BOOTP server, but not try to
3439c609719bSwdenk		  load any image using TFTP
3440c609719bSwdenk
3441c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3442c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3443c609719bSwdenk		  be automatically started (by internally calling
3444c609719bSwdenk		  "bootm")
3445c609719bSwdenk
34464a6fd34bSwdenk		  If set to "no", a standalone image passed to the
34474a6fd34bSwdenk		  "bootm" command will be copied to the load address
34484a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
34494a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
34504a6fd34bSwdenk		  data.
34514a6fd34bSwdenk
3452a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3453a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3454a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3455a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3456a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3457a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3458a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3459a28afca5SDavid A. Long		  must be accessible by the kernel.
3460a28afca5SDavid A. Long
346117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
346217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
346317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
346417ea1177Swdenk		  initialization code. So, for changes to be effective
346517ea1177Swdenk		  it must be saved and board must be reset.
346617ea1177Swdenk
3467c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3468c609719bSwdenk		  If this variable is not set, initrd images will be
3469c609719bSwdenk		  copied to the highest possible address in RAM; this
3470c609719bSwdenk		  is usually what you want since it allows for
3471c609719bSwdenk		  maximum initrd size. If for some reason you want to
3472c609719bSwdenk		  make sure that the initrd image is loaded below the
34736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3474c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3475c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3476c609719bSwdenk		  address to use (U-Boot will still check that it
3477c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3478c609719bSwdenk
3479c609719bSwdenk		  For instance, when you have a system with 16 MB
34807152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3481c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3482c609719bSwdenk		  the "bootargs" variable. However, now you must make
34837152b1d0Swdenk		  sure that the initrd image is placed in the first
3484c609719bSwdenk		  12 MB as well - this can be done with
3485c609719bSwdenk
3486c609719bSwdenk		  setenv initrd_high 00c00000
3487c609719bSwdenk
348838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
348938b99261Swdenk		  indication to U-Boot that all addresses are legal
349038b99261Swdenk		  for the Linux kernel, including addresses in flash
349138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
349238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
349338b99261Swdenk		  boot time on your system, but requires that this
349438b99261Swdenk		  feature is supported by your Linux kernel.
349538b99261Swdenk
3496c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3497c609719bSwdenk
3498c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3499dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3500c609719bSwdenk
3501c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3502c609719bSwdenk
3503c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3504c609719bSwdenk
3505c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3506c609719bSwdenk
3507c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3508c609719bSwdenk
3509c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3510c609719bSwdenk
3511e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3512a3d991bdSwdenk
3513e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3514e2a53458SMike Frysinger		  For example you can do the following
3515a3d991bdSwdenk
351648690d80SHeiko Schocher		  => setenv ethact FEC
351748690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
351848690d80SHeiko Schocher		  => setenv ethact SCC
351948690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3520a3d991bdSwdenk
3521e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3522e1692577SMatthias Fuchs		  available network interfaces.
3523e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3524e1692577SMatthias Fuchs
3525a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3526a3d991bdSwdenk		  either succeed or fail without retrying.
35276e592385Swdenk		  When set to "once" the network operation will
35286e592385Swdenk		  fail when all the available network interfaces
35296e592385Swdenk		  are tried once without success.
3530a3d991bdSwdenk		  Useful on scripts which control the retry operation
3531a3d991bdSwdenk		  themselves.
3532a3d991bdSwdenk
3533b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3534a1cf027aSJean-Christophe PLAGNIOL-VILLARD
353528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3536ecb0ccd9SWolfgang Denk		  UDP source port.
3537ecb0ccd9SWolfgang Denk
353828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
353928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
354028cb9375SWolfgang Denk
3541c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3542c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3543c96f86eeSWolfgang Denk
3544c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3545c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3546c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3547c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3548c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3549c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3550c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3551c96f86eeSWolfgang Denk
3552a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
355311ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3554a3d991bdSwdenk		  VLAN tagged frames.
3555c609719bSwdenk
3556c609719bSwdenkThe following environment variables may be used and automatically
3557c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3558c609719bSwdenkdepending the information provided by your boot server:
3559c609719bSwdenk
3560c609719bSwdenk  bootfile	- see above
3561c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3562fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3563c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3564c609719bSwdenk  hostname	- Target hostname
3565c609719bSwdenk  ipaddr	- see above
3566c609719bSwdenk  netmask	- Subnet Mask
3567c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3568c609719bSwdenk  serverip	- see above
3569c609719bSwdenk
3570c609719bSwdenk
3571c609719bSwdenkThere are two special Environment Variables:
3572c609719bSwdenk
3573c609719bSwdenk  serial#	- contains hardware identification information such
3574c609719bSwdenk		  as type string and/or serial number
3575c609719bSwdenk  ethaddr	- Ethernet address
3576c609719bSwdenk
3577c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3578c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3579c609719bSwdenkonce they have been set once.
3580c609719bSwdenk
3581c609719bSwdenk
3582c1551ea8SstroeseFurther special Environment Variables:
3583c1551ea8Sstroese
3584c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3585c1551ea8Sstroese		  with the "version" command. This variable is
3586c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3587c1551ea8Sstroese
3588c1551ea8Sstroese
3589c609719bSwdenkPlease note that changes to some configuration parameters may take
3590c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3591c609719bSwdenk
3592c609719bSwdenk
3593f07771ccSwdenkCommand Line Parsing:
3594f07771ccSwdenk=====================
3595f07771ccSwdenk
3596f07771ccSwdenkThere are two different command line parsers available with U-Boot:
35977152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3598f07771ccSwdenk
3599f07771ccSwdenkOld, simple command line parser:
3600f07771ccSwdenk--------------------------------
3601f07771ccSwdenk
3602f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3603f07771ccSwdenk- several commands on one line, separated by ';'
3604fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3605f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3606f07771ccSwdenk  for example:
3607fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3608f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3609f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3610f07771ccSwdenk
3611f07771ccSwdenkHush shell:
3612f07771ccSwdenk-----------
3613f07771ccSwdenk
3614f07771ccSwdenk- similar to Bourne shell, with control structures like
3615f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3616f07771ccSwdenk  until...do...done, ...
3617f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3618f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3619f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3620f07771ccSwdenk  command
3621f07771ccSwdenk
3622f07771ccSwdenkGeneral rules:
3623f07771ccSwdenk--------------
3624f07771ccSwdenk
3625f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3626f07771ccSwdenk    command) contains several commands separated by semicolon, and
3627f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3628f07771ccSwdenk    executed anyway.
3629f07771ccSwdenk
3630f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
363111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3632f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3633f07771ccSwdenk    variables are not executed.
3634f07771ccSwdenk
3635c609719bSwdenkNote for Redundant Ethernet Interfaces:
3636c609719bSwdenk=======================================
3637c609719bSwdenk
363811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3639c609719bSwdenksuch configurations and is capable of automatic selection of a
36407152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3641c609719bSwdenk
3642c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3643c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3644c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3645c609719bSwdenk
3646c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3647c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3648c609719bSwdenkding setting in the environment; if the corresponding environment
3649c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3650c609719bSwdenk
3651c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3652c609719bSwdenk  environment, the SROM's address is used.
3653c609719bSwdenk
3654c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3655c609719bSwdenk  environment exists, then the value from the environment variable is
3656c609719bSwdenk  used.
3657c609719bSwdenk
3658c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3659c609719bSwdenk  both addresses are the same, this MAC address is used.
3660c609719bSwdenk
3661c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3662c609719bSwdenk  addresses differ, the value from the environment is used and a
3663c609719bSwdenk  warning is printed.
3664c609719bSwdenk
3665c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3666c609719bSwdenk  is raised.
3667c609719bSwdenk
3668ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3669ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3670ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3671ecee9324SBen WarrenThe naming convention is as follows:
3672ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3673c609719bSwdenk
3674c609719bSwdenkImage Formats:
3675c609719bSwdenk==============
3676c609719bSwdenk
36773310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
36783310c549SMarian Balakowiczimages in two formats:
36793310c549SMarian Balakowicz
36803310c549SMarian BalakowiczNew uImage format (FIT)
36813310c549SMarian Balakowicz-----------------------
36823310c549SMarian Balakowicz
36833310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
36843310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
36853310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
36863310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
36873310c549SMarian Balakowicz
36883310c549SMarian Balakowicz
36893310c549SMarian BalakowiczOld uImage format
36903310c549SMarian Balakowicz-----------------
36913310c549SMarian Balakowicz
36923310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
36933310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
36943310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3695c609719bSwdenk
3696c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3697c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3698f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3699f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3700f5ed9e39SPeter Tyser  INTEGRITY).
37017b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
37021117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
37031117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3704c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3705c609719bSwdenk* Load Address
3706c609719bSwdenk* Entry Point
3707c609719bSwdenk* Image Name
3708c609719bSwdenk* Image Timestamp
3709c609719bSwdenk
3710c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3711c609719bSwdenkand the data portions of the image are secured against corruption by
3712c609719bSwdenkCRC32 checksums.
3713c609719bSwdenk
3714c609719bSwdenk
3715c609719bSwdenkLinux Support:
3716c609719bSwdenk==============
3717c609719bSwdenk
3718c609719bSwdenkAlthough U-Boot should support any OS or standalone application
37197152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3720c609719bSwdenkU-Boot.
3721c609719bSwdenk
3722c609719bSwdenkU-Boot includes many features that so far have been part of some
3723c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3724c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3725c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
37267152b1d0Swdenkserves several purposes:
3727c609719bSwdenk
3728c609719bSwdenk- the same features can be used for other OS or standalone
3729c609719bSwdenk  applications (for instance: using compressed images to reduce the
3730c609719bSwdenk  Flash memory footprint)
3731c609719bSwdenk
3732c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
37337152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3734c609719bSwdenk
3735c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3736c609719bSwdenk  images; of course this also means that different kernel images can
3737c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3738c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3739c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3740c609719bSwdenk  software is easier now.
3741c609719bSwdenk
3742c609719bSwdenk
3743c609719bSwdenkLinux HOWTO:
3744c609719bSwdenk============
3745c609719bSwdenk
3746c609719bSwdenkPorting Linux to U-Boot based systems:
3747c609719bSwdenk---------------------------------------
3748c609719bSwdenk
3749c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3750c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3751c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3752c609719bSwdenkLinux :-).
3753c609719bSwdenk
3754a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3755c609719bSwdenk
3756c609719bSwdenkJust make sure your machine specific header file (for instance
3757c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
37581dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
37591dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
37606d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3761c609719bSwdenk
3762c609719bSwdenk
3763c609719bSwdenkConfiguring the Linux kernel:
3764c609719bSwdenk-----------------------------
3765c609719bSwdenk
3766c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3767c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3768c609719bSwdenk
3769c609719bSwdenk
3770c609719bSwdenkBuilding a Linux Image:
3771c609719bSwdenk-----------------------
3772c609719bSwdenk
377324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
377424ee89b9Swdenknot used. If you use recent kernel source, a new build target
377524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
377624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
377724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
377824ee89b9Swdenk100% compatible format.
3779c609719bSwdenk
3780c609719bSwdenkExample:
3781c609719bSwdenk
3782c609719bSwdenk	make TQM850L_config
3783c609719bSwdenk	make oldconfig
3784c609719bSwdenk	make dep
378524ee89b9Swdenk	make uImage
3786c609719bSwdenk
378724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
378824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
378924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3790c609719bSwdenk
379124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
379224ee89b9Swdenk
379324ee89b9Swdenk* convert the kernel into a raw binary image:
379424ee89b9Swdenk
379524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
379624ee89b9Swdenk				 -R .note -R .comment \
379724ee89b9Swdenk				 -S vmlinux linux.bin
379824ee89b9Swdenk
379924ee89b9Swdenk* compress the binary image:
380024ee89b9Swdenk
380124ee89b9Swdenk	gzip -9 linux.bin
380224ee89b9Swdenk
380324ee89b9Swdenk* package compressed binary image for U-Boot:
380424ee89b9Swdenk
380524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
380624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
380724ee89b9Swdenk		-d linux.bin.gz uImage
380824ee89b9Swdenk
380924ee89b9Swdenk
381024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
381124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
381224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
381324ee89b9Swdenkbyte header containing information about target architecture,
381424ee89b9Swdenkoperating system, image type, compression method, entry points, time
381524ee89b9Swdenkstamp, CRC32 checksums, etc.
381624ee89b9Swdenk
381724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
381824ee89b9Swdenkprint the header information, or to build new images.
3819c609719bSwdenk
3820c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3821c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3822c609719bSwdenkchecksum verification:
3823c609719bSwdenk
3824c609719bSwdenk	tools/mkimage -l image
3825c609719bSwdenk	  -l ==> list image header information
3826c609719bSwdenk
3827c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3828c609719bSwdenkfrom a "data file" which is used as image payload:
3829c609719bSwdenk
3830c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3831c609719bSwdenk		      -n name -d data_file image
3832c609719bSwdenk	  -A ==> set architecture to 'arch'
3833c609719bSwdenk	  -O ==> set operating system to 'os'
3834c609719bSwdenk	  -T ==> set image type to 'type'
3835c609719bSwdenk	  -C ==> set compression type 'comp'
3836c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3837c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3838c609719bSwdenk	  -n ==> set image name to 'name'
3839c609719bSwdenk	  -d ==> use image data from 'datafile'
3840c609719bSwdenk
384169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
384269459791Swdenkaddress (0x00000000), but the entry point address depends on the
384369459791Swdenkkernel version:
3844c609719bSwdenk
3845c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
384624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3847c609719bSwdenk
3848c609719bSwdenkSo a typical call to build a U-Boot image would read:
3849c609719bSwdenk
385024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
385124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3852a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
385324ee89b9Swdenk	> examples/uImage.TQM850L
385424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3855c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3856c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3857c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3858c609719bSwdenk	Load Address: 0x00000000
385924ee89b9Swdenk	Entry Point:  0x00000000
3860c609719bSwdenk
3861c609719bSwdenkTo verify the contents of the image (or check for corruption):
3862c609719bSwdenk
386324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
386424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3865c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3866c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3867c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3868c609719bSwdenk	Load Address: 0x00000000
386924ee89b9Swdenk	Entry Point:  0x00000000
3870c609719bSwdenk
3871c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3872c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3873c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3874c609719bSwdenkneed to be uncompressed:
3875c609719bSwdenk
3876a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
387724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
387824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3879a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
388024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
388124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3882c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3883c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3884c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3885c609719bSwdenk	Load Address: 0x00000000
388624ee89b9Swdenk	Entry Point:  0x00000000
3887c609719bSwdenk
3888c609719bSwdenk
3889c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3890c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3891c609719bSwdenk
3892c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3893c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3894c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3895c609719bSwdenk	Image Name:   Simple Ramdisk Image
3896c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3897c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3898c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3899c609719bSwdenk	Load Address: 0x00000000
3900c609719bSwdenk	Entry Point:  0x00000000
3901c609719bSwdenk
3902c609719bSwdenk
3903c609719bSwdenkInstalling a Linux Image:
3904c609719bSwdenk-------------------------
3905c609719bSwdenk
3906c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3907c609719bSwdenkyou must convert the image to S-Record format:
3908c609719bSwdenk
3909c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3910c609719bSwdenk
3911c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3912c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3913c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3914c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3915c609719bSwdenkcommand.
3916c609719bSwdenk
3917c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3918c609719bSwdenkTQM8xxL is in the first Flash bank):
3919c609719bSwdenk
3920c609719bSwdenk	=> erase 40100000 401FFFFF
3921c609719bSwdenk
3922c609719bSwdenk	.......... done
3923c609719bSwdenk	Erased 8 sectors
3924c609719bSwdenk
3925c609719bSwdenk	=> loads 40100000
3926c609719bSwdenk	## Ready for S-Record download ...
3927c609719bSwdenk	~>examples/image.srec
3928c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3929c609719bSwdenk	...
3930c609719bSwdenk	15989 15990 15991 15992
3931c609719bSwdenk	[file transfer complete]
3932c609719bSwdenk	[connected]
3933c609719bSwdenk	## Start Addr = 0x00000000
3934c609719bSwdenk
3935c609719bSwdenk
3936c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3937c609719bSwdenkthis includes a checksum verification so you can be sure no data
3938c609719bSwdenkcorruption happened:
3939c609719bSwdenk
3940c609719bSwdenk	=> imi 40100000
3941c609719bSwdenk
3942c609719bSwdenk	## Checking Image at 40100000 ...
3943c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3944c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3945c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3946c609719bSwdenk	   Load Address: 00000000
3947c609719bSwdenk	   Entry Point:	 0000000c
3948c609719bSwdenk	   Verifying Checksum ... OK
3949c609719bSwdenk
3950c609719bSwdenk
3951c609719bSwdenkBoot Linux:
3952c609719bSwdenk-----------
3953c609719bSwdenk
3954c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3955c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3956c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3957c609719bSwdenkparameters. You can check and modify this variable using the
3958c609719bSwdenk"printenv" and "setenv" commands:
3959c609719bSwdenk
3960c609719bSwdenk
3961c609719bSwdenk	=> printenv bootargs
3962c609719bSwdenk	bootargs=root=/dev/ram
3963c609719bSwdenk
3964c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3965c609719bSwdenk
3966c609719bSwdenk	=> printenv bootargs
3967c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3968c609719bSwdenk
3969c609719bSwdenk	=> bootm 40020000
3970c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3971c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3972c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3973c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3974c609719bSwdenk	   Load Address: 00000000
3975c609719bSwdenk	   Entry Point:	 0000000c
3976c609719bSwdenk	   Verifying Checksum ... OK
3977c609719bSwdenk	   Uncompressing Kernel Image ... OK
3978c609719bSwdenk	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
3979c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3980c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3981c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3982c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3983c609719bSwdenk	...
3984c609719bSwdenk
398511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
39867152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3987c609719bSwdenkformat!) to the "bootm" command:
3988c609719bSwdenk
3989c609719bSwdenk	=> imi 40100000 40200000
3990c609719bSwdenk
3991c609719bSwdenk	## Checking Image at 40100000 ...
3992c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3993c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3994c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3995c609719bSwdenk	   Load Address: 00000000
3996c609719bSwdenk	   Entry Point:	 0000000c
3997c609719bSwdenk	   Verifying Checksum ... OK
3998c609719bSwdenk
3999c609719bSwdenk	## Checking Image at 40200000 ...
4000c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4001c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4002c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4003c609719bSwdenk	   Load Address: 00000000
4004c609719bSwdenk	   Entry Point:	 00000000
4005c609719bSwdenk	   Verifying Checksum ... OK
4006c609719bSwdenk
4007c609719bSwdenk	=> bootm 40100000 40200000
4008c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4009c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4010c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4011c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4012c609719bSwdenk	   Load Address: 00000000
4013c609719bSwdenk	   Entry Point:	 0000000c
4014c609719bSwdenk	   Verifying Checksum ... OK
4015c609719bSwdenk	   Uncompressing Kernel Image ... OK
4016c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4017c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4018c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4019c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4020c609719bSwdenk	   Load Address: 00000000
4021c609719bSwdenk	   Entry Point:	 00000000
4022c609719bSwdenk	   Verifying Checksum ... OK
4023c609719bSwdenk	   Loading Ramdisk ... OK
4024c609719bSwdenk	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
4025c609719bSwdenk	Boot arguments: root=/dev/ram
4026c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4027c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4028c609719bSwdenk	...
4029c609719bSwdenk	RAMDISK: Compressed image found at block 0
4030c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4031c609719bSwdenk
4032c609719bSwdenk	bash#
4033c609719bSwdenk
40340267768eSMatthew McClintockBoot Linux and pass a flat device tree:
40350267768eSMatthew McClintock-----------
40360267768eSMatthew McClintock
40370267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
40380267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
40390267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
40400267768eSMatthew McClintockflat device tree:
40410267768eSMatthew McClintock
40420267768eSMatthew McClintock=> print oftaddr
40430267768eSMatthew McClintockoftaddr=0x300000
40440267768eSMatthew McClintock=> print oft
40450267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
40460267768eSMatthew McClintock=> tftp $oftaddr $oft
40470267768eSMatthew McClintockSpeed: 1000, full duplex
40480267768eSMatthew McClintockUsing TSEC0 device
40490267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
40500267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
40510267768eSMatthew McClintockLoad address: 0x300000
40520267768eSMatthew McClintockLoading: #
40530267768eSMatthew McClintockdone
40540267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
40550267768eSMatthew McClintock=> tftp $loadaddr $bootfile
40560267768eSMatthew McClintockSpeed: 1000, full duplex
40570267768eSMatthew McClintockUsing TSEC0 device
40580267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
40590267768eSMatthew McClintockFilename 'uImage'.
40600267768eSMatthew McClintockLoad address: 0x200000
40610267768eSMatthew McClintockLoading:############
40620267768eSMatthew McClintockdone
40630267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
40640267768eSMatthew McClintock=> print loadaddr
40650267768eSMatthew McClintockloadaddr=200000
40660267768eSMatthew McClintock=> print oftaddr
40670267768eSMatthew McClintockoftaddr=0x300000
40680267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
40690267768eSMatthew McClintock## Booting image at 00200000 ...
40700267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
40710267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
40720267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
40730267768eSMatthew McClintock   Load Address: 00000000
40740267768eSMatthew McClintock   Entry Point:	 00000000
40750267768eSMatthew McClintock   Verifying Checksum ... OK
40760267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
40770267768eSMatthew McClintockBooting using flat device tree at 0x300000
40780267768eSMatthew McClintockUsing MPC85xx ADS machine description
40790267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
40800267768eSMatthew McClintock[snip]
40810267768eSMatthew McClintock
40820267768eSMatthew McClintock
40836069ff26SwdenkMore About U-Boot Image Types:
40846069ff26Swdenk------------------------------
40856069ff26Swdenk
40866069ff26SwdenkU-Boot supports the following image types:
40876069ff26Swdenk
40886069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
40896069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
40906069ff26Swdenk	well) you can continue to work in U-Boot after return from
40916069ff26Swdenk	the Standalone Program.
40926069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
40936069ff26Swdenk	will take over control completely. Usually these programs
40946069ff26Swdenk	will install their own set of exception handlers, device
40956069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
40966069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
40976069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
40986069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
40996069ff26Swdenk	being started.
41006069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
41016069ff26Swdenk	(Linux) kernel image and one or more data images like
41026069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
41036069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
41046069ff26Swdenk	server provides just a single image file, but you want to get
41056069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
41066069ff26Swdenk
41076069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
41086069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
41096069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
41106069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
41116069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
41126069ff26Swdenk	a multiple of 4 bytes).
41136069ff26Swdenk
41146069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
41156069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
41166069ff26Swdenk	flash memory.
41176069ff26Swdenk
41186069ff26Swdenk   "Script files" are command sequences that will be executed by
41196069ff26Swdenk	U-Boot's command interpreter; this feature is especially
41206069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
41216069ff26Swdenk	as command interpreter.
41226069ff26Swdenk
4123c609719bSwdenk
4124c609719bSwdenkStandalone HOWTO:
4125c609719bSwdenk=================
4126c609719bSwdenk
4127c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4128c609719bSwdenkrun "standalone" applications, which can use some resources of
4129c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4130c609719bSwdenk
4131c609719bSwdenkTwo simple examples are included with the sources:
4132c609719bSwdenk
4133c609719bSwdenk"Hello World" Demo:
4134c609719bSwdenk-------------------
4135c609719bSwdenk
4136c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4137c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4138c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4139c609719bSwdenklike that:
4140c609719bSwdenk
4141c609719bSwdenk	=> loads
4142c609719bSwdenk	## Ready for S-Record download ...
4143c609719bSwdenk	~>examples/hello_world.srec
4144c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4145c609719bSwdenk	[file transfer complete]
4146c609719bSwdenk	[connected]
4147c609719bSwdenk	## Start Addr = 0x00040004
4148c609719bSwdenk
4149c609719bSwdenk	=> go 40004 Hello World! This is a test.
4150c609719bSwdenk	## Starting application at 0x00040004 ...
4151c609719bSwdenk	Hello World
4152c609719bSwdenk	argc = 7
4153c609719bSwdenk	argv[0] = "40004"
4154c609719bSwdenk	argv[1] = "Hello"
4155c609719bSwdenk	argv[2] = "World!"
4156c609719bSwdenk	argv[3] = "This"
4157c609719bSwdenk	argv[4] = "is"
4158c609719bSwdenk	argv[5] = "a"
4159c609719bSwdenk	argv[6] = "test."
4160c609719bSwdenk	argv[7] = "<NULL>"
4161c609719bSwdenk	Hit any key to exit ...
4162c609719bSwdenk
4163c609719bSwdenk	## Application terminated, rc = 0x0
4164c609719bSwdenk
4165c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4166c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4167c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4168c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4169c609719bSwdenkcharacter, but this is just a demo program. The application can be
4170c609719bSwdenkcontrolled by the following keys:
4171c609719bSwdenk
4172c609719bSwdenk	? - print current values og the CPM Timer registers
4173c609719bSwdenk	b - enable interrupts and start timer
4174c609719bSwdenk	e - stop timer and disable interrupts
4175c609719bSwdenk	q - quit application
4176c609719bSwdenk
4177c609719bSwdenk	=> loads
4178c609719bSwdenk	## Ready for S-Record download ...
4179c609719bSwdenk	~>examples/timer.srec
4180c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4181c609719bSwdenk	[file transfer complete]
4182c609719bSwdenk	[connected]
4183c609719bSwdenk	## Start Addr = 0x00040004
4184c609719bSwdenk
4185c609719bSwdenk	=> go 40004
4186c609719bSwdenk	## Starting application at 0x00040004 ...
4187c609719bSwdenk	TIMERS=0xfff00980
4188c609719bSwdenk	Using timer 1
4189c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4190c609719bSwdenk
4191c609719bSwdenkHit 'b':
4192c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4193c609719bSwdenk	Enabling timer
4194c609719bSwdenkHit '?':
4195c609719bSwdenk	[q, b, e, ?] ........
4196c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4197c609719bSwdenkHit '?':
4198c609719bSwdenk	[q, b, e, ?] .
4199c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4200c609719bSwdenkHit '?':
4201c609719bSwdenk	[q, b, e, ?] .
4202c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4203c609719bSwdenkHit '?':
4204c609719bSwdenk	[q, b, e, ?] .
4205c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4206c609719bSwdenkHit 'e':
4207c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4208c609719bSwdenkHit 'q':
4209c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4210c609719bSwdenk
4211c609719bSwdenk
421285ec0bccSwdenkMinicom warning:
421385ec0bccSwdenk================
421485ec0bccSwdenk
42157152b1d0SwdenkOver time, many people have reported problems when trying to use the
421685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
421785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4218f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
421985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
422085ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
422185ec0bccSwdenk
422252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
422352f52c14Swdenkconfiguration to your "File transfer protocols" section:
422452f52c14Swdenk
422552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
422652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
422752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
422852f52c14Swdenk
422952f52c14Swdenk
4230c609719bSwdenkNetBSD Notes:
4231c609719bSwdenk=============
4232c609719bSwdenk
4233c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4234c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4235c609719bSwdenk
4236c609719bSwdenkBuilding requires a cross environment; it is known to work on
4237c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4238c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4239c609719bSwdenkNote that the cross-powerpc package does not install include files;
4240c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4241c609719bSwdenkmissing.  This file has to be installed and patched manually:
4242c609719bSwdenk
4243c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4244c609719bSwdenk	# mkdir powerpc
4245c609719bSwdenk	# ln -s powerpc machine
4246c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4247c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4248c609719bSwdenk
4249c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4250c609719bSwdenkand U-Boot include files.
4251c609719bSwdenk
4252c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4253c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4254c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4255c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
42562a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4257c609719bSwdenk
4258c609719bSwdenk
4259c609719bSwdenkImplementation Internals:
4260c609719bSwdenk=========================
4261c609719bSwdenk
4262c609719bSwdenkThe following is not intended to be a complete description of every
4263c609719bSwdenkimplementation detail. However, it should help to understand the
4264c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4265c609719bSwdenkhardware.
4266c609719bSwdenk
4267c609719bSwdenk
4268c609719bSwdenkInitial Stack, Global Data:
4269c609719bSwdenk---------------------------
4270c609719bSwdenk
4271c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4272c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4273c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4274c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4275c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4276c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4277c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4278c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4279c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4280c609719bSwdenklocked as (mis-) used as memory, etc.
4281c609719bSwdenk
42827152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
42830668236bSWolfgang Denk	U-Boot mailing list:
428443d9616cSwdenk
428543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
428643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
428743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
428843d9616cSwdenk	...
428943d9616cSwdenk
429043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
429143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
429243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
429343d9616cSwdenk	is that the cache is being used as a temporary supply of
429443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
429511ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
429643d9616cSwdenk	can see how this works by studying the cache architecture and
429743d9616cSwdenk	operation in the architecture and processor-specific manuals.
429843d9616cSwdenk
429943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
430043d9616cSwdenk	is another option for the system designer to use as an
430111ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
430243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
430343d9616cSwdenk	board designers haven't used it for something that would
430443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
430543d9616cSwdenk	used.
430643d9616cSwdenk
43076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
430843d9616cSwdenk	with your processor/board/system design. The default value
430943d9616cSwdenk	you will find in any recent u-boot distribution in
43108a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
431143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
431243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
431343d9616cSwdenk	that are supposed to respond to that address! That code in
431443d9616cSwdenk	start.S has been around a while and should work as is when
431543d9616cSwdenk	you get the config right.
431643d9616cSwdenk
431743d9616cSwdenk	-Chris Hallinan
431843d9616cSwdenk	DS4.COM, Inc.
431943d9616cSwdenk
4320c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4321c609719bSwdenkcode for the initialization procedures:
4322c609719bSwdenk
4323c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4324c609719bSwdenk  to write it.
4325c609719bSwdenk
432611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4327c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
43287152b1d0Swdenk  zation is performed later (when relocating to RAM).
4329c609719bSwdenk
4330c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4331c609719bSwdenk  that.
4332c609719bSwdenk
4333c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4334c609719bSwdenknormal global data to share information beween the code. But it
4335c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4336c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4337c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4338c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4339c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4340c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4341c609719bSwdenkreserve for this purpose.
4342c609719bSwdenk
43437152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4344c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4345c609719bSwdenkGCC's implementation.
4346c609719bSwdenk
4347c609719bSwdenkFor PowerPC, the following registers have specific use:
4348c609719bSwdenk	R1:	stack pointer
4349e7670f6cSWolfgang Denk	R2:	reserved for system use
4350c609719bSwdenk	R3-R4:	parameter passing and return values
4351c609719bSwdenk	R5-R10: parameter passing
4352c609719bSwdenk	R13:	small data area pointer
4353c609719bSwdenk	R30:	GOT pointer
4354c609719bSwdenk	R31:	frame pointer
4355c609719bSwdenk
4356e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4357e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4358e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4359c609719bSwdenk
4360e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4361c609719bSwdenk
4362c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4363c609719bSwdenk    address of the global data structure is known at compile time),
4364c609719bSwdenk    but it turned out that reserving a register results in somewhat
4365c609719bSwdenk    smaller code - although the code savings are not that big (on
4366c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4367c609719bSwdenk    624 text + 127 data).
4368c609719bSwdenk
4369c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
43704c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
43714c58eb55SMike Frysinger
4372c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
43734c58eb55SMike Frysinger
4374c609719bSwdenkOn ARM, the following registers are used:
4375c609719bSwdenk
4376c609719bSwdenk	R0:	function argument word/integer result
4377c609719bSwdenk	R1-R3:	function argument word
4378c609719bSwdenk	R9:	GOT pointer
4379c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4380c609719bSwdenk	R11:	argument (frame) pointer
4381c609719bSwdenk	R12:	temporary workspace
4382c609719bSwdenk	R13:	stack pointer
4383c609719bSwdenk	R14:	link register
4384c609719bSwdenk	R15:	program counter
4385c609719bSwdenk
4386c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4387c609719bSwdenk
43880df01fd3SThomas ChouOn Nios II, the ABI is documented here:
43890df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
43900df01fd3SThomas Chou
43910df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
43920df01fd3SThomas Chou
43930df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
43940df01fd3SThomas Chou    to access small data sections, so gp is free.
43950df01fd3SThomas Chou
4396d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4397d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4398c609719bSwdenk
4399c609719bSwdenkMemory Management:
4400c609719bSwdenk------------------
4401c609719bSwdenk
4402c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4403c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4404c609719bSwdenk
4405c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4406c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4407c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4408c609719bSwdenkphysical memory banks.
4409c609719bSwdenk
4410c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4411c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4412c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4413c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
44146d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4415c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4416c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4417c609719bSwdenk
4418c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4419c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4420c609719bSwdenk
4421c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4422c609719bSwdenkthis:
4423c609719bSwdenk
4424c609719bSwdenk	0x0000 0000	Exception Vector code
4425c609719bSwdenk	      :
4426c609719bSwdenk	0x0000 1FFF
4427c609719bSwdenk	0x0000 2000	Free for Application Use
4428c609719bSwdenk	      :
4429c609719bSwdenk	      :
4430c609719bSwdenk
4431c609719bSwdenk	      :
4432c609719bSwdenk	      :
4433c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4434c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4435c609719bSwdenk	0x00FC 0000	Malloc Arena
4436c609719bSwdenk	      :
4437c609719bSwdenk	0x00FD FFFF
4438c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4439c609719bSwdenk	...		eventually: LCD or video framebuffer
4440c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4441c609719bSwdenk	0x00FF FFFF	[End of RAM]
4442c609719bSwdenk
4443c609719bSwdenk
4444c609719bSwdenkSystem Initialization:
4445c609719bSwdenk----------------------
4446c609719bSwdenk
4447c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
444811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4449c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
44507152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4451c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4452c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4453c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4454c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4455c609719bSwdenkthe caches and the SIU.
4456c609719bSwdenk
4457c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4458c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4459c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4460c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4461c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4462c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4463c609719bSwdenkbanks.
4464c609719bSwdenk
4465c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
44667152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4467c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4468c609719bSwdenk0x00000000, with any additional banks following immediately to create
4469c609719bSwdenkcontiguous memory starting from 0.
4470c609719bSwdenk
4471c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4472c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4473c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4474c609719bSwdenkpages, and the final stack is set up.
4475c609719bSwdenk
4476c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4477c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4478c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4479c609719bSwdenknew address in RAM.
4480c609719bSwdenk
4481c609719bSwdenk
4482c609719bSwdenkU-Boot Porting Guide:
4483c609719bSwdenk----------------------
4484c609719bSwdenk
4485c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
44866aff3115Swdenklist, October 2002]
4487c609719bSwdenk
4488c609719bSwdenk
4489c609719bSwdenkint main(int argc, char *argv[])
4490c609719bSwdenk{
4491c609719bSwdenk	sighandler_t no_more_time;
4492c609719bSwdenk
4493c609719bSwdenk	signal(SIGALRM, no_more_time);
4494c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4495c609719bSwdenk
4496c609719bSwdenk	if (available_money > available_manpower) {
44976c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4498c609719bSwdenk		return 0;
4499c609719bSwdenk	}
4500c609719bSwdenk
4501c609719bSwdenk	Download latest U-Boot source;
4502c609719bSwdenk
45030668236bSWolfgang Denk	Subscribe to u-boot mailing list;
45046aff3115Swdenk
45056c3fef28SJerry Van Baren	if (clueless)
4506c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4507c609719bSwdenk
4508c609719bSwdenk	while (learning) {
4509c609719bSwdenk		Read the README file in the top level directory;
45107cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
45116c3fef28SJerry Van Baren		Read applicable doc/*.README;
4512c609719bSwdenk		Read the source, Luke;
45136c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4514c609719bSwdenk	}
4515c609719bSwdenk
45166c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
45176c3fef28SJerry Van Baren		Buy a BDI3000;
45186c3fef28SJerry Van Baren	else
4519c609719bSwdenk		Add a lot of aggravation and time;
4520c609719bSwdenk
45216c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
45226c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
45236c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
45246c3fef28SJerry Van Baren	} else {
4525c609719bSwdenk		Create your own board support subdirectory;
45266c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
45276c3fef28SJerry Van Baren	}
45286c3fef28SJerry Van Baren	Edit new board/<myboard> files
45296c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4530c609719bSwdenk
45316c3fef28SJerry Van Baren	while (!accepted) {
4532c609719bSwdenk		while (!running) {
4533c609719bSwdenk			do {
4534c609719bSwdenk				Add / modify source code;
4535c609719bSwdenk			} until (compiles);
4536c609719bSwdenk			Debug;
4537c609719bSwdenk			if (clueless)
4538c609719bSwdenk				email("Hi, I am having problems...");
4539c609719bSwdenk		}
45406c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
45416c3fef28SJerry Van Baren		if (reasonable critiques)
45426c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
45436c3fef28SJerry Van Baren		else
45446c3fef28SJerry Van Baren			Defend code as written;
45456c3fef28SJerry Van Baren	}
4546c609719bSwdenk
4547c609719bSwdenk	return 0;
4548c609719bSwdenk}
4549c609719bSwdenk
4550c609719bSwdenkvoid no_more_time (int sig)
4551c609719bSwdenk{
4552c609719bSwdenk      hire_a_guru();
4553c609719bSwdenk}
4554c609719bSwdenk
4555c609719bSwdenk
4556c609719bSwdenkCoding Standards:
4557c609719bSwdenk-----------------
4558c609719bSwdenk
4559c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
45602c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
45617ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4562c609719bSwdenk
45632c051651SDetlev ZundelSource files originating from a different project (for example the
45642c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
45652c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
45662c051651SDetlev Zundelsources.
45672c051651SDetlev Zundel
45682c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
45692c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
45702c051651SDetlev Zundelin your code.
4571c609719bSwdenk
4572c178d3daSwdenkPlease also stick to the following formatting rules:
4573180d3f74Swdenk- remove any trailing white space
45747ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4575180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
45767ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4577180d3f74Swdenk- do not add trailing empty lines to source files
4578180d3f74Swdenk
4579c609719bSwdenkSubmissions which do not conform to the standards may be returned
4580c609719bSwdenkwith a request to reformat the changes.
4581c609719bSwdenk
4582c609719bSwdenk
4583c609719bSwdenkSubmitting Patches:
4584c609719bSwdenk-------------------
4585c609719bSwdenk
4586c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4587c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4588c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4589c609719bSwdenk
45900d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4591218ca724SWolfgang Denk
45920668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
45930668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
45940668236bSWolfgang Denk
4595c609719bSwdenkWhen you send a patch, please include the following information with
4596c609719bSwdenkit:
4597c609719bSwdenk
4598c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4599c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4600c609719bSwdenk  patch actually fixes something.
4601c609719bSwdenk
4602c609719bSwdenk* For new features: a description of the feature and your
4603c609719bSwdenk  implementation.
4604c609719bSwdenk
4605c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4606c609719bSwdenk
4607c609719bSwdenk* For major contributions, your entry to the CREDITS file
4608c609719bSwdenk
4609c609719bSwdenk* When you add support for a new board, don't forget to add this
46107ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
4611c609719bSwdenk
4612c609719bSwdenk* If your patch adds new configuration options, don't forget to
4613c609719bSwdenk  document these in the README file.
4614c609719bSwdenk
4615218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4616218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
46177ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
4618218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4619218ca724SWolfgang Denk  with some other mail clients.
4620c609719bSwdenk
4621218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4622218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4623218ca724SWolfgang Denk  GNU diff.
46246dff5529Swdenk
4625218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4626218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4627218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4628218ca724SWolfgang Denk  affected files).
4629218ca724SWolfgang Denk
4630218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4631218ca724SWolfgang Denk  and compressed attachments must not be used.
4632c609719bSwdenk
463352f52c14Swdenk* If one logical set of modifications affects or creates several
463452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
463552f52c14Swdenk
463652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
463752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
463852f52c14Swdenk
463952f52c14Swdenk
4640c609719bSwdenkNotes:
4641c609719bSwdenk
4642c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4643c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4644c609719bSwdenk  for any of the boards.
4645c609719bSwdenk
4646c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4647c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4648c609719bSwdenk  returned with a request to re-formatting / split it.
4649c609719bSwdenk
4650c609719bSwdenk* If you modify existing code, make sure that your new code does not
4651c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4652c609719bSwdenk  When adding new features, these should compile conditionally only
4653c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4654c609719bSwdenk  disabled must not need more memory than the old code without your
4655c609719bSwdenk  modification.
465690dc6704Swdenk
46570668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
46580668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
46590668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
46600668236bSWolfgang Denk  bigger than the size limit should be avoided.
4661