xref: /openbmc/u-boot/README (revision 5356f5451e85695cf8f9782dee54cc8dfa5445e5)
1c609719bSwdenk#
2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1506eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
167fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
18392bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
18480421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1858d321b81SPeter Tyser    /lib		Architecture specific library files
186afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
187afc1ce82SMacpaul Lin    /cpu		CPU specific files
188afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
189afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser    /lib		Architecture specific library files
193a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1948d321b81SPeter Tyser    /cpu		CPU specific files
1958d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1968d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1978d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1988d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1998d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
2008d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
2018d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
2028d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
2038d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sh			Files generic to SH architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2088d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2098d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2108d321b81SPeter Tyser    /lib		Architecture specific library files
2118d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2128d321b81SPeter Tyser    /cpu		CPU specific files
2138d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2148d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2158d321b81SPeter Tyser    /lib		Architecture specific library files
2168d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2178d321b81SPeter Tyser/board			Board dependent files
2188d321b81SPeter Tyser/common			Misc architecture independent functions
2198d321b81SPeter Tyser/disk			Code for disk drive partition handling
2208d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2218d321b81SPeter Tyser/drivers		Commonly used device drivers
2228d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2238d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2248d321b81SPeter Tyser/include		Header Files
2258d321b81SPeter Tyser/lib			Files generic to all architectures
2268d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2278d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2288d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2298d321b81SPeter Tyser/net			Networking code
2308d321b81SPeter Tyser/post			Power On Self Test
2318d321b81SPeter Tyser/rtc			Real Time Clock drivers
2328d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
233c609719bSwdenk
234c609719bSwdenkSoftware Configuration:
235c609719bSwdenk=======================
236c609719bSwdenk
237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
238c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
239c609719bSwdenk
240c609719bSwdenkThere are two classes of configuration variables:
241c609719bSwdenk
242c609719bSwdenk* Configuration _OPTIONS_:
243c609719bSwdenk  These are selectable by the user and have names beginning with
244c609719bSwdenk  "CONFIG_".
245c609719bSwdenk
246c609719bSwdenk* Configuration _SETTINGS_:
247c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
248c609719bSwdenk  you don't know what you're doing; they have names beginning with
2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
250c609719bSwdenk
251c609719bSwdenkLater we will add a configuration tool - probably similar to or even
252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
253c609719bSwdenkdo the configuration by hand, which means creating some symbolic
254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
255c609719bSwdenkas an example here.
256c609719bSwdenk
257c609719bSwdenk
258c609719bSwdenkSelection of Processor Architecture and Board Type:
259c609719bSwdenk---------------------------------------------------
260c609719bSwdenk
261c609719bSwdenkFor all supported boards there are ready-to-use default
262c609719bSwdenkconfigurations available; just type "make <board_name>_config".
263c609719bSwdenk
264c609719bSwdenkExample: For a TQM823L module type:
265c609719bSwdenk
266c609719bSwdenk	cd u-boot
267c609719bSwdenk	make TQM823L_config
268c609719bSwdenk
26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
271c609719bSwdenkdirectory according to the instructions in cogent/README.
272c609719bSwdenk
273c609719bSwdenk
274c609719bSwdenkConfiguration Options:
275c609719bSwdenk----------------------
276c609719bSwdenk
277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
278c609719bSwdenksuch information is kept in a configuration file
279c609719bSwdenk"include/configs/<board_name>.h".
280c609719bSwdenk
281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
282c609719bSwdenk"include/configs/TQM823L.h".
283c609719bSwdenk
284c609719bSwdenk
2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2877f6c2cbcSwdenkbuild a config tool - later.
2887f6c2cbcSwdenk
2897f6c2cbcSwdenk
290c609719bSwdenkThe following options need to be configured:
291c609719bSwdenk
2922628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
293c609719bSwdenk
2942628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2956ccec449SWolfgang Denk
2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
298c609719bSwdenk
299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define exactly one of
301c609719bSwdenk		CONFIG_CMA286_60_OLD
302c609719bSwdenk--- FIXME --- not tested yet:
303c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
305c609719bSwdenk
306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
307c609719bSwdenk		Define exactly one of
308c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
309c609719bSwdenk
310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define one or more of
312c609719bSwdenk		CONFIG_CMA302
313c609719bSwdenk
314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31711ccc33fSMarcel Ziswiler					  the LCD display every second with
318c609719bSwdenk					  a "rotator" |\-/|\-/
319c609719bSwdenk
3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3212535d602Swdenk		CONFIG_ADSTYPE
3222535d602Swdenk		Possible values are:
3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3272535d602Swdenk
328cf946c6dSLei Wen- Marvell Family Member
329cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
330cf946c6dSLei Wen					  multiple fs option at one time
331cf946c6dSLei Wen					  for marvell soc family
332cf946c6dSLei Wen
333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
334c609719bSwdenk		Define exactly one of
335c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
336c609719bSwdenk
33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33966ca92a5Swdenk					  get_gclk_freq() cannot work
3405da627a4Swdenk					  e.g. if there is no 32KHz
3415da627a4Swdenk					  reference PIT/RTC clock
34266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34366ca92a5Swdenk					  or XTAL/EXTAL)
344c609719bSwdenk
34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34975d1ea7fSwdenk			See doc/README.MPC866
35075d1ea7fSwdenk
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35275d1ea7fSwdenk
35375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35475d1ea7fSwdenk		of relying on the correctness of the configured
35575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35975d1ea7fSwdenk
360506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
361506f3918SHeiko Schocher
362506f3918SHeiko Schocher		Define this option if you want to enable the
363506f3918SHeiko Schocher		ICache only when Code runs from RAM.
364506f3918SHeiko Schocher
36566412c63SKumar Gala- 85xx CPU Options:
36666412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36766412c63SKumar Gala
36866412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36966412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37066412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37166412c63SKumar Gala
3728f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3738f29084aSKumar Gala
3748f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3758f29084aSKumar Gala		tree nodes for the given platform.
3768f29084aSKumar Gala
3776cb461b4SDaniel Schwierzeck- Generic CPU options:
3786cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
3796cb461b4SDaniel Schwierzeck
3806cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
3816cb461b4SDaniel Schwierzeck		values is arch specific.
3826cb461b4SDaniel Schwierzeck
3830b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3850b953ffcSMarkus Klotzbuecher
3860b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3870b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3880b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3890b953ffcSMarkus Klotzbuecher
3906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3910b953ffcSMarkus Klotzbuecher
3920b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3930b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3940b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3950b953ffcSMarkus Klotzbuecher		by this value.
3960b953ffcSMarkus Klotzbuecher
39792bbd64eSDaniel Schwierzeck- MIPS CPU options:
39892bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
39992bbd64eSDaniel Schwierzeck
40092bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
40192bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
40292bbd64eSDaniel Schwierzeck		relocation.
40392bbd64eSDaniel Schwierzeck
40492bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
40592bbd64eSDaniel Schwierzeck
40692bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
40792bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
40892bbd64eSDaniel Schwierzeck		Possible values are:
40992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
41092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
41192bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
41292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
41392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
41492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
41592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
41692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
41792bbd64eSDaniel Schwierzeck
41892bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
41992bbd64eSDaniel Schwierzeck
42092bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
42192bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
42292bbd64eSDaniel Schwierzeck
42392bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
42492bbd64eSDaniel Schwierzeck
42592bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
42692bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
42792bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
42892bbd64eSDaniel Schwierzeck
429b67d8816SChristian Riesch- ARM options:
430b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
431b67d8816SChristian Riesch
432b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
433b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
434b67d8816SChristian Riesch
435*5356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
436*5356f545SAneesh V
437*5356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
438*5356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
439*5356f545SAneesh V		better code density. For ARM architectures that support
440*5356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
441*5356f545SAneesh V		GCC.
442*5356f545SAneesh V
4435da627a4Swdenk- Linux Kernel Interface:
444c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
445c609719bSwdenk
446c609719bSwdenk		U-Boot stores all clock information in Hz
447c609719bSwdenk		internally. For binary compatibility with older Linux
448c609719bSwdenk		kernels (which expect the clocks passed in the
449c609719bSwdenk		bd_info data to be in MHz) the environment variable
450c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
451c609719bSwdenk		converts clock data to MHZ before passing it to the
452c609719bSwdenk		Linux kernel.
453c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
454c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
455c609719bSwdenk		default environment.
456c609719bSwdenk
4575da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4585da627a4Swdenk
45911ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4605da627a4Swdenk		expect it to be in bytes, others in MB.
4615da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4625da627a4Swdenk
463fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
464f57f70aaSWolfgang Denk
465f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
466213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
467213bf8c8SGerald Van Baren		concepts).
468213bf8c8SGerald Van Baren
469213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
470213bf8c8SGerald Van Baren		 * New libfdt-based support
471213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4723bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
473213bf8c8SGerald Van Baren
474b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
475b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
476b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
477b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
478f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
479c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
480f57f70aaSWolfgang Denk
48111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
48211ccc33fSMarcel Ziswiler		addresses
4833bb342fcSKim Phillips
4844e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4854e253137SKumar Gala
4864e253137SKumar Gala		Board code has addition modification that it wants to make
4874e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4886705d81eSwdenk
4890267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4900267768eSMatthew McClintock
49111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4920267768eSMatthew McClintock		param header, the default value is zero if undefined.
4930267768eSMatthew McClintock
4943887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4953887c3fbSHeiko Schocher
4963887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4973887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4983887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4993887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5003887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5013887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5023887c3fbSHeiko Schocher
5037eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5047eb29398SIgor Grinberg
5057eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5067eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5077eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5087eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5097eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5107eb29398SIgor Grinberg		in a single configuration file and the machine type is
5117eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5127eb29398SIgor Grinberg
5130b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5140b2f4ecaSNiklaus Giger
5150b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5160b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5170b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5180b2f4ecaSNiklaus Giger
5190b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5200b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5210b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5220b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5230b2f4ecaSNiklaus Giger
5240b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5250b2f4ecaSNiklaus Giger
5260b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5270b2f4ecaSNiklaus Giger
5280b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5290b2f4ecaSNiklaus Giger		the defaults discussed just above.
5300b2f4ecaSNiklaus Giger
5312c451f78SAneesh V- Cache Configuration:
5322c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5332c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5342c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5352c451f78SAneesh V
53693bc2193SAneesh V- Cache Configuration for ARM:
53793bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
53893bc2193SAneesh V				      controller
53993bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
54093bc2193SAneesh V					controller register space
54193bc2193SAneesh V
5426705d81eSwdenk- Serial Ports:
54348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5446705d81eSwdenk
5456705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5466705d81eSwdenk
54748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5486705d81eSwdenk
5496705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5506705d81eSwdenk
5516705d81eSwdenk		CONFIG_PL011_CLOCK
5526705d81eSwdenk
5536705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5546705d81eSwdenk		the clock speed of the UARTs.
5556705d81eSwdenk
5566705d81eSwdenk		CONFIG_PL01x_PORTS
5576705d81eSwdenk
5586705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5596705d81eSwdenk		define this to a list of base addresses for each (supported)
5606705d81eSwdenk		port. See e.g. include/configs/versatile.h
5616705d81eSwdenk
562910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
563910f1ae3SJohn Rigby
564910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
565910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
566910f1ae3SJohn Rigby		this variable to initialize the extra register.
567910f1ae3SJohn Rigby
568910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
569910f1ae3SJohn Rigby
570910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
571910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
572910f1ae3SJohn Rigby		variable to flush the UART at init time.
573910f1ae3SJohn Rigby
5746705d81eSwdenk
575c609719bSwdenk- Console Interface:
576c609719bSwdenk		Depending on board, define exactly one serial port
577c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
578c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
579c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
580c609719bSwdenk
581c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
582c609719bSwdenk		port routines must be defined elsewhere
583c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
584c609719bSwdenk
585c609719bSwdenk		CONFIG_CFB_CONSOLE
586c609719bSwdenk		Enables console device for a color framebuffer. Needs following
587c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
588c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
589c609719bSwdenk						(default big endian)
590c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
591c609719bSwdenk						rectangle fill
592c609719bSwdenk						(cf. smiLynxEM)
593c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
594c609719bSwdenk						bit-blit (cf. smiLynxEM)
595c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
596c609719bSwdenk						(cols=pitch)
597c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
598c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
599c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
600c609719bSwdenk						(0-5, cf. cfb_console.c)
601c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
602c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
603c609719bSwdenk						(i.e. i8042_kbd_init())
604c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
605c609719bSwdenk						(i.e. i8042_tstc)
606c609719bSwdenk			VIDEO_GETC_FCT		get char fct
607c609719bSwdenk						(i.e. i8042_getc)
608c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
609c609719bSwdenk						(requires blink timer
610c609719bSwdenk						cf. i8042.c)
6116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
612c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
613c609719bSwdenk						upper right corner
614602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
615c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
616c609719bSwdenk						upper left corner
617a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
618a6c7ad2fSwdenk						linux_logo.h for logo.
619a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
620c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
62111ccc33fSMarcel Ziswiler						additional board info beside
622c609719bSwdenk						the logo
623c609719bSwdenk
624c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
625c609719bSwdenk		default i/o. Serial console can be forced with
626c609719bSwdenk		environment 'console=serial'.
627c609719bSwdenk
628a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
629a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
630a3ad8e26Swdenk		the "silent" environment variable. See
631a3ad8e26Swdenk		doc/README.silent for more information.
632a3ad8e26Swdenk
633c609719bSwdenk- Console Baudrate:
634c609719bSwdenk		CONFIG_BAUDRATE - in bps
635c609719bSwdenk		Select one of the baudrates listed in
6366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
638c609719bSwdenk
639c92fac91SHeiko Schocher- Console Rx buffer length
640c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
641c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6422b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
643c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
644c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
645c92fac91SHeiko Schocher		the SMC.
646c92fac91SHeiko Schocher
6479558b48aSGraeme Russ- Pre-Console Buffer:
6489558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6499558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6509558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6519558b48aSGraeme Russ		buffer any console messages prior to the console being
6529558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6539558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6549558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6559558b48aSGraeme Russ		bytes are output before the console is initialised, the
6569558b48aSGraeme Russ		earlier bytes are discarded.
6579558b48aSGraeme Russ
6589558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6599558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
6609558b48aSGraeme Russ
661046a37bdSSonny Rao- Safe printf() functions
662046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
663046a37bdSSonny Rao		the printf() functions. These are defined in
664046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
665046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
666046a37bdSSonny Rao		If this option is not given then these functions will
667046a37bdSSonny Rao		silently discard their buffer size argument - this means
668046a37bdSSonny Rao		you are not getting any overflow checking in this case.
669046a37bdSSonny Rao
670c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
671c609719bSwdenk		Delay before automatically booting the default image;
672c609719bSwdenk		set to -1 to disable autoboot.
673c609719bSwdenk
674c609719bSwdenk		See doc/README.autoboot for these options that
675c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
676c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
677c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
678c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
679c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
680c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
681c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
682c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
683c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
684c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
685c609719bSwdenk		CONFIG_RESET_TO_RETRY
686c609719bSwdenk
687c609719bSwdenk- Autoboot Command:
688c609719bSwdenk		CONFIG_BOOTCOMMAND
689c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
690c609719bSwdenk		define a command string that is automatically executed
691c609719bSwdenk		when no character is read on the console interface
692c609719bSwdenk		within "Boot Delay" after reset.
693c609719bSwdenk
694c609719bSwdenk		CONFIG_BOOTARGS
695c609719bSwdenk		This can be used to pass arguments to the bootm
696c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
697c609719bSwdenk		environment value "bootargs".
698c609719bSwdenk
699c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
700c609719bSwdenk		The value of these goes into the environment as
701c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
702c609719bSwdenk		as a convenience, when switching between booting from
70311ccc33fSMarcel Ziswiler		RAM and NFS.
704c609719bSwdenk
705c609719bSwdenk- Pre-Boot Commands:
706c609719bSwdenk		CONFIG_PREBOOT
707c609719bSwdenk
708c609719bSwdenk		When this option is #defined, the existence of the
709c609719bSwdenk		environment variable "preboot" will be checked
710c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
711c609719bSwdenk		countdown and/or running the auto-boot command resp.
712c609719bSwdenk		entering interactive mode.
713c609719bSwdenk
714c609719bSwdenk		This feature is especially useful when "preboot" is
715c609719bSwdenk		automatically generated or modified. For an example
716c609719bSwdenk		see the LWMON board specific code: here "preboot" is
717c609719bSwdenk		modified when the user holds down a certain
718c609719bSwdenk		combination of keys on the (special) keyboard when
719c609719bSwdenk		booting the systems
720c609719bSwdenk
721c609719bSwdenk- Serial Download Echo Mode:
722c609719bSwdenk		CONFIG_LOADS_ECHO
723c609719bSwdenk		If defined to 1, all characters received during a
724c609719bSwdenk		serial download (using the "loads" command) are
725c609719bSwdenk		echoed back. This might be needed by some terminal
726c609719bSwdenk		emulations (like "cu"), but may as well just take
727c609719bSwdenk		time on others. This setting #define's the initial
728c609719bSwdenk		value of the "loads_echo" environment variable.
729c609719bSwdenk
730602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
731c609719bSwdenk		CONFIG_KGDB_BAUDRATE
732c609719bSwdenk		Select one of the baudrates listed in
7336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
734c609719bSwdenk
735c609719bSwdenk- Monitor Functions:
736602ad3b3SJon Loeliger		Monitor commands can be included or excluded
737602ad3b3SJon Loeliger		from the build by using the #include files
738602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
739602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
740602ad3b3SJon Loeliger		and augmenting with additional #define's
741602ad3b3SJon Loeliger		for wanted commands.
742c609719bSwdenk
743602ad3b3SJon Loeliger		The default command configuration includes all commands
744602ad3b3SJon Loeliger		except those marked below with a "*".
745602ad3b3SJon Loeliger
746602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
747602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
748602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
749602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
750602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
751602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
752602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
753602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
754710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
755602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
756602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
757602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
758a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
759a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
760a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
761a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
762602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
763602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
764246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
765602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
766602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7670c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
768bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
769602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
770602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
771602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
772602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
773602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
774a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
775a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
776602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
777602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
778602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
779602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
780602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
781602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7820c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
783602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
784602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
785602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
786602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7871ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
788602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
789602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
79002c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
79102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
792602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
79356523f12Swdenk					  loop, loopw, mtest
794602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
795602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
796602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
79768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
798602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
799602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
800e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
801e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
802602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
803602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
804602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
805602ad3b3SJon Loeliger					  host
806602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
807602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
808602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
809602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
810602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
811602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
812602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
813602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
814602ad3b3SJon Loeliger					  (4xx only)
815f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
816c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
81702c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
81874de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
819602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8207a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8211fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
822ca366d0eSChe-liang Chiou		CONFIG_CMD_TIME		* run command and report execution time
823602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
824602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
825c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
826c609719bSwdenk
827c609719bSwdenk
828c609719bSwdenk		EXAMPLE: If you want all functions except of network
829c609719bSwdenk		support you can write:
830c609719bSwdenk
831602ad3b3SJon Loeliger		#include "config_cmd_all.h"
832602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
833c609719bSwdenk
834213bf8c8SGerald Van Baren	Other Commands:
835213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
836c609719bSwdenk
837c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
838602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
839c609719bSwdenk		what you (and your U-Boot users) are doing. Data
840c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
841c609719bSwdenk		8260 (where accesses to the IMMR region must be
842c609719bSwdenk		uncached), and it cannot be disabled on all other
843c609719bSwdenk		systems where we (mis-) use the data cache to hold an
844c609719bSwdenk		initial stack and some data.
845c609719bSwdenk
846c609719bSwdenk
847c609719bSwdenk		XXX - this list needs to get updated!
848c609719bSwdenk
84945ba8077SSimon Glass- Device tree:
85045ba8077SSimon Glass		CONFIG_OF_CONTROL
85145ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
85245ba8077SSimon Glass		to configure its devices, instead of relying on statically
85345ba8077SSimon Glass		compiled #defines in the board file. This option is
85445ba8077SSimon Glass		experimental and only available on a few boards. The device
85545ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
85645ba8077SSimon Glass
8572c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
8582c0f79e4SSimon Glass		be done using one of the two options below:
859bbb0b128SSimon Glass
860bbb0b128SSimon Glass		CONFIG_OF_EMBED
861bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
862bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
863bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
864bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
865bbb0b128SSimon Glass		the global data structure as gd->blob.
86645ba8077SSimon Glass
8672c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
8682c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
8692c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
8702c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
8712c0f79e4SSimon Glass
8722c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
8732c0f79e4SSimon Glass
8742c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
8752c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
8762c0f79e4SSimon Glass		still use the individual files if you need something more
8772c0f79e4SSimon Glass		exotic.
8782c0f79e4SSimon Glass
879c609719bSwdenk- Watchdog:
880c609719bSwdenk		CONFIG_WATCHDOG
881c609719bSwdenk		If this variable is defined, it enables watchdog
8826abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8836abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8846abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8856abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8866abe6fb6SDetlev Zundel		available, then no further board specific code should
8876abe6fb6SDetlev Zundel		be needed to use it.
8886abe6fb6SDetlev Zundel
8896abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8906abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8916abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8926abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
893c609719bSwdenk
894c1551ea8Sstroese- U-Boot Version:
895c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
896c1551ea8Sstroese		If this variable is defined, an environment variable
897c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
898c1551ea8Sstroese		version as printed by the "version" command.
899c1551ea8Sstroese		This variable is readonly.
900c1551ea8Sstroese
901c609719bSwdenk- Real-Time Clock:
902c609719bSwdenk
903602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
904c609719bSwdenk		has to be selected, too. Define exactly one of the
905c609719bSwdenk		following options:
906c609719bSwdenk
907c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
908c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9094e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
910c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9111cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
912c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9137f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9143bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9159536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9164c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
91871d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
91971d19f30SHeiko Schocher					  RV3029 RTC.
920c609719bSwdenk
921b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
922b37c7e5eSwdenk		must also be configured. See I2C Support, below.
923b37c7e5eSwdenk
924e92739d3SPeter Tyser- GPIO Support:
925e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
926e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
927e92739d3SPeter Tyser
9285dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9295dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9305dec49caSChris Packham		pins supported by a particular chip.
9315dec49caSChris Packham
932e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
933e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
934e92739d3SPeter Tyser
935c609719bSwdenk- Timestamp Support:
936c609719bSwdenk
937c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
938c609719bSwdenk		(date and time) of an image is printed by image
939c609719bSwdenk		commands like bootm or iminfo. This option is
940602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
941c609719bSwdenk
942c609719bSwdenk- Partition Support:
943c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
94407f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
945c609719bSwdenk
946602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
947218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
948218ca724SWolfgang Denk		least one partition type as well.
949c609719bSwdenk
950c609719bSwdenk- IDE Reset method:
9514d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9524d13cbadSwdenk		board configurations files but used nowhere!
953c609719bSwdenk
9544d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9554d13cbadSwdenk		be performed by calling the function
9564d13cbadSwdenk			ide_set_reset(int reset)
9574d13cbadSwdenk		which has to be defined in a board specific file
958c609719bSwdenk
959c609719bSwdenk- ATAPI Support:
960c609719bSwdenk		CONFIG_ATAPI
961c609719bSwdenk
962c609719bSwdenk		Set this to enable ATAPI support.
963c609719bSwdenk
964c40b2956Swdenk- LBA48 Support
965c40b2956Swdenk		CONFIG_LBA48
966c40b2956Swdenk
967c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9684b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
969c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
970c40b2956Swdenk		support disks up to 2.1TB.
971c40b2956Swdenk
9726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
973c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
974c40b2956Swdenk			Default is 32bit.
975c40b2956Swdenk
976c609719bSwdenk- SCSI Support:
977c609719bSwdenk		At the moment only there is only support for the
978c609719bSwdenk		SYM53C8XX SCSI controller; define
979c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
980c609719bSwdenk
9816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
984c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
985c609719bSwdenk		devices.
9866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
987c609719bSwdenk
988c609719bSwdenk- NETWORK Support (PCI):
989682011ffSwdenk		CONFIG_E1000
990ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
991ce5207e1SKyle Moffett
992ce5207e1SKyle Moffett		CONFIG_E1000_SPI
993ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
994ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
995ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
996ce5207e1SKyle Moffett
997ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
998ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
999ce5207e1SKyle Moffett		example with the "sspi" command.
1000ce5207e1SKyle Moffett
1001ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1002ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1003ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1004682011ffSwdenk
1005ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
100611ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1007ac3315c2SAndre Schwarz
1008c609719bSwdenk		CONFIG_EEPRO100
1009c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
101011ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1011c609719bSwdenk		write routine for first time initialisation.
1012c609719bSwdenk
1013c609719bSwdenk		CONFIG_TULIP
1014c609719bSwdenk		Support for Digital 2114x chips.
1015c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1016c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1017c609719bSwdenk
1018c609719bSwdenk		CONFIG_NATSEMI
1019c609719bSwdenk		Support for National dp83815 chips.
1020c609719bSwdenk
1021c609719bSwdenk		CONFIG_NS8382X
1022c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1023c609719bSwdenk
102445219c46Swdenk- NETWORK Support (other):
102545219c46Swdenk
1026c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1027c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1028c041e9d2SJens Scharsig
1029c041e9d2SJens Scharsig			CONFIG_RMII
1030c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1031c041e9d2SJens Scharsig
1032c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1033c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1034c041e9d2SJens Scharsig			The driver doen't show link status messages.
1035c041e9d2SJens Scharsig
1036efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1037efdd7319SRob Herring		Support for the Calxeda XGMAC device
1038efdd7319SRob Herring
103945219c46Swdenk		CONFIG_DRIVER_LAN91C96
104045219c46Swdenk		Support for SMSC's LAN91C96 chips.
104145219c46Swdenk
104245219c46Swdenk			CONFIG_LAN91C96_BASE
104345219c46Swdenk			Define this to hold the physical address
104445219c46Swdenk			of the LAN91C96's I/O space
104545219c46Swdenk
104645219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
104745219c46Swdenk			Define this to enable 32 bit addressing
104845219c46Swdenk
1049f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1050f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1051f39748aeSwdenk
1052f39748aeSwdenk			CONFIG_SMC91111_BASE
1053f39748aeSwdenk			Define this to hold the physical address
1054f39748aeSwdenk			of the device (I/O space)
1055f39748aeSwdenk
1056f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1057f39748aeSwdenk			Define this if data bus is 32 bits
1058f39748aeSwdenk
1059f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1060f39748aeSwdenk			Define this to use i/o functions instead of macros
1061f39748aeSwdenk			(some hardware wont work with macros)
1062f39748aeSwdenk
1063dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1064dc02badaSHeiko Schocher		Support for davinci emac
1065dc02badaSHeiko Schocher
1066dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1067dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1068dc02badaSHeiko Schocher
1069b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1070b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1071b3dbf4a5SMacpaul Lin
1072b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1073b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1074b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1075b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1076b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1077b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1078b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1079b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1080b3dbf4a5SMacpaul Lin
1081c2fff331SMike Rapoport		CONFIG_SMC911X
1082557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1083557b377dSJens Gehrlein
1084c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1085557b377dSJens Gehrlein			Define this to hold the physical address
1086557b377dSJens Gehrlein			of the device (I/O space)
1087557b377dSJens Gehrlein
1088c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1089557b377dSJens Gehrlein			Define this if data bus is 32 bits
1090557b377dSJens Gehrlein
1091c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1092557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1093557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1094c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1095557b377dSJens Gehrlein
10963d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
10973d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
10983d0075faSYoshihiro Shimoda
10993d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11003d0075faSYoshihiro Shimoda			Define the number of ports to be used
11013d0075faSYoshihiro Shimoda
11023d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11033d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11043d0075faSYoshihiro Shimoda
110568260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
110668260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
110768260aabSYoshihiro Shimoda
11085e124724SVadim Bendebury- TPM Support:
11095e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11105e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11115e124724SVadim Bendebury		per system is supported at this time.
11125e124724SVadim Bendebury
11135e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11145e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11155e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11165e124724SVadim Bendebury			0xfed40000.
11175e124724SVadim Bendebury
1118c609719bSwdenk- USB Support:
1119c609719bSwdenk		At the moment only the UHCI host controller is
11204d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1121c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1122c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
112330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1124c609719bSwdenk		storage devices.
1125c609719bSwdenk		Note:
1126c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1127c609719bSwdenk		(TEAC FD-05PUB).
11284d13cbadSwdenk		MPC5200 USB requires additional defines:
11294d13cbadSwdenk			CONFIG_USB_CLOCK
11304d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1131307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1132307ecb6dSEric Millbrandt				for USB on PSC3
11334d13cbadSwdenk			CONFIG_USB_CONFIG
11344d13cbadSwdenk				for differential drivers: 0x00001000
11354d13cbadSwdenk				for single ended drivers: 0x00005000
1136307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1137307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1139fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1140fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11414d13cbadSwdenk
11429ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11439ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
11449ab4ce22SSimon Glass
114516c8d5e7SWolfgang Denk- USB Device:
114616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
114716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
114816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
114911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
115016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
115116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
115216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
115316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
115416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
115516c8d5e7SWolfgang Denk		a Linux host by
115616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
115716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
115816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
115916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
116016c8d5e7SWolfgang Denk
116116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
116216c8d5e7SWolfgang Denk			Define this to build a UDC device
116316c8d5e7SWolfgang Denk
116416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
116516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
116616c8d5e7SWolfgang Denk			talk to the UDC device
116716c8d5e7SWolfgang Denk
1168f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1169f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1170f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1171f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1172f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1173f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1174f9da0f89SVipin KUMAR			speed.
1175f9da0f89SVipin KUMAR
11766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
117716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
117816c8d5e7SWolfgang Denk			be set to usbtty.
117916c8d5e7SWolfgang Denk
118016c8d5e7SWolfgang Denk			mpc8xx:
11816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
118216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
11836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
118416c8d5e7SWolfgang Denk
11856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
118616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
118816c8d5e7SWolfgang Denk
118916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
119016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
119116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
119216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
119316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
119416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
119516c8d5e7SWolfgang Denk
119616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
119716c8d5e7SWolfgang Denk			Define this string as the name of your company for
119816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
119916c8d5e7SWolfgang Denk
120016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
120116c8d5e7SWolfgang Denk			Define this string as the name of your product
120216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
120316c8d5e7SWolfgang Denk
120416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
120516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
120616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
120716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
120816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
120916c8d5e7SWolfgang Denk
121016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
121116c8d5e7SWolfgang Denk			Define this as the unique Product ID
121216c8d5e7SWolfgang Denk			for your device
121316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1214c609719bSwdenk
1215d70a560fSIgor Grinberg- ULPI Layer Support:
1216d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1217d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1218d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1219d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1220d70a560fSIgor Grinberg		viewport is supported.
1221d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1222d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1223c609719bSwdenk
1224c609719bSwdenk- MMC Support:
1225c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1226c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1227c609719bSwdenk		accessed from the boot prompt by mapping the device
1228c609719bSwdenk		to physical memory similar to flash. Command line is
1229602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1230602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1231c609719bSwdenk
1232afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1233afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1234afb35666SYoshihiro Shimoda
1235afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1236afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1237afb35666SYoshihiro Shimoda
1238afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1239afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1240afb35666SYoshihiro Shimoda
12416705d81eSwdenk- Journaling Flash filesystem support:
12426705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
12436705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
12446705d81eSwdenk		Define these for a default partition on a NAND device
12456705d81eSwdenk
12466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
12476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
12486705d81eSwdenk		Define these for a default partition on a NOR device
12496705d81eSwdenk
12506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
12516705d81eSwdenk		Define this to create an own partition. You have to provide a
12526705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
12536705d81eSwdenk
12546705d81eSwdenk		If you define only one JFFS2 partition you may also want to
12556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
12566705d81eSwdenk		to disable the command chpart. This is the default when you
12576705d81eSwdenk		have not defined a custom partition
12586705d81eSwdenk
1259c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1260c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1261656f4c65SDonggeun Kim
1262656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1263656f4c65SDonggeun Kim		file in FAT formatted partition.
1264656f4c65SDonggeun Kim
1265656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1266656f4c65SDonggeun Kim		user to write files to FAT.
1267c30a15e5SDonggeun Kim
1268c609719bSwdenk- Keyboard Support:
1269c609719bSwdenk		CONFIG_ISA_KEYBOARD
1270c609719bSwdenk
1271c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1272c609719bSwdenk		support
1273c609719bSwdenk
1274c609719bSwdenk		CONFIG_I8042_KBD
1275c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1276c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1277c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1278c609719bSwdenk		for cfb_console. Supports cursor blinking.
1279c609719bSwdenk
1280c609719bSwdenk- Video support:
1281c609719bSwdenk		CONFIG_VIDEO
1282c609719bSwdenk
1283c609719bSwdenk		Define this to enable video support (for output to
1284c609719bSwdenk		video).
1285c609719bSwdenk
1286c609719bSwdenk		CONFIG_VIDEO_CT69000
1287c609719bSwdenk
1288c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1289c609719bSwdenk
1290c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1291eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1292eeb1b77bSwdenk		video output is selected via environment 'videoout'
1293eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1294eeb1b77bSwdenk		assumed.
1295c609719bSwdenk
1296eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
129711ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1298eeb1b77bSwdenk		are possible:
1299eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1300eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1301eeb1b77bSwdenk
1302eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1303eeb1b77bSwdenk		-------------+---------------------------------------------
1304eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1305eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1306eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1307eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1308eeb1b77bSwdenk		-------------+---------------------------------------------
1309c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1310c609719bSwdenk
1311eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13127817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1313eeb1b77bSwdenk
1314eeb1b77bSwdenk
1315a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1316a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1317a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1318a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1319a6c7ad2fSwdenk
13207d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13217d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13227d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13237d3053fbSTimur Tabi		support, and should also define these other macros:
13247d3053fbSTimur Tabi
13257d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13267d3053fbSTimur Tabi			CONFIG_VIDEO
13277d3053fbSTimur Tabi			CONFIG_CMD_BMP
13287d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13297d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13307d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13317d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13327d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13337d3053fbSTimur Tabi
1334ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1335ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1336ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1337ba8e76bdSTimur Tabi		description of this variable.
13387d3053fbSTimur Tabi
1339682011ffSwdenk- Keyboard Support:
1340682011ffSwdenk		CONFIG_KEYBOARD
1341682011ffSwdenk
1342682011ffSwdenk		Define this to enable a custom keyboard support.
1343682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1344682011ffSwdenk		defined in your board-specific files.
1345682011ffSwdenk		The only board using this so far is RBC823.
1346a6c7ad2fSwdenk
1347c609719bSwdenk- LCD Support:	CONFIG_LCD
1348c609719bSwdenk
1349c609719bSwdenk		Define this to enable LCD support (for output to LCD
1350c609719bSwdenk		display); also select one of the supported displays
1351c609719bSwdenk		by defining one of these:
1352c609719bSwdenk
135339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
135439cf4804SStelian Pop
135539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
135639cf4804SStelian Pop
1357fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1358c609719bSwdenk
1359fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1360c609719bSwdenk
1361fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1362c609719bSwdenk
1363fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1364fd3103bbSwdenk			Active, color, single scan.
1365fd3103bbSwdenk
1366fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1367fd3103bbSwdenk
1368fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1369c609719bSwdenk			Active, color, single scan.
1370c609719bSwdenk
1371c609719bSwdenk		CONFIG_SHARP_16x9
1372c609719bSwdenk
1373c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1374c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1375c609719bSwdenk
1376c609719bSwdenk		CONFIG_SHARP_LQ64D341
1377c609719bSwdenk
1378c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1379c609719bSwdenk			Active, color, single scan.
1380c609719bSwdenk
1381c609719bSwdenk		CONFIG_HLD1045
1382c609719bSwdenk
1383c609719bSwdenk			HLD1045 display, 640x480.
1384c609719bSwdenk			Active, color, single scan.
1385c609719bSwdenk
1386c609719bSwdenk		CONFIG_OPTREX_BW
1387c609719bSwdenk
1388c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1389c609719bSwdenk			or
1390c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1391c609719bSwdenk			or
1392c609719bSwdenk			Hitachi	 SP14Q002
1393c609719bSwdenk
1394c609719bSwdenk			320x240. Black & white.
1395c609719bSwdenk
1396c609719bSwdenk		Normally display is black on white background; define
13976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1398c609719bSwdenk
13997152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1400d791b1dcSwdenk
1401d791b1dcSwdenk		If this option is set, the environment is checked for
1402d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1403d791b1dcSwdenk		of logo, copyright and system information on the LCD
1404e94d2cd9Swdenk		is suppressed and the BMP image at the address
1405d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1406d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1407d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1408d791b1dcSwdenk		loaded very quickly after power-on.
1409d791b1dcSwdenk
14101ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14111ca298ceSMatthias Weisser
14121ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14131ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14141ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14151ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14161ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14171ca298ceSMatthias Weisser		specify 'm' for centering the image.
14181ca298ceSMatthias Weisser
14191ca298ceSMatthias Weisser		Example:
14201ca298ceSMatthias Weisser		setenv splashpos m,m
14211ca298ceSMatthias Weisser			=> image at center of screen
14221ca298ceSMatthias Weisser
14231ca298ceSMatthias Weisser		setenv splashpos 30,20
14241ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14251ca298ceSMatthias Weisser
14261ca298ceSMatthias Weisser		setenv splashpos -10,m
14271ca298ceSMatthias Weisser			=> vertically centered image
14281ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14291ca298ceSMatthias Weisser
143098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
143198f4a3dfSStefan Roese
143298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
143398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
143498f4a3dfSStefan Roese		splashscreen support or the bmp command.
143598f4a3dfSStefan Roese
1436d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1437d5011762SAnatolij Gustschin
1438d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1439d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1440d5011762SAnatolij Gustschin		bmp command.
1441d5011762SAnatolij Gustschin
1442c29fdfc1Swdenk- Compression support:
1443c29fdfc1Swdenk		CONFIG_BZIP2
1444c29fdfc1Swdenk
1445c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1446c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1447c29fdfc1Swdenk		compressed images are supported.
1448c29fdfc1Swdenk
1449c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
14506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1451c29fdfc1Swdenk		be at least 4MB.
1452d791b1dcSwdenk
1453fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1454fc9c1727SLuigi 'Comio' Mantellini
1455fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1456fc9c1727SLuigi 'Comio' Mantellini		images is included.
1457fc9c1727SLuigi 'Comio' Mantellini
1458fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1459fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1460fc9c1727SLuigi 'Comio' Mantellini		formula:
1461fc9c1727SLuigi 'Comio' Mantellini
1462fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1463fc9c1727SLuigi 'Comio' Mantellini
1464fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1465fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1466fc9c1727SLuigi 'Comio' Mantellini
1467fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1468fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1469fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1470fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1471fc9c1727SLuigi 'Comio' Mantellini
1472fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1473fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
14746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1475fc9c1727SLuigi 'Comio' Mantellini
147617ea1177Swdenk- MII/PHY support:
147717ea1177Swdenk		CONFIG_PHY_ADDR
147817ea1177Swdenk
147917ea1177Swdenk		The address of PHY on MII bus.
148017ea1177Swdenk
148117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
148217ea1177Swdenk
148317ea1177Swdenk		The clock frequency of the MII bus
148417ea1177Swdenk
148517ea1177Swdenk		CONFIG_PHY_GIGE
148617ea1177Swdenk
148717ea1177Swdenk		If this option is set, support for speed/duplex
148811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
148917ea1177Swdenk
149017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
149117ea1177Swdenk
149217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
149317ea1177Swdenk		reset before any MII register access is possible.
149417ea1177Swdenk		For such PHY, set this option to the usec delay
149517ea1177Swdenk		required. (minimum 300usec for LXT971A)
149617ea1177Swdenk
149717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
149817ea1177Swdenk
149917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
150017ea1177Swdenk		command issued before MII status register can be read
150117ea1177Swdenk
1502c609719bSwdenk- Ethernet address:
1503c609719bSwdenk		CONFIG_ETHADDR
1504c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1505c609719bSwdenk		CONFIG_ETH2ADDR
1506c609719bSwdenk		CONFIG_ETH3ADDR
1507c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1508c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1509c609719bSwdenk
151011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
151111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1512c609719bSwdenk		is not determined automatically.
1513c609719bSwdenk
1514c609719bSwdenk- IP address:
1515c609719bSwdenk		CONFIG_IPADDR
1516c609719bSwdenk
1517c609719bSwdenk		Define a default value for the IP address to use for
151811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1519c609719bSwdenk		determined through e.g. bootp.
15201ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1521c609719bSwdenk
1522c609719bSwdenk- Server IP address:
1523c609719bSwdenk		CONFIG_SERVERIP
1524c609719bSwdenk
1525c609719bSwdenk		Defines a default value for the IP address of a TFTP
1526c609719bSwdenk		server to contact when using the "tftboot" command.
15271ebcd654SWolfgang Denk		(Environment variable "serverip")
1528c609719bSwdenk
152997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
153097cfe861SRobin Getz
153197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
153297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
153397cfe861SRobin Getz
15341ebcd654SWolfgang Denk- Gateway IP address:
15351ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15361ebcd654SWolfgang Denk
15371ebcd654SWolfgang Denk		Defines a default value for the IP address of the
15381ebcd654SWolfgang Denk		default router where packets to other networks are
15391ebcd654SWolfgang Denk		sent to.
15401ebcd654SWolfgang Denk		(Environment variable "gatewayip")
15411ebcd654SWolfgang Denk
15421ebcd654SWolfgang Denk- Subnet mask:
15431ebcd654SWolfgang Denk		CONFIG_NETMASK
15441ebcd654SWolfgang Denk
15451ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
15461ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
15471ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
15481ebcd654SWolfgang Denk		forwarded through a router.
15491ebcd654SWolfgang Denk		(Environment variable "netmask")
15501ebcd654SWolfgang Denk
155153a5c424SDavid Updegraff- Multicast TFTP Mode:
155253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
155353a5c424SDavid Updegraff
155453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
155553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
155611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
155753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
155853a5c424SDavid Updegraff		multicast group.
155953a5c424SDavid Updegraff
1560c609719bSwdenk- BOOTP Recovery Mode:
1561c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1562c609719bSwdenk
1563c609719bSwdenk		If you have many targets in a network that try to
1564c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1565c609719bSwdenk		systems send out BOOTP requests at precisely the same
1566c609719bSwdenk		moment (which would happen for instance at recovery
1567c609719bSwdenk		from a power failure, when all systems will try to
1568c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1569c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1570c609719bSwdenk		inserted before sending out BOOTP requests. The
15716c33c785SWolfgang Denk		following delays are inserted then:
1572c609719bSwdenk
1573c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1574c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1575c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1576c609719bSwdenk		4th and following
1577c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1578c609719bSwdenk
1579fe389a82Sstroese- DHCP Advanced Options:
15801fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
15811fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1582fe389a82Sstroese
15831fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
15841fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
15851fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
15861fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
15871fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
15881fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
15891fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
15901fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
15911fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
15921fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
15931fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
15941fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1595fe389a82Sstroese
15965d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
15975d110f0aSWilson Callan		environment variable, not the BOOTP server.
1598fe389a82Sstroese
1599fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1600fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1601fe389a82Sstroese		than one DNS serverip is offered to the client.
1602fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1603fe389a82Sstroese		serverip will be stored in the additional environment
1604fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1605fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16061fe80d79SJon Loeliger		is defined.
1607fe389a82Sstroese
1608fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1609fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1610fe389a82Sstroese		need the hostname of the DHCP requester.
16115d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16121fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16131fe80d79SJon Loeliger		option 12 to the DHCP server.
1614fe389a82Sstroese
1615d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1616d9a2f416SAras Vaichas
1617d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1618d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1619d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1620d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1621d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1622d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1623d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1624d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1625d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1626d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1627d9a2f416SAras Vaichas		this delay.
1628d9a2f416SAras Vaichas
1629a3d991bdSwdenk - CDP Options:
1630a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1631a3d991bdSwdenk
1632a3d991bdSwdenk		The device id used in CDP trigger frames.
1633a3d991bdSwdenk
1634a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1635a3d991bdSwdenk
1636a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1637a3d991bdSwdenk		of the device.
1638a3d991bdSwdenk
1639a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1640a3d991bdSwdenk
1641a3d991bdSwdenk		A printf format string which contains the ascii name of
1642a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
164311ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1644a3d991bdSwdenk
1645a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1646a3d991bdSwdenk
1647a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1648a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1649a3d991bdSwdenk
1650a3d991bdSwdenk		CONFIG_CDP_VERSION
1651a3d991bdSwdenk
1652a3d991bdSwdenk		An ascii string containing the version of the software.
1653a3d991bdSwdenk
1654a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1655a3d991bdSwdenk
1656a3d991bdSwdenk		An ascii string containing the name of the platform.
1657a3d991bdSwdenk
1658a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1659a3d991bdSwdenk
1660a3d991bdSwdenk		A 32bit integer sent on the trigger.
1661a3d991bdSwdenk
1662a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1663a3d991bdSwdenk
1664a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1665a3d991bdSwdenk		device in .1 of milliwatts.
1666a3d991bdSwdenk
1667a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1668a3d991bdSwdenk
1669a3d991bdSwdenk		A byte containing the id of the VLAN.
1670a3d991bdSwdenk
1671c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1672c609719bSwdenk
1673c609719bSwdenk		Several configurations allow to display the current
1674c609719bSwdenk		status using a LED. For instance, the LED will blink
1675c609719bSwdenk		fast while running U-Boot code, stop blinking as
1676c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1677c609719bSwdenk		start blinking slow once the Linux kernel is running
1678c609719bSwdenk		(supported by a status LED driver in the Linux
1679c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1680c609719bSwdenk		feature in U-Boot.
1681c609719bSwdenk
1682c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1683c609719bSwdenk
1684c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1685c609719bSwdenk		on those systems that support this (optional)
1686c609719bSwdenk		feature, like the TQM8xxL modules.
1687c609719bSwdenk
1688c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1689c609719bSwdenk
1690b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1691b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
169211ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1693c609719bSwdenk
1694b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1695602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1696b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1697b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1698c609719bSwdenk		command line interface.
1699c609719bSwdenk
1700bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1701c609719bSwdenk
1702b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1703b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1704b37c7e5eSwdenk		support for I2C.
1705c609719bSwdenk
1706b37c7e5eSwdenk		There are several other quantities that must also be
1707b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1708c609719bSwdenk
17096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1710b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
17116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
171211ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1713c609719bSwdenk
17148d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1715a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
17168d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
17178d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
17188d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1719b37c7e5eSwdenk
17205da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
17215da71efaSEric Millbrandt
17225da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
17235da71efaSEric Millbrandt		chips might think that the current transfer is still
17245da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
17255da71efaSEric Millbrandt		commands until the slave device responds.
17265da71efaSEric Millbrandt
1727b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1728b37c7e5eSwdenk
1729b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1730b37c7e5eSwdenk		then the following macros need to be defined (examples are
1731b37c7e5eSwdenk		from include/configs/lwmon.h):
1732c609719bSwdenk
1733c609719bSwdenk		I2C_INIT
1734c609719bSwdenk
1735b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1736c609719bSwdenk		controller or configure ports.
1737c609719bSwdenk
1738b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1739b37c7e5eSwdenk
1740c609719bSwdenk		I2C_PORT
1741c609719bSwdenk
1742c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1743c609719bSwdenk		assumes both bits are on the same port). Valid values
1744c609719bSwdenk		are 0..3 for ports A..D.
1745c609719bSwdenk
1746c609719bSwdenk		I2C_ACTIVE
1747c609719bSwdenk
1748c609719bSwdenk		The code necessary to make the I2C data line active
1749c609719bSwdenk		(driven).  If the data line is open collector, this
1750c609719bSwdenk		define can be null.
1751c609719bSwdenk
1752b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1753b37c7e5eSwdenk
1754c609719bSwdenk		I2C_TRISTATE
1755c609719bSwdenk
1756c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1757c609719bSwdenk		(inactive).  If the data line is open collector, this
1758c609719bSwdenk		define can be null.
1759c609719bSwdenk
1760b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1761b37c7e5eSwdenk
1762c609719bSwdenk		I2C_READ
1763c609719bSwdenk
1764c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1765c609719bSwdenk		FALSE if it is low.
1766c609719bSwdenk
1767b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1768b37c7e5eSwdenk
1769c609719bSwdenk		I2C_SDA(bit)
1770c609719bSwdenk
1771c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1772c609719bSwdenk		is FALSE, it clears it (low).
1773c609719bSwdenk
1774b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1775b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1776b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1777b37c7e5eSwdenk
1778c609719bSwdenk		I2C_SCL(bit)
1779c609719bSwdenk
1780c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1781c609719bSwdenk		is FALSE, it clears it (low).
1782c609719bSwdenk
1783b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1784b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1785b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1786b37c7e5eSwdenk
1787c609719bSwdenk		I2C_DELAY
1788c609719bSwdenk
1789c609719bSwdenk		This delay is invoked four times per clock cycle so this
1790c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1791b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1792b37c7e5eSwdenk		like:
1793b37c7e5eSwdenk
1794b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1795c609719bSwdenk
1796793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1797793b5726SMike Frysinger
1798793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1799793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1800793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1801793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1802793b5726SMike Frysinger
1803793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1804793b5726SMike Frysinger		the generic GPIO functions.
1805793b5726SMike Frysinger
18066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
180747cd00faSwdenk
180847cd00faSwdenk		When a board is reset during an i2c bus transfer
180947cd00faSwdenk		chips might think that the current transfer is still
181047cd00faSwdenk		in progress. On some boards it is possible to access
181147cd00faSwdenk		the i2c SCLK line directly, either by using the
181247cd00faSwdenk		processor pin as a GPIO or by having a second pin
181347cd00faSwdenk		connected to the bus. If this option is defined a
181447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
181547cd00faSwdenk		is run early in the boot sequence.
181647cd00faSwdenk
181726a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
181826a33504SRichard Retanubun
181926a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
182026a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
182126a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
182226a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
182326a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
182426a33504SRichard Retanubun		controller provide such a method. It is called at the end of
182526a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
182626a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
182726a33504SRichard Retanubun
182817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
182917ea1177Swdenk
183017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
183117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
183217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
183317ea1177Swdenk
1834bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1835bb99ad6dSBen Warren
1836bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1837bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1838bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1839bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1840bb99ad6dSBen Warren
18416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1842bb99ad6dSBen Warren
1843bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
18440f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
18450f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
18460f89c54bSPeter Tyser		a 1D array of device addresses
1847bb99ad6dSBen Warren
1848bb99ad6dSBen Warren		e.g.
1849bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
18506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1851bb99ad6dSBen Warren
1852bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1853bb99ad6dSBen Warren
1854bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
18556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1856bb99ad6dSBen Warren
1857bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1858bb99ad6dSBen Warren
18596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1860be5e6181STimur Tabi
1861be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1862be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1863be5e6181STimur Tabi
18646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
18650dc018ecSStefan Roese
18660dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
18670dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
18680dc018ecSStefan Roese
18696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
18700dc018ecSStefan Roese
18710dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
18720dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
18730dc018ecSStefan Roese
18746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
18759ebbb54fSVictor Gallardo
18769ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
18779ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
18789ebbb54fSVictor Gallardo		specified DTT device.
18799ebbb54fSVictor Gallardo
1880be5e6181STimur Tabi		CONFIG_FSL_I2C
1881be5e6181STimur Tabi
1882be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
18837817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1884be5e6181STimur Tabi
188567b23a32SHeiko Schocher		CONFIG_I2C_MUX
188667b23a32SHeiko Schocher
188767b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
188867b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
188967b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
189067b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
189167b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
189267b23a32SHeiko Schocher		the muxes to activate this new "bus".
189367b23a32SHeiko Schocher
189467b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
189567b23a32SHeiko Schocher		feature!
189667b23a32SHeiko Schocher
189767b23a32SHeiko Schocher		Example:
189867b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
189967b23a32SHeiko Schocher			The First mux with address 70 and channel 6
190067b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
190167b23a32SHeiko Schocher
190267b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
190367b23a32SHeiko Schocher
190467b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
190567b23a32SHeiko Schocher		of I2C Busses with muxes:
190667b23a32SHeiko Schocher
190767b23a32SHeiko Schocher		=> i2c bus
190867b23a32SHeiko Schocher		Busses reached over muxes:
190967b23a32SHeiko Schocher		Bus ID: 2
191067b23a32SHeiko Schocher		  reached over Mux(es):
191167b23a32SHeiko Schocher		    pca9544a@70 ch: 4
191267b23a32SHeiko Schocher		Bus ID: 3
191367b23a32SHeiko Schocher		  reached over Mux(es):
191467b23a32SHeiko Schocher		    pca9544a@70 ch: 6
191567b23a32SHeiko Schocher		    pca9544a@71 ch: 4
191667b23a32SHeiko Schocher		=>
191767b23a32SHeiko Schocher
191867b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1919f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1920f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
192167b23a32SHeiko Schocher		the channel 4.
192267b23a32SHeiko Schocher
192367b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1924f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
192567b23a32SHeiko Schocher		the 2 muxes.
192667b23a32SHeiko Schocher
192767b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
192867b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
192967b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
193067b23a32SHeiko Schocher		to add this option to other architectures.
193167b23a32SHeiko Schocher
19322ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
19332ac6985aSAndrew Dyer
19342ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
19352ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
19362ac6985aSAndrew Dyer		between writing the address pointer and reading the
19372ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
19382ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
19392ac6985aSAndrew Dyer		devices can use either method, but some require one or
19402ac6985aSAndrew Dyer		the other.
1941be5e6181STimur Tabi
1942c609719bSwdenk- SPI Support:	CONFIG_SPI
1943c609719bSwdenk
1944c609719bSwdenk		Enables SPI driver (so far only tested with
1945c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1946c609719bSwdenk		D/As on the SACSng board)
1947c609719bSwdenk
19486639562eSYoshihiro Shimoda		CONFIG_SH_SPI
19496639562eSYoshihiro Shimoda
19506639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
19516639562eSYoshihiro Shimoda		only SH7757 is supported.
19526639562eSYoshihiro Shimoda
1953c609719bSwdenk		CONFIG_SPI_X
1954c609719bSwdenk
1955c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1956c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1957c609719bSwdenk
1958c609719bSwdenk		CONFIG_SOFT_SPI
1959c609719bSwdenk
1960c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1961c609719bSwdenk		using hardware support. This is a general purpose
1962c609719bSwdenk		driver that only requires three general I/O port pins
1963c609719bSwdenk		(two outputs, one input) to function. If this is
1964c609719bSwdenk		defined, the board configuration must define several
1965c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1966c609719bSwdenk		an example, see include/configs/sacsng.h.
1967c609719bSwdenk
196804a9e118SBen Warren		CONFIG_HARD_SPI
196904a9e118SBen Warren
197004a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
197104a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
197204a9e118SBen Warren		must define a list of chip-select function pointers.
197304a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
197404a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
197504a9e118SBen Warren
197638254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
197738254f45SGuennadi Liakhovetski
197838254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
19792e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
198038254f45SGuennadi Liakhovetski
19810133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
19820133502eSMatthias Fuchs
19830133502eSMatthias Fuchs		Enables FPGA subsystem.
19840133502eSMatthias Fuchs
19850133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
19860133502eSMatthias Fuchs
19870133502eSMatthias Fuchs		Enables support for specific chip vendors.
19880133502eSMatthias Fuchs		(ALTERA, XILINX)
19890133502eSMatthias Fuchs
19900133502eSMatthias Fuchs		CONFIG_FPGA_<family>
19910133502eSMatthias Fuchs
19920133502eSMatthias Fuchs		Enables support for FPGA family.
19930133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
19940133502eSMatthias Fuchs
19950133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1996c609719bSwdenk
1997c609719bSwdenk		Specify the number of FPGA devices to support.
1998c609719bSwdenk
19996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2000c609719bSwdenk
2001c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2002c609719bSwdenk
20036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2004c609719bSwdenk
2005c609719bSwdenk		Enable checks on FPGA configuration interface busy
2006c609719bSwdenk		status by the configuration function. This option
2007c609719bSwdenk		will require a board or device specific function to
2008c609719bSwdenk		be written.
2009c609719bSwdenk
2010c609719bSwdenk		CONFIG_FPGA_DELAY
2011c609719bSwdenk
2012c609719bSwdenk		If defined, a function that provides delays in the FPGA
2013c609719bSwdenk		configuration driver.
2014c609719bSwdenk
20156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2016c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2017c609719bSwdenk
20186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2019c609719bSwdenk
2020c609719bSwdenk		Check for configuration errors during FPGA bitfile
2021c609719bSwdenk		loading. For example, abort during Virtex II
2022c609719bSwdenk		configuration if the INIT_B line goes low (which
2023c609719bSwdenk		indicated a CRC error).
2024c609719bSwdenk
20256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2026c609719bSwdenk
2027c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2028c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2029c609719bSwdenk		FPGA configuration sequence. The default time is 500
203011ccc33fSMarcel Ziswiler		ms.
2031c609719bSwdenk
20326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2033c609719bSwdenk
2034c609719bSwdenk		Maximum time to wait for BUSY to deassert during
203511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2036c609719bSwdenk
20376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2038c609719bSwdenk
2039c609719bSwdenk		Time to wait after FPGA configuration. The default is
204011ccc33fSMarcel Ziswiler		200 ms.
2041c609719bSwdenk
2042c609719bSwdenk- Configuration Management:
2043c609719bSwdenk		CONFIG_IDENT_STRING
2044c609719bSwdenk
2045c609719bSwdenk		If defined, this string will be added to the U-Boot
2046c609719bSwdenk		version information (U_BOOT_VERSION)
2047c609719bSwdenk
2048c609719bSwdenk- Vendor Parameter Protection:
2049c609719bSwdenk
2050c609719bSwdenk		U-Boot considers the values of the environment
2051c609719bSwdenk		variables "serial#" (Board Serial Number) and
20527152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2053c609719bSwdenk		are set once by the board vendor / manufacturer, and
2054c609719bSwdenk		protects these variables from casual modification by
2055c609719bSwdenk		the user. Once set, these variables are read-only,
2056c609719bSwdenk		and write or delete attempts are rejected. You can
205711ccc33fSMarcel Ziswiler		change this behaviour:
2058c609719bSwdenk
2059c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2060c609719bSwdenk		file, the write protection for vendor parameters is
206147cd00faSwdenk		completely disabled. Anybody can change or delete
2062c609719bSwdenk		these parameters.
2063c609719bSwdenk
2064c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2065c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
206611ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2067c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2068c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2069c609719bSwdenk		read-only.]
2070c609719bSwdenk
2071c609719bSwdenk- Protected RAM:
2072c609719bSwdenk		CONFIG_PRAM
2073c609719bSwdenk
2074c609719bSwdenk		Define this variable to enable the reservation of
2075c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2076c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2077c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2078c609719bSwdenk		this default value by defining an environment
2079c609719bSwdenk		variable "pram" to the number of kB you want to
2080c609719bSwdenk		reserve. Note that the board info structure will
2081c609719bSwdenk		still show the full amount of RAM. If pRAM is
2082c609719bSwdenk		reserved, a new environment variable "mem" will
2083c609719bSwdenk		automatically be defined to hold the amount of
2084c609719bSwdenk		remaining RAM in a form that can be passed as boot
2085c609719bSwdenk		argument to Linux, for instance like that:
2086c609719bSwdenk
2087fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2088c609719bSwdenk			saveenv
2089c609719bSwdenk
2090c609719bSwdenk		This way you can tell Linux not to use this memory,
2091c609719bSwdenk		either, which results in a memory region that will
2092c609719bSwdenk		not be affected by reboots.
2093c609719bSwdenk
2094c609719bSwdenk		*WARNING* If your board configuration uses automatic
2095c609719bSwdenk		detection of the RAM size, you must make sure that
2096c609719bSwdenk		this memory test is non-destructive. So far, the
2097c609719bSwdenk		following board configurations are known to be
2098c609719bSwdenk		"pRAM-clean":
2099c609719bSwdenk
2100c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2101c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
2102544d97e9SWolfgang Denk			FLAGADM, TQM8260
2103c609719bSwdenk
2104c609719bSwdenk- Error Recovery:
2105c609719bSwdenk		CONFIG_PANIC_HANG
2106c609719bSwdenk
2107c609719bSwdenk		Define this variable to stop the system in case of a
2108c609719bSwdenk		fatal error, so that you have to reset it manually.
2109c609719bSwdenk		This is probably NOT a good idea for an embedded
211011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2111c609719bSwdenk		automatically as fast as possible, but it may be
2112c609719bSwdenk		useful during development since you can try to debug
2113c609719bSwdenk		the conditions that lead to the situation.
2114c609719bSwdenk
2115c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2116c609719bSwdenk
2117c609719bSwdenk		This variable defines the number of retries for
2118c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2119c609719bSwdenk		before giving up the operation. If not defined, a
2120c609719bSwdenk		default value of 5 is used.
2121c609719bSwdenk
212240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
212340cb90eeSGuennadi Liakhovetski
212440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
212540cb90eeSGuennadi Liakhovetski
2126c609719bSwdenk- Command Interpreter:
21278078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
212804a85b3bSwdenk
212904a85b3bSwdenk		Enable auto completion of commands using TAB.
213004a85b3bSwdenk
21318078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
21328078f1a5SWolfgang Denk		for the "hush" shell.
21338078f1a5SWolfgang Denk
21348078f1a5SWolfgang Denk
21356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2136c609719bSwdenk
2137c609719bSwdenk		Define this variable to enable the "hush" shell (from
2138c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2139c609719bSwdenk		powerful command line syntax like
2140c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2141c609719bSwdenk		constructs ("shell scripts").
2142c609719bSwdenk
2143c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2144c609719bSwdenk		with a somewhat smaller memory footprint.
2145c609719bSwdenk
2146c609719bSwdenk
21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2148c609719bSwdenk
2149c609719bSwdenk		This defines the secondary prompt string, which is
2150c609719bSwdenk		printed when the command interpreter needs more input
2151c609719bSwdenk		to complete a command. Usually "> ".
2152c609719bSwdenk
2153c609719bSwdenk	Note:
2154c609719bSwdenk
2155c609719bSwdenk		In the current implementation, the local variables
2156c609719bSwdenk		space and global environment variables space are
2157c609719bSwdenk		separated. Local variables are those you define by
21583b57fe0aSwdenk		simply typing `name=value'. To access a local
2159c609719bSwdenk		variable later on, you have write `$name' or
21603b57fe0aSwdenk		`${name}'; to execute the contents of a variable
21613b57fe0aSwdenk		directly type `$name' at the command prompt.
2162c609719bSwdenk
2163c609719bSwdenk		Global environment variables are those you use
2164c609719bSwdenk		setenv/printenv to work with. To run a command stored
2165c609719bSwdenk		in such a variable, you need to use the run command,
2166c609719bSwdenk		and you must not use the '$' sign to access them.
2167c609719bSwdenk
2168c609719bSwdenk		To store commands and special characters in a
2169c609719bSwdenk		variable, please use double quotation marks
2170c609719bSwdenk		surrounding the whole text of the variable, instead
2171c609719bSwdenk		of the backslashes before semicolons and special
2172c609719bSwdenk		symbols.
2173c609719bSwdenk
2174aa0c71acSWolfgang Denk- Commandline Editing and History:
2175aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2176aa0c71acSWolfgang Denk
217711ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2178aa0c71acSWolfgang Denk		commandline input operations
2179aa0c71acSWolfgang Denk
2180a8c7c708Swdenk- Default Environment:
2181c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2182c609719bSwdenk
2183c609719bSwdenk		Define this to contain any number of null terminated
2184c609719bSwdenk		strings (variable = value pairs) that will be part of
21857152b1d0Swdenk		the default environment compiled into the boot image.
21862262cfeeSwdenk
2187c609719bSwdenk		For example, place something like this in your
2188c609719bSwdenk		board's config file:
2189c609719bSwdenk
2190c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2191c609719bSwdenk			"myvar1=value1\0" \
2192c609719bSwdenk			"myvar2=value2\0"
2193c609719bSwdenk
2194c609719bSwdenk		Warning: This method is based on knowledge about the
2195c609719bSwdenk		internal format how the environment is stored by the
21962262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2197c609719bSwdenk		interface! Although it is unlikely that this format
21987152b1d0Swdenk		will change soon, there is no guarantee either.
2199c609719bSwdenk		You better know what you are doing here.
2200c609719bSwdenk
2201c609719bSwdenk		Note: overly (ab)use of the default environment is
2202c609719bSwdenk		discouraged. Make sure to check other ways to preset
220374de7aefSWolfgang Denk		the environment like the "source" command or the
2204c609719bSwdenk		boot command first.
2205c609719bSwdenk
2206a8c7c708Swdenk- DataFlash Support:
22072abbe075Swdenk		CONFIG_HAS_DATAFLASH
22082abbe075Swdenk
22092abbe075Swdenk		Defining this option enables DataFlash features and
22102abbe075Swdenk		allows to read/write in Dataflash via the standard
22112abbe075Swdenk		commands cp, md...
22122abbe075Swdenk
2213f61ec45eSEric Nelson- Serial Flash support
2214f61ec45eSEric Nelson		CONFIG_CMD_SF
2215f61ec45eSEric Nelson
2216f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2217f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2218f61ec45eSEric Nelson
2219f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2220f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2221f61ec45eSEric Nelson		commands.
2222f61ec45eSEric Nelson
2223f61ec45eSEric Nelson		The following defaults may be provided by the platform
2224f61ec45eSEric Nelson		to handle the common case when only a single serial
2225f61ec45eSEric Nelson		flash is present on the system.
2226f61ec45eSEric Nelson
2227f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2228f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2229f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2230f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2231f61ec45eSEric Nelson
22323f85ce27Swdenk- SystemACE Support:
22333f85ce27Swdenk		CONFIG_SYSTEMACE
22343f85ce27Swdenk
22353f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
22363f85ce27Swdenk		chips attached via some sort of local bus. The address
223711ccc33fSMarcel Ziswiler		of the chip must also be defined in the
22386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
22393f85ce27Swdenk
22403f85ce27Swdenk		#define CONFIG_SYSTEMACE
22416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
22423f85ce27Swdenk
22433f85ce27Swdenk		When SystemACE support is added, the "ace" device type
22443f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
22453f85ce27Swdenk
2246ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2247ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2248ecb0ccd9SWolfgang Denk
224928cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2250ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
225128cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2252ecb0ccd9SWolfgang Denk		number generator is used.
2253ecb0ccd9SWolfgang Denk
225428cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
225528cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
225628cb9375SWolfgang Denk		defined, the normal port 69 is used.
225728cb9375SWolfgang Denk
225828cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2259ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2260ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2261ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2262ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2263ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2264ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2265ecb0ccd9SWolfgang Denk
2266a8c7c708Swdenk- Show boot progress:
2267c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2268c609719bSwdenk
2269c609719bSwdenk		Defining this option allows to add some board-
2270c609719bSwdenk		specific code (calling a user-provided function
2271c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2272c609719bSwdenk		the system's boot progress on some display (for
2273c609719bSwdenk		example, some LED's) on your board. At the moment,
2274c609719bSwdenk		the following checkpoints are implemented:
2275c609719bSwdenk
22763a608ca0SSimon Glass- Detailed boot stage timing
22773a608ca0SSimon Glass		CONFIG_BOOTSTAGE
22783a608ca0SSimon Glass		Define this option to get detailed timing of each stage
22793a608ca0SSimon Glass		of the boot process.
22803a608ca0SSimon Glass
22813a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
22823a608ca0SSimon Glass		This is the number of available user bootstage records.
22833a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
22843a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
22853a608ca0SSimon Glass		the limit, recording will stop.
22863a608ca0SSimon Glass
22873a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
22883a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
22893a608ca0SSimon Glass
22903a608ca0SSimon Glass		Timer summary in microseconds:
22913a608ca0SSimon Glass		       Mark    Elapsed  Stage
22923a608ca0SSimon Glass			  0          0  reset
22933a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
22943a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
22953a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
22963a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
22973a608ca0SSimon Glass		  3,910,375    250,777  main_loop
22983a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
22993a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
23003a608ca0SSimon Glass
23011372cce2SMarian BalakowiczLegacy uImage format:
23021372cce2SMarian Balakowicz
2303c609719bSwdenk  Arg	Where			When
2304c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2305c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2306c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2307c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2308c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2309c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2310c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2311c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2312c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
23131372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2314c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2315c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2316c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2317c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
23181372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2319c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
23201372cce2SMarian Balakowicz
23211372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
23221372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
23231372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
23241372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
23251372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
23261372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
23271372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
232811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
23291372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
23301372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
23311372cce2SMarian Balakowicz
2332ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2333c609719bSwdenk
2334a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
233563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
233663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
233763e73c9aSwdenk
2338566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2339566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2340566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2341566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2342566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2343566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2344566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2345566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2346566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2347566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2348566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2349566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2350566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2351566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2352566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2353566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2354566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2355566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2356566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2357566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2358566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2359566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2360566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2361566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2362566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2363566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2364566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2365566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2366566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2367566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2368566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2369566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2370566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2371566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2372566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2373566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2374566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2375566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2376566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2377566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2378566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2379566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2380566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2381566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2382566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2383566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2384566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2385c609719bSwdenk
2386566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2387c609719bSwdenk
2388566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2389566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2390566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2391206c60cbSwdenk
2392566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2393566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
239411ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2395566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2396566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2397566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
239874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
239974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2400566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2401c609719bSwdenk
24021372cce2SMarian BalakowiczFIT uImage format:
24031372cce2SMarian Balakowicz
24041372cce2SMarian Balakowicz  Arg	Where			When
24051372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
24061372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
24071372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
24081372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
24091372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
24101372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2411f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
24121372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
24131372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
24141372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
24151372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
24161372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
241711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
241811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
24191372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
24201372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
24211372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
24221372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
24231372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
24241372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
24251372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
24261372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
24271372cce2SMarian Balakowicz
24281372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
24291372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
24301372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
243111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
24321372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
24331372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
24341372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
24351372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
24361372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
24371372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
24381372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
24391372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
24401372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
24411372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
24421372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
24431372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
24441372cce2SMarian Balakowicz
244511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
24461372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
24471372cce2SMarian Balakowicz
244811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
24491372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
24501372cce2SMarian Balakowicz
245111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
24521372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
24531372cce2SMarian Balakowicz
24544cf2609bSWolfgang Denk- Standalone program support:
24554cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
24564cf2609bSWolfgang Denk
24576feff899SWolfgang Denk		This option defines a board specific value for the
24586feff899SWolfgang Denk		address where standalone program gets loaded, thus
24596feff899SWolfgang Denk		overwriting the architecture dependent default
24604cf2609bSWolfgang Denk		settings.
24614cf2609bSWolfgang Denk
24624cf2609bSWolfgang Denk- Frame Buffer Address:
24634cf2609bSWolfgang Denk		CONFIG_FB_ADDR
24644cf2609bSWolfgang Denk
24654cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
24664cf2609bSWolfgang Denk		address for frame buffer.
24674cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
24684cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
24696feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
24704cf2609bSWolfgang Denk
24714cf2609bSWolfgang Denk		Please see board_init_f function.
24724cf2609bSWolfgang Denk
2473cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2474cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2475cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2476cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2477cccfc2abSDetlev Zundel
2478cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2479cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2480cccfc2abSDetlev Zundel
2481cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2482cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2483cccfc2abSDetlev Zundel
2484cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2485cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2486cccfc2abSDetlev Zundel
2487cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2488cccfc2abSDetlev Zundel
2489cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2490cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2491cccfc2abSDetlev Zundel
24926a11cf48SDaniel Schwierzeck- SPL framework
24936a11cf48SDaniel Schwierzeck		CONFIG_SPL
24946a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
24956a11cf48SDaniel Schwierzeck
249695579793STom Rini		CONFIG_SPL_LDSCRIPT
249795579793STom Rini		LDSCRIPT for linking the SPL binary.
249895579793STom Rini
249995579793STom Rini		CONFIG_SPL_MAX_SIZE
250095579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
250195579793STom Rini
25026a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
25036a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
25046a11cf48SDaniel Schwierzeck
250595579793STom Rini		CONFIG_SPL_BSS_START_ADDR
250695579793STom Rini		Link address for the BSS within the SPL binary.
250795579793STom Rini
250895579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
250995579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
251095579793STom Rini
251195579793STom Rini		CONFIG_SPL_STACK
251295579793STom Rini		Adress of the start of the stack SPL will use
251395579793STom Rini
251495579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
251595579793STom Rini		Starting address of the malloc pool used in SPL.
251695579793STom Rini
251795579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
251895579793STom Rini		The size of the malloc pool used in SPL.
25196a11cf48SDaniel Schwierzeck
25206a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
25216a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
25226a11cf48SDaniel Schwierzeck
25236a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
25246a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
25256a11cf48SDaniel Schwierzeck
25266a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
25276a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
25286a11cf48SDaniel Schwierzeck
25296a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
25306a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
25316a11cf48SDaniel Schwierzeck
25326a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
25336a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
25346a11cf48SDaniel Schwierzeck
253595579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
253695579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
253795579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
253895579793STom Rini		Address, size and partition on the MMC to load U-Boot from
253995579793STom Rini		when the MMC is being used in raw mode.
254095579793STom Rini
254195579793STom Rini		CONFIG_SPL_FAT_SUPPORT
254295579793STom Rini		Support for fs/fat/libfat.o in SPL binary
254395579793STom Rini
254495579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
254595579793STom Rini		Filename to read to load U-Boot when reading from FAT
254695579793STom Rini
254795579793STom Rini		CONFIG_SPL_NAND_SIMPLE
254895579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
254995579793STom Rini
255095579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
255195579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
255295579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
255395579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
255495579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
255595579793STom Rini		Defines the size and behavior of the NAND that SPL uses
255695579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
255795579793STom Rini
255895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
255995579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
256095579793STom Rini		from.
256195579793STom Rini
256295579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
256395579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
256495579793STom Rini		to.
256595579793STom Rini
256695579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
256795579793STom Rini		Define this if you need to first read the OOB and then the
256895579793STom Rini		data. This is used for example on davinci plattforms.
256995579793STom Rini
257095579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
257195579793STom Rini		Support for an OMAP3-specific set of functions to return the
257295579793STom Rini		ID and MFR of the first attached NAND chip, if present.
257395579793STom Rini
25746a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
25756a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
25766a11cf48SDaniel Schwierzeck
25776a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
25786a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
25796a11cf48SDaniel Schwierzeck
25806a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
25816a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
25826a11cf48SDaniel Schwierzeck
25836a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
25846a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
25851372cce2SMarian Balakowicz
2586c609719bSwdenkModem Support:
2587c609719bSwdenk--------------
2588c609719bSwdenk
2589566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2590c609719bSwdenk
259111ccc33fSMarcel Ziswiler- Modem support enable:
2592c609719bSwdenk		CONFIG_MODEM_SUPPORT
2593c609719bSwdenk
2594c609719bSwdenk- RTS/CTS Flow control enable:
2595c609719bSwdenk		CONFIG_HWFLOW
2596c609719bSwdenk
2597c609719bSwdenk- Modem debug support:
2598c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2599c609719bSwdenk
2600c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2601c609719bSwdenk		for modem support. Useful only with BDI2000.
2602c609719bSwdenk
2603a8c7c708Swdenk- Interrupt support (PPC):
2604a8c7c708Swdenk
2605a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2606a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
260711ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2608a8c7c708Swdenk		should set decrementer_count to appropriate value. If
260911ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2610a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
261111ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2612a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2613a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2614a8c7c708Swdenk		general timer_interrupt().
2615a8c7c708Swdenk
2616c609719bSwdenk- General:
2617c609719bSwdenk
2618c609719bSwdenk		In the target system modem support is enabled when a
2619c609719bSwdenk		specific key (key combination) is pressed during
2620c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
262111ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2622c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2623c609719bSwdenk		function, returning 1 and thus enabling modem
2624c609719bSwdenk		initialization.
2625c609719bSwdenk
2626c609719bSwdenk		If there are no modem init strings in the
2627c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2628c609719bSwdenk		previous output (banner, info printfs) will be
262911ccc33fSMarcel Ziswiler		suppressed, though.
2630c609719bSwdenk
2631c609719bSwdenk		See also: doc/README.Modem
2632c609719bSwdenk
26339660e442SHelmut RaigerBoard initialization settings:
26349660e442SHelmut Raiger------------------------------
26359660e442SHelmut Raiger
26369660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
26379660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
26389660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
26399660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
26409660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
26419660e442SHelmut Raigertypically in board_init_f() and board_init_r().
26429660e442SHelmut Raiger
26439660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
26449660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
26459660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
26469660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2647c609719bSwdenk
2648c609719bSwdenkConfiguration Settings:
2649c609719bSwdenk-----------------------
2650c609719bSwdenk
26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2652c609719bSwdenk		undefine this when you're short of memory.
2653c609719bSwdenk
26542fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
26552fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
26562fb2604dSPeter Tyser
26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2658c609719bSwdenk		prompt for user input.
2659c609719bSwdenk
26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2661c609719bSwdenk
26626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2663c609719bSwdenk
26646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2665c609719bSwdenk
26666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2667c609719bSwdenk		the application (usually a Linux kernel) when it is
2668c609719bSwdenk		booted
2669c609719bSwdenk
26706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2671c609719bSwdenk		List of legal baudrate settings for this board.
2672c609719bSwdenk
26736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2674c609719bSwdenk		Suppress display of console information at boot.
2675c609719bSwdenk
26766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2677c609719bSwdenk		If the board specific function
2678c609719bSwdenk			extern int overwrite_console (void);
2679c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2680c609719bSwdenk		serial port, else the settings in the environment are used.
2681c609719bSwdenk
26826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2683c609719bSwdenk		Enable the call to overwrite_console().
2684c609719bSwdenk
26856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2686c609719bSwdenk		Enable overwrite of previous console environment settings.
2687c609719bSwdenk
26886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2689c609719bSwdenk		Begin and End addresses of the area used by the
2690c609719bSwdenk		simple memory test.
2691c609719bSwdenk
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2693c609719bSwdenk		Enable an alternate, more extensive memory test.
2694c609719bSwdenk
26956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
26965f535fe1Swdenk		Scratch address used by the alternate memory test
26975f535fe1Swdenk		You only need to set this if address zero isn't writeable
26985f535fe1Swdenk
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
27006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
270114f73ca6SStefan Roese		this specified memory area will get subtracted from the top
270211ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
270314f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
270414f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
270514f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
27065e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
270714f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
27085e12e75dSStefan Roese		will have to get fixed in Linux additionally.
270914f73ca6SStefan Roese
271014f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
271114f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
271214f73ca6SStefan Roese		be touched.
271314f73ca6SStefan Roese
271414f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
271514f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
271614f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
271714f73ca6SStefan Roese		non page size aligned address and this could cause major
271814f73ca6SStefan Roese		problems.
271914f73ca6SStefan Roese
27206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2721c609719bSwdenk		Default load address for network file downloads
2722c609719bSwdenk
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2724c609719bSwdenk		Enable temporary baudrate change while serial download
2725c609719bSwdenk
27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2727c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2728c609719bSwdenk
27296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2730c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2731c609719bSwdenk		Cogent motherboard)
2732c609719bSwdenk
27336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2734c609719bSwdenk		Physical start address of Flash memory.
2735c609719bSwdenk
27366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2737c609719bSwdenk		Physical start address of boot monitor code (set by
2738c609719bSwdenk		make config files to be same as the text base address
273914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
27406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2741c609719bSwdenk
27426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
27433b57fe0aSwdenk		Size of memory reserved for monitor code, used to
27443b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
27453b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
27463b57fe0aSwdenk		flash sector.
2747c609719bSwdenk
27486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2749c609719bSwdenk		Size of DRAM reserved for malloc() use.
2750c609719bSwdenk
27516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
275215940c9aSStefan Roese		Normally compressed uImages are limited to an
275315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
27546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
275515940c9aSStefan Roese		to adjust this setting to your needs.
2756c609719bSwdenk
27576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2758c609719bSwdenk		Maximum size of memory mapped by the startup code of
2759c609719bSwdenk		the Linux kernel; all data that must be processed by
27607d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
27617d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
27627d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
27637d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2764c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2765c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2766c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2767c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2768c609719bSwdenk
2769fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2770fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2771fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2772fca43cc8SJohn Rigby		is enabled.
2773fca43cc8SJohn Rigby
2774fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2775fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2776fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2777fca43cc8SJohn Rigby
2778fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2779fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2780fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2781fca43cc8SJohn Rigby
27826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2783c609719bSwdenk		Max number of Flash memory banks
2784c609719bSwdenk
27856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2786c609719bSwdenk		Max number of sectors on a Flash chip
2787c609719bSwdenk
27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2789c609719bSwdenk		Timeout for Flash erase operations (in ms)
2790c609719bSwdenk
27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2792c609719bSwdenk		Timeout for Flash write operations (in ms)
2793c609719bSwdenk
27946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
27958564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
27968564acf9Swdenk
27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
27988564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
27998564acf9Swdenk
28006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
28018564acf9Swdenk		If defined, hardware flash sectors protection is used
28028564acf9Swdenk		instead of U-Boot software protection.
28038564acf9Swdenk
28046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2805c609719bSwdenk
2806c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2807c609719bSwdenk		without this option such a download has to be
2808c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2809c609719bSwdenk		copy from RAM to flash.
2810c609719bSwdenk
2811c609719bSwdenk		The two-step approach is usually more reliable, since
2812c609719bSwdenk		you can check if the download worked before you erase
281311ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
281411ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2815c609719bSwdenk		downloaded image) this option may be very useful.
2816c609719bSwdenk
28176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2818c609719bSwdenk		Define if the flash driver uses extra elements in the
28195653fc33Swdenk		common flash structure for storing flash geometry.
28205653fc33Swdenk
282100b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
28225653fc33Swdenk		This option also enables the building of the cfi_flash driver
28235653fc33Swdenk		in the drivers directory
282453cf9435Sstroese
282591809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
282691809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
282791809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
282891809ed5SPiotr Ziecik		to the MTD layer.
282991809ed5SPiotr Ziecik
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
283196ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
283296ef831fSGuennadi Liakhovetski
283396ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
283496ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
283596ef831fSGuennadi Liakhovetski		write commands.
283696ef831fSGuennadi Liakhovetski
28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
28385568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
28395568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
28405568e613SStefan Roese		is useful, if some of the configured banks are only
28415568e613SStefan Roese		optionally available.
28425568e613SStefan Roese
28439a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
28449a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
28459a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
28469a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
28479a042e9cSJerry Van Baren
28486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
284911ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
285011ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
285153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
285253cf9435Sstroese		buffers can be full shortly after enabling the interface
285311ccc33fSMarcel Ziswiler		on high Ethernet traffic.
285453cf9435Sstroese		Defaults to 4 if not defined.
2855c609719bSwdenk
2856ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2857ea882bafSWolfgang Denk
2858ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2859ea882bafSWolfgang Denk	internally to store the environment settings. The default
2860ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2861ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2862ea882bafSWolfgang Denk	lib/hashtable.c for details.
2863ea882bafSWolfgang Denk
2864c609719bSwdenkThe following definitions that deal with the placement and management
2865c609719bSwdenkof environment data (variable area); in general, we support the
2866c609719bSwdenkfollowing configurations:
2867c609719bSwdenk
2868c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2869c3eb3fe4SMike Frysinger
2870c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2871c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2872c3eb3fe4SMike Frysinger
28735a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2874c609719bSwdenk
2875c609719bSwdenk	Define this if the environment is in flash memory.
2876c609719bSwdenk
2877c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2878c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2879c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2880c609719bSwdenk	   sector" type flash chips, which have several smaller
2881c609719bSwdenk	   sectors at the start or the end. For instance, such a
2882c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2883c609719bSwdenk	   such a case you would place the environment in one of the
2884c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2885c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2886c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2887c609719bSwdenk	   between U-Boot and the environment.
2888c609719bSwdenk
28890e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2890c609719bSwdenk
2891c609719bSwdenk	   Offset of environment data (variable area) to the
2892c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2893c609719bSwdenk	   type flash chips the second sector can be used: the offset
2894c609719bSwdenk	   for this sector is given here.
2895c609719bSwdenk
28966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2897c609719bSwdenk
28980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2899c609719bSwdenk
2900c609719bSwdenk	   This is just another way to specify the start address of
2901c609719bSwdenk	   the flash sector containing the environment (instead of
29020e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2903c609719bSwdenk
29040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2905c609719bSwdenk
2906c609719bSwdenk	   Size of the sector containing the environment.
2907c609719bSwdenk
2908c609719bSwdenk
2909c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2910c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2911c609719bSwdenk	   the environment.
2912c609719bSwdenk
29130e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2914c609719bSwdenk
29155a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
29160e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2917c609719bSwdenk	   of this flash sector for the environment. This saves
2918c609719bSwdenk	   memory for the RAM copy of the environment.
2919c609719bSwdenk
2920c609719bSwdenk	   It may also save flash memory if you decide to use this
2921c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2922c609719bSwdenk	   since then the remainder of the flash sector could be used
2923c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2924c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2925c609719bSwdenk	   updating the environment in flash makes it always
2926c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2927c609719bSwdenk	   wrong before the contents has been restored from a copy in
2928c609719bSwdenk	   RAM, your target system will be dead.
2929c609719bSwdenk
29300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
29310e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2932c609719bSwdenk
2933c609719bSwdenk	   These settings describe a second storage area used to hold
293411ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
29353e38691eSwdenk	   a valid backup copy in case there is a power failure during
2936c609719bSwdenk	   a "saveenv" operation.
2937c609719bSwdenk
2938c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2939c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2940c609719bSwdenkaccordingly!
2941c609719bSwdenk
2942c609719bSwdenk
29439314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2944c609719bSwdenk
2945c609719bSwdenk	Define this if you have some non-volatile memory device
2946c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2947c609719bSwdenk	environment.
2948c609719bSwdenk
29490e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
29500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2951c609719bSwdenk
295211ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2953c609719bSwdenk	  want to use for environment. It is assumed that this memory
2954c609719bSwdenk	  can just be read and written to, without any special
2955c609719bSwdenk	  provision.
2956c609719bSwdenk
2957c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2958c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
295911ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2960c609719bSwdenkU-Boot will hang.
2961c609719bSwdenk
2962c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2963c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2964c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2965c609719bSwdenkto save the current settings.
2966c609719bSwdenk
2967c609719bSwdenk
2968bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2969c609719bSwdenk
2970c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2971c609719bSwdenk	device and a driver for it.
2972c609719bSwdenk
29730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
29740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2975c609719bSwdenk
2976c609719bSwdenk	  These two #defines specify the offset and size of the
2977c609719bSwdenk	  environment area within the total memory of your EEPROM.
2978c609719bSwdenk
29796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2980c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2981c609719bSwdenk	  The default address is zero.
2982c609719bSwdenk
29836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2984c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2985c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2986c609719bSwdenk	  would require six bits.
2987c609719bSwdenk
29886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2989c609719bSwdenk	  If defined, the number of milliseconds to delay between
2990c609719bSwdenk	  page writes.	The default is zero milliseconds.
2991c609719bSwdenk
29926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2993c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2994c609719bSwdenk	  that this is NOT the chip address length!
2995c609719bSwdenk
29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
29975cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
29985cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
29995cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
30005cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
30015cf91d6bSwdenk	  byte chips.
30025cf91d6bSwdenk
30035cf91d6bSwdenk	  Note that we consider the length of the address field to
30045cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
30055cf91d6bSwdenk	  in the chip address.
30065cf91d6bSwdenk
30076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3008c609719bSwdenk	  The size in bytes of the EEPROM device.
3009c609719bSwdenk
3010548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3011548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3012548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3013548738b4SHeiko Schocher
3014548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3015548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3016548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3017548738b4SHeiko Schocher	  EEPROM. For example:
3018548738b4SHeiko Schocher
3019548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3020548738b4SHeiko Schocher
3021548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3022548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3023c609719bSwdenk
3024057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
30255779d8d9Swdenk
30265779d8d9Swdenk	Define this if you have a DataFlash memory device which you
30275779d8d9Swdenk	want to use for the environment.
30285779d8d9Swdenk
30290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30310e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
30325779d8d9Swdenk
30335779d8d9Swdenk	  These three #defines specify the offset and size of the
30345779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
30355779d8d9Swdenk	  at the specified address.
30365779d8d9Swdenk
30370a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
30380a85a9e7SLiu Gang
30390a85a9e7SLiu Gang	Define this if you have a remote memory space which you
30400a85a9e7SLiu Gang	want to use for the local device's environment.
30410a85a9e7SLiu Gang
30420a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
30430a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
30440a85a9e7SLiu Gang
30450a85a9e7SLiu Gang	  These two #defines specify the address and size of the
30460a85a9e7SLiu Gang	  environment area within the remote memory space. The
30470a85a9e7SLiu Gang	  local device can get the environment from remote memory
30480a85a9e7SLiu Gang	  space by SRIO or other links.
30490a85a9e7SLiu Gang
30500a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
30510a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
30520a85a9e7SLiu Gangenvironment stored in a remote NOR flash by SRIO link, but it can
30530a85a9e7SLiu Gangnot erase, write this NOR flash by SRIO interface.
30540a85a9e7SLiu Gang
305551bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
305613a5695bSwdenk
305713a5695bSwdenk	Define this if you have a NAND device which you want to use
305813a5695bSwdenk	for the environment.
305913a5695bSwdenk
30600e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
306213a5695bSwdenk
306313a5695bSwdenk	  These two #defines specify the offset and size of the environment
3064fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3065fdd813deSScott Wood	  aligned to an erase block boundary.
30665779d8d9Swdenk
3067fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3068e443c944SMarkus Klotzbuecher
30690e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3070fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3071fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3072fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3073fdd813deSScott Wood	  aligned to an erase block boundary.
3074e443c944SMarkus Klotzbuecher
3075fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3076fdd813deSScott Wood
3077fdd813deSScott Wood	  Specifies the length of the region in which the environment
3078fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3079fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3080fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3081fdd813deSScott Wood	  the range to be avoided.
3082fdd813deSScott Wood
3083fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3084fdd813deSScott Wood
3085fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3086fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3087fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3088fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3089fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3090e443c944SMarkus Klotzbuecher
3091b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3092b74ab737SGuennadi Liakhovetski
3093b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3094b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3095b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3096b74ab737SGuennadi Liakhovetski
30976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3098c609719bSwdenk
3099c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3100c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3101c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3102c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3103c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3104c609719bSwdenk	to be a good choice since it makes it far enough from the
3105c609719bSwdenk	start of the data area as well as from the stack pointer.
3106c609719bSwdenk
3107e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3108c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3109cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3110c609719bSwdenkuntil then to read environment variables.
3111c609719bSwdenk
311285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
311385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
311485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
311585ec0bccSwdenknecessary, because the first environment variable we need is the
311685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
311785ec0bccSwdenkhave any device yet where we could complain.]
3118c609719bSwdenk
3119c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3120c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
312185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3122c609719bSwdenk
31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3124fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3125fc3e2165Swdenk
31266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3127fc3e2165Swdenk		      also needs to be defined.
3128fc3e2165Swdenk
31296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3130fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3131c609719bSwdenk
3132f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3133f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3134f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3135f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3136f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3137f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3138f5675aa5SRon Madrid
3139c609719bSwdenkLow Level (hardware related) configuration options:
3140dc7c9a1aSwdenk---------------------------------------------------
3141c609719bSwdenk
31426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3143c609719bSwdenk		Cache Line Size of the CPU.
3144c609719bSwdenk
31456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3146c609719bSwdenk		Default address of the IMMR after system reset.
31472535d602Swdenk
31482535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
31492535d602Swdenk		and RPXsuper) to be able to adjust the position of
31502535d602Swdenk		the IMMR register after a reset.
3151c609719bSwdenk
3152e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3153e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3154e46fedfeSTimur Tabi		PowerPC SOCs.
3155e46fedfeSTimur Tabi
3156e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3157e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3158e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3159e46fedfeSTimur Tabi
3160e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3161e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3162e46fedfeSTimur Tabi
3163e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3164e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3165e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3166e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3167e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3168e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3169e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3170e46fedfeSTimur Tabi
3171e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3172e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3173e46fedfeSTimur Tabi
3174e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3175e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3176e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3177e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3178e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3179e46fedfeSTimur Tabi
3180e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3181e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3182e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3183e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3184e46fedfeSTimur Tabi
3185e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3186e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3187e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3188e46fedfeSTimur Tabi
31897f6c2cbcSwdenk- Floppy Disk Support:
31906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
31917f6c2cbcSwdenk
31927f6c2cbcSwdenk		the default drive number (default value 0)
31937f6c2cbcSwdenk
31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
31957f6c2cbcSwdenk
319611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
31977f6c2cbcSwdenk		(default value 1)
31987f6c2cbcSwdenk
31996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
32007f6c2cbcSwdenk
32017f6c2cbcSwdenk		defines the offset of register from address. It
32027f6c2cbcSwdenk		depends on which part of the data bus is connected to
320311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
32047f6c2cbcSwdenk
32056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
32066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
32077f6c2cbcSwdenk		default value.
32087f6c2cbcSwdenk
32096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
32107f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
32117f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
32127f6c2cbcSwdenk		source code. It is used to make hardware dependant
32137f6c2cbcSwdenk		initializations.
32147f6c2cbcSwdenk
32150abddf82SMacpaul Lin- CONFIG_IDE_AHB:
32160abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
32170abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
32180abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
32190abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
32200abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
32210abddf82SMacpaul Lin		is requierd.
32220abddf82SMacpaul Lin
32236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
322425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
322525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3226c609719bSwdenk
32276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3228c609719bSwdenk
32297152b1d0Swdenk		Start address of memory area that can be used for
3230c609719bSwdenk		initial data and stack; please note that this must be
3231c609719bSwdenk		writable memory that is working WITHOUT special
3232c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3233c609719bSwdenk		will become available only after programming the
3234c609719bSwdenk		memory controller and running certain initialization
3235c609719bSwdenk		sequences.
3236c609719bSwdenk
3237c609719bSwdenk		U-Boot uses the following memory types:
3238c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3239c609719bSwdenk		- MPC824X: data cache
3240c609719bSwdenk		- PPC4xx:  data cache
3241c609719bSwdenk
32426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3243c609719bSwdenk
3244c609719bSwdenk		Offset of the initial data structure in the memory
32456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
32466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3247c609719bSwdenk		data is located at the end of the available space
3248553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
32496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
32506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
32516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3252c609719bSwdenk
3253c609719bSwdenk	Note:
3254c609719bSwdenk		On the MPC824X (or other systems that use the data
3255c609719bSwdenk		cache for initial memory) the address chosen for
32566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3257c609719bSwdenk		point to an otherwise UNUSED address space between
3258c609719bSwdenk		the top of RAM and the start of the PCI space.
3259c609719bSwdenk
32606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3261c609719bSwdenk
32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3263c609719bSwdenk
32646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3265c609719bSwdenk
32666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3267c609719bSwdenk
32686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3269c609719bSwdenk
32706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3271c609719bSwdenk
32726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3273c609719bSwdenk		SDRAM timing
3274c609719bSwdenk
32756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3276c609719bSwdenk		periodic timer for refresh
3277c609719bSwdenk
32786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3279c609719bSwdenk
32806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
32816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
32836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3284c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3285c609719bSwdenk
3286c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
32876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
32886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3289c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3290c609719bSwdenk
32916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
32926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3293c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3294c609719bSwdenk		Prescaler definitions (SDRAM timing)
3295c609719bSwdenk
32966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3297c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3298c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3299c609719bSwdenk
33006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3301b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3302b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3303b423d055SHeiko Schocher
33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3305c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3306c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3307c609719bSwdenk
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3309c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3310c609719bSwdenk		wrong setting might damage your board. Read
3311c609719bSwdenk		doc/README.MBX before setting this variable!
3312c609719bSwdenk
33136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3314ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3315ea909b76Swdenk		(Power On Self Tests). This definition overrides
3316ea909b76Swdenk		#define'd default value in commproc.h resp.
3317ea909b76Swdenk		cpm_8260.h.
3318ea909b76Swdenk
33196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
33206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
33216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
33236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
33246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
33256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
33266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3327a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
33285d232d0eSwdenk
33299cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
33309cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
33319cacf4fcSDirk Eibach		required.
33329cacf4fcSDirk Eibach
3333a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3334a09b9b68SKumar Gala		Chip has SRIO or not
3335a09b9b68SKumar Gala
3336a09b9b68SKumar Gala- CONFIG_SRIO1:
3337a09b9b68SKumar Gala		Board has SRIO 1 port available
3338a09b9b68SKumar Gala
3339a09b9b68SKumar Gala- CONFIG_SRIO2:
3340a09b9b68SKumar Gala		Board has SRIO 2 port available
3341a09b9b68SKumar Gala
3342a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3343a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3344a09b9b68SKumar Gala
3345a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3346a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3347a09b9b68SKumar Gala
3348a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3349a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3350a09b9b68SKumar Gala
3351eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3352eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3353eced4626SAlex Waterman		16 bit bus.
3354eced4626SAlex Waterman
3355eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3356eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3357eced4626SAlex Waterman		a default value will be used.
3358eced4626SAlex Waterman
3359bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3360218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3361218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3362218ca724SWolfgang Denk
3363bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3364bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3365bb99ad6dSBen Warren
33666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3367218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3368218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3369218ca724SWolfgang Denk		to something your driver can deal with.
3370bb99ad6dSBen Warren
33711b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
33721b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
33731b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
33741b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
33751b3e3c4fSYork Sun		header files or board specific files.
33761b3e3c4fSYork Sun
33776f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
33786f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
33796f5e1dc5SYork Sun
33806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3381218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3382218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
33832ad6b513STimur Tabi
3384c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3385c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3386c26e454dSwdenk
3387c26e454dSwdenk- CONFIG_FEC[12]_PHY
3388c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
33896e592385Swdenk		to the given FEC; i. e.
3390c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3391c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3392c26e454dSwdenk
3393c26e454dSwdenk		When set to -1, means to probe for first available.
3394c26e454dSwdenk
3395c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3396c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3397c26e454dSwdenk		(so program the FEC to ignore it).
3398c26e454dSwdenk
3399c26e454dSwdenk- CONFIG_RMII
3400c26e454dSwdenk		Enable RMII mode for all FECs.
3401c26e454dSwdenk		Note that this is a global option, we can't
3402c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3403c26e454dSwdenk
34045cf91d6bSwdenk- CONFIG_CRC32_VERIFY
34055cf91d6bSwdenk		Add a verify option to the crc32 command.
34065cf91d6bSwdenk		The syntax is:
34075cf91d6bSwdenk
34085cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
34095cf91d6bSwdenk
34105cf91d6bSwdenk		Where address/count indicate a memory area
34115cf91d6bSwdenk		and crc32 is the correct crc32 which the
34125cf91d6bSwdenk		area should have.
34135cf91d6bSwdenk
341456523f12Swdenk- CONFIG_LOOPW
341556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3416602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
341756523f12Swdenk
34187b466641Sstroese- CONFIG_MX_CYCLIC
34197b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
34207b466641Sstroese		"md/mw" commands.
34217b466641Sstroese		Examples:
34227b466641Sstroese
34237b466641Sstroese		=> mdc.b 10 4 500
34247b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
34257b466641Sstroese
34267b466641Sstroese		=> mwc.l 100 12345678 10
34277b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
34287b466641Sstroese
34297b466641Sstroese		This only takes effect if the memory commands are activated
3430602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
34317b466641Sstroese
34328aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3433afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3434e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3435e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3436e03f3169SWolfgang Denk		relocate itself into RAM.
34378aa1a2d1Swdenk
3438e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3439e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3440e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3441e03f3169SWolfgang Denk		these initializations itself.
34428aa1a2d1Swdenk
3443401bb30bSAneesh V- CONFIG_SPL_BUILD
3444df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3445df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3446df81238bSMagnus Lilja		compiling a NAND SPL.
3447400558b5Swdenk
3448d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3449d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3450d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3451d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3452d8834a13SMatthias Weisser		conditions but may increase the binary size.
3453d8834a13SMatthias Weisser
3454f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3455f2717b47STimur Tabi-----------------------------------
3456f2717b47STimur Tabi
3457f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3458f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3459f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3460f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3461f2717b47STimur Tabiwithin that device.
3462f2717b47STimur Tabi
3463f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3464f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3465f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3466f2717b47STimur Tabi	is also specified.
3467f2717b47STimur Tabi
3468f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3469f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3470f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3471f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3472f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3473f2717b47STimur Tabi
3474f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3475f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3476f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3477f2717b47STimur Tabi	virtual address in NOR flash.
3478f2717b47STimur Tabi
3479f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3480f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3481f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3482f2717b47STimur Tabi
3483f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3484f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3485f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3486f2717b47STimur Tabi
3487f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3488f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3489f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3490f2717b47STimur Tabi
3491292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3492292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3493292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3494292dc6c5SLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3495292dc6c5SLiu Gang	->master inbound window->master LAW->the ucode address in master's
3496292dc6c5SLiu Gang	NOR flash.
3497f2717b47STimur Tabi
3498c609719bSwdenkBuilding the Software:
3499c609719bSwdenk======================
3500c609719bSwdenk
3501218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3502218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3503218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3504218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3505218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3506218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3507c609719bSwdenk
3508218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3509218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3510218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3511218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3512218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3513c609719bSwdenk
3514218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3515218ca724SWolfgang Denk	$ export CROSS_COMPILE
3516c609719bSwdenk
35172f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
35182f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
35192f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
35202f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
35212f8d396bSPeter Tyser
35222f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
35232f8d396bSPeter Tyser
35242f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
35252f8d396bSPeter Tyser      be executed on computers running Windows.
35262f8d396bSPeter Tyser
3527c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3528c609719bSwdenksources you must configure U-Boot for one specific board type. This
3529c609719bSwdenkis done by typing:
3530c609719bSwdenk
3531c609719bSwdenk	make NAME_config
3532c609719bSwdenk
3533218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
35344d675ae6SMichael Jonesrations; see boards.cfg for supported names.
353554387ac9Swdenk
3536c609719bSwdenkNote: for some board special configuration names may exist; check if
3537c609719bSwdenk      additional information is available from the board vendor; for
35382729af9dSwdenk      instance, the TQM823L systems are available without (standard)
35392729af9dSwdenk      or with LCD support. You can select such additional "features"
354011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3541c609719bSwdenk
35422729af9dSwdenk      make TQM823L_config
35432729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3544c609719bSwdenk
3545c609719bSwdenk      make TQM823L_LCD_config
3546c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3547c609719bSwdenk
3548c609719bSwdenk      etc.
3549c609719bSwdenk
3550c609719bSwdenk
3551c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
35527152b1d0Swdenkimages ready for download to / installation on your system:
3553c609719bSwdenk
3554c609719bSwdenk- "u-boot.bin" is a raw binary image
3555c609719bSwdenk- "u-boot" is an image in ELF binary format
3556c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3557c609719bSwdenk
3558baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3559baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3560baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3561baf31249SMarian Balakowicz
3562baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3563baf31249SMarian Balakowicz
3564baf31249SMarian Balakowicz	make O=/tmp/build distclean
3565baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3566baf31249SMarian Balakowicz	make O=/tmp/build all
3567baf31249SMarian Balakowicz
3568baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3569baf31249SMarian Balakowicz
3570baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3571baf31249SMarian Balakowicz	make distclean
3572baf31249SMarian Balakowicz	make NAME_config
3573baf31249SMarian Balakowicz	make all
3574baf31249SMarian Balakowicz
3575baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3576baf31249SMarian Balakowiczvariable.
3577baf31249SMarian Balakowicz
3578c609719bSwdenk
3579c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3580c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3581c609719bSwdenknative "make".
3582c609719bSwdenk
3583c609719bSwdenk
3584c609719bSwdenkIf the system board that you have is not listed, then you will need
3585c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3586c609719bSwdenksteps:
3587c609719bSwdenk
3588c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
35894d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
35904d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3591c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
359285ec0bccSwdenk    files you need. In your board directory, you will need at least
359385ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
359485ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
359585ec0bccSwdenk    your board
3596c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3597c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
359885ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3599c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3600c609719bSwdenk    to be installed on your target system.
360185ec0bccSwdenk6.  Debug and solve any problems that might arise.
3602c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3603c609719bSwdenk
3604c609719bSwdenk
3605c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3606c609719bSwdenk==============================================================
3607c609719bSwdenk
3608c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3609c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3610c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3611c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3612218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3613c609719bSwdenk
3614c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3615c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3616c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3617c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3618c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
36197152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3620218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3621218ca724SWolfgang Denkyou can type
3622c609719bSwdenk
3623c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3624c609719bSwdenk
3625c609719bSwdenkor to build on a native PowerPC system you can type
3626c609719bSwdenk
3627c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3628c609719bSwdenk
3629218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3630218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3631218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3632218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3633218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3634218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3635218ca724SWolfgang Denkvariable. For example:
3636baf31249SMarian Balakowicz
3637baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3638baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3639baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3640baf31249SMarian Balakowicz
3641218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3642218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3643218ca724SWolfgang Denkduring the whole build process.
3644baf31249SMarian Balakowicz
3645baf31249SMarian Balakowicz
3646c609719bSwdenkSee also "U-Boot Porting Guide" below.
3647c609719bSwdenk
3648c609719bSwdenk
3649c609719bSwdenkMonitor Commands - Overview:
3650c609719bSwdenk============================
3651c609719bSwdenk
3652c609719bSwdenkgo	- start application at address 'addr'
3653c609719bSwdenkrun	- run commands in an environment variable
3654c609719bSwdenkbootm	- boot application image from memory
3655c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
365644f074c7SMarek Vasutbootz   - boot zImage from memory
3657c609719bSwdenktftpboot- boot image via network using TFTP protocol
3658c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3659c609719bSwdenk	       (and eventually "gatewayip")
36601fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3661c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3662c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3663c609719bSwdenkloads	- load S-Record file over serial line
3664c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3665c609719bSwdenkmd	- memory display
3666c609719bSwdenkmm	- memory modify (auto-incrementing)
3667c609719bSwdenknm	- memory modify (constant address)
3668c609719bSwdenkmw	- memory write (fill)
3669c609719bSwdenkcp	- memory copy
3670c609719bSwdenkcmp	- memory compare
3671c609719bSwdenkcrc32	- checksum calculation
36720f89c54bSPeter Tyseri2c	- I2C sub-system
3673c609719bSwdenksspi	- SPI utility commands
3674c609719bSwdenkbase	- print or set address offset
3675c609719bSwdenkprintenv- print environment variables
3676c609719bSwdenksetenv	- set environment variables
3677c609719bSwdenksaveenv - save environment variables to persistent storage
3678c609719bSwdenkprotect - enable or disable FLASH write protection
3679c609719bSwdenkerase	- erase FLASH memory
3680c609719bSwdenkflinfo	- print FLASH memory information
3681c609719bSwdenkbdinfo	- print Board Info structure
3682c609719bSwdenkiminfo	- print header information for application image
3683c609719bSwdenkconinfo - print console devices and informations
3684c609719bSwdenkide	- IDE sub-system
3685c609719bSwdenkloop	- infinite loop on address range
368656523f12Swdenkloopw	- infinite write loop on address range
3687c609719bSwdenkmtest	- simple RAM test
3688c609719bSwdenkicache	- enable or disable instruction cache
3689c609719bSwdenkdcache	- enable or disable data cache
3690c609719bSwdenkreset	- Perform RESET of the CPU
3691c609719bSwdenkecho	- echo args to console
3692c609719bSwdenkversion - print monitor version
3693c609719bSwdenkhelp	- print online help
3694c609719bSwdenk?	- alias for 'help'
3695c609719bSwdenk
3696c609719bSwdenk
3697c609719bSwdenkMonitor Commands - Detailed Description:
3698c609719bSwdenk========================================
3699c609719bSwdenk
3700c609719bSwdenkTODO.
3701c609719bSwdenk
3702c609719bSwdenkFor now: just type "help <command>".
3703c609719bSwdenk
3704c609719bSwdenk
3705c609719bSwdenkEnvironment Variables:
3706c609719bSwdenk======================
3707c609719bSwdenk
3708c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3709c609719bSwdenkcan be made persistent by saving to Flash memory.
3710c609719bSwdenk
3711c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3712c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3713c609719bSwdenkwithout a value can be used to delete a variable from the
3714c609719bSwdenkenvironment. As long as you don't save the environment you are
3715c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3716c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3717c609719bSwdenk
3718c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3719c96f86eeSWolfgang Denk
3720c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3721c609719bSwdenk
3722c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3723c609719bSwdenk
3724c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3725c609719bSwdenk
3726c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3727c609719bSwdenk
3728c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3729c609719bSwdenk
3730c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3731c609719bSwdenk
37327d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
37337d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
37347d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
37357d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
37367d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
37377d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3738c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3739c3624e6eSGrant Likely		  bootm_mapsize.
3740c3624e6eSGrant Likely
3741c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3742c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3743c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3744c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3745c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3746c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3747c3624e6eSGrant Likely		  used otherwise.
37487d721e34SBartlomiej Sieka
37497d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
37507d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
37517d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
37527d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
37537d721e34SBartlomiej Sieka		  environment variable.
37547d721e34SBartlomiej Sieka
37554bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
37564bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
37574bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
37584bae9090SBartlomiej Sieka
3759c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3760c609719bSwdenk		  "bootp" will just load perform a lookup of the
3761c609719bSwdenk		  configuration from the BOOTP server, but not try to
3762c609719bSwdenk		  load any image using TFTP
3763c609719bSwdenk
3764c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3765c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3766c609719bSwdenk		  be automatically started (by internally calling
3767c609719bSwdenk		  "bootm")
3768c609719bSwdenk
37694a6fd34bSwdenk		  If set to "no", a standalone image passed to the
37704a6fd34bSwdenk		  "bootm" command will be copied to the load address
37714a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
37724a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
37734a6fd34bSwdenk		  data.
37744a6fd34bSwdenk
3775a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3776a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3777fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3778fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3779fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3780fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3781fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3782fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3783fa34f6b2SShawn Guo		  access it during the boot procedure.
3784fa34f6b2SShawn Guo
3785a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3786a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3787a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3788a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3789a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3790a28afca5SDavid A. Long		  must be accessible by the kernel.
3791a28afca5SDavid A. Long
3792eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3793eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3794eea63e05SSimon Glass		  defined.
3795eea63e05SSimon Glass
379617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
379717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
379817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
379917ea1177Swdenk		  initialization code. So, for changes to be effective
380017ea1177Swdenk		  it must be saved and board must be reset.
380117ea1177Swdenk
3802c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3803c609719bSwdenk		  If this variable is not set, initrd images will be
3804c609719bSwdenk		  copied to the highest possible address in RAM; this
3805c609719bSwdenk		  is usually what you want since it allows for
3806c609719bSwdenk		  maximum initrd size. If for some reason you want to
3807c609719bSwdenk		  make sure that the initrd image is loaded below the
38086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3809c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3810c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3811c609719bSwdenk		  address to use (U-Boot will still check that it
3812c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3813c609719bSwdenk
3814c609719bSwdenk		  For instance, when you have a system with 16 MB
38157152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3816c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3817c609719bSwdenk		  the "bootargs" variable. However, now you must make
38187152b1d0Swdenk		  sure that the initrd image is placed in the first
3819c609719bSwdenk		  12 MB as well - this can be done with
3820c609719bSwdenk
3821c609719bSwdenk		  setenv initrd_high 00c00000
3822c609719bSwdenk
382338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
382438b99261Swdenk		  indication to U-Boot that all addresses are legal
382538b99261Swdenk		  for the Linux kernel, including addresses in flash
382638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
382738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
382838b99261Swdenk		  boot time on your system, but requires that this
382938b99261Swdenk		  feature is supported by your Linux kernel.
383038b99261Swdenk
3831c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3832c609719bSwdenk
3833c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3834dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3835c609719bSwdenk
3836c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3837c609719bSwdenk
3838c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3839c609719bSwdenk
3840c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3841c609719bSwdenk
3842c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3843c609719bSwdenk
3844c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3845c609719bSwdenk
3846e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3847a3d991bdSwdenk
3848e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3849e2a53458SMike Frysinger		  For example you can do the following
3850a3d991bdSwdenk
385148690d80SHeiko Schocher		  => setenv ethact FEC
385248690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
385348690d80SHeiko Schocher		  => setenv ethact SCC
385448690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3855a3d991bdSwdenk
3856e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3857e1692577SMatthias Fuchs		  available network interfaces.
3858e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3859e1692577SMatthias Fuchs
3860a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3861a3d991bdSwdenk		  either succeed or fail without retrying.
38626e592385Swdenk		  When set to "once" the network operation will
38636e592385Swdenk		  fail when all the available network interfaces
38646e592385Swdenk		  are tried once without success.
3865a3d991bdSwdenk		  Useful on scripts which control the retry operation
3866a3d991bdSwdenk		  themselves.
3867a3d991bdSwdenk
3868b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3869a1cf027aSJean-Christophe PLAGNIOL-VILLARD
387028cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3871ecb0ccd9SWolfgang Denk		  UDP source port.
3872ecb0ccd9SWolfgang Denk
387328cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
387428cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
387528cb9375SWolfgang Denk
3876c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3877c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3878c96f86eeSWolfgang Denk
3879c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3880c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3881c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3882c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3883c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3884c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3885c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3886c96f86eeSWolfgang Denk
3887a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
388811ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3889a3d991bdSwdenk		  VLAN tagged frames.
3890c609719bSwdenk
3891dc0b7b0eSJason HobbsThe following image location variables contain the location of images
3892dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
3893dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
3894dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
3895dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
3896dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
3897dc0b7b0eSJason Hobbsflash or offset in NAND flash.
3898dc0b7b0eSJason Hobbs
3899dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
3900dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
3901dc0b7b0eSJason Hobbsboards use these variables for other purposes.
3902dc0b7b0eSJason Hobbs
3903dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
3904dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
3905dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
3906dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
3907dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
3908dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3909dc0b7b0eSJason Hobbs
3910c609719bSwdenkThe following environment variables may be used and automatically
3911c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3912c609719bSwdenkdepending the information provided by your boot server:
3913c609719bSwdenk
3914c609719bSwdenk  bootfile	- see above
3915c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3916fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3917c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3918c609719bSwdenk  hostname	- Target hostname
3919c609719bSwdenk  ipaddr	- see above
3920c609719bSwdenk  netmask	- Subnet Mask
3921c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3922c609719bSwdenk  serverip	- see above
3923c609719bSwdenk
3924c609719bSwdenk
3925c609719bSwdenkThere are two special Environment Variables:
3926c609719bSwdenk
3927c609719bSwdenk  serial#	- contains hardware identification information such
3928c609719bSwdenk		  as type string and/or serial number
3929c609719bSwdenk  ethaddr	- Ethernet address
3930c609719bSwdenk
3931c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3932c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3933c609719bSwdenkonce they have been set once.
3934c609719bSwdenk
3935c609719bSwdenk
3936c1551ea8SstroeseFurther special Environment Variables:
3937c1551ea8Sstroese
3938c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3939c1551ea8Sstroese		  with the "version" command. This variable is
3940c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3941c1551ea8Sstroese
3942c1551ea8Sstroese
3943c609719bSwdenkPlease note that changes to some configuration parameters may take
3944c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3945c609719bSwdenk
3946c609719bSwdenk
3947f07771ccSwdenkCommand Line Parsing:
3948f07771ccSwdenk=====================
3949f07771ccSwdenk
3950f07771ccSwdenkThere are two different command line parsers available with U-Boot:
39517152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3952f07771ccSwdenk
3953f07771ccSwdenkOld, simple command line parser:
3954f07771ccSwdenk--------------------------------
3955f07771ccSwdenk
3956f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3957f07771ccSwdenk- several commands on one line, separated by ';'
3958fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3959f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3960f07771ccSwdenk  for example:
3961fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3962f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3963f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3964f07771ccSwdenk
3965f07771ccSwdenkHush shell:
3966f07771ccSwdenk-----------
3967f07771ccSwdenk
3968f07771ccSwdenk- similar to Bourne shell, with control structures like
3969f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3970f07771ccSwdenk  until...do...done, ...
3971f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3972f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3973f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3974f07771ccSwdenk  command
3975f07771ccSwdenk
3976f07771ccSwdenkGeneral rules:
3977f07771ccSwdenk--------------
3978f07771ccSwdenk
3979f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3980f07771ccSwdenk    command) contains several commands separated by semicolon, and
3981f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3982f07771ccSwdenk    executed anyway.
3983f07771ccSwdenk
3984f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
398511ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3986f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3987f07771ccSwdenk    variables are not executed.
3988f07771ccSwdenk
3989c609719bSwdenkNote for Redundant Ethernet Interfaces:
3990c609719bSwdenk=======================================
3991c609719bSwdenk
399211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3993c609719bSwdenksuch configurations and is capable of automatic selection of a
39947152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3995c609719bSwdenk
3996c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3997c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3998c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3999c609719bSwdenk
4000c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4001c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4002c609719bSwdenkding setting in the environment; if the corresponding environment
4003c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4004c609719bSwdenk
4005c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4006c609719bSwdenk  environment, the SROM's address is used.
4007c609719bSwdenk
4008c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4009c609719bSwdenk  environment exists, then the value from the environment variable is
4010c609719bSwdenk  used.
4011c609719bSwdenk
4012c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4013c609719bSwdenk  both addresses are the same, this MAC address is used.
4014c609719bSwdenk
4015c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4016c609719bSwdenk  addresses differ, the value from the environment is used and a
4017c609719bSwdenk  warning is printed.
4018c609719bSwdenk
4019c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4020c609719bSwdenk  is raised.
4021c609719bSwdenk
4022ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4023ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4024ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4025ecee9324SBen WarrenThe naming convention is as follows:
4026ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4027c609719bSwdenk
4028c609719bSwdenkImage Formats:
4029c609719bSwdenk==============
4030c609719bSwdenk
40313310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
40323310c549SMarian Balakowiczimages in two formats:
40333310c549SMarian Balakowicz
40343310c549SMarian BalakowiczNew uImage format (FIT)
40353310c549SMarian Balakowicz-----------------------
40363310c549SMarian Balakowicz
40373310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
40383310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
40393310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
40403310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
40413310c549SMarian Balakowicz
40423310c549SMarian Balakowicz
40433310c549SMarian BalakowiczOld uImage format
40443310c549SMarian Balakowicz-----------------
40453310c549SMarian Balakowicz
40463310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
40473310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
40483310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4049c609719bSwdenk
4050c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4051c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4052f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4053f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4054f5ed9e39SPeter Tyser  INTEGRITY).
40557b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4056afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4057afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4058c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4059c609719bSwdenk* Load Address
4060c609719bSwdenk* Entry Point
4061c609719bSwdenk* Image Name
4062c609719bSwdenk* Image Timestamp
4063c609719bSwdenk
4064c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4065c609719bSwdenkand the data portions of the image are secured against corruption by
4066c609719bSwdenkCRC32 checksums.
4067c609719bSwdenk
4068c609719bSwdenk
4069c609719bSwdenkLinux Support:
4070c609719bSwdenk==============
4071c609719bSwdenk
4072c609719bSwdenkAlthough U-Boot should support any OS or standalone application
40737152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4074c609719bSwdenkU-Boot.
4075c609719bSwdenk
4076c609719bSwdenkU-Boot includes many features that so far have been part of some
4077c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4078c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4079c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
40807152b1d0Swdenkserves several purposes:
4081c609719bSwdenk
4082c609719bSwdenk- the same features can be used for other OS or standalone
4083c609719bSwdenk  applications (for instance: using compressed images to reduce the
4084c609719bSwdenk  Flash memory footprint)
4085c609719bSwdenk
4086c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
40877152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4088c609719bSwdenk
4089c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4090c609719bSwdenk  images; of course this also means that different kernel images can
4091c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4092c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4093c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4094c609719bSwdenk  software is easier now.
4095c609719bSwdenk
4096c609719bSwdenk
4097c609719bSwdenkLinux HOWTO:
4098c609719bSwdenk============
4099c609719bSwdenk
4100c609719bSwdenkPorting Linux to U-Boot based systems:
4101c609719bSwdenk---------------------------------------
4102c609719bSwdenk
4103c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4104c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4105c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4106c609719bSwdenkLinux :-).
4107c609719bSwdenk
4108a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4109c609719bSwdenk
4110c609719bSwdenkJust make sure your machine specific header file (for instance
4111c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
41121dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
41131dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
41146d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4115c609719bSwdenk
4116c609719bSwdenk
4117c609719bSwdenkConfiguring the Linux kernel:
4118c609719bSwdenk-----------------------------
4119c609719bSwdenk
4120c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4121c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4122c609719bSwdenk
4123c609719bSwdenk
4124c609719bSwdenkBuilding a Linux Image:
4125c609719bSwdenk-----------------------
4126c609719bSwdenk
412724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
412824ee89b9Swdenknot used. If you use recent kernel source, a new build target
412924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
413024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
413124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
413224ee89b9Swdenk100% compatible format.
4133c609719bSwdenk
4134c609719bSwdenkExample:
4135c609719bSwdenk
4136c609719bSwdenk	make TQM850L_config
4137c609719bSwdenk	make oldconfig
4138c609719bSwdenk	make dep
413924ee89b9Swdenk	make uImage
4140c609719bSwdenk
414124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
414224ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
414324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4144c609719bSwdenk
414524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
414624ee89b9Swdenk
414724ee89b9Swdenk* convert the kernel into a raw binary image:
414824ee89b9Swdenk
414924ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
415024ee89b9Swdenk				 -R .note -R .comment \
415124ee89b9Swdenk				 -S vmlinux linux.bin
415224ee89b9Swdenk
415324ee89b9Swdenk* compress the binary image:
415424ee89b9Swdenk
415524ee89b9Swdenk	gzip -9 linux.bin
415624ee89b9Swdenk
415724ee89b9Swdenk* package compressed binary image for U-Boot:
415824ee89b9Swdenk
415924ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
416024ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
416124ee89b9Swdenk		-d linux.bin.gz uImage
416224ee89b9Swdenk
416324ee89b9Swdenk
416424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
416524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
416624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
416724ee89b9Swdenkbyte header containing information about target architecture,
416824ee89b9Swdenkoperating system, image type, compression method, entry points, time
416924ee89b9Swdenkstamp, CRC32 checksums, etc.
417024ee89b9Swdenk
417124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
417224ee89b9Swdenkprint the header information, or to build new images.
4173c609719bSwdenk
4174c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4175c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4176c609719bSwdenkchecksum verification:
4177c609719bSwdenk
4178c609719bSwdenk	tools/mkimage -l image
4179c609719bSwdenk	  -l ==> list image header information
4180c609719bSwdenk
4181c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4182c609719bSwdenkfrom a "data file" which is used as image payload:
4183c609719bSwdenk
4184c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4185c609719bSwdenk		      -n name -d data_file image
4186c609719bSwdenk	  -A ==> set architecture to 'arch'
4187c609719bSwdenk	  -O ==> set operating system to 'os'
4188c609719bSwdenk	  -T ==> set image type to 'type'
4189c609719bSwdenk	  -C ==> set compression type 'comp'
4190c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4191c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4192c609719bSwdenk	  -n ==> set image name to 'name'
4193c609719bSwdenk	  -d ==> use image data from 'datafile'
4194c609719bSwdenk
419569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
419669459791Swdenkaddress (0x00000000), but the entry point address depends on the
419769459791Swdenkkernel version:
4198c609719bSwdenk
4199c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
420024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4201c609719bSwdenk
4202c609719bSwdenkSo a typical call to build a U-Boot image would read:
4203c609719bSwdenk
420424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
420524ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4206a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
420724ee89b9Swdenk	> examples/uImage.TQM850L
420824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4209c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4210c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4211c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4212c609719bSwdenk	Load Address: 0x00000000
421324ee89b9Swdenk	Entry Point:  0x00000000
4214c609719bSwdenk
4215c609719bSwdenkTo verify the contents of the image (or check for corruption):
4216c609719bSwdenk
421724ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
421824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4219c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4220c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4221c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4222c609719bSwdenk	Load Address: 0x00000000
422324ee89b9Swdenk	Entry Point:  0x00000000
4224c609719bSwdenk
4225c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4226c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4227c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4228c609719bSwdenkneed to be uncompressed:
4229c609719bSwdenk
4230a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
423124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
423224ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4233a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
423424ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
423524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4236c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4237c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4238c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4239c609719bSwdenk	Load Address: 0x00000000
424024ee89b9Swdenk	Entry Point:  0x00000000
4241c609719bSwdenk
4242c609719bSwdenk
4243c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4244c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4245c609719bSwdenk
4246c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4247c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4248c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4249c609719bSwdenk	Image Name:   Simple Ramdisk Image
4250c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4251c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4252c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4253c609719bSwdenk	Load Address: 0x00000000
4254c609719bSwdenk	Entry Point:  0x00000000
4255c609719bSwdenk
4256c609719bSwdenk
4257c609719bSwdenkInstalling a Linux Image:
4258c609719bSwdenk-------------------------
4259c609719bSwdenk
4260c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4261c609719bSwdenkyou must convert the image to S-Record format:
4262c609719bSwdenk
4263c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4264c609719bSwdenk
4265c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4266c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4267c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4268c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4269c609719bSwdenkcommand.
4270c609719bSwdenk
4271c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4272c609719bSwdenkTQM8xxL is in the first Flash bank):
4273c609719bSwdenk
4274c609719bSwdenk	=> erase 40100000 401FFFFF
4275c609719bSwdenk
4276c609719bSwdenk	.......... done
4277c609719bSwdenk	Erased 8 sectors
4278c609719bSwdenk
4279c609719bSwdenk	=> loads 40100000
4280c609719bSwdenk	## Ready for S-Record download ...
4281c609719bSwdenk	~>examples/image.srec
4282c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4283c609719bSwdenk	...
4284c609719bSwdenk	15989 15990 15991 15992
4285c609719bSwdenk	[file transfer complete]
4286c609719bSwdenk	[connected]
4287c609719bSwdenk	## Start Addr = 0x00000000
4288c609719bSwdenk
4289c609719bSwdenk
4290c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4291c609719bSwdenkthis includes a checksum verification so you can be sure no data
4292c609719bSwdenkcorruption happened:
4293c609719bSwdenk
4294c609719bSwdenk	=> imi 40100000
4295c609719bSwdenk
4296c609719bSwdenk	## Checking Image at 40100000 ...
4297c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4298c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4299c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4300c609719bSwdenk	   Load Address: 00000000
4301c609719bSwdenk	   Entry Point:	 0000000c
4302c609719bSwdenk	   Verifying Checksum ... OK
4303c609719bSwdenk
4304c609719bSwdenk
4305c609719bSwdenkBoot Linux:
4306c609719bSwdenk-----------
4307c609719bSwdenk
4308c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4309c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4310c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4311c609719bSwdenkparameters. You can check and modify this variable using the
4312c609719bSwdenk"printenv" and "setenv" commands:
4313c609719bSwdenk
4314c609719bSwdenk
4315c609719bSwdenk	=> printenv bootargs
4316c609719bSwdenk	bootargs=root=/dev/ram
4317c609719bSwdenk
4318c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4319c609719bSwdenk
4320c609719bSwdenk	=> printenv bootargs
4321c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4322c609719bSwdenk
4323c609719bSwdenk	=> bootm 40020000
4324c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4325c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4326c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4327c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4328c609719bSwdenk	   Load Address: 00000000
4329c609719bSwdenk	   Entry Point:	 0000000c
4330c609719bSwdenk	   Verifying Checksum ... OK
4331c609719bSwdenk	   Uncompressing Kernel Image ... OK
4332c609719bSwdenk	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
4333c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4334c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4335c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4336c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4337c609719bSwdenk	...
4338c609719bSwdenk
433911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
43407152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4341c609719bSwdenkformat!) to the "bootm" command:
4342c609719bSwdenk
4343c609719bSwdenk	=> imi 40100000 40200000
4344c609719bSwdenk
4345c609719bSwdenk	## Checking Image at 40100000 ...
4346c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4347c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4348c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4349c609719bSwdenk	   Load Address: 00000000
4350c609719bSwdenk	   Entry Point:	 0000000c
4351c609719bSwdenk	   Verifying Checksum ... OK
4352c609719bSwdenk
4353c609719bSwdenk	## Checking Image at 40200000 ...
4354c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4355c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4356c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4357c609719bSwdenk	   Load Address: 00000000
4358c609719bSwdenk	   Entry Point:	 00000000
4359c609719bSwdenk	   Verifying Checksum ... OK
4360c609719bSwdenk
4361c609719bSwdenk	=> bootm 40100000 40200000
4362c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4363c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4364c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4365c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4366c609719bSwdenk	   Load Address: 00000000
4367c609719bSwdenk	   Entry Point:	 0000000c
4368c609719bSwdenk	   Verifying Checksum ... OK
4369c609719bSwdenk	   Uncompressing Kernel Image ... OK
4370c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4371c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4372c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4373c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4374c609719bSwdenk	   Load Address: 00000000
4375c609719bSwdenk	   Entry Point:	 00000000
4376c609719bSwdenk	   Verifying Checksum ... OK
4377c609719bSwdenk	   Loading Ramdisk ... OK
4378c609719bSwdenk	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
4379c609719bSwdenk	Boot arguments: root=/dev/ram
4380c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4381c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4382c609719bSwdenk	...
4383c609719bSwdenk	RAMDISK: Compressed image found at block 0
4384c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4385c609719bSwdenk
4386c609719bSwdenk	bash#
4387c609719bSwdenk
43880267768eSMatthew McClintockBoot Linux and pass a flat device tree:
43890267768eSMatthew McClintock-----------
43900267768eSMatthew McClintock
43910267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
43920267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
43930267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
43940267768eSMatthew McClintockflat device tree:
43950267768eSMatthew McClintock
43960267768eSMatthew McClintock=> print oftaddr
43970267768eSMatthew McClintockoftaddr=0x300000
43980267768eSMatthew McClintock=> print oft
43990267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
44000267768eSMatthew McClintock=> tftp $oftaddr $oft
44010267768eSMatthew McClintockSpeed: 1000, full duplex
44020267768eSMatthew McClintockUsing TSEC0 device
44030267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
44040267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
44050267768eSMatthew McClintockLoad address: 0x300000
44060267768eSMatthew McClintockLoading: #
44070267768eSMatthew McClintockdone
44080267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
44090267768eSMatthew McClintock=> tftp $loadaddr $bootfile
44100267768eSMatthew McClintockSpeed: 1000, full duplex
44110267768eSMatthew McClintockUsing TSEC0 device
44120267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
44130267768eSMatthew McClintockFilename 'uImage'.
44140267768eSMatthew McClintockLoad address: 0x200000
44150267768eSMatthew McClintockLoading:############
44160267768eSMatthew McClintockdone
44170267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
44180267768eSMatthew McClintock=> print loadaddr
44190267768eSMatthew McClintockloadaddr=200000
44200267768eSMatthew McClintock=> print oftaddr
44210267768eSMatthew McClintockoftaddr=0x300000
44220267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
44230267768eSMatthew McClintock## Booting image at 00200000 ...
44240267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
44250267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
44260267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
44270267768eSMatthew McClintock   Load Address: 00000000
44280267768eSMatthew McClintock   Entry Point:	 00000000
44290267768eSMatthew McClintock   Verifying Checksum ... OK
44300267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
44310267768eSMatthew McClintockBooting using flat device tree at 0x300000
44320267768eSMatthew McClintockUsing MPC85xx ADS machine description
44330267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
44340267768eSMatthew McClintock[snip]
44350267768eSMatthew McClintock
44360267768eSMatthew McClintock
44376069ff26SwdenkMore About U-Boot Image Types:
44386069ff26Swdenk------------------------------
44396069ff26Swdenk
44406069ff26SwdenkU-Boot supports the following image types:
44416069ff26Swdenk
44426069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
44436069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
44446069ff26Swdenk	well) you can continue to work in U-Boot after return from
44456069ff26Swdenk	the Standalone Program.
44466069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
44476069ff26Swdenk	will take over control completely. Usually these programs
44486069ff26Swdenk	will install their own set of exception handlers, device
44496069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
44506069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
44516069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
44526069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
44536069ff26Swdenk	being started.
44546069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
44556069ff26Swdenk	(Linux) kernel image and one or more data images like
44566069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
44576069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
44586069ff26Swdenk	server provides just a single image file, but you want to get
44596069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
44606069ff26Swdenk
44616069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
44626069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
44636069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
44646069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
44656069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
44666069ff26Swdenk	a multiple of 4 bytes).
44676069ff26Swdenk
44686069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
44696069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
44706069ff26Swdenk	flash memory.
44716069ff26Swdenk
44726069ff26Swdenk   "Script files" are command sequences that will be executed by
44736069ff26Swdenk	U-Boot's command interpreter; this feature is especially
44746069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
44756069ff26Swdenk	as command interpreter.
44766069ff26Swdenk
447744f074c7SMarek VasutBooting the Linux zImage:
447844f074c7SMarek Vasut-------------------------
447944f074c7SMarek Vasut
448044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
448144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
448244f074c7SMarek Vasutas the syntax of "bootm" command.
448344f074c7SMarek Vasut
4484017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4485017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4486017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4487017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4488017e1f3fSMarek Vasut
4489c609719bSwdenk
4490c609719bSwdenkStandalone HOWTO:
4491c609719bSwdenk=================
4492c609719bSwdenk
4493c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4494c609719bSwdenkrun "standalone" applications, which can use some resources of
4495c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4496c609719bSwdenk
4497c609719bSwdenkTwo simple examples are included with the sources:
4498c609719bSwdenk
4499c609719bSwdenk"Hello World" Demo:
4500c609719bSwdenk-------------------
4501c609719bSwdenk
4502c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4503c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4504c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4505c609719bSwdenklike that:
4506c609719bSwdenk
4507c609719bSwdenk	=> loads
4508c609719bSwdenk	## Ready for S-Record download ...
4509c609719bSwdenk	~>examples/hello_world.srec
4510c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4511c609719bSwdenk	[file transfer complete]
4512c609719bSwdenk	[connected]
4513c609719bSwdenk	## Start Addr = 0x00040004
4514c609719bSwdenk
4515c609719bSwdenk	=> go 40004 Hello World! This is a test.
4516c609719bSwdenk	## Starting application at 0x00040004 ...
4517c609719bSwdenk	Hello World
4518c609719bSwdenk	argc = 7
4519c609719bSwdenk	argv[0] = "40004"
4520c609719bSwdenk	argv[1] = "Hello"
4521c609719bSwdenk	argv[2] = "World!"
4522c609719bSwdenk	argv[3] = "This"
4523c609719bSwdenk	argv[4] = "is"
4524c609719bSwdenk	argv[5] = "a"
4525c609719bSwdenk	argv[6] = "test."
4526c609719bSwdenk	argv[7] = "<NULL>"
4527c609719bSwdenk	Hit any key to exit ...
4528c609719bSwdenk
4529c609719bSwdenk	## Application terminated, rc = 0x0
4530c609719bSwdenk
4531c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4532c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4533c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4534c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4535c609719bSwdenkcharacter, but this is just a demo program. The application can be
4536c609719bSwdenkcontrolled by the following keys:
4537c609719bSwdenk
4538c609719bSwdenk	? - print current values og the CPM Timer registers
4539c609719bSwdenk	b - enable interrupts and start timer
4540c609719bSwdenk	e - stop timer and disable interrupts
4541c609719bSwdenk	q - quit application
4542c609719bSwdenk
4543c609719bSwdenk	=> loads
4544c609719bSwdenk	## Ready for S-Record download ...
4545c609719bSwdenk	~>examples/timer.srec
4546c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4547c609719bSwdenk	[file transfer complete]
4548c609719bSwdenk	[connected]
4549c609719bSwdenk	## Start Addr = 0x00040004
4550c609719bSwdenk
4551c609719bSwdenk	=> go 40004
4552c609719bSwdenk	## Starting application at 0x00040004 ...
4553c609719bSwdenk	TIMERS=0xfff00980
4554c609719bSwdenk	Using timer 1
4555c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4556c609719bSwdenk
4557c609719bSwdenkHit 'b':
4558c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4559c609719bSwdenk	Enabling timer
4560c609719bSwdenkHit '?':
4561c609719bSwdenk	[q, b, e, ?] ........
4562c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4563c609719bSwdenkHit '?':
4564c609719bSwdenk	[q, b, e, ?] .
4565c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4566c609719bSwdenkHit '?':
4567c609719bSwdenk	[q, b, e, ?] .
4568c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4569c609719bSwdenkHit '?':
4570c609719bSwdenk	[q, b, e, ?] .
4571c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4572c609719bSwdenkHit 'e':
4573c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4574c609719bSwdenkHit 'q':
4575c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4576c609719bSwdenk
4577c609719bSwdenk
457885ec0bccSwdenkMinicom warning:
457985ec0bccSwdenk================
458085ec0bccSwdenk
45817152b1d0SwdenkOver time, many people have reported problems when trying to use the
458285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
458385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4584f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
458585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
458685ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
458785ec0bccSwdenk
458852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
458952f52c14Swdenkconfiguration to your "File transfer protocols" section:
459052f52c14Swdenk
459152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
459252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
459352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
459452f52c14Swdenk
459552f52c14Swdenk
4596c609719bSwdenkNetBSD Notes:
4597c609719bSwdenk=============
4598c609719bSwdenk
4599c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4600c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4601c609719bSwdenk
4602c609719bSwdenkBuilding requires a cross environment; it is known to work on
4603c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4604c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4605c609719bSwdenkNote that the cross-powerpc package does not install include files;
4606c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4607c609719bSwdenkmissing.  This file has to be installed and patched manually:
4608c609719bSwdenk
4609c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4610c609719bSwdenk	# mkdir powerpc
4611c609719bSwdenk	# ln -s powerpc machine
4612c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4613c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4614c609719bSwdenk
4615c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4616c609719bSwdenkand U-Boot include files.
4617c609719bSwdenk
4618c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4619c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4620c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4621c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
46222a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4623c609719bSwdenk
4624c609719bSwdenk
4625c609719bSwdenkImplementation Internals:
4626c609719bSwdenk=========================
4627c609719bSwdenk
4628c609719bSwdenkThe following is not intended to be a complete description of every
4629c609719bSwdenkimplementation detail. However, it should help to understand the
4630c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4631c609719bSwdenkhardware.
4632c609719bSwdenk
4633c609719bSwdenk
4634c609719bSwdenkInitial Stack, Global Data:
4635c609719bSwdenk---------------------------
4636c609719bSwdenk
4637c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4638c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4639c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4640c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4641c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4642c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4643c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4644c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4645c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4646c609719bSwdenklocked as (mis-) used as memory, etc.
4647c609719bSwdenk
46487152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
46490668236bSWolfgang Denk	U-Boot mailing list:
465043d9616cSwdenk
465143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
465243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
465343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
465443d9616cSwdenk	...
465543d9616cSwdenk
465643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
465743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
465843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
465943d9616cSwdenk	is that the cache is being used as a temporary supply of
466043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
466111ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
466243d9616cSwdenk	can see how this works by studying the cache architecture and
466343d9616cSwdenk	operation in the architecture and processor-specific manuals.
466443d9616cSwdenk
466543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
466643d9616cSwdenk	is another option for the system designer to use as an
466711ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
466843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
466943d9616cSwdenk	board designers haven't used it for something that would
467043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
467143d9616cSwdenk	used.
467243d9616cSwdenk
46736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
467443d9616cSwdenk	with your processor/board/system design. The default value
467543d9616cSwdenk	you will find in any recent u-boot distribution in
46768a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
467743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
467843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
467943d9616cSwdenk	that are supposed to respond to that address! That code in
468043d9616cSwdenk	start.S has been around a while and should work as is when
468143d9616cSwdenk	you get the config right.
468243d9616cSwdenk
468343d9616cSwdenk	-Chris Hallinan
468443d9616cSwdenk	DS4.COM, Inc.
468543d9616cSwdenk
4686c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4687c609719bSwdenkcode for the initialization procedures:
4688c609719bSwdenk
4689c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4690c609719bSwdenk  to write it.
4691c609719bSwdenk
469211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4693c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
46947152b1d0Swdenk  zation is performed later (when relocating to RAM).
4695c609719bSwdenk
4696c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4697c609719bSwdenk  that.
4698c609719bSwdenk
4699c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4700c609719bSwdenknormal global data to share information beween the code. But it
4701c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4702c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4703c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4704c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4705c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4706c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4707c609719bSwdenkreserve for this purpose.
4708c609719bSwdenk
47097152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4710c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4711c609719bSwdenkGCC's implementation.
4712c609719bSwdenk
4713c609719bSwdenkFor PowerPC, the following registers have specific use:
4714c609719bSwdenk	R1:	stack pointer
4715e7670f6cSWolfgang Denk	R2:	reserved for system use
4716c609719bSwdenk	R3-R4:	parameter passing and return values
4717c609719bSwdenk	R5-R10: parameter passing
4718c609719bSwdenk	R13:	small data area pointer
4719c609719bSwdenk	R30:	GOT pointer
4720c609719bSwdenk	R31:	frame pointer
4721c609719bSwdenk
4722e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4723e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4724e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4725c609719bSwdenk
4726e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4727c609719bSwdenk
4728c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4729c609719bSwdenk    address of the global data structure is known at compile time),
4730c609719bSwdenk    but it turned out that reserving a register results in somewhat
4731c609719bSwdenk    smaller code - although the code savings are not that big (on
4732c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4733c609719bSwdenk    624 text + 127 data).
4734c609719bSwdenk
4735c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
47364c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
47374c58eb55SMike Frysinger
4738c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
47394c58eb55SMike Frysinger
4740c609719bSwdenkOn ARM, the following registers are used:
4741c609719bSwdenk
4742c609719bSwdenk	R0:	function argument word/integer result
4743c609719bSwdenk	R1-R3:	function argument word
4744c609719bSwdenk	R9:	GOT pointer
4745c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4746c609719bSwdenk	R11:	argument (frame) pointer
4747c609719bSwdenk	R12:	temporary workspace
4748c609719bSwdenk	R13:	stack pointer
4749c609719bSwdenk	R14:	link register
4750c609719bSwdenk	R15:	program counter
4751c609719bSwdenk
4752c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4753c609719bSwdenk
47540df01fd3SThomas ChouOn Nios II, the ABI is documented here:
47550df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
47560df01fd3SThomas Chou
47570df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
47580df01fd3SThomas Chou
47590df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
47600df01fd3SThomas Chou    to access small data sections, so gp is free.
47610df01fd3SThomas Chou
4762afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4763afc1ce82SMacpaul Lin
4764afc1ce82SMacpaul Lin	R0-R1:	argument/return
4765afc1ce82SMacpaul Lin	R2-R5:	argument
4766afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4767afc1ce82SMacpaul Lin	R16:	trampoline register
4768afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4769afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4770afc1ce82SMacpaul Lin	R30:	link register (LP)
4771afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4772afc1ce82SMacpaul Lin	PC:	program counter (PC)
4773afc1ce82SMacpaul Lin
4774afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4775afc1ce82SMacpaul Lin
4776d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4777d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4778c609719bSwdenk
4779c609719bSwdenkMemory Management:
4780c609719bSwdenk------------------
4781c609719bSwdenk
4782c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4783c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4784c609719bSwdenk
4785c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4786c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4787c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4788c609719bSwdenkphysical memory banks.
4789c609719bSwdenk
4790c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4791c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4792c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4793c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
47946d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4795c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4796c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4797c609719bSwdenk
4798c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4799c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4800c609719bSwdenk
4801c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4802c609719bSwdenkthis:
4803c609719bSwdenk
4804c609719bSwdenk	0x0000 0000	Exception Vector code
4805c609719bSwdenk	      :
4806c609719bSwdenk	0x0000 1FFF
4807c609719bSwdenk	0x0000 2000	Free for Application Use
4808c609719bSwdenk	      :
4809c609719bSwdenk	      :
4810c609719bSwdenk
4811c609719bSwdenk	      :
4812c609719bSwdenk	      :
4813c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4814c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4815c609719bSwdenk	0x00FC 0000	Malloc Arena
4816c609719bSwdenk	      :
4817c609719bSwdenk	0x00FD FFFF
4818c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4819c609719bSwdenk	...		eventually: LCD or video framebuffer
4820c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4821c609719bSwdenk	0x00FF FFFF	[End of RAM]
4822c609719bSwdenk
4823c609719bSwdenk
4824c609719bSwdenkSystem Initialization:
4825c609719bSwdenk----------------------
4826c609719bSwdenk
4827c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
482811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4829c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
48307152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4831c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4832c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4833c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4834c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4835c609719bSwdenkthe caches and the SIU.
4836c609719bSwdenk
4837c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4838c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4839c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4840c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4841c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4842c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4843c609719bSwdenkbanks.
4844c609719bSwdenk
4845c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
48467152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4847c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4848c609719bSwdenk0x00000000, with any additional banks following immediately to create
4849c609719bSwdenkcontiguous memory starting from 0.
4850c609719bSwdenk
4851c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4852c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4853c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4854c609719bSwdenkpages, and the final stack is set up.
4855c609719bSwdenk
4856c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4857c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4858c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4859c609719bSwdenknew address in RAM.
4860c609719bSwdenk
4861c609719bSwdenk
4862c609719bSwdenkU-Boot Porting Guide:
4863c609719bSwdenk----------------------
4864c609719bSwdenk
4865c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
48666aff3115Swdenklist, October 2002]
4867c609719bSwdenk
4868c609719bSwdenk
4869c609719bSwdenkint main(int argc, char *argv[])
4870c609719bSwdenk{
4871c609719bSwdenk	sighandler_t no_more_time;
4872c609719bSwdenk
4873c609719bSwdenk	signal(SIGALRM, no_more_time);
4874c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4875c609719bSwdenk
4876c609719bSwdenk	if (available_money > available_manpower) {
48776c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4878c609719bSwdenk		return 0;
4879c609719bSwdenk	}
4880c609719bSwdenk
4881c609719bSwdenk	Download latest U-Boot source;
4882c609719bSwdenk
48830668236bSWolfgang Denk	Subscribe to u-boot mailing list;
48846aff3115Swdenk
48856c3fef28SJerry Van Baren	if (clueless)
4886c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4887c609719bSwdenk
4888c609719bSwdenk	while (learning) {
4889c609719bSwdenk		Read the README file in the top level directory;
48907cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
48916c3fef28SJerry Van Baren		Read applicable doc/*.README;
4892c609719bSwdenk		Read the source, Luke;
48936c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4894c609719bSwdenk	}
4895c609719bSwdenk
48966c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
48976c3fef28SJerry Van Baren		Buy a BDI3000;
48986c3fef28SJerry Van Baren	else
4899c609719bSwdenk		Add a lot of aggravation and time;
4900c609719bSwdenk
49016c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
49026c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
49036c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
49046c3fef28SJerry Van Baren	} else {
4905c609719bSwdenk		Create your own board support subdirectory;
49066c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
49076c3fef28SJerry Van Baren	}
49086c3fef28SJerry Van Baren	Edit new board/<myboard> files
49096c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4910c609719bSwdenk
49116c3fef28SJerry Van Baren	while (!accepted) {
4912c609719bSwdenk		while (!running) {
4913c609719bSwdenk			do {
4914c609719bSwdenk				Add / modify source code;
4915c609719bSwdenk			} until (compiles);
4916c609719bSwdenk			Debug;
4917c609719bSwdenk			if (clueless)
4918c609719bSwdenk				email("Hi, I am having problems...");
4919c609719bSwdenk		}
49206c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
49216c3fef28SJerry Van Baren		if (reasonable critiques)
49226c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
49236c3fef28SJerry Van Baren		else
49246c3fef28SJerry Van Baren			Defend code as written;
49256c3fef28SJerry Van Baren	}
4926c609719bSwdenk
4927c609719bSwdenk	return 0;
4928c609719bSwdenk}
4929c609719bSwdenk
4930c609719bSwdenkvoid no_more_time (int sig)
4931c609719bSwdenk{
4932c609719bSwdenk      hire_a_guru();
4933c609719bSwdenk}
4934c609719bSwdenk
4935c609719bSwdenk
4936c609719bSwdenkCoding Standards:
4937c609719bSwdenk-----------------
4938c609719bSwdenk
4939c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
49402c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
49417ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4942c609719bSwdenk
49432c051651SDetlev ZundelSource files originating from a different project (for example the
49442c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
49452c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
49462c051651SDetlev Zundelsources.
49472c051651SDetlev Zundel
49482c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
49492c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
49502c051651SDetlev Zundelin your code.
4951c609719bSwdenk
4952c178d3daSwdenkPlease also stick to the following formatting rules:
4953180d3f74Swdenk- remove any trailing white space
49547ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4955180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
49567ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4957180d3f74Swdenk- do not add trailing empty lines to source files
4958180d3f74Swdenk
4959c609719bSwdenkSubmissions which do not conform to the standards may be returned
4960c609719bSwdenkwith a request to reformat the changes.
4961c609719bSwdenk
4962c609719bSwdenk
4963c609719bSwdenkSubmitting Patches:
4964c609719bSwdenk-------------------
4965c609719bSwdenk
4966c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4967c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4968c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4969c609719bSwdenk
49700d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4971218ca724SWolfgang Denk
49720668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
49730668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
49740668236bSWolfgang Denk
4975c609719bSwdenkWhen you send a patch, please include the following information with
4976c609719bSwdenkit:
4977c609719bSwdenk
4978c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4979c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4980c609719bSwdenk  patch actually fixes something.
4981c609719bSwdenk
4982c609719bSwdenk* For new features: a description of the feature and your
4983c609719bSwdenk  implementation.
4984c609719bSwdenk
4985c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4986c609719bSwdenk
4987c609719bSwdenk* For major contributions, your entry to the CREDITS file
4988c609719bSwdenk
4989c609719bSwdenk* When you add support for a new board, don't forget to add this
49907ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
4991c609719bSwdenk
4992c609719bSwdenk* If your patch adds new configuration options, don't forget to
4993c609719bSwdenk  document these in the README file.
4994c609719bSwdenk
4995218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4996218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
49977ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
4998218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4999218ca724SWolfgang Denk  with some other mail clients.
5000c609719bSwdenk
5001218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5002218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5003218ca724SWolfgang Denk  GNU diff.
50046dff5529Swdenk
5005218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5006218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5007218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5008218ca724SWolfgang Denk  affected files).
5009218ca724SWolfgang Denk
5010218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5011218ca724SWolfgang Denk  and compressed attachments must not be used.
5012c609719bSwdenk
501352f52c14Swdenk* If one logical set of modifications affects or creates several
501452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
501552f52c14Swdenk
501652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
501752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
501852f52c14Swdenk
501952f52c14Swdenk
5020c609719bSwdenkNotes:
5021c609719bSwdenk
5022c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5023c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5024c609719bSwdenk  for any of the boards.
5025c609719bSwdenk
5026c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5027c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5028c609719bSwdenk  returned with a request to re-formatting / split it.
5029c609719bSwdenk
5030c609719bSwdenk* If you modify existing code, make sure that your new code does not
5031c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5032c609719bSwdenk  When adding new features, these should compile conditionally only
5033c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5034c609719bSwdenk  disabled must not need more memory than the old code without your
5035c609719bSwdenk  modification.
503690dc6704Swdenk
50370668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
50380668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
50390668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
50400668236bSWolfgang Denk  bigger than the size limit should be avoided.
5041