xref: /openbmc/u-boot/README (revision 765b0bdb899d614d0455f19548901b79f2baa66c)
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
57adb9d851SRobert P. J. DayNote: There is no CHANGELOG file in the actual U-Boot source tree;
58adb9d851SRobert P. J. Dayit can be created dynamically from the Git log using:
59adb9d851SRobert P. J. Day
60adb9d851SRobert P. J. Day	make CHANGELOG
61adb9d851SRobert P. J. Day
62c609719bSwdenk
63c609719bSwdenkWhere to get help:
64c609719bSwdenk==================
65c609719bSwdenk
66c609719bSwdenkIn case you have questions about, problems with or contributions for
67c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
680c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
690c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
700c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
710c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
72c609719bSwdenk
73c609719bSwdenk
74218ca724SWolfgang DenkWhere to get source code:
75218ca724SWolfgang Denk=========================
76218ca724SWolfgang Denk
77218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
78218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
79218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
80218ca724SWolfgang Denk
81218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
8211ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
83218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
84218ca724SWolfgang Denkdirectory.
85218ca724SWolfgang Denk
86d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
87218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
88218ca724SWolfgang Denk
89218ca724SWolfgang Denk
90c609719bSwdenkWhere we come from:
91c609719bSwdenk===================
92c609719bSwdenk
93c609719bSwdenk- start from 8xxrom sources
9424ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
95c609719bSwdenk- clean up code
96c609719bSwdenk- make it easier to add custom boards
97c609719bSwdenk- make it possible to add other [PowerPC] CPUs
98c609719bSwdenk- extend functions, especially:
99c609719bSwdenk  * Provide extended interface to Linux boot loader
100c609719bSwdenk  * S-Record download
101c609719bSwdenk  * network boot
10211ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
10324ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
104c609719bSwdenk- add other CPU families (starting with ARM)
10524ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1060d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10724ee89b9Swdenk
10824ee89b9Swdenk
10924ee89b9SwdenkNames and Spelling:
11024ee89b9Swdenk===================
11124ee89b9Swdenk
11224ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
11324ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
11424ee89b9Swdenkin source files etc.). Example:
11524ee89b9Swdenk
11624ee89b9Swdenk	This is the README file for the U-Boot project.
11724ee89b9Swdenk
11824ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11924ee89b9Swdenk
12024ee89b9Swdenk	include/asm-ppc/u-boot.h
12124ee89b9Swdenk
12224ee89b9Swdenk	#include <asm/u-boot.h>
12324ee89b9Swdenk
12424ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12524ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12624ee89b9Swdenk
12724ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12824ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
129c609719bSwdenk
130c609719bSwdenk
13193f19cc0SwdenkVersioning:
13293f19cc0Swdenk===========
13393f19cc0Swdenk
134360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
135360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
136360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
137360d883aSThomas Webernames consisting of the calendar year and month of the release date.
138360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
139360d883aSThomas Weberreleases in "stable" maintenance trees.
14093f19cc0Swdenk
141360d883aSThomas WeberExamples:
142360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
143360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
144360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14593f19cc0Swdenk
14693f19cc0Swdenk
147c609719bSwdenkDirectory Hierarchy:
148c609719bSwdenk====================
149c609719bSwdenk
1508d321b81SPeter Tyser/arch			Architecture specific files
1518d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1528d321b81SPeter Tyser    /cpu		CPU specific files
1538d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1548d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1556eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1568d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1578d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1588d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1598d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1608d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1618d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1628d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1638d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1648d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1658d321b81SPeter Tyser    /lib		Architecture specific library files
1668d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1678d321b81SPeter Tyser    /cpu		CPU specific files
1688d321b81SPeter Tyser    /lib		Architecture specific library files
1698d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1708d321b81SPeter Tyser    /cpu		CPU specific files
1718d321b81SPeter Tyser    /lib		Architecture specific library files
172fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1738d321b81SPeter Tyser    /cpu		CPU specific files
1748d321b81SPeter Tyser    /lib		Architecture specific library files
1758d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1768d321b81SPeter Tyser    /cpu		CPU specific files
1778d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1788d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1798d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1808d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1818d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1828d321b81SPeter Tyser    /lib		Architecture specific library files
1838d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1848d321b81SPeter Tyser    /cpu		CPU specific files
1858d321b81SPeter Tyser    /lib		Architecture specific library files
1868d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1878d321b81SPeter Tyser    /cpu		CPU specific files
18892bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
18980421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1908d321b81SPeter Tyser    /lib		Architecture specific library files
191afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
192afc1ce82SMacpaul Lin    /cpu		CPU specific files
193afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
194afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1958d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1968d321b81SPeter Tyser    /cpu		CPU specific files
1978d321b81SPeter Tyser    /lib		Architecture specific library files
198a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1998d321b81SPeter Tyser    /cpu		CPU specific files
2008d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
2018d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
2028d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
2038d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
2048d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
2058d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
2068d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
2078d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
2088d321b81SPeter Tyser    /lib		Architecture specific library files
2098d321b81SPeter Tyser  /sh			Files generic to SH architecture
2108d321b81SPeter Tyser    /cpu		CPU specific files
2118d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2128d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2138d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2148d321b81SPeter Tyser    /lib		Architecture specific library files
2158d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2168d321b81SPeter Tyser    /cpu		CPU specific files
2178d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2188d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2198d321b81SPeter Tyser    /lib		Architecture specific library files
2208d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2218d321b81SPeter Tyser/board			Board dependent files
2228d321b81SPeter Tyser/common			Misc architecture independent functions
2238d321b81SPeter Tyser/disk			Code for disk drive partition handling
2248d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2258d321b81SPeter Tyser/drivers		Commonly used device drivers
2268d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2278d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2288d321b81SPeter Tyser/include		Header Files
2298d321b81SPeter Tyser/lib			Files generic to all architectures
2308d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2318d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2328d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2338d321b81SPeter Tyser/net			Networking code
2348d321b81SPeter Tyser/post			Power On Self Test
2358d321b81SPeter Tyser/rtc			Real Time Clock drivers
2368d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
237c609719bSwdenk
238c609719bSwdenkSoftware Configuration:
239c609719bSwdenk=======================
240c609719bSwdenk
241c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
242c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
243c609719bSwdenk
244c609719bSwdenkThere are two classes of configuration variables:
245c609719bSwdenk
246c609719bSwdenk* Configuration _OPTIONS_:
247c609719bSwdenk  These are selectable by the user and have names beginning with
248c609719bSwdenk  "CONFIG_".
249c609719bSwdenk
250c609719bSwdenk* Configuration _SETTINGS_:
251c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
252c609719bSwdenk  you don't know what you're doing; they have names beginning with
2536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
254c609719bSwdenk
255c609719bSwdenkLater we will add a configuration tool - probably similar to or even
256c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
257c609719bSwdenkdo the configuration by hand, which means creating some symbolic
258c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
259c609719bSwdenkas an example here.
260c609719bSwdenk
261c609719bSwdenk
262c609719bSwdenkSelection of Processor Architecture and Board Type:
263c609719bSwdenk---------------------------------------------------
264c609719bSwdenk
265c609719bSwdenkFor all supported boards there are ready-to-use default
266c609719bSwdenkconfigurations available; just type "make <board_name>_config".
267c609719bSwdenk
268c609719bSwdenkExample: For a TQM823L module type:
269c609719bSwdenk
270c609719bSwdenk	cd u-boot
271c609719bSwdenk	make TQM823L_config
272c609719bSwdenk
27311ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
274c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
275c609719bSwdenkdirectory according to the instructions in cogent/README.
276c609719bSwdenk
277c609719bSwdenk
278c609719bSwdenkConfiguration Options:
279c609719bSwdenk----------------------
280c609719bSwdenk
281c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
282c609719bSwdenksuch information is kept in a configuration file
283c609719bSwdenk"include/configs/<board_name>.h".
284c609719bSwdenk
285c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
286c609719bSwdenk"include/configs/TQM823L.h".
287c609719bSwdenk
288c609719bSwdenk
2897f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2907f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2917f6c2cbcSwdenkbuild a config tool - later.
2927f6c2cbcSwdenk
2937f6c2cbcSwdenk
294c609719bSwdenkThe following options need to be configured:
295c609719bSwdenk
2962628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
297c609719bSwdenk
2982628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2996ccec449SWolfgang Denk
3006ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
30109ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
302c609719bSwdenk
303c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
304c609719bSwdenk		Define exactly one of
305c609719bSwdenk		CONFIG_CMA286_60_OLD
306c609719bSwdenk--- FIXME --- not tested yet:
307c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
309c609719bSwdenk
310c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define exactly one of
312c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
313c609719bSwdenk
314c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_CMA302
317c609719bSwdenk
318c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319c609719bSwdenk		Define one or more of
320c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
32111ccc33fSMarcel Ziswiler					  the LCD display every second with
322c609719bSwdenk					  a "rotator" |\-/|\-/
323c609719bSwdenk
3242535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3252535d602Swdenk		CONFIG_ADSTYPE
3262535d602Swdenk		Possible values are:
3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3312535d602Swdenk
332cf946c6dSLei Wen- Marvell Family Member
333cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
334cf946c6dSLei Wen					  multiple fs option at one time
335cf946c6dSLei Wen					  for marvell soc family
336cf946c6dSLei Wen
337c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
338c609719bSwdenk		Define exactly one of
339c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
340c609719bSwdenk
34111ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
34266ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
34366ca92a5Swdenk					  get_gclk_freq() cannot work
3445da627a4Swdenk					  e.g. if there is no 32KHz
3455da627a4Swdenk					  reference PIT/RTC clock
34666ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34766ca92a5Swdenk					  or XTAL/EXTAL)
348c609719bSwdenk
34966ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
35266ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
35375d1ea7fSwdenk			See doc/README.MPC866
35475d1ea7fSwdenk
3556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35675d1ea7fSwdenk
35775d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35875d1ea7fSwdenk		of relying on the correctness of the configured
35975d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
36075d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
36175d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
36375d1ea7fSwdenk
364506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
365506f3918SHeiko Schocher
366506f3918SHeiko Schocher		Define this option if you want to enable the
367506f3918SHeiko Schocher		ICache only when Code runs from RAM.
368506f3918SHeiko Schocher
36966412c63SKumar Gala- 85xx CPU Options:
370ffd06e02SYork Sun		CONFIG_SYS_PPC64
371ffd06e02SYork Sun
372ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
373ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
374ffd06e02SYork Sun		compliance, among other possible reasons.
375ffd06e02SYork Sun
37666412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
37766412c63SKumar Gala
37866412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
37966412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
38066412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
38166412c63SKumar Gala
3828f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3838f29084aSKumar Gala
3848f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3858f29084aSKumar Gala		tree nodes for the given platform.
3868f29084aSKumar Gala
387afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
388afa6b551SPrabhakar Kushwaha
389afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
390afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
391afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
392afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
393afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
394afa6b551SPrabhakar Kushwaha		purpose.
395afa6b551SPrabhakar Kushwaha
39633eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
39733eee330SScott Wood
39833eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
39933eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
40033eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
40133eee330SScott Wood
40233eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
40333eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
40433eee330SScott Wood
40533eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
40633eee330SScott Wood		for which the A004510 workaround should be applied.
40733eee330SScott Wood
40833eee330SScott Wood		The rest of SVR is either not relevant to the decision
40933eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
41033eee330SScott Wood		p2041) or is implied by the build target, which controls
41133eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
41233eee330SScott Wood
41333eee330SScott Wood		See Freescale App Note 4493 for more information about
41433eee330SScott Wood		this erratum.
41533eee330SScott Wood
41674fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
41774fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
41874fa22edSPrabhakar Kushwaha		requred during NOR boot.
41974fa22edSPrabhakar Kushwaha
42033eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
42133eee330SScott Wood
42233eee330SScott Wood		This is the value to write into CCSR offset 0x18600
42333eee330SScott Wood		according to the A004510 workaround.
42433eee330SScott Wood
425*765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426*765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
427*765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
428*765b0bdbSPriyanka Jain
429*765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430*765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
431*765b0bdbSPriyanka Jain
4326cb461b4SDaniel Schwierzeck- Generic CPU options:
4336cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4346cb461b4SDaniel Schwierzeck
4356cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4366cb461b4SDaniel Schwierzeck		values is arch specific.
4376cb461b4SDaniel Schwierzeck
4380b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
4400b953ffcSMarkus Klotzbuecher
4410b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4420b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4430b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4440b953ffcSMarkus Klotzbuecher
4456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4460b953ffcSMarkus Klotzbuecher
4470b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4480b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4490b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4500b953ffcSMarkus Klotzbuecher		by this value.
4510b953ffcSMarkus Klotzbuecher
45292bbd64eSDaniel Schwierzeck- MIPS CPU options:
45392bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
45492bbd64eSDaniel Schwierzeck
45592bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
45692bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
45792bbd64eSDaniel Schwierzeck		relocation.
45892bbd64eSDaniel Schwierzeck
45992bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
46092bbd64eSDaniel Schwierzeck
46192bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
46292bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
46392bbd64eSDaniel Schwierzeck		Possible values are:
46492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
46592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
46692bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
46792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
46892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
46992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
47092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
47192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
47292bbd64eSDaniel Schwierzeck
47392bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
47492bbd64eSDaniel Schwierzeck
47592bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
47692bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
47792bbd64eSDaniel Schwierzeck
47892bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
47992bbd64eSDaniel Schwierzeck
48092bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
48192bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
48292bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
48392bbd64eSDaniel Schwierzeck
484b67d8816SChristian Riesch- ARM options:
485b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
486b67d8816SChristian Riesch
487b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
488b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
489b67d8816SChristian Riesch
4905356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4915356f545SAneesh V
4925356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4935356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4945356f545SAneesh V		better code density. For ARM architectures that support
4955356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4965356f545SAneesh V		GCC.
4975356f545SAneesh V
498c5d4752cSStephen Warren		CONFIG_ARM_ERRATA_716044
4990678587fSStephen Warren		CONFIG_ARM_ERRATA_742230
5000678587fSStephen Warren		CONFIG_ARM_ERRATA_743622
5010678587fSStephen Warren		CONFIG_ARM_ERRATA_751472
5020678587fSStephen Warren
5030678587fSStephen Warren		If set, the workarounds for these ARM errata are applied early
5040678587fSStephen Warren		during U-Boot startup. Note that these options force the
5050678587fSStephen Warren		workarounds to be applied; no CPU-type/version detection
5060678587fSStephen Warren		exists, unlike the similar options in the Linux kernel. Do not
5070678587fSStephen Warren		set these options unless they apply!
5080678587fSStephen Warren
509795659dcSStephen Warren- CPU timer options:
510795659dcSStephen Warren		CONFIG_SYS_HZ
511795659dcSStephen Warren
512795659dcSStephen Warren		The frequency of the timer returned by get_timer().
513795659dcSStephen Warren		get_timer() must operate in milliseconds and this CONFIG
514795659dcSStephen Warren		option must be set to 1000.
515795659dcSStephen Warren
5165da627a4Swdenk- Linux Kernel Interface:
517c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
518c609719bSwdenk
519c609719bSwdenk		U-Boot stores all clock information in Hz
520c609719bSwdenk		internally. For binary compatibility with older Linux
521c609719bSwdenk		kernels (which expect the clocks passed in the
522c609719bSwdenk		bd_info data to be in MHz) the environment variable
523c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
524c609719bSwdenk		converts clock data to MHZ before passing it to the
525c609719bSwdenk		Linux kernel.
526c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
527c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
528c609719bSwdenk		default environment.
529c609719bSwdenk
5305da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5315da627a4Swdenk
53211ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
5335da627a4Swdenk		expect it to be in bytes, others in MB.
5345da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5355da627a4Swdenk
536fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
537f57f70aaSWolfgang Denk
538f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
539213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
540213bf8c8SGerald Van Baren		concepts).
541213bf8c8SGerald Van Baren
542213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
543213bf8c8SGerald Van Baren		 * New libfdt-based support
544213bf8c8SGerald Van Baren		 * Adds the "fdt" command
5453bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
546213bf8c8SGerald Van Baren
547b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
548b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
549b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
550b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
551f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
552c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
553f57f70aaSWolfgang Denk
55411ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
55511ccc33fSMarcel Ziswiler		addresses
5563bb342fcSKim Phillips
5574e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
5584e253137SKumar Gala
5594e253137SKumar Gala		Board code has addition modification that it wants to make
5604e253137SKumar Gala		to the flat device tree before handing it off to the kernel
5616705d81eSwdenk
5620267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
5630267768eSMatthew McClintock
56411ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5650267768eSMatthew McClintock		param header, the default value is zero if undefined.
5660267768eSMatthew McClintock
5673887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5683887c3fbSHeiko Schocher
5693887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5703887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5713887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5723887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5733887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5743887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5753887c3fbSHeiko Schocher
5767eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5777eb29398SIgor Grinberg
5787eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5797eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5807eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5817eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5827eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5837eb29398SIgor Grinberg		in a single configuration file and the machine type is
5847eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5857eb29398SIgor Grinberg
5860b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5870b2f4ecaSNiklaus Giger
5880b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5890b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5900b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5910b2f4ecaSNiklaus Giger
5920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5940b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5960b2f4ecaSNiklaus Giger
5970b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5980b2f4ecaSNiklaus Giger
5990b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
6000b2f4ecaSNiklaus Giger
6010b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6020b2f4ecaSNiklaus Giger		the defaults discussed just above.
6030b2f4ecaSNiklaus Giger
6042c451f78SAneesh V- Cache Configuration:
6052c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6062c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6072c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6082c451f78SAneesh V
60993bc2193SAneesh V- Cache Configuration for ARM:
61093bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
61193bc2193SAneesh V				      controller
61293bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
61393bc2193SAneesh V					controller register space
61493bc2193SAneesh V
6156705d81eSwdenk- Serial Ports:
61648d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6176705d81eSwdenk
6186705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6196705d81eSwdenk
62048d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6216705d81eSwdenk
6226705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6236705d81eSwdenk
6246705d81eSwdenk		CONFIG_PL011_CLOCK
6256705d81eSwdenk
6266705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6276705d81eSwdenk		the clock speed of the UARTs.
6286705d81eSwdenk
6296705d81eSwdenk		CONFIG_PL01x_PORTS
6306705d81eSwdenk
6316705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6326705d81eSwdenk		define this to a list of base addresses for each (supported)
6336705d81eSwdenk		port. See e.g. include/configs/versatile.h
6346705d81eSwdenk
635910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
636910f1ae3SJohn Rigby
637910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
638910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
639910f1ae3SJohn Rigby		this variable to initialize the extra register.
640910f1ae3SJohn Rigby
641910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
642910f1ae3SJohn Rigby
643910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
644910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
645910f1ae3SJohn Rigby		variable to flush the UART at init time.
646910f1ae3SJohn Rigby
6476705d81eSwdenk
648c609719bSwdenk- Console Interface:
649c609719bSwdenk		Depending on board, define exactly one serial port
650c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
651c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
652c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
653c609719bSwdenk
654c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
655c609719bSwdenk		port routines must be defined elsewhere
656c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
657c609719bSwdenk
658c609719bSwdenk		CONFIG_CFB_CONSOLE
659c609719bSwdenk		Enables console device for a color framebuffer. Needs following
660c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
661c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
662c609719bSwdenk						(default big endian)
663c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
664c609719bSwdenk						rectangle fill
665c609719bSwdenk						(cf. smiLynxEM)
666c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
667c609719bSwdenk						bit-blit (cf. smiLynxEM)
668c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
669c609719bSwdenk						(cols=pitch)
670c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
671c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
672c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
673c609719bSwdenk						(0-5, cf. cfb_console.c)
674c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
675c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
676c609719bSwdenk						(i.e. i8042_kbd_init())
677c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
678c609719bSwdenk						(i.e. i8042_tstc)
679c609719bSwdenk			VIDEO_GETC_FCT		get char fct
680c609719bSwdenk						(i.e. i8042_getc)
681c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
682c609719bSwdenk						(requires blink timer
683c609719bSwdenk						cf. i8042.c)
6846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
685c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
686c609719bSwdenk						upper right corner
687602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
688c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
689c609719bSwdenk						upper left corner
690a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
691a6c7ad2fSwdenk						linux_logo.h for logo.
692a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
693c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
69411ccc33fSMarcel Ziswiler						additional board info beside
695c609719bSwdenk						the logo
696c609719bSwdenk
69733a35bbbSPali Rohár		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
69833a35bbbSPali Rohár		a limited number of ANSI escape sequences (cursor control,
69933a35bbbSPali Rohár		erase functions and limited graphics rendition control).
70033a35bbbSPali Rohár
701c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
702c609719bSwdenk		default i/o. Serial console can be forced with
703c609719bSwdenk		environment 'console=serial'.
704c609719bSwdenk
705a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
706a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
707a3ad8e26Swdenk		the "silent" environment variable. See
708a3ad8e26Swdenk		doc/README.silent for more information.
709a3ad8e26Swdenk
710c609719bSwdenk- Console Baudrate:
711c609719bSwdenk		CONFIG_BAUDRATE - in bps
712c609719bSwdenk		Select one of the baudrates listed in
7136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
7146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
715c609719bSwdenk
716c92fac91SHeiko Schocher- Console Rx buffer length
717c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
718c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
7192b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
720c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
721c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
722c92fac91SHeiko Schocher		the SMC.
723c92fac91SHeiko Schocher
7249558b48aSGraeme Russ- Pre-Console Buffer:
7259558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
7269558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
7279558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
7289558b48aSGraeme Russ		buffer any console messages prior to the console being
7299558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
7309558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
7319558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
7329558b48aSGraeme Russ		bytes are output before the console is initialised, the
7339558b48aSGraeme Russ		earlier bytes are discarded.
7349558b48aSGraeme Russ
7359558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
7369558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
7379558b48aSGraeme Russ
738046a37bdSSonny Rao- Safe printf() functions
739046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
740046a37bdSSonny Rao		the printf() functions. These are defined in
741046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
742046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
743046a37bdSSonny Rao		If this option is not given then these functions will
744046a37bdSSonny Rao		silently discard their buffer size argument - this means
745046a37bdSSonny Rao		you are not getting any overflow checking in this case.
746046a37bdSSonny Rao
747c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
748c609719bSwdenk		Delay before automatically booting the default image;
749c609719bSwdenk		set to -1 to disable autoboot.
75093d7212fSJoe Hershberger		set to -2 to autoboot with no delay and not check for abort
75193d7212fSJoe Hershberger		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
752c609719bSwdenk
753c609719bSwdenk		See doc/README.autoboot for these options that
754c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
755c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
756c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
757c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
758c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
759c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
760c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
761c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
762c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
763c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
764c609719bSwdenk		CONFIG_RESET_TO_RETRY
765c609719bSwdenk
766c609719bSwdenk- Autoboot Command:
767c609719bSwdenk		CONFIG_BOOTCOMMAND
768c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
769c609719bSwdenk		define a command string that is automatically executed
770c609719bSwdenk		when no character is read on the console interface
771c609719bSwdenk		within "Boot Delay" after reset.
772c609719bSwdenk
773c609719bSwdenk		CONFIG_BOOTARGS
774c609719bSwdenk		This can be used to pass arguments to the bootm
775c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
776c609719bSwdenk		environment value "bootargs".
777c609719bSwdenk
778c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
779c609719bSwdenk		The value of these goes into the environment as
780c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
781c609719bSwdenk		as a convenience, when switching between booting from
78211ccc33fSMarcel Ziswiler		RAM and NFS.
783c609719bSwdenk
784c609719bSwdenk- Pre-Boot Commands:
785c609719bSwdenk		CONFIG_PREBOOT
786c609719bSwdenk
787c609719bSwdenk		When this option is #defined, the existence of the
788c609719bSwdenk		environment variable "preboot" will be checked
789c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
790c609719bSwdenk		countdown and/or running the auto-boot command resp.
791c609719bSwdenk		entering interactive mode.
792c609719bSwdenk
793c609719bSwdenk		This feature is especially useful when "preboot" is
794c609719bSwdenk		automatically generated or modified. For an example
795c609719bSwdenk		see the LWMON board specific code: here "preboot" is
796c609719bSwdenk		modified when the user holds down a certain
797c609719bSwdenk		combination of keys on the (special) keyboard when
798c609719bSwdenk		booting the systems
799c609719bSwdenk
800c609719bSwdenk- Serial Download Echo Mode:
801c609719bSwdenk		CONFIG_LOADS_ECHO
802c609719bSwdenk		If defined to 1, all characters received during a
803c609719bSwdenk		serial download (using the "loads" command) are
804c609719bSwdenk		echoed back. This might be needed by some terminal
805c609719bSwdenk		emulations (like "cu"), but may as well just take
806c609719bSwdenk		time on others. This setting #define's the initial
807c609719bSwdenk		value of the "loads_echo" environment variable.
808c609719bSwdenk
809602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
810c609719bSwdenk		CONFIG_KGDB_BAUDRATE
811c609719bSwdenk		Select one of the baudrates listed in
8126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
813c609719bSwdenk
814c609719bSwdenk- Monitor Functions:
815602ad3b3SJon Loeliger		Monitor commands can be included or excluded
816602ad3b3SJon Loeliger		from the build by using the #include files
817c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
818c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
819602ad3b3SJon Loeliger		and augmenting with additional #define's
820602ad3b3SJon Loeliger		for wanted commands.
821c609719bSwdenk
822602ad3b3SJon Loeliger		The default command configuration includes all commands
823602ad3b3SJon Loeliger		except those marked below with a "*".
824602ad3b3SJon Loeliger
825602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
826602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
827602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
828602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
829602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
830602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
831602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
832602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
833710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
834602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
835602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
836602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
837a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
838a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
839a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
840a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
841602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
842602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
843246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
844602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
845602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
8465e2b3e0cSJoe Hershberger		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
847fffad71bSJoe Hershberger		CONFIG_CMD_ENV_FLAGS	* display details about env flags
8480c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
84903e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
85003e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
851bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
852602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
85303e2ecf6SStephen Warren		CONFIG_CMD_FAT		* FAT command support
854602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
855602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
856602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
857ccca7dfdSBenoît Thébaudeau		CONFIG_CMD_FUSE		  Device fuse support
85853fdc7efSAnton Staaf		CONFIG_CMD_GETTIME	* Get time since boot
859a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
860a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
861bf36c5d5SSimon Glass		CONFIG_CMD_HASH		* calculate hash / digest
862602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
863602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
864602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
865602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8668fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8678fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS_NAND	  List all images found in NAND flash
868602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
8690c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
870c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
871602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
872602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
873602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
874602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
8751ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
876d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
877d22c338eSJoe Hershberger					  (169.254.*.*)
878602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
879602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
88002c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
88102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
88215a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
883602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
884a2681707SWolfgang Denk					  loop, loopw
885a2681707SWolfgang Denk		CONFIG_CMD_MEMTEST	  mtest
886602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
887602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
888602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
88968d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
890602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
891602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
892e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
893e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
894602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
895602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
896602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
897602ad3b3SJon Loeliger					  host
898602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
899ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
900602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
901602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
902d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
903602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
904602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
905602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
906602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
907602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
908602ad3b3SJon Loeliger					  (4xx only)
909f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
910c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
91102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9127d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
91374de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
914602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9157a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9161fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
917da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
918da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
919602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
920602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
921c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
922c609719bSwdenk
923c609719bSwdenk
924c609719bSwdenk		EXAMPLE: If you want all functions except of network
925c609719bSwdenk		support you can write:
926c609719bSwdenk
927602ad3b3SJon Loeliger		#include "config_cmd_all.h"
928602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
929c609719bSwdenk
930213bf8c8SGerald Van Baren	Other Commands:
931213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
932c609719bSwdenk
933c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
934602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
935c609719bSwdenk		what you (and your U-Boot users) are doing. Data
936c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
937c609719bSwdenk		8260 (where accesses to the IMMR region must be
938c609719bSwdenk		uncached), and it cannot be disabled on all other
939c609719bSwdenk		systems where we (mis-) use the data cache to hold an
940c609719bSwdenk		initial stack and some data.
941c609719bSwdenk
942c609719bSwdenk
943c609719bSwdenk		XXX - this list needs to get updated!
944c609719bSwdenk
945a5ecbe62SWolfgang Denk- Regular expression support:
946a5ecbe62SWolfgang Denk		CONFIG_REGEX
947a5ecbe62SWolfgang Denk                If this variable is defined, U-Boot is linked against
948a5ecbe62SWolfgang Denk                the SLRE (Super Light Regular Expression) library,
949a5ecbe62SWolfgang Denk                which adds regex support to some commands, as for
950a5ecbe62SWolfgang Denk                example "env grep" and "setexpr".
951a5ecbe62SWolfgang Denk
95245ba8077SSimon Glass- Device tree:
95345ba8077SSimon Glass		CONFIG_OF_CONTROL
95445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
95545ba8077SSimon Glass		to configure its devices, instead of relying on statically
95645ba8077SSimon Glass		compiled #defines in the board file. This option is
95745ba8077SSimon Glass		experimental and only available on a few boards. The device
95845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
95945ba8077SSimon Glass
9602c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9612c0f79e4SSimon Glass		be done using one of the two options below:
962bbb0b128SSimon Glass
963bbb0b128SSimon Glass		CONFIG_OF_EMBED
964bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
965bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
966bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
967bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
968bbb0b128SSimon Glass		the global data structure as gd->blob.
96945ba8077SSimon Glass
9702c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9712c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9722c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9732c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9742c0f79e4SSimon Glass
9752c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9762c0f79e4SSimon Glass
9772c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9782c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9792c0f79e4SSimon Glass		still use the individual files if you need something more
9802c0f79e4SSimon Glass		exotic.
9812c0f79e4SSimon Glass
982c609719bSwdenk- Watchdog:
983c609719bSwdenk		CONFIG_WATCHDOG
984c609719bSwdenk		If this variable is defined, it enables watchdog
9856abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9866abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9876abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9886abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9896abe6fb6SDetlev Zundel		available, then no further board specific code should
9906abe6fb6SDetlev Zundel		be needed to use it.
9916abe6fb6SDetlev Zundel
9926abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9936abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9946abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9956abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
996c609719bSwdenk
997c1551ea8Sstroese- U-Boot Version:
998c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
999c1551ea8Sstroese		If this variable is defined, an environment variable
1000c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1001c1551ea8Sstroese		version as printed by the "version" command.
1002a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1003a1ea8e51SBenoît Thébaudeau		next reset.
1004c1551ea8Sstroese
1005c609719bSwdenk- Real-Time Clock:
1006c609719bSwdenk
1007602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1008c609719bSwdenk		has to be selected, too. Define exactly one of the
1009c609719bSwdenk		following options:
1010c609719bSwdenk
1011c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1012c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10134e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1014c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10151cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1016c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10177f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10183bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10199536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10204c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
102271d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
102371d19f30SHeiko Schocher					  RV3029 RTC.
1024c609719bSwdenk
1025b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1026b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1027b37c7e5eSwdenk
1028e92739d3SPeter Tyser- GPIO Support:
1029e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1030e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1031e92739d3SPeter Tyser
10325dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10335dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10345dec49caSChris Packham		pins supported by a particular chip.
10355dec49caSChris Packham
1036e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1037e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1038e92739d3SPeter Tyser
1039c609719bSwdenk- Timestamp Support:
1040c609719bSwdenk
1041c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1042c609719bSwdenk		(date and time) of an image is printed by image
1043c609719bSwdenk		commands like bootm or iminfo. This option is
1044602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1045c609719bSwdenk
1046923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1047923c46f9SKarl O. Pinc		Zero or more of the following:
1048923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1049923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1050923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1051923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1052923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1053923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1054923c46f9SKarl O. Pinc				       disk/part_efi.c
1055923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1056c609719bSwdenk
1057602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1058218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1059923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1060c609719bSwdenk
1061c609719bSwdenk- IDE Reset method:
10624d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10634d13cbadSwdenk		board configurations files but used nowhere!
1064c609719bSwdenk
10654d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10664d13cbadSwdenk		be performed by calling the function
10674d13cbadSwdenk			ide_set_reset(int reset)
10684d13cbadSwdenk		which has to be defined in a board specific file
1069c609719bSwdenk
1070c609719bSwdenk- ATAPI Support:
1071c609719bSwdenk		CONFIG_ATAPI
1072c609719bSwdenk
1073c609719bSwdenk		Set this to enable ATAPI support.
1074c609719bSwdenk
1075c40b2956Swdenk- LBA48 Support
1076c40b2956Swdenk		CONFIG_LBA48
1077c40b2956Swdenk
1078c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10794b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1080c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1081c40b2956Swdenk		support disks up to 2.1TB.
1082c40b2956Swdenk
10836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1084c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1085c40b2956Swdenk			Default is 32bit.
1086c40b2956Swdenk
1087c609719bSwdenk- SCSI Support:
1088c609719bSwdenk		At the moment only there is only support for the
1089c609719bSwdenk		SYM53C8XX SCSI controller; define
1090c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1091c609719bSwdenk
10926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1095c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1096c609719bSwdenk		devices.
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1098c609719bSwdenk
1099447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1100447c031bSStefan Reinauer                SCSI devices found during the last scan.
1101447c031bSStefan Reinauer
1102c609719bSwdenk- NETWORK Support (PCI):
1103682011ffSwdenk		CONFIG_E1000
1104ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1105ce5207e1SKyle Moffett
1106ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1107ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1108ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1109ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1110ce5207e1SKyle Moffett
1111ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1112ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1113ce5207e1SKyle Moffett		example with the "sspi" command.
1114ce5207e1SKyle Moffett
1115ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1116ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1117ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1118682011ffSwdenk
1119ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
112011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1121ac3315c2SAndre Schwarz
1122c609719bSwdenk		CONFIG_EEPRO100
1123c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
112411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1125c609719bSwdenk		write routine for first time initialisation.
1126c609719bSwdenk
1127c609719bSwdenk		CONFIG_TULIP
1128c609719bSwdenk		Support for Digital 2114x chips.
1129c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1130c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1131c609719bSwdenk
1132c609719bSwdenk		CONFIG_NATSEMI
1133c609719bSwdenk		Support for National dp83815 chips.
1134c609719bSwdenk
1135c609719bSwdenk		CONFIG_NS8382X
1136c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1137c609719bSwdenk
113845219c46Swdenk- NETWORK Support (other):
113945219c46Swdenk
1140c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1141c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1142c041e9d2SJens Scharsig
1143c041e9d2SJens Scharsig			CONFIG_RMII
1144c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1145c041e9d2SJens Scharsig
1146c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1147c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1148c041e9d2SJens Scharsig			The driver doen't show link status messages.
1149c041e9d2SJens Scharsig
1150efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1151efdd7319SRob Herring		Support for the Calxeda XGMAC device
1152efdd7319SRob Herring
11533bb46d23SAshok		CONFIG_LAN91C96
115445219c46Swdenk		Support for SMSC's LAN91C96 chips.
115545219c46Swdenk
115645219c46Swdenk			CONFIG_LAN91C96_BASE
115745219c46Swdenk			Define this to hold the physical address
115845219c46Swdenk			of the LAN91C96's I/O space
115945219c46Swdenk
116045219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
116145219c46Swdenk			Define this to enable 32 bit addressing
116245219c46Swdenk
11633bb46d23SAshok		CONFIG_SMC91111
1164f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1165f39748aeSwdenk
1166f39748aeSwdenk			CONFIG_SMC91111_BASE
1167f39748aeSwdenk			Define this to hold the physical address
1168f39748aeSwdenk			of the device (I/O space)
1169f39748aeSwdenk
1170f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1171f39748aeSwdenk			Define this if data bus is 32 bits
1172f39748aeSwdenk
1173f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1174f39748aeSwdenk			Define this to use i/o functions instead of macros
1175f39748aeSwdenk			(some hardware wont work with macros)
1176f39748aeSwdenk
1177dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1178dc02badaSHeiko Schocher		Support for davinci emac
1179dc02badaSHeiko Schocher
1180dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1181dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1182dc02badaSHeiko Schocher
1183b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1184b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1185b3dbf4a5SMacpaul Lin
1186b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1187b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1188b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1189b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1190b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1191b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1192b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1193b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1194b3dbf4a5SMacpaul Lin
1195c2fff331SMike Rapoport		CONFIG_SMC911X
1196557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1197557b377dSJens Gehrlein
1198c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1199557b377dSJens Gehrlein			Define this to hold the physical address
1200557b377dSJens Gehrlein			of the device (I/O space)
1201557b377dSJens Gehrlein
1202c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1203557b377dSJens Gehrlein			Define this if data bus is 32 bits
1204557b377dSJens Gehrlein
1205c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1206557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1207557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1208c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1209557b377dSJens Gehrlein
12103d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12113d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12123d0075faSYoshihiro Shimoda
12133d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12143d0075faSYoshihiro Shimoda			Define the number of ports to be used
12153d0075faSYoshihiro Shimoda
12163d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12173d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12183d0075faSYoshihiro Shimoda
121968260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
122068260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
122168260aabSYoshihiro Shimoda
12225e124724SVadim Bendebury- TPM Support:
122390899cc0SChe-liang Chiou		CONFIG_TPM
122490899cc0SChe-liang Chiou		Support TPM devices.
122590899cc0SChe-liang Chiou
12261b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12271b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12281b393db5STom Wai-Hong Tam		per system is supported at this time.
12291b393db5STom Wai-Hong Tam
12301b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12311b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12321b393db5STom Wai-Hong Tam
12331b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12341b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12351b393db5STom Wai-Hong Tam
12361b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12371b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12381b393db5STom Wai-Hong Tam
123990899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12405e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12415e124724SVadim Bendebury		per system is supported at this time.
12425e124724SVadim Bendebury
12435e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12445e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12455e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12465e124724SVadim Bendebury			0xfed40000.
12475e124724SVadim Bendebury
1248c609719bSwdenk- USB Support:
1249c609719bSwdenk		At the moment only the UHCI host controller is
12504d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1251c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1252c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
125330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1254c609719bSwdenk		storage devices.
1255c609719bSwdenk		Note:
1256c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1257c609719bSwdenk		(TEAC FD-05PUB).
12584d13cbadSwdenk		MPC5200 USB requires additional defines:
12594d13cbadSwdenk			CONFIG_USB_CLOCK
12604d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1261307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1262307ecb6dSEric Millbrandt				for USB on PSC3
12634d13cbadSwdenk			CONFIG_USB_CONFIG
12644d13cbadSwdenk				for differential drivers: 0x00001000
12654d13cbadSwdenk				for single ended drivers: 0x00005000
1266307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1267307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1269fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1270fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12714d13cbadSwdenk
12729ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12739ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12749ab4ce22SSimon Glass
1275aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1276aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1277aa155058SKuo-Jung Su
127816c8d5e7SWolfgang Denk- USB Device:
127916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
128016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
128116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
128211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
128316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
128416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
128516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
128616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
128716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
128816c8d5e7SWolfgang Denk		a Linux host by
128916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
129016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
129116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
129216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
129316c8d5e7SWolfgang Denk
129416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
129516c8d5e7SWolfgang Denk			Define this to build a UDC device
129616c8d5e7SWolfgang Denk
129716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
129816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
129916c8d5e7SWolfgang Denk			talk to the UDC device
130016c8d5e7SWolfgang Denk
1301f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1302f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1303f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1304f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1305f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1306f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1307f9da0f89SVipin KUMAR			speed.
1308f9da0f89SVipin KUMAR
13096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
131016c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
131116c8d5e7SWolfgang Denk			be set to usbtty.
131216c8d5e7SWolfgang Denk
131316c8d5e7SWolfgang Denk			mpc8xx:
13146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
131516c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
131716c8d5e7SWolfgang Denk
13186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
131916c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
132116c8d5e7SWolfgang Denk
132216c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
132316c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
132416c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
132516c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
132616c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
132716c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
132816c8d5e7SWolfgang Denk
132916c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
133016c8d5e7SWolfgang Denk			Define this string as the name of your company for
133116c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
133216c8d5e7SWolfgang Denk
133316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
133416c8d5e7SWolfgang Denk			Define this string as the name of your product
133516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
133616c8d5e7SWolfgang Denk
133716c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
133816c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
133916c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
134016c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
134116c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
134216c8d5e7SWolfgang Denk
134316c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
134416c8d5e7SWolfgang Denk			Define this as the unique Product ID
134516c8d5e7SWolfgang Denk			for your device
134616c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1347c609719bSwdenk
1348d70a560fSIgor Grinberg- ULPI Layer Support:
1349d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1350d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1351d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1352d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1353d70a560fSIgor Grinberg		viewport is supported.
1354d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1355d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13566d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13576d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13586d365ea0SLucas Stach		the appropriate value in Hz.
1359c609719bSwdenk
1360c609719bSwdenk- MMC Support:
1361c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1362c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1363c609719bSwdenk		accessed from the boot prompt by mapping the device
1364c609719bSwdenk		to physical memory similar to flash. Command line is
1365602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1366602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1367c609719bSwdenk
1368afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1369afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1370afb35666SYoshihiro Shimoda
1371afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1372afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1373afb35666SYoshihiro Shimoda
1374afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1375afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1376afb35666SYoshihiro Shimoda
1377b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1378b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1379b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1380b3ba6e94STom Rini
1381b3ba6e94STom Rini		CONFIG_CMD_DFU
1382b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1383b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1384b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1385b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1386b3ba6e94STom Rini
1387b3ba6e94STom Rini		CONFIG_DFU_MMC
1388b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1389b3ba6e94STom Rini
1390c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1391c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1392c6631764SPantelis Antoniou
1393ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1394ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1395ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1396ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1397ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1398ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1399ea2453d5SPantelis Antoniou
14006705d81eSwdenk- Journaling Flash filesystem support:
14016705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14026705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14036705d81eSwdenk		Define these for a default partition on a NAND device
14046705d81eSwdenk
14056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14076705d81eSwdenk		Define these for a default partition on a NOR device
14086705d81eSwdenk
14096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14106705d81eSwdenk		Define this to create an own partition. You have to provide a
14116705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14126705d81eSwdenk
14136705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14156705d81eSwdenk		to disable the command chpart. This is the default when you
14166705d81eSwdenk		have not defined a custom partition
14176705d81eSwdenk
1418c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1419c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1420656f4c65SDonggeun Kim
1421656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1422656f4c65SDonggeun Kim		file in FAT formatted partition.
1423656f4c65SDonggeun Kim
1424656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1425656f4c65SDonggeun Kim		user to write files to FAT.
1426c30a15e5SDonggeun Kim
142784cd9327SGabe BlackCBFS (Coreboot Filesystem) support
142884cd9327SGabe Black		CONFIG_CMD_CBFS
142984cd9327SGabe Black
143084cd9327SGabe Black		Define this to enable support for reading from a Coreboot
143184cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
143284cd9327SGabe Black		and cbfsload.
143384cd9327SGabe Black
1434c609719bSwdenk- Keyboard Support:
1435c609719bSwdenk		CONFIG_ISA_KEYBOARD
1436c609719bSwdenk
1437c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1438c609719bSwdenk		support
1439c609719bSwdenk
1440c609719bSwdenk		CONFIG_I8042_KBD
1441c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1442c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1443c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1444c609719bSwdenk		for cfb_console. Supports cursor blinking.
1445c609719bSwdenk
1446c609719bSwdenk- Video support:
1447c609719bSwdenk		CONFIG_VIDEO
1448c609719bSwdenk
1449c609719bSwdenk		Define this to enable video support (for output to
1450c609719bSwdenk		video).
1451c609719bSwdenk
1452c609719bSwdenk		CONFIG_VIDEO_CT69000
1453c609719bSwdenk
1454c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1455c609719bSwdenk
1456c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1457eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1458eeb1b77bSwdenk		video output is selected via environment 'videoout'
1459eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1460eeb1b77bSwdenk		assumed.
1461c609719bSwdenk
1462eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
146311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1464eeb1b77bSwdenk		are possible:
1465eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1466eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1467eeb1b77bSwdenk
1468eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1469eeb1b77bSwdenk		-------------+---------------------------------------------
1470eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1471eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1472eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1473eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1474eeb1b77bSwdenk		-------------+---------------------------------------------
1475c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1476c609719bSwdenk
1477eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
14787817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1479eeb1b77bSwdenk
1480eeb1b77bSwdenk
1481a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1482a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1483a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1484a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1485a6c7ad2fSwdenk
14867d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14877d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14887d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14897d3053fbSTimur Tabi		support, and should also define these other macros:
14907d3053fbSTimur Tabi
14917d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14927d3053fbSTimur Tabi			CONFIG_VIDEO
14937d3053fbSTimur Tabi			CONFIG_CMD_BMP
14947d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14957d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14967d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14977d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14987d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14997d3053fbSTimur Tabi
1500ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1501ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1502ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1503ba8e76bdSTimur Tabi		description of this variable.
15047d3053fbSTimur Tabi
1505058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1506058d59b0SSimon Glass
1507058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1508058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1509058d59b0SSimon Glass		driver.
1510058d59b0SSimon Glass
1511058d59b0SSimon Glass
1512682011ffSwdenk- Keyboard Support:
1513682011ffSwdenk		CONFIG_KEYBOARD
1514682011ffSwdenk
1515682011ffSwdenk		Define this to enable a custom keyboard support.
1516682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1517682011ffSwdenk		defined in your board-specific files.
1518682011ffSwdenk		The only board using this so far is RBC823.
1519a6c7ad2fSwdenk
1520c609719bSwdenk- LCD Support:	CONFIG_LCD
1521c609719bSwdenk
1522c609719bSwdenk		Define this to enable LCD support (for output to LCD
1523c609719bSwdenk		display); also select one of the supported displays
1524c609719bSwdenk		by defining one of these:
1525c609719bSwdenk
152639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
152739cf4804SStelian Pop
152839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
152939cf4804SStelian Pop
1530fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1531c609719bSwdenk
1532fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1533c609719bSwdenk
1534fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1535c609719bSwdenk
1536fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1537fd3103bbSwdenk			Active, color, single scan.
1538fd3103bbSwdenk
1539fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1540fd3103bbSwdenk
1541fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1542c609719bSwdenk			Active, color, single scan.
1543c609719bSwdenk
1544c609719bSwdenk		CONFIG_SHARP_16x9
1545c609719bSwdenk
1546c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1547c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1548c609719bSwdenk
1549c609719bSwdenk		CONFIG_SHARP_LQ64D341
1550c609719bSwdenk
1551c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1552c609719bSwdenk			Active, color, single scan.
1553c609719bSwdenk
1554c609719bSwdenk		CONFIG_HLD1045
1555c609719bSwdenk
1556c609719bSwdenk			HLD1045 display, 640x480.
1557c609719bSwdenk			Active, color, single scan.
1558c609719bSwdenk
1559c609719bSwdenk		CONFIG_OPTREX_BW
1560c609719bSwdenk
1561c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1562c609719bSwdenk			or
1563c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1564c609719bSwdenk			or
1565c609719bSwdenk			Hitachi	 SP14Q002
1566c609719bSwdenk
1567c609719bSwdenk			320x240. Black & white.
1568c609719bSwdenk
1569c609719bSwdenk		Normally display is black on white background; define
15706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1571c609719bSwdenk
1572676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1573676d319eSSimon Glass
1574676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1575676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1576676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1577676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1578676d319eSSimon Glass		a per-section basis.
1579676d319eSSimon Glass
15800d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
15810d89efefSSimon Glass
15820d89efefSSimon Glass		When the console need to be scrolled, this is the number of
15830d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
15840d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
15850d89efefSSimon Glass		is slow.
1586676d319eSSimon Glass
158745d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
158845d7f525STom Wai-Hong Tam
158945d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
159045d7f525STom Wai-Hong Tam
1591735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1592735987c5STom Wai-Hong Tam
1593735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1594735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1595735987c5STom Wai-Hong Tam
15967152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1597d791b1dcSwdenk
1598d791b1dcSwdenk		If this option is set, the environment is checked for
1599d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1600d791b1dcSwdenk		of logo, copyright and system information on the LCD
1601e94d2cd9Swdenk		is suppressed and the BMP image at the address
1602d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1603d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1604d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1605d791b1dcSwdenk		loaded very quickly after power-on.
1606d791b1dcSwdenk
1607c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1608c0880485SNikita Kiryanov
1609c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1610c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1611c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1612c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1613c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1614c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1615c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1616c0880485SNikita Kiryanov		there is no need to set this option.
1617c0880485SNikita Kiryanov
16181ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16191ca298ceSMatthias Weisser
16201ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16211ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16221ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16231ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16241ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16251ca298ceSMatthias Weisser		specify 'm' for centering the image.
16261ca298ceSMatthias Weisser
16271ca298ceSMatthias Weisser		Example:
16281ca298ceSMatthias Weisser		setenv splashpos m,m
16291ca298ceSMatthias Weisser			=> image at center of screen
16301ca298ceSMatthias Weisser
16311ca298ceSMatthias Weisser		setenv splashpos 30,20
16321ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16331ca298ceSMatthias Weisser
16341ca298ceSMatthias Weisser		setenv splashpos -10,m
16351ca298ceSMatthias Weisser			=> vertically centered image
16361ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16371ca298ceSMatthias Weisser
1638581bb419SNikita Kiryanov		CONFIG_SPLASH_SCREEN_PREPARE
1639581bb419SNikita Kiryanov
1640581bb419SNikita Kiryanov		If this option is set then the board_splash_screen_prepare()
1641581bb419SNikita Kiryanov		function, which must be defined in your code, is called as part
1642581bb419SNikita Kiryanov		of the splash screen display sequence. It gives the board an
1643581bb419SNikita Kiryanov		opportunity to prepare the splash image data before it is
1644581bb419SNikita Kiryanov		processed and sent to the frame buffer by U-Boot.
1645581bb419SNikita Kiryanov
164698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
164798f4a3dfSStefan Roese
164898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
164998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
165098f4a3dfSStefan Roese		splashscreen support or the bmp command.
165198f4a3dfSStefan Roese
1652d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1653d5011762SAnatolij Gustschin
1654d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1655d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1656d5011762SAnatolij Gustschin		bmp command.
1657d5011762SAnatolij Gustschin
1658f2b96dfbSLei Wen- Do compresssing for memory range:
1659f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1660f2b96dfbSLei Wen
1661f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1662f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1663f2b96dfbSLei Wen
1664c29fdfc1Swdenk- Compression support:
1665c29fdfc1Swdenk		CONFIG_BZIP2
1666c29fdfc1Swdenk
1667c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1668c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1669c29fdfc1Swdenk		compressed images are supported.
1670c29fdfc1Swdenk
1671c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1673c29fdfc1Swdenk		be at least 4MB.
1674d791b1dcSwdenk
1675fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1676fc9c1727SLuigi 'Comio' Mantellini
1677fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1678fc9c1727SLuigi 'Comio' Mantellini		images is included.
1679fc9c1727SLuigi 'Comio' Mantellini
1680fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1681fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1682fc9c1727SLuigi 'Comio' Mantellini		formula:
1683fc9c1727SLuigi 'Comio' Mantellini
1684fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1685fc9c1727SLuigi 'Comio' Mantellini
1686fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1687fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1688fc9c1727SLuigi 'Comio' Mantellini
1689fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1690fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1691fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1692fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1693fc9c1727SLuigi 'Comio' Mantellini
1694fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1695fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
16966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1697fc9c1727SLuigi 'Comio' Mantellini
169817ea1177Swdenk- MII/PHY support:
169917ea1177Swdenk		CONFIG_PHY_ADDR
170017ea1177Swdenk
170117ea1177Swdenk		The address of PHY on MII bus.
170217ea1177Swdenk
170317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
170417ea1177Swdenk
170517ea1177Swdenk		The clock frequency of the MII bus
170617ea1177Swdenk
170717ea1177Swdenk		CONFIG_PHY_GIGE
170817ea1177Swdenk
170917ea1177Swdenk		If this option is set, support for speed/duplex
171011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
171117ea1177Swdenk
171217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
171317ea1177Swdenk
171417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
171517ea1177Swdenk		reset before any MII register access is possible.
171617ea1177Swdenk		For such PHY, set this option to the usec delay
171717ea1177Swdenk		required. (minimum 300usec for LXT971A)
171817ea1177Swdenk
171917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
172017ea1177Swdenk
172117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
172217ea1177Swdenk		command issued before MII status register can be read
172317ea1177Swdenk
1724c609719bSwdenk- Ethernet address:
1725c609719bSwdenk		CONFIG_ETHADDR
1726c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1727c609719bSwdenk		CONFIG_ETH2ADDR
1728c609719bSwdenk		CONFIG_ETH3ADDR
1729c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1730c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1731c609719bSwdenk
173211ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
173311ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1734c609719bSwdenk		is not determined automatically.
1735c609719bSwdenk
1736c609719bSwdenk- IP address:
1737c609719bSwdenk		CONFIG_IPADDR
1738c609719bSwdenk
1739c609719bSwdenk		Define a default value for the IP address to use for
174011ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1741c609719bSwdenk		determined through e.g. bootp.
17421ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1743c609719bSwdenk
1744c609719bSwdenk- Server IP address:
1745c609719bSwdenk		CONFIG_SERVERIP
1746c609719bSwdenk
1747c609719bSwdenk		Defines a default value for the IP address of a TFTP
1748c609719bSwdenk		server to contact when using the "tftboot" command.
17491ebcd654SWolfgang Denk		(Environment variable "serverip")
1750c609719bSwdenk
175197cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
175297cfe861SRobin Getz
175397cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
175497cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
175597cfe861SRobin Getz
17561ebcd654SWolfgang Denk- Gateway IP address:
17571ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17581ebcd654SWolfgang Denk
17591ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17601ebcd654SWolfgang Denk		default router where packets to other networks are
17611ebcd654SWolfgang Denk		sent to.
17621ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17631ebcd654SWolfgang Denk
17641ebcd654SWolfgang Denk- Subnet mask:
17651ebcd654SWolfgang Denk		CONFIG_NETMASK
17661ebcd654SWolfgang Denk
17671ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
17681ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
17691ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
17701ebcd654SWolfgang Denk		forwarded through a router.
17711ebcd654SWolfgang Denk		(Environment variable "netmask")
17721ebcd654SWolfgang Denk
177353a5c424SDavid Updegraff- Multicast TFTP Mode:
177453a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
177553a5c424SDavid Updegraff
177653a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
177753a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
177811ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
177953a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
178053a5c424SDavid Updegraff		multicast group.
178153a5c424SDavid Updegraff
1782c609719bSwdenk- BOOTP Recovery Mode:
1783c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1784c609719bSwdenk
1785c609719bSwdenk		If you have many targets in a network that try to
1786c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1787c609719bSwdenk		systems send out BOOTP requests at precisely the same
1788c609719bSwdenk		moment (which would happen for instance at recovery
1789c609719bSwdenk		from a power failure, when all systems will try to
1790c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1791c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1792c609719bSwdenk		inserted before sending out BOOTP requests. The
17936c33c785SWolfgang Denk		following delays are inserted then:
1794c609719bSwdenk
1795c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1796c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1797c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1798c609719bSwdenk		4th and following
1799c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1800c609719bSwdenk
1801fe389a82Sstroese- DHCP Advanced Options:
18021fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18031fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1804fe389a82Sstroese
18051fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18061fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18071fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18081fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18091fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18101fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18111fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18121fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18131fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18141fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18151fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18161fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18172c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1818fe389a82Sstroese
18195d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18205d110f0aSWilson Callan		environment variable, not the BOOTP server.
1821fe389a82Sstroese
18222c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18232c00e099SJoe Hershberger		after the configured retry count, the call will fail
18242c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18252c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18262c00e099SJoe Hershberger		is not available.
18272c00e099SJoe Hershberger
1828fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1829fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1830fe389a82Sstroese		than one DNS serverip is offered to the client.
1831fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1832fe389a82Sstroese		serverip will be stored in the additional environment
1833fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1834fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18351fe80d79SJon Loeliger		is defined.
1836fe389a82Sstroese
1837fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1838fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1839fe389a82Sstroese		need the hostname of the DHCP requester.
18405d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18411fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18421fe80d79SJon Loeliger		option 12 to the DHCP server.
1843fe389a82Sstroese
1844d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1845d9a2f416SAras Vaichas
1846d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1847d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1848d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1849d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1850d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1851d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1852d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1853d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1854d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1855d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1856d9a2f416SAras Vaichas		this delay.
1857d9a2f416SAras Vaichas
1858d22c338eSJoe Hershberger - Link-local IP address negotiation:
1859d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1860d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1861d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1862d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1863d22c338eSJoe Hershberger
1864d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1865d22c338eSJoe Hershberger
1866a3d991bdSwdenk - CDP Options:
1867a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1868a3d991bdSwdenk
1869a3d991bdSwdenk		The device id used in CDP trigger frames.
1870a3d991bdSwdenk
1871a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1872a3d991bdSwdenk
1873a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1874a3d991bdSwdenk		of the device.
1875a3d991bdSwdenk
1876a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1877a3d991bdSwdenk
1878a3d991bdSwdenk		A printf format string which contains the ascii name of
1879a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
188011ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1881a3d991bdSwdenk
1882a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1883a3d991bdSwdenk
1884a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1885a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1886a3d991bdSwdenk
1887a3d991bdSwdenk		CONFIG_CDP_VERSION
1888a3d991bdSwdenk
1889a3d991bdSwdenk		An ascii string containing the version of the software.
1890a3d991bdSwdenk
1891a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1892a3d991bdSwdenk
1893a3d991bdSwdenk		An ascii string containing the name of the platform.
1894a3d991bdSwdenk
1895a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1896a3d991bdSwdenk
1897a3d991bdSwdenk		A 32bit integer sent on the trigger.
1898a3d991bdSwdenk
1899a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1900a3d991bdSwdenk
1901a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1902a3d991bdSwdenk		device in .1 of milliwatts.
1903a3d991bdSwdenk
1904a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1905a3d991bdSwdenk
1906a3d991bdSwdenk		A byte containing the id of the VLAN.
1907a3d991bdSwdenk
1908c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1909c609719bSwdenk
1910c609719bSwdenk		Several configurations allow to display the current
1911c609719bSwdenk		status using a LED. For instance, the LED will blink
1912c609719bSwdenk		fast while running U-Boot code, stop blinking as
1913c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1914c609719bSwdenk		start blinking slow once the Linux kernel is running
1915c609719bSwdenk		(supported by a status LED driver in the Linux
1916c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1917c609719bSwdenk		feature in U-Boot.
1918c609719bSwdenk
1919c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1920c609719bSwdenk
1921c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1922c609719bSwdenk		on those systems that support this (optional)
1923c609719bSwdenk		feature, like the TQM8xxL modules.
1924c609719bSwdenk
1925c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1926c609719bSwdenk
1927b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1928b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
192911ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1930c609719bSwdenk
1931b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1932602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1933b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1934b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1935c609719bSwdenk		command line interface.
1936c609719bSwdenk
1937bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1938c609719bSwdenk
1939b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1940b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1941b37c7e5eSwdenk		support for I2C.
1942c609719bSwdenk
1943b37c7e5eSwdenk		There are several other quantities that must also be
1944b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1945c609719bSwdenk
19466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1947b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
19486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
194911ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1950c609719bSwdenk
19518d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1952a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
19538d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
19548d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
19558d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1956b37c7e5eSwdenk
19575da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
19585da71efaSEric Millbrandt
19595da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
19605da71efaSEric Millbrandt		chips might think that the current transfer is still
19615da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
19625da71efaSEric Millbrandt		commands until the slave device responds.
19635da71efaSEric Millbrandt
1964b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1965b37c7e5eSwdenk
1966b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1967b37c7e5eSwdenk		then the following macros need to be defined (examples are
1968b37c7e5eSwdenk		from include/configs/lwmon.h):
1969c609719bSwdenk
1970c609719bSwdenk		I2C_INIT
1971c609719bSwdenk
1972b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1973c609719bSwdenk		controller or configure ports.
1974c609719bSwdenk
1975b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1976b37c7e5eSwdenk
1977c609719bSwdenk		I2C_PORT
1978c609719bSwdenk
1979c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1980c609719bSwdenk		assumes both bits are on the same port). Valid values
1981c609719bSwdenk		are 0..3 for ports A..D.
1982c609719bSwdenk
1983c609719bSwdenk		I2C_ACTIVE
1984c609719bSwdenk
1985c609719bSwdenk		The code necessary to make the I2C data line active
1986c609719bSwdenk		(driven).  If the data line is open collector, this
1987c609719bSwdenk		define can be null.
1988c609719bSwdenk
1989b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1990b37c7e5eSwdenk
1991c609719bSwdenk		I2C_TRISTATE
1992c609719bSwdenk
1993c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1994c609719bSwdenk		(inactive).  If the data line is open collector, this
1995c609719bSwdenk		define can be null.
1996c609719bSwdenk
1997b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1998b37c7e5eSwdenk
1999c609719bSwdenk		I2C_READ
2000c609719bSwdenk
2001472d5460SYork Sun		Code that returns true if the I2C data line is high,
2002472d5460SYork Sun		false if it is low.
2003c609719bSwdenk
2004b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2005b37c7e5eSwdenk
2006c609719bSwdenk		I2C_SDA(bit)
2007c609719bSwdenk
2008472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2009472d5460SYork Sun		is false, it clears it (low).
2010c609719bSwdenk
2011b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2012b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2013b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2014b37c7e5eSwdenk
2015c609719bSwdenk		I2C_SCL(bit)
2016c609719bSwdenk
2017472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2018472d5460SYork Sun		is false, it clears it (low).
2019c609719bSwdenk
2020b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2021b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2022b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2023b37c7e5eSwdenk
2024c609719bSwdenk		I2C_DELAY
2025c609719bSwdenk
2026c609719bSwdenk		This delay is invoked four times per clock cycle so this
2027c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2028b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2029b37c7e5eSwdenk		like:
2030b37c7e5eSwdenk
2031b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2032c609719bSwdenk
2033793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2034793b5726SMike Frysinger
2035793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2036793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2037793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2038793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2039793b5726SMike Frysinger
2040793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2041793b5726SMike Frysinger		the generic GPIO functions.
2042793b5726SMike Frysinger
20436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
204447cd00faSwdenk
204547cd00faSwdenk		When a board is reset during an i2c bus transfer
204647cd00faSwdenk		chips might think that the current transfer is still
204747cd00faSwdenk		in progress. On some boards it is possible to access
204847cd00faSwdenk		the i2c SCLK line directly, either by using the
204947cd00faSwdenk		processor pin as a GPIO or by having a second pin
205047cd00faSwdenk		connected to the bus. If this option is defined a
205147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
205247cd00faSwdenk		is run early in the boot sequence.
205347cd00faSwdenk
205426a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
205526a33504SRichard Retanubun
205626a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
205726a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
205826a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
205926a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
206026a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
206126a33504SRichard Retanubun		controller provide such a method. It is called at the end of
206226a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
206326a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
206426a33504SRichard Retanubun
206517ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
206617ea1177Swdenk
206717ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
206817ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
206917ea1177Swdenk		variable "i2cfast". (see also i2cfast)
207017ea1177Swdenk
2071bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2072bb99ad6dSBen Warren
2073bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2074bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2075bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2076bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2077bb99ad6dSBen Warren
20786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2079bb99ad6dSBen Warren
2080bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
20810f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
20820f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
20830f89c54bSPeter Tyser		a 1D array of device addresses
2084bb99ad6dSBen Warren
2085bb99ad6dSBen Warren		e.g.
2086bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
20876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2088bb99ad6dSBen Warren
2089bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2090bb99ad6dSBen Warren
2091bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
20926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2093bb99ad6dSBen Warren
2094bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2095bb99ad6dSBen Warren
20966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2097be5e6181STimur Tabi
2098be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2099be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2100be5e6181STimur Tabi
21016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
21020dc018ecSStefan Roese
21030dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
21040dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
21050dc018ecSStefan Roese
21066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
21070dc018ecSStefan Roese
21080dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
21090dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
21100dc018ecSStefan Roese
21116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
21129ebbb54fSVictor Gallardo
21139ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
21149ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
21159ebbb54fSVictor Gallardo		specified DTT device.
21169ebbb54fSVictor Gallardo
2117be5e6181STimur Tabi		CONFIG_FSL_I2C
2118be5e6181STimur Tabi
2119be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
21207817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
2121be5e6181STimur Tabi
212267b23a32SHeiko Schocher		CONFIG_I2C_MUX
212367b23a32SHeiko Schocher
212467b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
212567b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
212667b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
212767b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
212867b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
212967b23a32SHeiko Schocher		the muxes to activate this new "bus".
213067b23a32SHeiko Schocher
213167b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
213267b23a32SHeiko Schocher		feature!
213367b23a32SHeiko Schocher
213467b23a32SHeiko Schocher		Example:
213567b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
213667b23a32SHeiko Schocher			The First mux with address 70 and channel 6
213767b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
213867b23a32SHeiko Schocher
213967b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
214067b23a32SHeiko Schocher
214167b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
214267b23a32SHeiko Schocher		of I2C Busses with muxes:
214367b23a32SHeiko Schocher
214467b23a32SHeiko Schocher		=> i2c bus
214567b23a32SHeiko Schocher		Busses reached over muxes:
214667b23a32SHeiko Schocher		Bus ID: 2
214767b23a32SHeiko Schocher		  reached over Mux(es):
214867b23a32SHeiko Schocher		    pca9544a@70 ch: 4
214967b23a32SHeiko Schocher		Bus ID: 3
215067b23a32SHeiko Schocher		  reached over Mux(es):
215167b23a32SHeiko Schocher		    pca9544a@70 ch: 6
215267b23a32SHeiko Schocher		    pca9544a@71 ch: 4
215367b23a32SHeiko Schocher		=>
215467b23a32SHeiko Schocher
215567b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2156f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2157f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
215867b23a32SHeiko Schocher		the channel 4.
215967b23a32SHeiko Schocher
216067b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2161f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
216267b23a32SHeiko Schocher		the 2 muxes.
216367b23a32SHeiko Schocher
216467b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
216567b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
216667b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
216767b23a32SHeiko Schocher		to add this option to other architectures.
216867b23a32SHeiko Schocher
21692ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
21702ac6985aSAndrew Dyer
21712ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
21722ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
21732ac6985aSAndrew Dyer		between writing the address pointer and reading the
21742ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
21752ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
21762ac6985aSAndrew Dyer		devices can use either method, but some require one or
21772ac6985aSAndrew Dyer		the other.
2178be5e6181STimur Tabi
2179c609719bSwdenk- SPI Support:	CONFIG_SPI
2180c609719bSwdenk
2181c609719bSwdenk		Enables SPI driver (so far only tested with
2182c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2183c609719bSwdenk		D/As on the SACSng board)
2184c609719bSwdenk
21856639562eSYoshihiro Shimoda		CONFIG_SH_SPI
21866639562eSYoshihiro Shimoda
21876639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
21886639562eSYoshihiro Shimoda		only SH7757 is supported.
21896639562eSYoshihiro Shimoda
2190c609719bSwdenk		CONFIG_SPI_X
2191c609719bSwdenk
2192c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2193c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2194c609719bSwdenk
2195c609719bSwdenk		CONFIG_SOFT_SPI
2196c609719bSwdenk
2197c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2198c609719bSwdenk		using hardware support. This is a general purpose
2199c609719bSwdenk		driver that only requires three general I/O port pins
2200c609719bSwdenk		(two outputs, one input) to function. If this is
2201c609719bSwdenk		defined, the board configuration must define several
2202c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2203c609719bSwdenk		an example, see include/configs/sacsng.h.
2204c609719bSwdenk
220504a9e118SBen Warren		CONFIG_HARD_SPI
220604a9e118SBen Warren
220704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
220804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
220904a9e118SBen Warren		must define a list of chip-select function pointers.
221004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
221104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
221204a9e118SBen Warren
221338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
221438254f45SGuennadi Liakhovetski
221538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
22162e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
221738254f45SGuennadi Liakhovetski
22180133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
22190133502eSMatthias Fuchs
22200133502eSMatthias Fuchs		Enables FPGA subsystem.
22210133502eSMatthias Fuchs
22220133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
22230133502eSMatthias Fuchs
22240133502eSMatthias Fuchs		Enables support for specific chip vendors.
22250133502eSMatthias Fuchs		(ALTERA, XILINX)
22260133502eSMatthias Fuchs
22270133502eSMatthias Fuchs		CONFIG_FPGA_<family>
22280133502eSMatthias Fuchs
22290133502eSMatthias Fuchs		Enables support for FPGA family.
22300133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
22310133502eSMatthias Fuchs
22320133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2233c609719bSwdenk
2234c609719bSwdenk		Specify the number of FPGA devices to support.
2235c609719bSwdenk
22366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2237c609719bSwdenk
2238c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2239c609719bSwdenk
22406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2241c609719bSwdenk
2242c609719bSwdenk		Enable checks on FPGA configuration interface busy
2243c609719bSwdenk		status by the configuration function. This option
2244c609719bSwdenk		will require a board or device specific function to
2245c609719bSwdenk		be written.
2246c609719bSwdenk
2247c609719bSwdenk		CONFIG_FPGA_DELAY
2248c609719bSwdenk
2249c609719bSwdenk		If defined, a function that provides delays in the FPGA
2250c609719bSwdenk		configuration driver.
2251c609719bSwdenk
22526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2253c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2254c609719bSwdenk
22556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2256c609719bSwdenk
2257c609719bSwdenk		Check for configuration errors during FPGA bitfile
2258c609719bSwdenk		loading. For example, abort during Virtex II
2259c609719bSwdenk		configuration if the INIT_B line goes low (which
2260c609719bSwdenk		indicated a CRC error).
2261c609719bSwdenk
22626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2263c609719bSwdenk
2264c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2265c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2266c609719bSwdenk		FPGA configuration sequence. The default time is 500
226711ccc33fSMarcel Ziswiler		ms.
2268c609719bSwdenk
22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2270c609719bSwdenk
2271c609719bSwdenk		Maximum time to wait for BUSY to deassert during
227211ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2273c609719bSwdenk
22746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2275c609719bSwdenk
2276c609719bSwdenk		Time to wait after FPGA configuration. The default is
227711ccc33fSMarcel Ziswiler		200 ms.
2278c609719bSwdenk
2279c609719bSwdenk- Configuration Management:
2280c609719bSwdenk		CONFIG_IDENT_STRING
2281c609719bSwdenk
2282c609719bSwdenk		If defined, this string will be added to the U-Boot
2283c609719bSwdenk		version information (U_BOOT_VERSION)
2284c609719bSwdenk
2285c609719bSwdenk- Vendor Parameter Protection:
2286c609719bSwdenk
2287c609719bSwdenk		U-Boot considers the values of the environment
2288c609719bSwdenk		variables "serial#" (Board Serial Number) and
22897152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2290c609719bSwdenk		are set once by the board vendor / manufacturer, and
2291c609719bSwdenk		protects these variables from casual modification by
2292c609719bSwdenk		the user. Once set, these variables are read-only,
2293c609719bSwdenk		and write or delete attempts are rejected. You can
229411ccc33fSMarcel Ziswiler		change this behaviour:
2295c609719bSwdenk
2296c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2297c609719bSwdenk		file, the write protection for vendor parameters is
229847cd00faSwdenk		completely disabled. Anybody can change or delete
2299c609719bSwdenk		these parameters.
2300c609719bSwdenk
2301c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2302c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
230311ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2304c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2305c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2306c609719bSwdenk		read-only.]
2307c609719bSwdenk
23082598090bSJoe Hershberger		The same can be accomplished in a more flexible way
23092598090bSJoe Hershberger		for any variable by configuring the type of access
23102598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
23112598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
23122598090bSJoe Hershberger
2313c609719bSwdenk- Protected RAM:
2314c609719bSwdenk		CONFIG_PRAM
2315c609719bSwdenk
2316c609719bSwdenk		Define this variable to enable the reservation of
2317c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2318c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2319c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2320c609719bSwdenk		this default value by defining an environment
2321c609719bSwdenk		variable "pram" to the number of kB you want to
2322c609719bSwdenk		reserve. Note that the board info structure will
2323c609719bSwdenk		still show the full amount of RAM. If pRAM is
2324c609719bSwdenk		reserved, a new environment variable "mem" will
2325c609719bSwdenk		automatically be defined to hold the amount of
2326c609719bSwdenk		remaining RAM in a form that can be passed as boot
2327c609719bSwdenk		argument to Linux, for instance like that:
2328c609719bSwdenk
2329fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2330c609719bSwdenk			saveenv
2331c609719bSwdenk
2332c609719bSwdenk		This way you can tell Linux not to use this memory,
2333c609719bSwdenk		either, which results in a memory region that will
2334c609719bSwdenk		not be affected by reboots.
2335c609719bSwdenk
2336c609719bSwdenk		*WARNING* If your board configuration uses automatic
2337c609719bSwdenk		detection of the RAM size, you must make sure that
2338c609719bSwdenk		this memory test is non-destructive. So far, the
2339c609719bSwdenk		following board configurations are known to be
2340c609719bSwdenk		"pRAM-clean":
2341c609719bSwdenk
23421b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
23431b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2344544d97e9SWolfgang Denk			FLAGADM, TQM8260
2345c609719bSwdenk
234640fef049SGabe Black- Access to physical memory region (> 4GB)
234740fef049SGabe Black		Some basic support is provided for operations on memory not
234840fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
234940fef049SGabe Black		support access to more than 4GB of memory on 32-bit
235040fef049SGabe Black		machines using physical address extension or similar.
235140fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
235240fef049SGabe Black		currently only supports clearing the memory.
235340fef049SGabe Black
2354c609719bSwdenk- Error Recovery:
2355c609719bSwdenk		CONFIG_PANIC_HANG
2356c609719bSwdenk
2357c609719bSwdenk		Define this variable to stop the system in case of a
2358c609719bSwdenk		fatal error, so that you have to reset it manually.
2359c609719bSwdenk		This is probably NOT a good idea for an embedded
236011ccc33fSMarcel Ziswiler		system where you want the system to reboot
2361c609719bSwdenk		automatically as fast as possible, but it may be
2362c609719bSwdenk		useful during development since you can try to debug
2363c609719bSwdenk		the conditions that lead to the situation.
2364c609719bSwdenk
2365c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2366c609719bSwdenk
2367c609719bSwdenk		This variable defines the number of retries for
2368c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2369c609719bSwdenk		before giving up the operation. If not defined, a
2370c609719bSwdenk		default value of 5 is used.
2371c609719bSwdenk
237240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
237340cb90eeSGuennadi Liakhovetski
237440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
237540cb90eeSGuennadi Liakhovetski
237648a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
237748a3e999STetsuyuki Kobayashi
237848a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
237948a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
238048a3e999STetsuyuki Kobayashi		try longer timeout such as
238148a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
238248a3e999STetsuyuki Kobayashi
2383c609719bSwdenk- Command Interpreter:
23848078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
238504a85b3bSwdenk
238604a85b3bSwdenk		Enable auto completion of commands using TAB.
238704a85b3bSwdenk
23888078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
23898078f1a5SWolfgang Denk		for the "hush" shell.
23908078f1a5SWolfgang Denk
23918078f1a5SWolfgang Denk
23926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2393c609719bSwdenk
2394c609719bSwdenk		Define this variable to enable the "hush" shell (from
2395c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2396c609719bSwdenk		powerful command line syntax like
2397c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2398c609719bSwdenk		constructs ("shell scripts").
2399c609719bSwdenk
2400c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2401c609719bSwdenk		with a somewhat smaller memory footprint.
2402c609719bSwdenk
2403c609719bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2405c609719bSwdenk
2406c609719bSwdenk		This defines the secondary prompt string, which is
2407c609719bSwdenk		printed when the command interpreter needs more input
2408c609719bSwdenk		to complete a command. Usually "> ".
2409c609719bSwdenk
2410c609719bSwdenk	Note:
2411c609719bSwdenk
2412c609719bSwdenk		In the current implementation, the local variables
2413c609719bSwdenk		space and global environment variables space are
2414c609719bSwdenk		separated. Local variables are those you define by
24153b57fe0aSwdenk		simply typing `name=value'. To access a local
2416c609719bSwdenk		variable later on, you have write `$name' or
24173b57fe0aSwdenk		`${name}'; to execute the contents of a variable
24183b57fe0aSwdenk		directly type `$name' at the command prompt.
2419c609719bSwdenk
2420c609719bSwdenk		Global environment variables are those you use
2421c609719bSwdenk		setenv/printenv to work with. To run a command stored
2422c609719bSwdenk		in such a variable, you need to use the run command,
2423c609719bSwdenk		and you must not use the '$' sign to access them.
2424c609719bSwdenk
2425c609719bSwdenk		To store commands and special characters in a
2426c609719bSwdenk		variable, please use double quotation marks
2427c609719bSwdenk		surrounding the whole text of the variable, instead
2428c609719bSwdenk		of the backslashes before semicolons and special
2429c609719bSwdenk		symbols.
2430c609719bSwdenk
2431aa0c71acSWolfgang Denk- Commandline Editing and History:
2432aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2433aa0c71acSWolfgang Denk
243411ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2435aa0c71acSWolfgang Denk		commandline input operations
2436aa0c71acSWolfgang Denk
2437a8c7c708Swdenk- Default Environment:
2438c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2439c609719bSwdenk
2440c609719bSwdenk		Define this to contain any number of null terminated
2441c609719bSwdenk		strings (variable = value pairs) that will be part of
24427152b1d0Swdenk		the default environment compiled into the boot image.
24432262cfeeSwdenk
2444c609719bSwdenk		For example, place something like this in your
2445c609719bSwdenk		board's config file:
2446c609719bSwdenk
2447c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2448c609719bSwdenk			"myvar1=value1\0" \
2449c609719bSwdenk			"myvar2=value2\0"
2450c609719bSwdenk
2451c609719bSwdenk		Warning: This method is based on knowledge about the
2452c609719bSwdenk		internal format how the environment is stored by the
24532262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2454c609719bSwdenk		interface! Although it is unlikely that this format
24557152b1d0Swdenk		will change soon, there is no guarantee either.
2456c609719bSwdenk		You better know what you are doing here.
2457c609719bSwdenk
2458c609719bSwdenk		Note: overly (ab)use of the default environment is
2459c609719bSwdenk		discouraged. Make sure to check other ways to preset
246074de7aefSWolfgang Denk		the environment like the "source" command or the
2461c609719bSwdenk		boot command first.
2462c609719bSwdenk
24635e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
24645e724ca2SStephen Warren
24655e724ca2SStephen Warren		Define this in order to add variables describing the
24665e724ca2SStephen Warren		U-Boot build configuration to the default environment.
24675e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
24685e724ca2SStephen Warren
24695e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
24705e724ca2SStephen Warren
24715e724ca2SStephen Warren		- CONFIG_SYS_ARCH
24725e724ca2SStephen Warren		- CONFIG_SYS_CPU
24735e724ca2SStephen Warren		- CONFIG_SYS_BOARD
24745e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
24755e724ca2SStephen Warren		- CONFIG_SYS_SOC
24765e724ca2SStephen Warren
24777e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
24787e27f89fSTom Rini
24797e27f89fSTom Rini		Define this in order to add variables describing certain
24807e27f89fSTom Rini		run-time determined information about the hardware to the
24817e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
24827e27f89fSTom Rini
248306fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
248406fd8538SSimon Glass
248506fd8538SSimon Glass		Normally the environment is loaded when the board is
248606fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
248706fd8538SSimon Glass		that so that the environment is not available until
248806fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
248906fd8538SSimon Glass		this is instead controlled by the value of
249006fd8538SSimon Glass		/config/load-environment.
249106fd8538SSimon Glass
2492a8c7c708Swdenk- DataFlash Support:
24932abbe075Swdenk		CONFIG_HAS_DATAFLASH
24942abbe075Swdenk
24952abbe075Swdenk		Defining this option enables DataFlash features and
24962abbe075Swdenk		allows to read/write in Dataflash via the standard
24972abbe075Swdenk		commands cp, md...
24982abbe075Swdenk
2499f61ec45eSEric Nelson- Serial Flash support
2500f61ec45eSEric Nelson		CONFIG_CMD_SF
2501f61ec45eSEric Nelson
2502f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2503f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2504f61ec45eSEric Nelson
2505f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2506f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2507f61ec45eSEric Nelson		commands.
2508f61ec45eSEric Nelson
2509f61ec45eSEric Nelson		The following defaults may be provided by the platform
2510f61ec45eSEric Nelson		to handle the common case when only a single serial
2511f61ec45eSEric Nelson		flash is present on the system.
2512f61ec45eSEric Nelson
2513f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2514f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2515f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2516f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2517f61ec45eSEric Nelson
251824007273SSimon Glass		CONFIG_CMD_SF_TEST
251924007273SSimon Glass
252024007273SSimon Glass		Define this option to include a destructive SPI flash
252124007273SSimon Glass		test ('sf test').
252224007273SSimon Glass
25233f85ce27Swdenk- SystemACE Support:
25243f85ce27Swdenk		CONFIG_SYSTEMACE
25253f85ce27Swdenk
25263f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
25273f85ce27Swdenk		chips attached via some sort of local bus. The address
252811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
25296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
25303f85ce27Swdenk
25313f85ce27Swdenk		#define CONFIG_SYSTEMACE
25326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
25333f85ce27Swdenk
25343f85ce27Swdenk		When SystemACE support is added, the "ace" device type
25353f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
25363f85ce27Swdenk
2537ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2538ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2539ecb0ccd9SWolfgang Denk
254028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2541ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
254228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2543ecb0ccd9SWolfgang Denk		number generator is used.
2544ecb0ccd9SWolfgang Denk
254528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
254628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
254728cb9375SWolfgang Denk		defined, the normal port 69 is used.
254828cb9375SWolfgang Denk
254928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2550ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2551ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2552ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2553ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2554ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2555ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2556ecb0ccd9SWolfgang Denk
2557bf36c5d5SSimon Glass- Hashing support:
2558bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2559bf36c5d5SSimon Glass
2560bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2561bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2562bf36c5d5SSimon Glass
2563bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2564bf36c5d5SSimon Glass
2565bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2566bf36c5d5SSimon Glass		size a little.
2567bf36c5d5SSimon Glass
2568bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2569bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2570bf36c5d5SSimon Glass
2571bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2572bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2573bf36c5d5SSimon Glass
2574a8c7c708Swdenk- Show boot progress:
2575c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2576c609719bSwdenk
2577c609719bSwdenk		Defining this option allows to add some board-
2578c609719bSwdenk		specific code (calling a user-provided function
2579c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2580c609719bSwdenk		the system's boot progress on some display (for
2581c609719bSwdenk		example, some LED's) on your board. At the moment,
2582c609719bSwdenk		the following checkpoints are implemented:
2583c609719bSwdenk
25843a608ca0SSimon Glass- Detailed boot stage timing
25853a608ca0SSimon Glass		CONFIG_BOOTSTAGE
25863a608ca0SSimon Glass		Define this option to get detailed timing of each stage
25873a608ca0SSimon Glass		of the boot process.
25883a608ca0SSimon Glass
25893a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
25903a608ca0SSimon Glass		This is the number of available user bootstage records.
25913a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
25923a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
25933a608ca0SSimon Glass		the limit, recording will stop.
25943a608ca0SSimon Glass
25953a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
25963a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
25973a608ca0SSimon Glass
25983a608ca0SSimon Glass		Timer summary in microseconds:
25993a608ca0SSimon Glass		       Mark    Elapsed  Stage
26003a608ca0SSimon Glass			  0          0  reset
26013a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
26023a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
26033a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
26043a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
26053a608ca0SSimon Glass		  3,910,375    250,777  main_loop
26063a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
26073a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
26083a608ca0SSimon Glass
26092eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
26102eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
26112eba38cfSSimon Glass		and un/stashing of bootstage data.
26122eba38cfSSimon Glass
261394fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
261494fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
261594fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
261694fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
261794fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
261894fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
261994fd1316SSimon Glass		For example:
262094fd1316SSimon Glass
262194fd1316SSimon Glass		bootstage {
262294fd1316SSimon Glass			154 {
262394fd1316SSimon Glass				name = "board_init_f";
262494fd1316SSimon Glass				mark = <3575678>;
262594fd1316SSimon Glass			};
262694fd1316SSimon Glass			170 {
262794fd1316SSimon Glass				name = "lcd";
262894fd1316SSimon Glass				accum = <33482>;
262994fd1316SSimon Glass			};
263094fd1316SSimon Glass		};
263194fd1316SSimon Glass
263294fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
263394fd1316SSimon Glass
26341372cce2SMarian BalakowiczLegacy uImage format:
26351372cce2SMarian Balakowicz
2636c609719bSwdenk  Arg	Where			When
2637c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2638c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2639c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2640c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2641c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2642c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2643c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2644c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2645c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
26461372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2647c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2648c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2649c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2650c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
26511372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2652c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
26531372cce2SMarian Balakowicz
26541372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
26551372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
26561372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
26571372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
26581372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
26591372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
26601372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
266111ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
26621372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
26631372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
26641372cce2SMarian Balakowicz
2665ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2666c609719bSwdenk
2667a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
266863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
266963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
267063e73c9aSwdenk
2671566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2672566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2673566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2674566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2675566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2676566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2677566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2678566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2679566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2680566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2681566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2682566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2683566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2684566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2685566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2686566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2687566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2688566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2689566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2690566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2691566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2692566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2693566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2694566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2695566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2696566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2697566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2698566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2699566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2700566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2701566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2702566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2703566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2704566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2705566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2706566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2707566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2708566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2709566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2710566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2711566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2712566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2713566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2714566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2715566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2716566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2717566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2718c609719bSwdenk
2719566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2720c609719bSwdenk
2721566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2722566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2723566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2724206c60cbSwdenk
2725566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2726566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
272711ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2728566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2729566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2730566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
273174de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
273274de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2733566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2734c609719bSwdenk
27351372cce2SMarian BalakowiczFIT uImage format:
27361372cce2SMarian Balakowicz
27371372cce2SMarian Balakowicz  Arg	Where			When
27381372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
27391372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
27401372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
27411372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
27421372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
27431372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2744f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
27451372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
27461372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
27471372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
27481372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
27491372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
275011ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
275111ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
27521372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
27531372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
27541372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
27551372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
27561372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
27571372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
27581372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
27591372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
27601372cce2SMarian Balakowicz
27611372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
27621372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
27631372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
276411ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
27651372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
27661372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
27671372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
27681372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
27691372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
27701372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
27711372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
27721372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
27731372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
27741372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
27751372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
27761372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
27771372cce2SMarian Balakowicz
277811ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
27791372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
27801372cce2SMarian Balakowicz
278111ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
27821372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
27831372cce2SMarian Balakowicz
278411ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
27851372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
27861372cce2SMarian Balakowicz
2787d95f6ec7SGabe Black- FIT image support:
2788d95f6ec7SGabe Black		CONFIG_FIT
2789d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2790d95f6ec7SGabe Black
2791d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2792d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2793d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2794d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2795d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2796d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2797d95f6ec7SGabe Black
27984cf2609bSWolfgang Denk- Standalone program support:
27994cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
28004cf2609bSWolfgang Denk
28016feff899SWolfgang Denk		This option defines a board specific value for the
28026feff899SWolfgang Denk		address where standalone program gets loaded, thus
28036feff899SWolfgang Denk		overwriting the architecture dependent default
28044cf2609bSWolfgang Denk		settings.
28054cf2609bSWolfgang Denk
28064cf2609bSWolfgang Denk- Frame Buffer Address:
28074cf2609bSWolfgang Denk		CONFIG_FB_ADDR
28084cf2609bSWolfgang Denk
28094cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
281044a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
281144a53b57SWolfgang Denk		when using a graphics controller has separate video
281244a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
281344a53b57SWolfgang Denk		the given address instead of dynamically reserving it
281444a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
281544a53b57SWolfgang Denk		the memory for the frame buffer depending on the
281644a53b57SWolfgang Denk		configured panel size.
28174cf2609bSWolfgang Denk
28184cf2609bSWolfgang Denk		Please see board_init_f function.
28194cf2609bSWolfgang Denk
2820cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2821cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2822cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2823cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2824cccfc2abSDetlev Zundel
2825cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2826cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2827cccfc2abSDetlev Zundel
2828cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2829cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2830cccfc2abSDetlev Zundel
2831cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2832cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2833cccfc2abSDetlev Zundel
2834cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2835cccfc2abSDetlev Zundel
2836cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2837cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2838cccfc2abSDetlev Zundel
283970c219cdSJoe Hershberger- UBI support
284070c219cdSJoe Hershberger		CONFIG_CMD_UBI
284170c219cdSJoe Hershberger
284270c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
284370c219cdSJoe Hershberger		with the UBI flash translation layer
284470c219cdSJoe Hershberger
284570c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
284670c219cdSJoe Hershberger
2847147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2848147162daSJoe Hershberger
2849147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2850147162daSJoe Hershberger		warnings and errors enabled.
2851147162daSJoe Hershberger
285270c219cdSJoe Hershberger- UBIFS support
285370c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
285470c219cdSJoe Hershberger
285570c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
285670c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
285770c219cdSJoe Hershberger
285870c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
285970c219cdSJoe Hershberger
2860147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2861147162daSJoe Hershberger
2862147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2863147162daSJoe Hershberger		warnings and errors enabled.
2864147162daSJoe Hershberger
28656a11cf48SDaniel Schwierzeck- SPL framework
28666a11cf48SDaniel Schwierzeck		CONFIG_SPL
28676a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
28686a11cf48SDaniel Schwierzeck
286995579793STom Rini		CONFIG_SPL_LDSCRIPT
287095579793STom Rini		LDSCRIPT for linking the SPL binary.
287195579793STom Rini
28726ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
28736ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
28746ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
28756ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
28768960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
28776ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
28786ebc3461SAlbert ARIBAUD
287995579793STom Rini		CONFIG_SPL_MAX_SIZE
28806ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
28816ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
28826ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
28836ebc3461SAlbert ARIBAUD		not exceed it.
288495579793STom Rini
28856a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
28866a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
28876a11cf48SDaniel Schwierzeck
288894a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
288994a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
289094a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
289194a45bb1SScott Wood
289295579793STom Rini		CONFIG_SPL_BSS_START_ADDR
289395579793STom Rini		Link address for the BSS within the SPL binary.
289495579793STom Rini
289595579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
28966ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
28976ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
28986ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
28998960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29006ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
290195579793STom Rini
290295579793STom Rini		CONFIG_SPL_STACK
290395579793STom Rini		Adress of the start of the stack SPL will use
290495579793STom Rini
290594a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
290694a45bb1SScott Wood		Adress of the start of the stack SPL will use after
290794a45bb1SScott Wood		relocation.  If unspecified, this is equal to
290894a45bb1SScott Wood		CONFIG_SPL_STACK.
290994a45bb1SScott Wood
291095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
291195579793STom Rini		Starting address of the malloc pool used in SPL.
291295579793STom Rini
291395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
291495579793STom Rini		The size of the malloc pool used in SPL.
29156a11cf48SDaniel Schwierzeck
291647f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
291747f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
291847f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
291947f7bcaeSTom Rini		NAND loading of the Linux Kernel.
292047f7bcaeSTom Rini
2921861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2922861a86f4STom Rini		For ARM, enable an optional function to print more information
2923861a86f4STom Rini		about the running system.
2924861a86f4STom Rini
29254b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
29264b919725SScott Wood		Arch init code should be built for a very small image
29274b919725SScott Wood
29286a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
29296a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
29306a11cf48SDaniel Schwierzeck
29316a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
29326a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
29336a11cf48SDaniel Schwierzeck
29346a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
29356a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
29366a11cf48SDaniel Schwierzeck
29376a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
29386a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
29396a11cf48SDaniel Schwierzeck
29406a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
29416a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
29426a11cf48SDaniel Schwierzeck
294395579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
294495579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
294595579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
294695579793STom Rini		Address, size and partition on the MMC to load U-Boot from
294795579793STom Rini		when the MMC is being used in raw mode.
294895579793STom Rini
29492b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
29502b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
29512b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
29522b75b0adSPeter Korsgaard
29532b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
29542b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
29552b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
29562b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
29572b75b0adSPeter Korsgaard		(for falcon mode)
29582b75b0adSPeter Korsgaard
295995579793STom Rini		CONFIG_SPL_FAT_SUPPORT
296095579793STom Rini		Support for fs/fat/libfat.o in SPL binary
296195579793STom Rini
296295579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
296395579793STom Rini		Filename to read to load U-Boot when reading from FAT
296495579793STom Rini
29657ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
29667ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
29677ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
29687ad2cc79SPeter Korsgaard
29697ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
29707ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
29717ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
29727ad2cc79SPeter Korsgaard
297306f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
297406f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
297506f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
297606f60ae3SScott Wood		continuing (the hardware starts execution after just
297706f60ae3SScott Wood		loading the first page rather than the full 4K).
297806f60ae3SScott Wood
29796f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
29806f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
29816f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
29826f2f01b9SScott Wood
29836f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
29846f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
29856f2f01b9SScott Wood
29866f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
29876f2f01b9SScott Wood		Include standard software ECC in the SPL
29886f2f01b9SScott Wood
298995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
29907d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
29917d4b7955SScott Wood		expose the cmd_ctrl() interface.
299295579793STom Rini
299395579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
299495579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
299595579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
299695579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
299795579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
299895579793STom Rini		Defines the size and behavior of the NAND that SPL uses
29997d4b7955SScott Wood		to read U-Boot
300095579793STom Rini
300195579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
30027d4b7955SScott Wood		Location in NAND to read U-Boot from
30037d4b7955SScott Wood
30047d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
30057d4b7955SScott Wood		Location in memory to load U-Boot to
30067d4b7955SScott Wood
30077d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
30087d4b7955SScott Wood		Size of image to load
300995579793STom Rini
301095579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
30117d4b7955SScott Wood		Entry point in loaded image to jump to
301295579793STom Rini
301395579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
301495579793STom Rini		Define this if you need to first read the OOB and then the
301595579793STom Rini		data. This is used for example on davinci plattforms.
301695579793STom Rini
301795579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
301895579793STom Rini		Support for an OMAP3-specific set of functions to return the
301995579793STom Rini		ID and MFR of the first attached NAND chip, if present.
302095579793STom Rini
30216a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
30226a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
30236a11cf48SDaniel Schwierzeck
30246a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
30256a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
30266a11cf48SDaniel Schwierzeck
30276a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
30286a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
30296a11cf48SDaniel Schwierzeck
3030c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3031c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3032c57b953dSPavel Machek
30336a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
30346a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
30351372cce2SMarian Balakowicz
303674752baaSScott Wood		CONFIG_SPL_PAD_TO
30376113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
30386113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
30396113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
30406113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
30416113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
304274752baaSScott Wood
3043ca2fca22SScott Wood		CONFIG_SPL_TARGET
3044ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3045ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3046ca2fca22SScott Wood		example if more than one image needs to be produced.
3047ca2fca22SScott Wood
304887ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
304987ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
305087ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
305187ebee39SSimon Glass		option to re-enable it. This will affect the output of the
305287ebee39SSimon Glass		bootm command when booting a FIT image.
305387ebee39SSimon Glass
3054c609719bSwdenkModem Support:
3055c609719bSwdenk--------------
3056c609719bSwdenk
3057566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3058c609719bSwdenk
305911ccc33fSMarcel Ziswiler- Modem support enable:
3060c609719bSwdenk		CONFIG_MODEM_SUPPORT
3061c609719bSwdenk
3062c609719bSwdenk- RTS/CTS Flow control enable:
3063c609719bSwdenk		CONFIG_HWFLOW
3064c609719bSwdenk
3065c609719bSwdenk- Modem debug support:
3066c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3067c609719bSwdenk
3068c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3069c609719bSwdenk		for modem support. Useful only with BDI2000.
3070c609719bSwdenk
3071a8c7c708Swdenk- Interrupt support (PPC):
3072a8c7c708Swdenk
3073a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3074a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
307511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3076a8c7c708Swdenk		should set decrementer_count to appropriate value. If
307711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3078a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
307911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3080a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3081a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3082a8c7c708Swdenk		general timer_interrupt().
3083a8c7c708Swdenk
3084c609719bSwdenk- General:
3085c609719bSwdenk
3086c609719bSwdenk		In the target system modem support is enabled when a
3087c609719bSwdenk		specific key (key combination) is pressed during
3088c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
308911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3090c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3091c609719bSwdenk		function, returning 1 and thus enabling modem
3092c609719bSwdenk		initialization.
3093c609719bSwdenk
3094c609719bSwdenk		If there are no modem init strings in the
3095c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3096c609719bSwdenk		previous output (banner, info printfs) will be
309711ccc33fSMarcel Ziswiler		suppressed, though.
3098c609719bSwdenk
3099c609719bSwdenk		See also: doc/README.Modem
3100c609719bSwdenk
31019660e442SHelmut RaigerBoard initialization settings:
31029660e442SHelmut Raiger------------------------------
31039660e442SHelmut Raiger
31049660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
31059660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
31069660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
31079660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
31089660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
31099660e442SHelmut Raigertypically in board_init_f() and board_init_r().
31109660e442SHelmut Raiger
31119660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
31129660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
31139660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
31149660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3115c609719bSwdenk
3116c609719bSwdenkConfiguration Settings:
3117c609719bSwdenk-----------------------
3118c609719bSwdenk
31196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3120c609719bSwdenk		undefine this when you're short of memory.
3121c609719bSwdenk
31222fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
31232fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
31242fb2604dSPeter Tyser
31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3126c609719bSwdenk		prompt for user input.
3127c609719bSwdenk
31286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3129c609719bSwdenk
31306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3131c609719bSwdenk
31326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3133c609719bSwdenk
31346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3135c609719bSwdenk		the application (usually a Linux kernel) when it is
3136c609719bSwdenk		booted
3137c609719bSwdenk
31386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3139c609719bSwdenk		List of legal baudrate settings for this board.
3140c609719bSwdenk
31416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3142c609719bSwdenk		Suppress display of console information at boot.
3143c609719bSwdenk
31446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3145c609719bSwdenk		If the board specific function
3146c609719bSwdenk			extern int overwrite_console (void);
3147c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3148c609719bSwdenk		serial port, else the settings in the environment are used.
3149c609719bSwdenk
31506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3151c609719bSwdenk		Enable the call to overwrite_console().
3152c609719bSwdenk
31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3154c609719bSwdenk		Enable overwrite of previous console environment settings.
3155c609719bSwdenk
31566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3157c609719bSwdenk		Begin and End addresses of the area used by the
3158c609719bSwdenk		simple memory test.
3159c609719bSwdenk
31606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3161c609719bSwdenk		Enable an alternate, more extensive memory test.
3162c609719bSwdenk
31636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
31645f535fe1Swdenk		Scratch address used by the alternate memory test
31655f535fe1Swdenk		You only need to set this if address zero isn't writeable
31665f535fe1Swdenk
31676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
31686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
316914f73ca6SStefan Roese		this specified memory area will get subtracted from the top
317011ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
317114f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
317214f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
317314f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
31745e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
317514f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
31765e12e75dSStefan Roese		will have to get fixed in Linux additionally.
317714f73ca6SStefan Roese
317814f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
317914f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
318014f73ca6SStefan Roese		be touched.
318114f73ca6SStefan Roese
318214f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
318314f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
318414f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
318514f73ca6SStefan Roese		non page size aligned address and this could cause major
318614f73ca6SStefan Roese		problems.
318714f73ca6SStefan Roese
31886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3189c609719bSwdenk		Enable temporary baudrate change while serial download
3190c609719bSwdenk
31916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3192c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3193c609719bSwdenk
31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3195c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3196c609719bSwdenk		Cogent motherboard)
3197c609719bSwdenk
31986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3199c609719bSwdenk		Physical start address of Flash memory.
3200c609719bSwdenk
32016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3202c609719bSwdenk		Physical start address of boot monitor code (set by
3203c609719bSwdenk		make config files to be same as the text base address
320414d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
32056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3206c609719bSwdenk
32076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
32083b57fe0aSwdenk		Size of memory reserved for monitor code, used to
32093b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
32103b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
32113b57fe0aSwdenk		flash sector.
3212c609719bSwdenk
32136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3214c609719bSwdenk		Size of DRAM reserved for malloc() use.
3215c609719bSwdenk
32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
321715940c9aSStefan Roese		Normally compressed uImages are limited to an
321815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
32196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
322015940c9aSStefan Roese		to adjust this setting to your needs.
3221c609719bSwdenk
32226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3223c609719bSwdenk		Maximum size of memory mapped by the startup code of
3224c609719bSwdenk		the Linux kernel; all data that must be processed by
32257d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
32267d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
32277d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
32287d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3229c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3230c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3231c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3232c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3233c609719bSwdenk
3234fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3235fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3236fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3237fca43cc8SJohn Rigby		is enabled.
3238fca43cc8SJohn Rigby
3239fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3240fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3241fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3242fca43cc8SJohn Rigby
3243fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3244fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3245fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3246fca43cc8SJohn Rigby
32476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3248c609719bSwdenk		Max number of Flash memory banks
3249c609719bSwdenk
32506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3251c609719bSwdenk		Max number of sectors on a Flash chip
3252c609719bSwdenk
32536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3254c609719bSwdenk		Timeout for Flash erase operations (in ms)
3255c609719bSwdenk
32566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3257c609719bSwdenk		Timeout for Flash write operations (in ms)
3258c609719bSwdenk
32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
32608564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
32618564acf9Swdenk
32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
32638564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
32648564acf9Swdenk
32656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
32668564acf9Swdenk		If defined, hardware flash sectors protection is used
32678564acf9Swdenk		instead of U-Boot software protection.
32688564acf9Swdenk
32696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3270c609719bSwdenk
3271c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3272c609719bSwdenk		without this option such a download has to be
3273c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3274c609719bSwdenk		copy from RAM to flash.
3275c609719bSwdenk
3276c609719bSwdenk		The two-step approach is usually more reliable, since
3277c609719bSwdenk		you can check if the download worked before you erase
327811ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
327911ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3280c609719bSwdenk		downloaded image) this option may be very useful.
3281c609719bSwdenk
32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3283c609719bSwdenk		Define if the flash driver uses extra elements in the
32845653fc33Swdenk		common flash structure for storing flash geometry.
32855653fc33Swdenk
328600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
32875653fc33Swdenk		This option also enables the building of the cfi_flash driver
32885653fc33Swdenk		in the drivers directory
328953cf9435Sstroese
329091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
329191809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
329291809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
329391809ed5SPiotr Ziecik		to the MTD layer.
329491809ed5SPiotr Ziecik
32956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
329696ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
329796ef831fSGuennadi Liakhovetski
329896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
329996ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
330096ef831fSGuennadi Liakhovetski		write commands.
330196ef831fSGuennadi Liakhovetski
33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
33035568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
33045568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
33055568e613SStefan Roese		is useful, if some of the configured banks are only
33065568e613SStefan Roese		optionally available.
33075568e613SStefan Roese
33089a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
33099a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
33109a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
33119a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
33129a042e9cSJerry Van Baren
3313352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3314352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3315352ef3f1SStefan Roese		against the source after the write operation. An error message
3316352ef3f1SStefan Roese		will be printed when the contents are not identical.
3317352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3318352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3319352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3320352ef3f1SStefan Roese		this option if you really know what you are doing.
3321352ef3f1SStefan Roese
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
332311ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
332411ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
332553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
332653cf9435Sstroese		buffers can be full shortly after enabling the interface
332711ccc33fSMarcel Ziswiler		on high Ethernet traffic.
332853cf9435Sstroese		Defaults to 4 if not defined.
3329c609719bSwdenk
3330ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3331ea882bafSWolfgang Denk
3332ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3333ea882bafSWolfgang Denk	internally to store the environment settings. The default
3334ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3335ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3336ea882bafSWolfgang Denk	lib/hashtable.c for details.
3337ea882bafSWolfgang Denk
33382598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
33392598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
33402598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
33412598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
33422598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
33432598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
33442598090bSJoe Hershberger
33452598090bSJoe Hershberger	The format of the list is:
33462598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3347267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3348267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
33492598090bSJoe Hershberger		entry = variable_name[:attributes]
33502598090bSJoe Hershberger		list = entry[,list]
33512598090bSJoe Hershberger
33522598090bSJoe Hershberger	The type attributes are:
33532598090bSJoe Hershberger		s - String (default)
33542598090bSJoe Hershberger		d - Decimal
33552598090bSJoe Hershberger		x - Hexadecimal
33562598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
33572598090bSJoe Hershberger		i - IP address
33582598090bSJoe Hershberger		m - MAC address
33592598090bSJoe Hershberger
3360267541f7SJoe Hershberger	The access attributes are:
3361267541f7SJoe Hershberger		a - Any (default)
3362267541f7SJoe Hershberger		r - Read-only
3363267541f7SJoe Hershberger		o - Write-once
3364267541f7SJoe Hershberger		c - Change-default
3365267541f7SJoe Hershberger
33662598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
33672598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
33682598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
33692598090bSJoe Hershberger
33702598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
33712598090bSJoe Hershberger		Define this to a list (string) to define validation that
33722598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
33732598090bSJoe Hershberger		environment variable.  To override a setting in the static
33742598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
33752598090bSJoe Hershberger		".flags" variable.
33762598090bSJoe Hershberger
3377267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3378267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3379267541f7SJoe Hershberger	access flags.
3380267541f7SJoe Hershberger
33815c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
33825c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
33835c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
33845c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
33855c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
33865c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
33875c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
33885c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
33895c1a7ea6SSimon Glass	your board please report the problem and send patches!
33905c1a7ea6SSimon Glass
3391632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3392632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3393632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3394632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3395632efa74SSimon Glass	directly. You should not need to touch this setting.
3396632efa74SSimon Glass
33970b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
33980b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
33990b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
34000b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3401632efa74SSimon Glass
3402c609719bSwdenkThe following definitions that deal with the placement and management
3403c609719bSwdenkof environment data (variable area); in general, we support the
3404c609719bSwdenkfollowing configurations:
3405c609719bSwdenk
3406c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3407c3eb3fe4SMike Frysinger
3408c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3409c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3410c3eb3fe4SMike Frysinger
34115a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3412c609719bSwdenk
3413c609719bSwdenk	Define this if the environment is in flash memory.
3414c609719bSwdenk
3415c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3416c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3417c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3418c609719bSwdenk	   sector" type flash chips, which have several smaller
3419c609719bSwdenk	   sectors at the start or the end. For instance, such a
3420c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3421c609719bSwdenk	   such a case you would place the environment in one of the
3422c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3423c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3424c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3425c609719bSwdenk	   between U-Boot and the environment.
3426c609719bSwdenk
34270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3428c609719bSwdenk
3429c609719bSwdenk	   Offset of environment data (variable area) to the
3430c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3431c609719bSwdenk	   type flash chips the second sector can be used: the offset
3432c609719bSwdenk	   for this sector is given here.
3433c609719bSwdenk
34346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3435c609719bSwdenk
34360e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3437c609719bSwdenk
3438c609719bSwdenk	   This is just another way to specify the start address of
3439c609719bSwdenk	   the flash sector containing the environment (instead of
34400e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3441c609719bSwdenk
34420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3443c609719bSwdenk
3444c609719bSwdenk	   Size of the sector containing the environment.
3445c609719bSwdenk
3446c609719bSwdenk
3447c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3448c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3449c609719bSwdenk	   the environment.
3450c609719bSwdenk
34510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3452c609719bSwdenk
34535a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
34540e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3455c609719bSwdenk	   of this flash sector for the environment. This saves
3456c609719bSwdenk	   memory for the RAM copy of the environment.
3457c609719bSwdenk
3458c609719bSwdenk	   It may also save flash memory if you decide to use this
3459c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3460c609719bSwdenk	   since then the remainder of the flash sector could be used
3461c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3462c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3463c609719bSwdenk	   updating the environment in flash makes it always
3464c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3465c609719bSwdenk	   wrong before the contents has been restored from a copy in
3466c609719bSwdenk	   RAM, your target system will be dead.
3467c609719bSwdenk
34680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
34690e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3470c609719bSwdenk
3471c609719bSwdenk	   These settings describe a second storage area used to hold
347211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
34733e38691eSwdenk	   a valid backup copy in case there is a power failure during
3474c609719bSwdenk	   a "saveenv" operation.
3475c609719bSwdenk
3476c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3477c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3478c609719bSwdenkaccordingly!
3479c609719bSwdenk
3480c609719bSwdenk
34819314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3482c609719bSwdenk
3483c609719bSwdenk	Define this if you have some non-volatile memory device
3484c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3485c609719bSwdenk	environment.
3486c609719bSwdenk
34870e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
34880e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3489c609719bSwdenk
349011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3491c609719bSwdenk	  want to use for environment. It is assumed that this memory
3492c609719bSwdenk	  can just be read and written to, without any special
3493c609719bSwdenk	  provision.
3494c609719bSwdenk
3495c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3496c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
349711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3498c609719bSwdenkU-Boot will hang.
3499c609719bSwdenk
3500c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3501c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3502c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3503c609719bSwdenkto save the current settings.
3504c609719bSwdenk
3505c609719bSwdenk
3506bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3507c609719bSwdenk
3508c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3509c609719bSwdenk	device and a driver for it.
3510c609719bSwdenk
35110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3513c609719bSwdenk
3514c609719bSwdenk	  These two #defines specify the offset and size of the
3515c609719bSwdenk	  environment area within the total memory of your EEPROM.
3516c609719bSwdenk
35176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3518c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3519c609719bSwdenk	  The default address is zero.
3520c609719bSwdenk
35216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3522c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3523c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3524c609719bSwdenk	  would require six bits.
3525c609719bSwdenk
35266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3527c609719bSwdenk	  If defined, the number of milliseconds to delay between
3528c609719bSwdenk	  page writes.	The default is zero milliseconds.
3529c609719bSwdenk
35306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3531c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3532c609719bSwdenk	  that this is NOT the chip address length!
3533c609719bSwdenk
35346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
35355cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
35365cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
35375cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
35385cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
35395cf91d6bSwdenk	  byte chips.
35405cf91d6bSwdenk
35415cf91d6bSwdenk	  Note that we consider the length of the address field to
35425cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
35435cf91d6bSwdenk	  in the chip address.
35445cf91d6bSwdenk
35456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3546c609719bSwdenk	  The size in bytes of the EEPROM device.
3547c609719bSwdenk
3548548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3549548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3550548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3551548738b4SHeiko Schocher
3552548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3553548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3554548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3555548738b4SHeiko Schocher	  EEPROM. For example:
3556548738b4SHeiko Schocher
3557548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3558548738b4SHeiko Schocher
3559548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3560548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3561c609719bSwdenk
3562057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
35635779d8d9Swdenk
35645779d8d9Swdenk	Define this if you have a DataFlash memory device which you
35655779d8d9Swdenk	want to use for the environment.
35665779d8d9Swdenk
35670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
35690e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
35705779d8d9Swdenk
35715779d8d9Swdenk	  These three #defines specify the offset and size of the
35725779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
35735779d8d9Swdenk	  at the specified address.
35745779d8d9Swdenk
35750a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
35760a85a9e7SLiu Gang
35770a85a9e7SLiu Gang	Define this if you have a remote memory space which you
35780a85a9e7SLiu Gang	want to use for the local device's environment.
35790a85a9e7SLiu Gang
35800a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
35810a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
35820a85a9e7SLiu Gang
35830a85a9e7SLiu Gang	  These two #defines specify the address and size of the
35840a85a9e7SLiu Gang	  environment area within the remote memory space. The
35850a85a9e7SLiu Gang	  local device can get the environment from remote memory
3586fc54c7faSLiu Gang	  space by SRIO or PCIE links.
35870a85a9e7SLiu Gang
35880a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
35890a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3590fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3591fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
35920a85a9e7SLiu Gang
359351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
359413a5695bSwdenk
359513a5695bSwdenk	Define this if you have a NAND device which you want to use
359613a5695bSwdenk	for the environment.
359713a5695bSwdenk
35980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
360013a5695bSwdenk
360113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3602fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3603fdd813deSScott Wood	  aligned to an erase block boundary.
36045779d8d9Swdenk
3605fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3606e443c944SMarkus Klotzbuecher
36070e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3608fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3609fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3610fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3611fdd813deSScott Wood	  aligned to an erase block boundary.
3612e443c944SMarkus Klotzbuecher
3613fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3614fdd813deSScott Wood
3615fdd813deSScott Wood	  Specifies the length of the region in which the environment
3616fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3617fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3618fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3619fdd813deSScott Wood	  the range to be avoided.
3620fdd813deSScott Wood
3621fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3622fdd813deSScott Wood
3623fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3624fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3625fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3626fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3627fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3628e443c944SMarkus Klotzbuecher
3629b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3630b74ab737SGuennadi Liakhovetski
3631b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3632b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3633b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3634b74ab737SGuennadi Liakhovetski
36352b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
36362b74433fSJoe Hershberger
36372b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
36382b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
36392b74433fSJoe Hershberger	accesses, which is important on NAND.
36402b74433fSJoe Hershberger
36412b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
36422b74433fSJoe Hershberger
36432b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
36442b74433fSJoe Hershberger
36452b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
36462b74433fSJoe Hershberger
36472b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
36482b74433fSJoe Hershberger	  environment in.
36492b74433fSJoe Hershberger
3650785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3651785881f7SJoe Hershberger
3652785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3653785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3654785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3655785881f7SJoe Hershberger
36562b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
36572b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
36582b74433fSJoe Hershberger
36592b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
36602b74433fSJoe Hershberger	  when storing the env in UBI.
36612b74433fSJoe Hershberger
366206e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
366306e4ae5fSStephen Warren
366406e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
366506e4ae5fSStephen Warren	environment.
366606e4ae5fSStephen Warren
366706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
366806e4ae5fSStephen Warren
366906e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
367006e4ae5fSStephen Warren
367106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
367206e4ae5fSStephen Warren
367306e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
367406e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
367506e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
367606e4ae5fSStephen Warren
367706e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
367806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
367906e4ae5fSStephen Warren
368006e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
368106e4ae5fSStephen Warren	  area within the specified MMC device.
368206e4ae5fSStephen Warren
36835c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
36845c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
36855c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
36865c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
36875c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
36885c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
36895c088ee8SStephen Warren	  maximum possible space before it, to store other data.
36905c088ee8SStephen Warren
369106e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
369206e4ae5fSStephen Warren	  MMC sector boundary.
369306e4ae5fSStephen Warren
369406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
369506e4ae5fSStephen Warren
369606e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
369706e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
369806e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
369906e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
370006e4ae5fSStephen Warren
37015c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
37025c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
37035c088ee8SStephen Warren
370406e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
370506e4ae5fSStephen Warren	  an MMC sector boundary.
370606e4ae5fSStephen Warren
370706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
370806e4ae5fSStephen Warren
370906e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
371006e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
371106e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
371206e4ae5fSStephen Warren
37136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3714c609719bSwdenk
3715c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3716c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3717c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3718c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3719c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3720c609719bSwdenk	to be a good choice since it makes it far enough from the
3721c609719bSwdenk	start of the data area as well as from the stack pointer.
3722c609719bSwdenk
3723e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3724c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3725cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3726c609719bSwdenkuntil then to read environment variables.
3727c609719bSwdenk
372885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
372985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
373085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
373185ec0bccSwdenknecessary, because the first environment variable we need is the
373285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
373385ec0bccSwdenkhave any device yet where we could complain.]
3734c609719bSwdenk
3735c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3736c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
373785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3738c609719bSwdenk
37396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3740fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3741fc3e2165Swdenk
37426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3743fc3e2165Swdenk		      also needs to be defined.
3744fc3e2165Swdenk
37456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3746fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3747c609719bSwdenk
3748f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3749f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3750f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3751f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3752f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3753f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3754f5675aa5SRon Madrid
3755b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3756b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3757b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3758b2b92f53SSimon Glass		to do this.
3759b2b92f53SSimon Glass
3760e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3761e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3762e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3763e2e3e2b1SSimon Glass		present.
3764e2e3e2b1SSimon Glass
3765c609719bSwdenkLow Level (hardware related) configuration options:
3766dc7c9a1aSwdenk---------------------------------------------------
3767c609719bSwdenk
37686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3769c609719bSwdenk		Cache Line Size of the CPU.
3770c609719bSwdenk
37716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3772c609719bSwdenk		Default address of the IMMR after system reset.
37732535d602Swdenk
37742535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
37752535d602Swdenk		and RPXsuper) to be able to adjust the position of
37762535d602Swdenk		the IMMR register after a reset.
3777c609719bSwdenk
3778e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3779e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3780e46fedfeSTimur Tabi		PowerPC SOCs.
3781e46fedfeSTimur Tabi
3782e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3783e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3784e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3785e46fedfeSTimur Tabi
3786e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3787e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3788e46fedfeSTimur Tabi
3789e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3790e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3791e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3792e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3793e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3794e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3795e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3796e46fedfeSTimur Tabi
3797e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3798e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3799e46fedfeSTimur Tabi
3800e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3801e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3802e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3803e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3804e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3805e46fedfeSTimur Tabi
3806e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3807e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3808e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3809e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3810e46fedfeSTimur Tabi
3811e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3812e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3813e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3814e46fedfeSTimur Tabi
38157f6c2cbcSwdenk- Floppy Disk Support:
38166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
38177f6c2cbcSwdenk
38187f6c2cbcSwdenk		the default drive number (default value 0)
38197f6c2cbcSwdenk
38206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
38217f6c2cbcSwdenk
382211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
38237f6c2cbcSwdenk		(default value 1)
38247f6c2cbcSwdenk
38256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
38267f6c2cbcSwdenk
38277f6c2cbcSwdenk		defines the offset of register from address. It
38287f6c2cbcSwdenk		depends on which part of the data bus is connected to
382911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
38307f6c2cbcSwdenk
38316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
38326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
38337f6c2cbcSwdenk		default value.
38347f6c2cbcSwdenk
38356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
38367f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
38377f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
38387f6c2cbcSwdenk		source code. It is used to make hardware dependant
38397f6c2cbcSwdenk		initializations.
38407f6c2cbcSwdenk
38410abddf82SMacpaul Lin- CONFIG_IDE_AHB:
38420abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
38430abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
38440abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
38450abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
38460abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
38470abddf82SMacpaul Lin		is requierd.
38480abddf82SMacpaul Lin
38496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
385025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
385125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3852c609719bSwdenk
38536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3854c609719bSwdenk
38557152b1d0Swdenk		Start address of memory area that can be used for
3856c609719bSwdenk		initial data and stack; please note that this must be
3857c609719bSwdenk		writable memory that is working WITHOUT special
3858c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3859c609719bSwdenk		will become available only after programming the
3860c609719bSwdenk		memory controller and running certain initialization
3861c609719bSwdenk		sequences.
3862c609719bSwdenk
3863c609719bSwdenk		U-Boot uses the following memory types:
3864c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3865c609719bSwdenk		- MPC824X: data cache
3866c609719bSwdenk		- PPC4xx:  data cache
3867c609719bSwdenk
38686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3869c609719bSwdenk
3870c609719bSwdenk		Offset of the initial data structure in the memory
38716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
38726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3873c609719bSwdenk		data is located at the end of the available space
3874553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
38756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
38766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
38776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3878c609719bSwdenk
3879c609719bSwdenk	Note:
3880c609719bSwdenk		On the MPC824X (or other systems that use the data
3881c609719bSwdenk		cache for initial memory) the address chosen for
38826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3883c609719bSwdenk		point to an otherwise UNUSED address space between
3884c609719bSwdenk		the top of RAM and the start of the PCI space.
3885c609719bSwdenk
38866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3887c609719bSwdenk
38886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3889c609719bSwdenk
38906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3891c609719bSwdenk
38926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3893c609719bSwdenk
38946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3895c609719bSwdenk
38966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3897c609719bSwdenk
38986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3899c609719bSwdenk		SDRAM timing
3900c609719bSwdenk
39016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3902c609719bSwdenk		periodic timer for refresh
3903c609719bSwdenk
39046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3905c609719bSwdenk
39066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
39076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
39086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
39096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3910c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3911c609719bSwdenk
3912c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
39136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
39146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3915c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3916c609719bSwdenk
39176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
39186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3919c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3920c609719bSwdenk		Prescaler definitions (SDRAM timing)
3921c609719bSwdenk
39226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3923c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3924c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3925c609719bSwdenk
39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3927b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3928b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3929b423d055SHeiko Schocher
39306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3931c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3932c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3933c609719bSwdenk
39346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3935c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3936c609719bSwdenk		wrong setting might damage your board. Read
3937c609719bSwdenk		doc/README.MBX before setting this variable!
3938c609719bSwdenk
39396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3940ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3941ea909b76Swdenk		(Power On Self Tests). This definition overrides
3942ea909b76Swdenk		#define'd default value in commproc.h resp.
3943ea909b76Swdenk		cpm_8260.h.
3944ea909b76Swdenk
39456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
39466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
39476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
39486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
39496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
39506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
39516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
39526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3953a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
39545d232d0eSwdenk
39559cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
39569cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
39579cacf4fcSDirk Eibach		required.
39589cacf4fcSDirk Eibach
395969fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
396069fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
396169fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
396269fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
396369fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
396469fd2d3bSAndrew Sharp		by coreboot or similar.
396569fd2d3bSAndrew Sharp
3966842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
3967842033e6SGabor Juhos		Enable support for indirect PCI bridges.
3968842033e6SGabor Juhos
3969a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3970a09b9b68SKumar Gala		Chip has SRIO or not
3971a09b9b68SKumar Gala
3972a09b9b68SKumar Gala- CONFIG_SRIO1:
3973a09b9b68SKumar Gala		Board has SRIO 1 port available
3974a09b9b68SKumar Gala
3975a09b9b68SKumar Gala- CONFIG_SRIO2:
3976a09b9b68SKumar Gala		Board has SRIO 2 port available
3977a09b9b68SKumar Gala
3978a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3979a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3980a09b9b68SKumar Gala
3981a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3982a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3983a09b9b68SKumar Gala
3984a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3985a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3986a09b9b68SKumar Gala
398766bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
398866bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
398966bd1846SFabio Estevam		a 16 bit bus.
399066bd1846SFabio Estevam		Not all NAND drivers use this symbol.
3991a430e916SFabio Estevam		Example of drivers that use it:
399266bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
3993a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
3994eced4626SAlex Waterman
3995eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3996eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3997eced4626SAlex Waterman		a default value will be used.
3998eced4626SAlex Waterman
3999bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4000218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4001218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4002218ca724SWolfgang Denk
4003bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4004bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4005bb99ad6dSBen Warren
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4007218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4008218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4009218ca724SWolfgang Denk		to something your driver can deal with.
4010bb99ad6dSBen Warren
40111b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
40121b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
40131b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
40141b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
40151b3e3c4fSYork Sun		header files or board specific files.
40161b3e3c4fSYork Sun
40176f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
40186f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
40196f5e1dc5SYork Sun
40206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4021218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4022218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
40232ad6b513STimur Tabi
4024c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4025c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4026c26e454dSwdenk
4027c26e454dSwdenk- CONFIG_FEC[12]_PHY
4028c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
40296e592385Swdenk		to the given FEC; i. e.
4030c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4031c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4032c26e454dSwdenk
4033c26e454dSwdenk		When set to -1, means to probe for first available.
4034c26e454dSwdenk
4035c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4036c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4037c26e454dSwdenk		(so program the FEC to ignore it).
4038c26e454dSwdenk
4039c26e454dSwdenk- CONFIG_RMII
4040c26e454dSwdenk		Enable RMII mode for all FECs.
4041c26e454dSwdenk		Note that this is a global option, we can't
4042c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4043c26e454dSwdenk
40445cf91d6bSwdenk- CONFIG_CRC32_VERIFY
40455cf91d6bSwdenk		Add a verify option to the crc32 command.
40465cf91d6bSwdenk		The syntax is:
40475cf91d6bSwdenk
40485cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
40495cf91d6bSwdenk
40505cf91d6bSwdenk		Where address/count indicate a memory area
40515cf91d6bSwdenk		and crc32 is the correct crc32 which the
40525cf91d6bSwdenk		area should have.
40535cf91d6bSwdenk
405456523f12Swdenk- CONFIG_LOOPW
405556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4056602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
405756523f12Swdenk
40587b466641Sstroese- CONFIG_MX_CYCLIC
40597b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
40607b466641Sstroese		"md/mw" commands.
40617b466641Sstroese		Examples:
40627b466641Sstroese
40637b466641Sstroese		=> mdc.b 10 4 500
40647b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
40657b466641Sstroese
40667b466641Sstroese		=> mwc.l 100 12345678 10
40677b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
40687b466641Sstroese
40697b466641Sstroese		This only takes effect if the memory commands are activated
4070602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
40717b466641Sstroese
40728aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4073afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4074e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4075e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4076e03f3169SWolfgang Denk		relocate itself into RAM.
40778aa1a2d1Swdenk
4078e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4079e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4080e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4081e03f3169SWolfgang Denk		these initializations itself.
40828aa1a2d1Swdenk
4083401bb30bSAneesh V- CONFIG_SPL_BUILD
4084df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4085df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4086df81238bSMagnus Lilja		compiling a NAND SPL.
4087400558b5Swdenk
40884213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
40894213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
40904213fc29SSimon Glass		effective address. It is therefore not necessary to regard
40914213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
40924213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
40934213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
40944213fc29SSimon Glass		addressable memory. This option causes some memory accesses
40954213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
40964213fc29SSimon Glass
4097d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4098d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4099d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4100d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4101d8834a13SMatthias Weisser		conditions but may increase the binary size.
4102d8834a13SMatthias Weisser
4103588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4104588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4105588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4106b16f521aSGabe Black
4107fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4108fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4109fc33705eSMark Jackson
4110fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
41115b5ece9eSGabe Black
4112f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4113f2717b47STimur Tabi-----------------------------------
4114f2717b47STimur Tabi
4115f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4116f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4117f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4118f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4119f2717b47STimur Tabiwithin that device.
4120f2717b47STimur Tabi
4121f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4122f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4123f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4124f2717b47STimur Tabi	is also specified.
4125f2717b47STimur Tabi
4126f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4127f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4128f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4129f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4130f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4131f2717b47STimur Tabi
4132f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4133f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4134f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4135f2717b47STimur Tabi	virtual address in NOR flash.
4136f2717b47STimur Tabi
4137f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4138f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4139f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4140f2717b47STimur Tabi
4141f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4142f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4143f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4144f2717b47STimur Tabi
4145f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4146f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4147f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4148f2717b47STimur Tabi
4149292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4150292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4151292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4152fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4153fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4154fc54c7faSLiu Gang	master's memory space.
4155f2717b47STimur Tabi
4156c609719bSwdenkBuilding the Software:
4157c609719bSwdenk======================
4158c609719bSwdenk
4159218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4160218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4161218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4162218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4163218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4164218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4165c609719bSwdenk
4166218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4167218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4168218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4169218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4170218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4171c609719bSwdenk
4172218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4173218ca724SWolfgang Denk	$ export CROSS_COMPILE
4174c609719bSwdenk
41752f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
41762f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
41772f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
41782f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
41792f8d396bSPeter Tyser
41802f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
41812f8d396bSPeter Tyser
41822f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
41832f8d396bSPeter Tyser      be executed on computers running Windows.
41842f8d396bSPeter Tyser
4185c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4186c609719bSwdenksources you must configure U-Boot for one specific board type. This
4187c609719bSwdenkis done by typing:
4188c609719bSwdenk
4189c609719bSwdenk	make NAME_config
4190c609719bSwdenk
4191218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
41924d675ae6SMichael Jonesrations; see boards.cfg for supported names.
419354387ac9Swdenk
4194c609719bSwdenkNote: for some board special configuration names may exist; check if
4195c609719bSwdenk      additional information is available from the board vendor; for
41962729af9dSwdenk      instance, the TQM823L systems are available without (standard)
41972729af9dSwdenk      or with LCD support. You can select such additional "features"
419811ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4199c609719bSwdenk
42002729af9dSwdenk      make TQM823L_config
42012729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4202c609719bSwdenk
4203c609719bSwdenk      make TQM823L_LCD_config
4204c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4205c609719bSwdenk
4206c609719bSwdenk      etc.
4207c609719bSwdenk
4208c609719bSwdenk
4209c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
42107152b1d0Swdenkimages ready for download to / installation on your system:
4211c609719bSwdenk
4212c609719bSwdenk- "u-boot.bin" is a raw binary image
4213c609719bSwdenk- "u-boot" is an image in ELF binary format
4214c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4215c609719bSwdenk
4216baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4217baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4218baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4219baf31249SMarian Balakowicz
4220baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4221baf31249SMarian Balakowicz
4222baf31249SMarian Balakowicz	make O=/tmp/build distclean
4223baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4224baf31249SMarian Balakowicz	make O=/tmp/build all
4225baf31249SMarian Balakowicz
4226baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4227baf31249SMarian Balakowicz
4228baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4229baf31249SMarian Balakowicz	make distclean
4230baf31249SMarian Balakowicz	make NAME_config
4231baf31249SMarian Balakowicz	make all
4232baf31249SMarian Balakowicz
4233baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4234baf31249SMarian Balakowiczvariable.
4235baf31249SMarian Balakowicz
4236c609719bSwdenk
4237c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4238c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4239c609719bSwdenknative "make".
4240c609719bSwdenk
4241c609719bSwdenk
4242c609719bSwdenkIf the system board that you have is not listed, then you will need
4243c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4244c609719bSwdenksteps:
4245c609719bSwdenk
4246c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
42474d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
42484d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4249c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
425085ec0bccSwdenk    files you need. In your board directory, you will need at least
425185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
425285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
425385ec0bccSwdenk    your board
4254c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4255c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
425685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4257c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4258c609719bSwdenk    to be installed on your target system.
425985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4260c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4261c609719bSwdenk
4262c609719bSwdenk
4263c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4264c609719bSwdenk==============================================================
4265c609719bSwdenk
4266c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4267c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4268c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4269c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4270218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4271c609719bSwdenk
4272c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4273c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4274c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4275c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4276c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
42777152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4278218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4279218ca724SWolfgang Denkyou can type
4280c609719bSwdenk
4281c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4282c609719bSwdenk
4283c609719bSwdenkor to build on a native PowerPC system you can type
4284c609719bSwdenk
4285c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4286c609719bSwdenk
4287218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4288218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4289218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4290218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4291218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4292218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4293218ca724SWolfgang Denkvariable. For example:
4294baf31249SMarian Balakowicz
4295baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4296baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4297baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4298baf31249SMarian Balakowicz
4299218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4300218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4301218ca724SWolfgang Denkduring the whole build process.
4302baf31249SMarian Balakowicz
4303baf31249SMarian Balakowicz
4304c609719bSwdenkSee also "U-Boot Porting Guide" below.
4305c609719bSwdenk
4306c609719bSwdenk
4307c609719bSwdenkMonitor Commands - Overview:
4308c609719bSwdenk============================
4309c609719bSwdenk
4310c609719bSwdenkgo	- start application at address 'addr'
4311c609719bSwdenkrun	- run commands in an environment variable
4312c609719bSwdenkbootm	- boot application image from memory
4313c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
431444f074c7SMarek Vasutbootz   - boot zImage from memory
4315c609719bSwdenktftpboot- boot image via network using TFTP protocol
4316c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4317c609719bSwdenk	       (and eventually "gatewayip")
43181fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4319c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4320c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4321c609719bSwdenkloads	- load S-Record file over serial line
4322c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4323c609719bSwdenkmd	- memory display
4324c609719bSwdenkmm	- memory modify (auto-incrementing)
4325c609719bSwdenknm	- memory modify (constant address)
4326c609719bSwdenkmw	- memory write (fill)
4327c609719bSwdenkcp	- memory copy
4328c609719bSwdenkcmp	- memory compare
4329c609719bSwdenkcrc32	- checksum calculation
43300f89c54bSPeter Tyseri2c	- I2C sub-system
4331c609719bSwdenksspi	- SPI utility commands
4332c609719bSwdenkbase	- print or set address offset
4333c609719bSwdenkprintenv- print environment variables
4334c609719bSwdenksetenv	- set environment variables
4335c609719bSwdenksaveenv - save environment variables to persistent storage
4336c609719bSwdenkprotect - enable or disable FLASH write protection
4337c609719bSwdenkerase	- erase FLASH memory
4338c609719bSwdenkflinfo	- print FLASH memory information
433910635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4340c609719bSwdenkbdinfo	- print Board Info structure
4341c609719bSwdenkiminfo	- print header information for application image
4342c609719bSwdenkconinfo - print console devices and informations
4343c609719bSwdenkide	- IDE sub-system
4344c609719bSwdenkloop	- infinite loop on address range
434556523f12Swdenkloopw	- infinite write loop on address range
4346c609719bSwdenkmtest	- simple RAM test
4347c609719bSwdenkicache	- enable or disable instruction cache
4348c609719bSwdenkdcache	- enable or disable data cache
4349c609719bSwdenkreset	- Perform RESET of the CPU
4350c609719bSwdenkecho	- echo args to console
4351c609719bSwdenkversion - print monitor version
4352c609719bSwdenkhelp	- print online help
4353c609719bSwdenk?	- alias for 'help'
4354c609719bSwdenk
4355c609719bSwdenk
4356c609719bSwdenkMonitor Commands - Detailed Description:
4357c609719bSwdenk========================================
4358c609719bSwdenk
4359c609719bSwdenkTODO.
4360c609719bSwdenk
4361c609719bSwdenkFor now: just type "help <command>".
4362c609719bSwdenk
4363c609719bSwdenk
4364c609719bSwdenkEnvironment Variables:
4365c609719bSwdenk======================
4366c609719bSwdenk
4367c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4368c609719bSwdenkcan be made persistent by saving to Flash memory.
4369c609719bSwdenk
4370c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4371c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4372c609719bSwdenkwithout a value can be used to delete a variable from the
4373c609719bSwdenkenvironment. As long as you don't save the environment you are
4374c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4375c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4376c609719bSwdenk
4377c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4378c96f86eeSWolfgang Denk
4379c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4380c609719bSwdenk
4381c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4382c609719bSwdenk
4383c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4384c609719bSwdenk
4385c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4386c609719bSwdenk
4387c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4388c609719bSwdenk
4389c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4390c609719bSwdenk
43917d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
43927d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
43937d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
43947d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
43957d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
43967d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4397c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4398c3624e6eSGrant Likely		  bootm_mapsize.
4399c3624e6eSGrant Likely
4400c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4401c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4402c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4403c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4404c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4405c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4406c3624e6eSGrant Likely		  used otherwise.
44077d721e34SBartlomiej Sieka
44087d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
44097d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44107d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
44117d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
44127d721e34SBartlomiej Sieka		  environment variable.
44137d721e34SBartlomiej Sieka
44144bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
44154bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
44164bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
44174bae9090SBartlomiej Sieka
4418c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4419c609719bSwdenk		  "bootp" will just load perform a lookup of the
4420c609719bSwdenk		  configuration from the BOOTP server, but not try to
4421c609719bSwdenk		  load any image using TFTP
4422c609719bSwdenk
4423c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4424c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4425c609719bSwdenk		  be automatically started (by internally calling
4426c609719bSwdenk		  "bootm")
4427c609719bSwdenk
44284a6fd34bSwdenk		  If set to "no", a standalone image passed to the
44294a6fd34bSwdenk		  "bootm" command will be copied to the load address
44304a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
44314a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
44324a6fd34bSwdenk		  data.
44334a6fd34bSwdenk
4434a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4435a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4436fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4437fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4438fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4439fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4440fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4441fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4442fa34f6b2SShawn Guo		  access it during the boot procedure.
4443fa34f6b2SShawn Guo
4444a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4445a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4446a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4447a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4448a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4449a28afca5SDavid A. Long		  must be accessible by the kernel.
4450a28afca5SDavid A. Long
4451eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4452eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4453eea63e05SSimon Glass		  defined.
4454eea63e05SSimon Glass
445517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
445617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
445717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
445817ea1177Swdenk		  initialization code. So, for changes to be effective
445917ea1177Swdenk		  it must be saved and board must be reset.
446017ea1177Swdenk
4461c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4462c609719bSwdenk		  If this variable is not set, initrd images will be
4463c609719bSwdenk		  copied to the highest possible address in RAM; this
4464c609719bSwdenk		  is usually what you want since it allows for
4465c609719bSwdenk		  maximum initrd size. If for some reason you want to
4466c609719bSwdenk		  make sure that the initrd image is loaded below the
44676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4468c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4469c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4470c609719bSwdenk		  address to use (U-Boot will still check that it
4471c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4472c609719bSwdenk
4473c609719bSwdenk		  For instance, when you have a system with 16 MB
44747152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4475c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4476c609719bSwdenk		  the "bootargs" variable. However, now you must make
44777152b1d0Swdenk		  sure that the initrd image is placed in the first
4478c609719bSwdenk		  12 MB as well - this can be done with
4479c609719bSwdenk
4480c609719bSwdenk		  setenv initrd_high 00c00000
4481c609719bSwdenk
448238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
448338b99261Swdenk		  indication to U-Boot that all addresses are legal
448438b99261Swdenk		  for the Linux kernel, including addresses in flash
448538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
448638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
448738b99261Swdenk		  boot time on your system, but requires that this
448838b99261Swdenk		  feature is supported by your Linux kernel.
448938b99261Swdenk
4490c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4491c609719bSwdenk
4492c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4493dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4494c609719bSwdenk
4495c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4496c609719bSwdenk
4497c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4498c609719bSwdenk
4499c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4500c609719bSwdenk
4501c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4502c609719bSwdenk
4503c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4504c609719bSwdenk
4505e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4506a3d991bdSwdenk
4507e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4508e2a53458SMike Frysinger		  For example you can do the following
4509a3d991bdSwdenk
451048690d80SHeiko Schocher		  => setenv ethact FEC
451148690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
451248690d80SHeiko Schocher		  => setenv ethact SCC
451348690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4514a3d991bdSwdenk
4515e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4516e1692577SMatthias Fuchs		  available network interfaces.
4517e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4518e1692577SMatthias Fuchs
4519a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4520a3d991bdSwdenk		  either succeed or fail without retrying.
45216e592385Swdenk		  When set to "once" the network operation will
45226e592385Swdenk		  fail when all the available network interfaces
45236e592385Swdenk		  are tried once without success.
4524a3d991bdSwdenk		  Useful on scripts which control the retry operation
4525a3d991bdSwdenk		  themselves.
4526a3d991bdSwdenk
4527b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4528a1cf027aSJean-Christophe PLAGNIOL-VILLARD
452928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4530ecb0ccd9SWolfgang Denk		  UDP source port.
4531ecb0ccd9SWolfgang Denk
453228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
453328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
453428cb9375SWolfgang Denk
4535c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4536c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4537c96f86eeSWolfgang Denk
4538c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4539c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4540c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4541c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4542c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4543c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4544c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4545c96f86eeSWolfgang Denk
4546a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
454711ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4548a3d991bdSwdenk		  VLAN tagged frames.
4549c609719bSwdenk
4550dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4551dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4552dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4553dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4554dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4555dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4556dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4557dc0b7b0eSJason Hobbs
4558dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4559dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4560dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4561dc0b7b0eSJason Hobbs
4562dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4563dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4564dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4565dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4566dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4567dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4568dc0b7b0eSJason Hobbs
4569c609719bSwdenkThe following environment variables may be used and automatically
4570c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4571c609719bSwdenkdepending the information provided by your boot server:
4572c609719bSwdenk
4573c609719bSwdenk  bootfile	- see above
4574c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4575fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4576c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4577c609719bSwdenk  hostname	- Target hostname
4578c609719bSwdenk  ipaddr	- see above
4579c609719bSwdenk  netmask	- Subnet Mask
4580c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4581c609719bSwdenk  serverip	- see above
4582c609719bSwdenk
4583c609719bSwdenk
4584c609719bSwdenkThere are two special Environment Variables:
4585c609719bSwdenk
4586c609719bSwdenk  serial#	- contains hardware identification information such
4587c609719bSwdenk		  as type string and/or serial number
4588c609719bSwdenk  ethaddr	- Ethernet address
4589c609719bSwdenk
4590c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4591c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4592c609719bSwdenkonce they have been set once.
4593c609719bSwdenk
4594c609719bSwdenk
4595c1551ea8SstroeseFurther special Environment Variables:
4596c1551ea8Sstroese
4597c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4598c1551ea8Sstroese		  with the "version" command. This variable is
4599c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4600c1551ea8Sstroese
4601c1551ea8Sstroese
4602c609719bSwdenkPlease note that changes to some configuration parameters may take
4603c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4604c609719bSwdenk
4605c609719bSwdenk
4606170ab110SJoe HershbergerCallback functions for environment variables:
4607170ab110SJoe Hershberger---------------------------------------------
4608170ab110SJoe Hershberger
4609170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4610170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4611170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4612170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4613170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4614170ab110SJoe Hershberger
4615170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4616170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4617170ab110SJoe Hershberger
4618170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4619170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4620170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4621170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4622170ab110SJoe Hershberger
4623170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4624170ab110SJoe Hershberger	list = entry[,list]
4625170ab110SJoe Hershberger
4626170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4627170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4628170ab110SJoe Hershberger
4629170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4630170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4631170ab110SJoe Hershbergeroverride any association in the static list. You can define
4632170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4633170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4634170ab110SJoe Hershberger
4635170ab110SJoe Hershberger
4636f07771ccSwdenkCommand Line Parsing:
4637f07771ccSwdenk=====================
4638f07771ccSwdenk
4639f07771ccSwdenkThere are two different command line parsers available with U-Boot:
46407152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4641f07771ccSwdenk
4642f07771ccSwdenkOld, simple command line parser:
4643f07771ccSwdenk--------------------------------
4644f07771ccSwdenk
4645f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4646f07771ccSwdenk- several commands on one line, separated by ';'
4647fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4648f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4649f07771ccSwdenk  for example:
4650fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4651f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4652f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4653f07771ccSwdenk
4654f07771ccSwdenkHush shell:
4655f07771ccSwdenk-----------
4656f07771ccSwdenk
4657f07771ccSwdenk- similar to Bourne shell, with control structures like
4658f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4659f07771ccSwdenk  until...do...done, ...
4660f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4661f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4662f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4663f07771ccSwdenk  command
4664f07771ccSwdenk
4665f07771ccSwdenkGeneral rules:
4666f07771ccSwdenk--------------
4667f07771ccSwdenk
4668f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4669f07771ccSwdenk    command) contains several commands separated by semicolon, and
4670f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4671f07771ccSwdenk    executed anyway.
4672f07771ccSwdenk
4673f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
467411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4675f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4676f07771ccSwdenk    variables are not executed.
4677f07771ccSwdenk
4678c609719bSwdenkNote for Redundant Ethernet Interfaces:
4679c609719bSwdenk=======================================
4680c609719bSwdenk
468111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4682c609719bSwdenksuch configurations and is capable of automatic selection of a
46837152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4684c609719bSwdenk
4685c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4686c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4687c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4688c609719bSwdenk
4689c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4690c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4691c609719bSwdenkding setting in the environment; if the corresponding environment
4692c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4693c609719bSwdenk
4694c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4695c609719bSwdenk  environment, the SROM's address is used.
4696c609719bSwdenk
4697c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4698c609719bSwdenk  environment exists, then the value from the environment variable is
4699c609719bSwdenk  used.
4700c609719bSwdenk
4701c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4702c609719bSwdenk  both addresses are the same, this MAC address is used.
4703c609719bSwdenk
4704c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4705c609719bSwdenk  addresses differ, the value from the environment is used and a
4706c609719bSwdenk  warning is printed.
4707c609719bSwdenk
4708c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4709c609719bSwdenk  is raised.
4710c609719bSwdenk
4711ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4712ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4713ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4714ecee9324SBen WarrenThe naming convention is as follows:
4715ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4716c609719bSwdenk
4717c609719bSwdenkImage Formats:
4718c609719bSwdenk==============
4719c609719bSwdenk
47203310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
47213310c549SMarian Balakowiczimages in two formats:
47223310c549SMarian Balakowicz
47233310c549SMarian BalakowiczNew uImage format (FIT)
47243310c549SMarian Balakowicz-----------------------
47253310c549SMarian Balakowicz
47263310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
47273310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
47283310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
47293310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
47303310c549SMarian Balakowicz
47313310c549SMarian Balakowicz
47323310c549SMarian BalakowiczOld uImage format
47333310c549SMarian Balakowicz-----------------
47343310c549SMarian Balakowicz
47353310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
47363310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
47373310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4738c609719bSwdenk
4739c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4740c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4741f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4742f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4743f5ed9e39SPeter Tyser  INTEGRITY).
47447b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4745afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4746afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4747c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4748c609719bSwdenk* Load Address
4749c609719bSwdenk* Entry Point
4750c609719bSwdenk* Image Name
4751c609719bSwdenk* Image Timestamp
4752c609719bSwdenk
4753c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4754c609719bSwdenkand the data portions of the image are secured against corruption by
4755c609719bSwdenkCRC32 checksums.
4756c609719bSwdenk
4757c609719bSwdenk
4758c609719bSwdenkLinux Support:
4759c609719bSwdenk==============
4760c609719bSwdenk
4761c609719bSwdenkAlthough U-Boot should support any OS or standalone application
47627152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4763c609719bSwdenkU-Boot.
4764c609719bSwdenk
4765c609719bSwdenkU-Boot includes many features that so far have been part of some
4766c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4767c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4768c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
47697152b1d0Swdenkserves several purposes:
4770c609719bSwdenk
4771c609719bSwdenk- the same features can be used for other OS or standalone
4772c609719bSwdenk  applications (for instance: using compressed images to reduce the
4773c609719bSwdenk  Flash memory footprint)
4774c609719bSwdenk
4775c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
47767152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4777c609719bSwdenk
4778c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4779c609719bSwdenk  images; of course this also means that different kernel images can
4780c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4781c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4782c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4783c609719bSwdenk  software is easier now.
4784c609719bSwdenk
4785c609719bSwdenk
4786c609719bSwdenkLinux HOWTO:
4787c609719bSwdenk============
4788c609719bSwdenk
4789c609719bSwdenkPorting Linux to U-Boot based systems:
4790c609719bSwdenk---------------------------------------
4791c609719bSwdenk
4792c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4793c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4794c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4795c609719bSwdenkLinux :-).
4796c609719bSwdenk
4797a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4798c609719bSwdenk
4799c609719bSwdenkJust make sure your machine specific header file (for instance
4800c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
48011dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
48021dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
48036d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4804c609719bSwdenk
4805c609719bSwdenk
4806c609719bSwdenkConfiguring the Linux kernel:
4807c609719bSwdenk-----------------------------
4808c609719bSwdenk
4809c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4810c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4811c609719bSwdenk
4812c609719bSwdenk
4813c609719bSwdenkBuilding a Linux Image:
4814c609719bSwdenk-----------------------
4815c609719bSwdenk
481624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
481724ee89b9Swdenknot used. If you use recent kernel source, a new build target
481824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
481924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
482024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
482124ee89b9Swdenk100% compatible format.
4822c609719bSwdenk
4823c609719bSwdenkExample:
4824c609719bSwdenk
4825c609719bSwdenk	make TQM850L_config
4826c609719bSwdenk	make oldconfig
4827c609719bSwdenk	make dep
482824ee89b9Swdenk	make uImage
4829c609719bSwdenk
483024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
483124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
483224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4833c609719bSwdenk
483424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
483524ee89b9Swdenk
483624ee89b9Swdenk* convert the kernel into a raw binary image:
483724ee89b9Swdenk
483824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
483924ee89b9Swdenk				 -R .note -R .comment \
484024ee89b9Swdenk				 -S vmlinux linux.bin
484124ee89b9Swdenk
484224ee89b9Swdenk* compress the binary image:
484324ee89b9Swdenk
484424ee89b9Swdenk	gzip -9 linux.bin
484524ee89b9Swdenk
484624ee89b9Swdenk* package compressed binary image for U-Boot:
484724ee89b9Swdenk
484824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
484924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
485024ee89b9Swdenk		-d linux.bin.gz uImage
485124ee89b9Swdenk
485224ee89b9Swdenk
485324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
485424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
485524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
485624ee89b9Swdenkbyte header containing information about target architecture,
485724ee89b9Swdenkoperating system, image type, compression method, entry points, time
485824ee89b9Swdenkstamp, CRC32 checksums, etc.
485924ee89b9Swdenk
486024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
486124ee89b9Swdenkprint the header information, or to build new images.
4862c609719bSwdenk
4863c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4864c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4865c609719bSwdenkchecksum verification:
4866c609719bSwdenk
4867c609719bSwdenk	tools/mkimage -l image
4868c609719bSwdenk	  -l ==> list image header information
4869c609719bSwdenk
4870c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4871c609719bSwdenkfrom a "data file" which is used as image payload:
4872c609719bSwdenk
4873c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4874c609719bSwdenk		      -n name -d data_file image
4875c609719bSwdenk	  -A ==> set architecture to 'arch'
4876c609719bSwdenk	  -O ==> set operating system to 'os'
4877c609719bSwdenk	  -T ==> set image type to 'type'
4878c609719bSwdenk	  -C ==> set compression type 'comp'
4879c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4880c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4881c609719bSwdenk	  -n ==> set image name to 'name'
4882c609719bSwdenk	  -d ==> use image data from 'datafile'
4883c609719bSwdenk
488469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
488569459791Swdenkaddress (0x00000000), but the entry point address depends on the
488669459791Swdenkkernel version:
4887c609719bSwdenk
4888c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
488924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4890c609719bSwdenk
4891c609719bSwdenkSo a typical call to build a U-Boot image would read:
4892c609719bSwdenk
489324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
489424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4895a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
489624ee89b9Swdenk	> examples/uImage.TQM850L
489724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4898c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4899c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4900c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4901c609719bSwdenk	Load Address: 0x00000000
490224ee89b9Swdenk	Entry Point:  0x00000000
4903c609719bSwdenk
4904c609719bSwdenkTo verify the contents of the image (or check for corruption):
4905c609719bSwdenk
490624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
490724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4908c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4909c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4910c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4911c609719bSwdenk	Load Address: 0x00000000
491224ee89b9Swdenk	Entry Point:  0x00000000
4913c609719bSwdenk
4914c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4915c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4916c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4917c609719bSwdenkneed to be uncompressed:
4918c609719bSwdenk
4919a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
492024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
492124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4922a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
492324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
492424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4925c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4926c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4927c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4928c609719bSwdenk	Load Address: 0x00000000
492924ee89b9Swdenk	Entry Point:  0x00000000
4930c609719bSwdenk
4931c609719bSwdenk
4932c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4933c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4934c609719bSwdenk
4935c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4936c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4937c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4938c609719bSwdenk	Image Name:   Simple Ramdisk Image
4939c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4940c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4941c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4942c609719bSwdenk	Load Address: 0x00000000
4943c609719bSwdenk	Entry Point:  0x00000000
4944c609719bSwdenk
4945c609719bSwdenk
4946c609719bSwdenkInstalling a Linux Image:
4947c609719bSwdenk-------------------------
4948c609719bSwdenk
4949c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4950c609719bSwdenkyou must convert the image to S-Record format:
4951c609719bSwdenk
4952c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4953c609719bSwdenk
4954c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4955c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4956c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4957c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4958c609719bSwdenkcommand.
4959c609719bSwdenk
4960c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4961c609719bSwdenkTQM8xxL is in the first Flash bank):
4962c609719bSwdenk
4963c609719bSwdenk	=> erase 40100000 401FFFFF
4964c609719bSwdenk
4965c609719bSwdenk	.......... done
4966c609719bSwdenk	Erased 8 sectors
4967c609719bSwdenk
4968c609719bSwdenk	=> loads 40100000
4969c609719bSwdenk	## Ready for S-Record download ...
4970c609719bSwdenk	~>examples/image.srec
4971c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4972c609719bSwdenk	...
4973c609719bSwdenk	15989 15990 15991 15992
4974c609719bSwdenk	[file transfer complete]
4975c609719bSwdenk	[connected]
4976c609719bSwdenk	## Start Addr = 0x00000000
4977c609719bSwdenk
4978c609719bSwdenk
4979c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4980c609719bSwdenkthis includes a checksum verification so you can be sure no data
4981c609719bSwdenkcorruption happened:
4982c609719bSwdenk
4983c609719bSwdenk	=> imi 40100000
4984c609719bSwdenk
4985c609719bSwdenk	## Checking Image at 40100000 ...
4986c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4987c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4988c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4989c609719bSwdenk	   Load Address: 00000000
4990c609719bSwdenk	   Entry Point:	 0000000c
4991c609719bSwdenk	   Verifying Checksum ... OK
4992c609719bSwdenk
4993c609719bSwdenk
4994c609719bSwdenkBoot Linux:
4995c609719bSwdenk-----------
4996c609719bSwdenk
4997c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4998c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4999c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5000c609719bSwdenkparameters. You can check and modify this variable using the
5001c609719bSwdenk"printenv" and "setenv" commands:
5002c609719bSwdenk
5003c609719bSwdenk
5004c609719bSwdenk	=> printenv bootargs
5005c609719bSwdenk	bootargs=root=/dev/ram
5006c609719bSwdenk
5007c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5008c609719bSwdenk
5009c609719bSwdenk	=> printenv bootargs
5010c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5011c609719bSwdenk
5012c609719bSwdenk	=> bootm 40020000
5013c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5014c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5015c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5016c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5017c609719bSwdenk	   Load Address: 00000000
5018c609719bSwdenk	   Entry Point:	 0000000c
5019c609719bSwdenk	   Verifying Checksum ... OK
5020c609719bSwdenk	   Uncompressing Kernel Image ... OK
5021c609719bSwdenk	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
5022c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5023c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5024c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5025c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5026c609719bSwdenk	...
5027c609719bSwdenk
502811ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
50297152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5030c609719bSwdenkformat!) to the "bootm" command:
5031c609719bSwdenk
5032c609719bSwdenk	=> imi 40100000 40200000
5033c609719bSwdenk
5034c609719bSwdenk	## Checking Image at 40100000 ...
5035c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5036c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5037c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5038c609719bSwdenk	   Load Address: 00000000
5039c609719bSwdenk	   Entry Point:	 0000000c
5040c609719bSwdenk	   Verifying Checksum ... OK
5041c609719bSwdenk
5042c609719bSwdenk	## Checking Image at 40200000 ...
5043c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5044c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5045c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5046c609719bSwdenk	   Load Address: 00000000
5047c609719bSwdenk	   Entry Point:	 00000000
5048c609719bSwdenk	   Verifying Checksum ... OK
5049c609719bSwdenk
5050c609719bSwdenk	=> bootm 40100000 40200000
5051c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5052c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5053c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5054c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5055c609719bSwdenk	   Load Address: 00000000
5056c609719bSwdenk	   Entry Point:	 0000000c
5057c609719bSwdenk	   Verifying Checksum ... OK
5058c609719bSwdenk	   Uncompressing Kernel Image ... OK
5059c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5060c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5061c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5062c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5063c609719bSwdenk	   Load Address: 00000000
5064c609719bSwdenk	   Entry Point:	 00000000
5065c609719bSwdenk	   Verifying Checksum ... OK
5066c609719bSwdenk	   Loading Ramdisk ... OK
5067c609719bSwdenk	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
5068c609719bSwdenk	Boot arguments: root=/dev/ram
5069c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5070c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5071c609719bSwdenk	...
5072c609719bSwdenk	RAMDISK: Compressed image found at block 0
5073c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5074c609719bSwdenk
5075c609719bSwdenk	bash#
5076c609719bSwdenk
50770267768eSMatthew McClintockBoot Linux and pass a flat device tree:
50780267768eSMatthew McClintock-----------
50790267768eSMatthew McClintock
50800267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
50810267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
50820267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
50830267768eSMatthew McClintockflat device tree:
50840267768eSMatthew McClintock
50850267768eSMatthew McClintock=> print oftaddr
50860267768eSMatthew McClintockoftaddr=0x300000
50870267768eSMatthew McClintock=> print oft
50880267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
50890267768eSMatthew McClintock=> tftp $oftaddr $oft
50900267768eSMatthew McClintockSpeed: 1000, full duplex
50910267768eSMatthew McClintockUsing TSEC0 device
50920267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
50930267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
50940267768eSMatthew McClintockLoad address: 0x300000
50950267768eSMatthew McClintockLoading: #
50960267768eSMatthew McClintockdone
50970267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
50980267768eSMatthew McClintock=> tftp $loadaddr $bootfile
50990267768eSMatthew McClintockSpeed: 1000, full duplex
51000267768eSMatthew McClintockUsing TSEC0 device
51010267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
51020267768eSMatthew McClintockFilename 'uImage'.
51030267768eSMatthew McClintockLoad address: 0x200000
51040267768eSMatthew McClintockLoading:############
51050267768eSMatthew McClintockdone
51060267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
51070267768eSMatthew McClintock=> print loadaddr
51080267768eSMatthew McClintockloadaddr=200000
51090267768eSMatthew McClintock=> print oftaddr
51100267768eSMatthew McClintockoftaddr=0x300000
51110267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
51120267768eSMatthew McClintock## Booting image at 00200000 ...
51130267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
51140267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
51150267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
51160267768eSMatthew McClintock   Load Address: 00000000
51170267768eSMatthew McClintock   Entry Point:	 00000000
51180267768eSMatthew McClintock   Verifying Checksum ... OK
51190267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
51200267768eSMatthew McClintockBooting using flat device tree at 0x300000
51210267768eSMatthew McClintockUsing MPC85xx ADS machine description
51220267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
51230267768eSMatthew McClintock[snip]
51240267768eSMatthew McClintock
51250267768eSMatthew McClintock
51266069ff26SwdenkMore About U-Boot Image Types:
51276069ff26Swdenk------------------------------
51286069ff26Swdenk
51296069ff26SwdenkU-Boot supports the following image types:
51306069ff26Swdenk
51316069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
51326069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
51336069ff26Swdenk	well) you can continue to work in U-Boot after return from
51346069ff26Swdenk	the Standalone Program.
51356069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
51366069ff26Swdenk	will take over control completely. Usually these programs
51376069ff26Swdenk	will install their own set of exception handlers, device
51386069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
51396069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
51406069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
51416069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
51426069ff26Swdenk	being started.
51436069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
51446069ff26Swdenk	(Linux) kernel image and one or more data images like
51456069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
51466069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
51476069ff26Swdenk	server provides just a single image file, but you want to get
51486069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
51496069ff26Swdenk
51506069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
51516069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
51526069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
51536069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
51546069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
51556069ff26Swdenk	a multiple of 4 bytes).
51566069ff26Swdenk
51576069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
51586069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
51596069ff26Swdenk	flash memory.
51606069ff26Swdenk
51616069ff26Swdenk   "Script files" are command sequences that will be executed by
51626069ff26Swdenk	U-Boot's command interpreter; this feature is especially
51636069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
51646069ff26Swdenk	as command interpreter.
51656069ff26Swdenk
516644f074c7SMarek VasutBooting the Linux zImage:
516744f074c7SMarek Vasut-------------------------
516844f074c7SMarek Vasut
516944f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
517044f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
517144f074c7SMarek Vasutas the syntax of "bootm" command.
517244f074c7SMarek Vasut
51738ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5174017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5175017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5176017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5177017e1f3fSMarek Vasut
5178c609719bSwdenk
5179c609719bSwdenkStandalone HOWTO:
5180c609719bSwdenk=================
5181c609719bSwdenk
5182c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5183c609719bSwdenkrun "standalone" applications, which can use some resources of
5184c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5185c609719bSwdenk
5186c609719bSwdenkTwo simple examples are included with the sources:
5187c609719bSwdenk
5188c609719bSwdenk"Hello World" Demo:
5189c609719bSwdenk-------------------
5190c609719bSwdenk
5191c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5192c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5193c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5194c609719bSwdenklike that:
5195c609719bSwdenk
5196c609719bSwdenk	=> loads
5197c609719bSwdenk	## Ready for S-Record download ...
5198c609719bSwdenk	~>examples/hello_world.srec
5199c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5200c609719bSwdenk	[file transfer complete]
5201c609719bSwdenk	[connected]
5202c609719bSwdenk	## Start Addr = 0x00040004
5203c609719bSwdenk
5204c609719bSwdenk	=> go 40004 Hello World! This is a test.
5205c609719bSwdenk	## Starting application at 0x00040004 ...
5206c609719bSwdenk	Hello World
5207c609719bSwdenk	argc = 7
5208c609719bSwdenk	argv[0] = "40004"
5209c609719bSwdenk	argv[1] = "Hello"
5210c609719bSwdenk	argv[2] = "World!"
5211c609719bSwdenk	argv[3] = "This"
5212c609719bSwdenk	argv[4] = "is"
5213c609719bSwdenk	argv[5] = "a"
5214c609719bSwdenk	argv[6] = "test."
5215c609719bSwdenk	argv[7] = "<NULL>"
5216c609719bSwdenk	Hit any key to exit ...
5217c609719bSwdenk
5218c609719bSwdenk	## Application terminated, rc = 0x0
5219c609719bSwdenk
5220c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5221c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5222c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5223c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5224c609719bSwdenkcharacter, but this is just a demo program. The application can be
5225c609719bSwdenkcontrolled by the following keys:
5226c609719bSwdenk
5227c609719bSwdenk	? - print current values og the CPM Timer registers
5228c609719bSwdenk	b - enable interrupts and start timer
5229c609719bSwdenk	e - stop timer and disable interrupts
5230c609719bSwdenk	q - quit application
5231c609719bSwdenk
5232c609719bSwdenk	=> loads
5233c609719bSwdenk	## Ready for S-Record download ...
5234c609719bSwdenk	~>examples/timer.srec
5235c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5236c609719bSwdenk	[file transfer complete]
5237c609719bSwdenk	[connected]
5238c609719bSwdenk	## Start Addr = 0x00040004
5239c609719bSwdenk
5240c609719bSwdenk	=> go 40004
5241c609719bSwdenk	## Starting application at 0x00040004 ...
5242c609719bSwdenk	TIMERS=0xfff00980
5243c609719bSwdenk	Using timer 1
5244c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5245c609719bSwdenk
5246c609719bSwdenkHit 'b':
5247c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5248c609719bSwdenk	Enabling timer
5249c609719bSwdenkHit '?':
5250c609719bSwdenk	[q, b, e, ?] ........
5251c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5252c609719bSwdenkHit '?':
5253c609719bSwdenk	[q, b, e, ?] .
5254c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5255c609719bSwdenkHit '?':
5256c609719bSwdenk	[q, b, e, ?] .
5257c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5258c609719bSwdenkHit '?':
5259c609719bSwdenk	[q, b, e, ?] .
5260c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5261c609719bSwdenkHit 'e':
5262c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5263c609719bSwdenkHit 'q':
5264c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5265c609719bSwdenk
5266c609719bSwdenk
526785ec0bccSwdenkMinicom warning:
526885ec0bccSwdenk================
526985ec0bccSwdenk
52707152b1d0SwdenkOver time, many people have reported problems when trying to use the
527185ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
527285ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5273f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
527485ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5275e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5276e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5277e53515a2SKarl O. Pincfor help with kermit.
5278e53515a2SKarl O. Pinc
527985ec0bccSwdenk
528052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
528152f52c14Swdenkconfiguration to your "File transfer protocols" section:
528252f52c14Swdenk
528352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
528452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
528552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
528652f52c14Swdenk
528752f52c14Swdenk
5288c609719bSwdenkNetBSD Notes:
5289c609719bSwdenk=============
5290c609719bSwdenk
5291c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5292c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5293c609719bSwdenk
5294c609719bSwdenkBuilding requires a cross environment; it is known to work on
5295c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5296c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5297c609719bSwdenkNote that the cross-powerpc package does not install include files;
5298c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5299c609719bSwdenkmissing.  This file has to be installed and patched manually:
5300c609719bSwdenk
5301c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5302c609719bSwdenk	# mkdir powerpc
5303c609719bSwdenk	# ln -s powerpc machine
5304c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5305c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5306c609719bSwdenk
5307c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5308c609719bSwdenkand U-Boot include files.
5309c609719bSwdenk
5310c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5311c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5312c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5313c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
53142a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5315c609719bSwdenk
5316c609719bSwdenk
5317c609719bSwdenkImplementation Internals:
5318c609719bSwdenk=========================
5319c609719bSwdenk
5320c609719bSwdenkThe following is not intended to be a complete description of every
5321c609719bSwdenkimplementation detail. However, it should help to understand the
5322c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5323c609719bSwdenkhardware.
5324c609719bSwdenk
5325c609719bSwdenk
5326c609719bSwdenkInitial Stack, Global Data:
5327c609719bSwdenk---------------------------
5328c609719bSwdenk
5329c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5330c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5331c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5332c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5333c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5334c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5335c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5336c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5337c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5338c609719bSwdenklocked as (mis-) used as memory, etc.
5339c609719bSwdenk
53407152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
53410668236bSWolfgang Denk	U-Boot mailing list:
534243d9616cSwdenk
534343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
534443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
534543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
534643d9616cSwdenk	...
534743d9616cSwdenk
534843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
534943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
535043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
535143d9616cSwdenk	is that the cache is being used as a temporary supply of
535243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
535311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
535443d9616cSwdenk	can see how this works by studying the cache architecture and
535543d9616cSwdenk	operation in the architecture and processor-specific manuals.
535643d9616cSwdenk
535743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
535843d9616cSwdenk	is another option for the system designer to use as an
535911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
536043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
536143d9616cSwdenk	board designers haven't used it for something that would
536243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
536343d9616cSwdenk	used.
536443d9616cSwdenk
53656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
536643d9616cSwdenk	with your processor/board/system design. The default value
536743d9616cSwdenk	you will find in any recent u-boot distribution in
53688a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
536943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
537043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
537143d9616cSwdenk	that are supposed to respond to that address! That code in
537243d9616cSwdenk	start.S has been around a while and should work as is when
537343d9616cSwdenk	you get the config right.
537443d9616cSwdenk
537543d9616cSwdenk	-Chris Hallinan
537643d9616cSwdenk	DS4.COM, Inc.
537743d9616cSwdenk
5378c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5379c609719bSwdenkcode for the initialization procedures:
5380c609719bSwdenk
5381c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5382c609719bSwdenk  to write it.
5383c609719bSwdenk
538411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5385c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
53867152b1d0Swdenk  zation is performed later (when relocating to RAM).
5387c609719bSwdenk
5388c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5389c609719bSwdenk  that.
5390c609719bSwdenk
5391c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5392c609719bSwdenknormal global data to share information beween the code. But it
5393c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5394c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5395c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5396c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5397c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5398c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5399c609719bSwdenkreserve for this purpose.
5400c609719bSwdenk
54017152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5402c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5403c609719bSwdenkGCC's implementation.
5404c609719bSwdenk
5405c609719bSwdenkFor PowerPC, the following registers have specific use:
5406c609719bSwdenk	R1:	stack pointer
5407e7670f6cSWolfgang Denk	R2:	reserved for system use
5408c609719bSwdenk	R3-R4:	parameter passing and return values
5409c609719bSwdenk	R5-R10: parameter passing
5410c609719bSwdenk	R13:	small data area pointer
5411c609719bSwdenk	R30:	GOT pointer
5412c609719bSwdenk	R31:	frame pointer
5413c609719bSwdenk
5414e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5415e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5416e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5417c609719bSwdenk
5418e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5419c609719bSwdenk
5420c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5421c609719bSwdenk    address of the global data structure is known at compile time),
5422c609719bSwdenk    but it turned out that reserving a register results in somewhat
5423c609719bSwdenk    smaller code - although the code savings are not that big (on
5424c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5425c609719bSwdenk    624 text + 127 data).
5426c609719bSwdenk
5427c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
54284c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
54294c58eb55SMike Frysinger
5430c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
54314c58eb55SMike Frysinger
5432c609719bSwdenkOn ARM, the following registers are used:
5433c609719bSwdenk
5434c609719bSwdenk	R0:	function argument word/integer result
5435c609719bSwdenk	R1-R3:	function argument word
5436c609719bSwdenk	R9:	GOT pointer
5437c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5438c609719bSwdenk	R11:	argument (frame) pointer
5439c609719bSwdenk	R12:	temporary workspace
5440c609719bSwdenk	R13:	stack pointer
5441c609719bSwdenk	R14:	link register
5442c609719bSwdenk	R15:	program counter
5443c609719bSwdenk
5444c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5445c609719bSwdenk
54460df01fd3SThomas ChouOn Nios II, the ABI is documented here:
54470df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
54480df01fd3SThomas Chou
54490df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
54500df01fd3SThomas Chou
54510df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
54520df01fd3SThomas Chou    to access small data sections, so gp is free.
54530df01fd3SThomas Chou
5454afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5455afc1ce82SMacpaul Lin
5456afc1ce82SMacpaul Lin	R0-R1:	argument/return
5457afc1ce82SMacpaul Lin	R2-R5:	argument
5458afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5459afc1ce82SMacpaul Lin	R16:	trampoline register
5460afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5461afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5462afc1ce82SMacpaul Lin	R30:	link register (LP)
5463afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5464afc1ce82SMacpaul Lin	PC:	program counter (PC)
5465afc1ce82SMacpaul Lin
5466afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5467afc1ce82SMacpaul Lin
5468d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5469d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5470c609719bSwdenk
5471c609719bSwdenkMemory Management:
5472c609719bSwdenk------------------
5473c609719bSwdenk
5474c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5475c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5476c609719bSwdenk
5477c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5478c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5479c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5480c609719bSwdenkphysical memory banks.
5481c609719bSwdenk
5482c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5483c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5484c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5485c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
54866d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5487c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5488c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5489c609719bSwdenk
5490c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5491c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5492c609719bSwdenk
5493c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5494c609719bSwdenkthis:
5495c609719bSwdenk
5496c609719bSwdenk	0x0000 0000	Exception Vector code
5497c609719bSwdenk	      :
5498c609719bSwdenk	0x0000 1FFF
5499c609719bSwdenk	0x0000 2000	Free for Application Use
5500c609719bSwdenk	      :
5501c609719bSwdenk	      :
5502c609719bSwdenk
5503c609719bSwdenk	      :
5504c609719bSwdenk	      :
5505c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5506c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5507c609719bSwdenk	0x00FC 0000	Malloc Arena
5508c609719bSwdenk	      :
5509c609719bSwdenk	0x00FD FFFF
5510c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5511c609719bSwdenk	...		eventually: LCD or video framebuffer
5512c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5513c609719bSwdenk	0x00FF FFFF	[End of RAM]
5514c609719bSwdenk
5515c609719bSwdenk
5516c609719bSwdenkSystem Initialization:
5517c609719bSwdenk----------------------
5518c609719bSwdenk
5519c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
552011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5521c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
55227152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5523c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5524c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5525c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5526c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5527c609719bSwdenkthe caches and the SIU.
5528c609719bSwdenk
5529c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5530c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5531c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5532c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5533c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5534c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5535c609719bSwdenkbanks.
5536c609719bSwdenk
5537c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
55387152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5539c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5540c609719bSwdenk0x00000000, with any additional banks following immediately to create
5541c609719bSwdenkcontiguous memory starting from 0.
5542c609719bSwdenk
5543c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5544c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5545c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5546c609719bSwdenkpages, and the final stack is set up.
5547c609719bSwdenk
5548c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5549c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5550c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5551c609719bSwdenknew address in RAM.
5552c609719bSwdenk
5553c609719bSwdenk
5554c609719bSwdenkU-Boot Porting Guide:
5555c609719bSwdenk----------------------
5556c609719bSwdenk
5557c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
55586aff3115Swdenklist, October 2002]
5559c609719bSwdenk
5560c609719bSwdenk
5561c609719bSwdenkint main(int argc, char *argv[])
5562c609719bSwdenk{
5563c609719bSwdenk	sighandler_t no_more_time;
5564c609719bSwdenk
5565c609719bSwdenk	signal(SIGALRM, no_more_time);
5566c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5567c609719bSwdenk
5568c609719bSwdenk	if (available_money > available_manpower) {
55696c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5570c609719bSwdenk		return 0;
5571c609719bSwdenk	}
5572c609719bSwdenk
5573c609719bSwdenk	Download latest U-Boot source;
5574c609719bSwdenk
55750668236bSWolfgang Denk	Subscribe to u-boot mailing list;
55766aff3115Swdenk
55776c3fef28SJerry Van Baren	if (clueless)
5578c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5579c609719bSwdenk
5580c609719bSwdenk	while (learning) {
5581c609719bSwdenk		Read the README file in the top level directory;
55827cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
55836c3fef28SJerry Van Baren		Read applicable doc/*.README;
5584c609719bSwdenk		Read the source, Luke;
55856c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5586c609719bSwdenk	}
5587c609719bSwdenk
55886c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
55896c3fef28SJerry Van Baren		Buy a BDI3000;
55906c3fef28SJerry Van Baren	else
5591c609719bSwdenk		Add a lot of aggravation and time;
5592c609719bSwdenk
55936c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
55946c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
55956c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
55966c3fef28SJerry Van Baren	} else {
5597c609719bSwdenk		Create your own board support subdirectory;
55986c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
55996c3fef28SJerry Van Baren	}
56006c3fef28SJerry Van Baren	Edit new board/<myboard> files
56016c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5602c609719bSwdenk
56036c3fef28SJerry Van Baren	while (!accepted) {
5604c609719bSwdenk		while (!running) {
5605c609719bSwdenk			do {
5606c609719bSwdenk				Add / modify source code;
5607c609719bSwdenk			} until (compiles);
5608c609719bSwdenk			Debug;
5609c609719bSwdenk			if (clueless)
5610c609719bSwdenk				email("Hi, I am having problems...");
5611c609719bSwdenk		}
56126c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
56136c3fef28SJerry Van Baren		if (reasonable critiques)
56146c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
56156c3fef28SJerry Van Baren		else
56166c3fef28SJerry Van Baren			Defend code as written;
56176c3fef28SJerry Van Baren	}
5618c609719bSwdenk
5619c609719bSwdenk	return 0;
5620c609719bSwdenk}
5621c609719bSwdenk
5622c609719bSwdenkvoid no_more_time (int sig)
5623c609719bSwdenk{
5624c609719bSwdenk      hire_a_guru();
5625c609719bSwdenk}
5626c609719bSwdenk
5627c609719bSwdenk
5628c609719bSwdenkCoding Standards:
5629c609719bSwdenk-----------------
5630c609719bSwdenk
5631c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
56322c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
56337ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5634c609719bSwdenk
56352c051651SDetlev ZundelSource files originating from a different project (for example the
56362c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
56372c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
56382c051651SDetlev Zundelsources.
56392c051651SDetlev Zundel
56402c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
56412c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
56422c051651SDetlev Zundelin your code.
5643c609719bSwdenk
5644c178d3daSwdenkPlease also stick to the following formatting rules:
5645180d3f74Swdenk- remove any trailing white space
56467ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5647180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
56487ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5649180d3f74Swdenk- do not add trailing empty lines to source files
5650180d3f74Swdenk
5651c609719bSwdenkSubmissions which do not conform to the standards may be returned
5652c609719bSwdenkwith a request to reformat the changes.
5653c609719bSwdenk
5654c609719bSwdenk
5655c609719bSwdenkSubmitting Patches:
5656c609719bSwdenk-------------------
5657c609719bSwdenk
5658c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5659c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5660c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5661c609719bSwdenk
56620d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5663218ca724SWolfgang Denk
56640668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
56650668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
56660668236bSWolfgang Denk
5667c609719bSwdenkWhen you send a patch, please include the following information with
5668c609719bSwdenkit:
5669c609719bSwdenk
5670c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5671c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5672c609719bSwdenk  patch actually fixes something.
5673c609719bSwdenk
5674c609719bSwdenk* For new features: a description of the feature and your
5675c609719bSwdenk  implementation.
5676c609719bSwdenk
5677c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5678c609719bSwdenk
5679c609719bSwdenk* For major contributions, your entry to the CREDITS file
5680c609719bSwdenk
5681c609719bSwdenk* When you add support for a new board, don't forget to add this
56827ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5683c609719bSwdenk
5684c609719bSwdenk* If your patch adds new configuration options, don't forget to
5685c609719bSwdenk  document these in the README file.
5686c609719bSwdenk
5687218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5688218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
56897ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5690218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5691218ca724SWolfgang Denk  with some other mail clients.
5692c609719bSwdenk
5693218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5694218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5695218ca724SWolfgang Denk  GNU diff.
56966dff5529Swdenk
5697218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5698218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5699218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5700218ca724SWolfgang Denk  affected files).
5701218ca724SWolfgang Denk
5702218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5703218ca724SWolfgang Denk  and compressed attachments must not be used.
5704c609719bSwdenk
570552f52c14Swdenk* If one logical set of modifications affects or creates several
570652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
570752f52c14Swdenk
570852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
570952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
571052f52c14Swdenk
571152f52c14Swdenk
5712c609719bSwdenkNotes:
5713c609719bSwdenk
5714c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5715c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5716c609719bSwdenk  for any of the boards.
5717c609719bSwdenk
5718c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5719c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5720c609719bSwdenk  returned with a request to re-formatting / split it.
5721c609719bSwdenk
5722c609719bSwdenk* If you modify existing code, make sure that your new code does not
5723c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5724c609719bSwdenk  When adding new features, these should compile conditionally only
5725c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5726c609719bSwdenk  disabled must not need more memory than the old code without your
5727c609719bSwdenk  modification.
572890dc6704Swdenk
57290668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
57300668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
57310668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
57320668236bSWolfgang Denk  bigger than the size limit should be avoided.
5733