xref: /openbmc/u-boot/README (revision 00f792e0df9ae942427e44595a0f4379582accee)
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
425765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
427765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
428765b0bdbSPriyanka Jain
429765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
431765b0bdbSPriyanka 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
8574d98b5c8SVincent Stehlé		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
8674d98b5c8SVincent Stehlé		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
8754d98b5c8SVincent Stehlé		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
8804d98b5c8SVincent Stehlé		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
8854d98b5c8SVincent Stehlé		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
8924d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
893e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
894e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
895602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
896602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
897602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
898602ad3b3SJon Loeliger					  host
899602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
900ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
901602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
902602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
903d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
904602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
905602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
906602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
907602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
908602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
909602ad3b3SJon Loeliger					  (4xx only)
910f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
9114d98b5c8SVincent Stehlé		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
91202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
9137d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
91474de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
915602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
9167a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
9171fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
918da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
919da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
920602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
921602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
922c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
9234d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
924c609719bSwdenk
925c609719bSwdenk
926c609719bSwdenk		EXAMPLE: If you want all functions except of network
927c609719bSwdenk		support you can write:
928c609719bSwdenk
929602ad3b3SJon Loeliger		#include "config_cmd_all.h"
930602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
931c609719bSwdenk
932213bf8c8SGerald Van Baren	Other Commands:
933213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
934c609719bSwdenk
935c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
936602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
937c609719bSwdenk		what you (and your U-Boot users) are doing. Data
938c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
939c609719bSwdenk		8260 (where accesses to the IMMR region must be
940c609719bSwdenk		uncached), and it cannot be disabled on all other
941c609719bSwdenk		systems where we (mis-) use the data cache to hold an
942c609719bSwdenk		initial stack and some data.
943c609719bSwdenk
944c609719bSwdenk
945c609719bSwdenk		XXX - this list needs to get updated!
946c609719bSwdenk
947a5ecbe62SWolfgang Denk- Regular expression support:
948a5ecbe62SWolfgang Denk		CONFIG_REGEX
949a5ecbe62SWolfgang Denk                If this variable is defined, U-Boot is linked against
950a5ecbe62SWolfgang Denk                the SLRE (Super Light Regular Expression) library,
951a5ecbe62SWolfgang Denk                which adds regex support to some commands, as for
952a5ecbe62SWolfgang Denk                example "env grep" and "setexpr".
953a5ecbe62SWolfgang Denk
95445ba8077SSimon Glass- Device tree:
95545ba8077SSimon Glass		CONFIG_OF_CONTROL
95645ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
95745ba8077SSimon Glass		to configure its devices, instead of relying on statically
95845ba8077SSimon Glass		compiled #defines in the board file. This option is
95945ba8077SSimon Glass		experimental and only available on a few boards. The device
96045ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
96145ba8077SSimon Glass
9622c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
9632c0f79e4SSimon Glass		be done using one of the two options below:
964bbb0b128SSimon Glass
965bbb0b128SSimon Glass		CONFIG_OF_EMBED
966bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
967bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
968bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
969bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
970bbb0b128SSimon Glass		the global data structure as gd->blob.
97145ba8077SSimon Glass
9722c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9732c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9742c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9752c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9762c0f79e4SSimon Glass
9772c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9782c0f79e4SSimon Glass
9792c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9802c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9812c0f79e4SSimon Glass		still use the individual files if you need something more
9822c0f79e4SSimon Glass		exotic.
9832c0f79e4SSimon Glass
984c609719bSwdenk- Watchdog:
985c609719bSwdenk		CONFIG_WATCHDOG
986c609719bSwdenk		If this variable is defined, it enables watchdog
9876abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9886abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
9896abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9906abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9916abe6fb6SDetlev Zundel		available, then no further board specific code should
9926abe6fb6SDetlev Zundel		be needed to use it.
9936abe6fb6SDetlev Zundel
9946abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9956abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9966abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9976abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
998c609719bSwdenk
999c1551ea8Sstroese- U-Boot Version:
1000c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
1001c1551ea8Sstroese		If this variable is defined, an environment variable
1002c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
1003c1551ea8Sstroese		version as printed by the "version" command.
1004a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
1005a1ea8e51SBenoît Thébaudeau		next reset.
1006c1551ea8Sstroese
1007c609719bSwdenk- Real-Time Clock:
1008c609719bSwdenk
1009602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
1010c609719bSwdenk		has to be selected, too. Define exactly one of the
1011c609719bSwdenk		following options:
1012c609719bSwdenk
1013c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
1014c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
10154e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
1016c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
10171cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
1018c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
10197f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
10203bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
10219536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
10224c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
10236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
102471d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
102571d19f30SHeiko Schocher					  RV3029 RTC.
1026c609719bSwdenk
1027b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
1028b37c7e5eSwdenk		must also be configured. See I2C Support, below.
1029b37c7e5eSwdenk
1030e92739d3SPeter Tyser- GPIO Support:
1031e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
1032e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
1033e92739d3SPeter Tyser
10345dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
10355dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
10365dec49caSChris Packham		pins supported by a particular chip.
10375dec49caSChris Packham
1038e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
1039e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
1040e92739d3SPeter Tyser
1041c609719bSwdenk- Timestamp Support:
1042c609719bSwdenk
1043c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1044c609719bSwdenk		(date and time) of an image is printed by image
1045c609719bSwdenk		commands like bootm or iminfo. This option is
1046602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1047c609719bSwdenk
1048923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1049923c46f9SKarl O. Pinc		Zero or more of the following:
1050923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1051923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
1052923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
1053923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1054923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1055923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1056923c46f9SKarl O. Pinc				       disk/part_efi.c
1057923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1058c609719bSwdenk
1059602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1060218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
1061923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1062c609719bSwdenk
1063c609719bSwdenk- IDE Reset method:
10644d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10654d13cbadSwdenk		board configurations files but used nowhere!
1066c609719bSwdenk
10674d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10684d13cbadSwdenk		be performed by calling the function
10694d13cbadSwdenk			ide_set_reset(int reset)
10704d13cbadSwdenk		which has to be defined in a board specific file
1071c609719bSwdenk
1072c609719bSwdenk- ATAPI Support:
1073c609719bSwdenk		CONFIG_ATAPI
1074c609719bSwdenk
1075c609719bSwdenk		Set this to enable ATAPI support.
1076c609719bSwdenk
1077c40b2956Swdenk- LBA48 Support
1078c40b2956Swdenk		CONFIG_LBA48
1079c40b2956Swdenk
1080c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10814b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1082c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1083c40b2956Swdenk		support disks up to 2.1TB.
1084c40b2956Swdenk
10856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1086c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1087c40b2956Swdenk			Default is 32bit.
1088c40b2956Swdenk
1089c609719bSwdenk- SCSI Support:
1090c609719bSwdenk		At the moment only there is only support for the
1091c609719bSwdenk		SYM53C8XX SCSI controller; define
1092c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1093c609719bSwdenk
10946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1097c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1098c609719bSwdenk		devices.
10996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1100c609719bSwdenk
1101447c031bSStefan Reinauer                The environment variable 'scsidevs' is set to the number of
1102447c031bSStefan Reinauer                SCSI devices found during the last scan.
1103447c031bSStefan Reinauer
1104c609719bSwdenk- NETWORK Support (PCI):
1105682011ffSwdenk		CONFIG_E1000
1106ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1107ce5207e1SKyle Moffett
1108ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1109ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1110ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1111ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1112ce5207e1SKyle Moffett
1113ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1114ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1115ce5207e1SKyle Moffett		example with the "sspi" command.
1116ce5207e1SKyle Moffett
1117ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1118ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1119ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1120682011ffSwdenk
1121ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
112211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1123ac3315c2SAndre Schwarz
1124c609719bSwdenk		CONFIG_EEPRO100
1125c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
112611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1127c609719bSwdenk		write routine for first time initialisation.
1128c609719bSwdenk
1129c609719bSwdenk		CONFIG_TULIP
1130c609719bSwdenk		Support for Digital 2114x chips.
1131c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1132c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1133c609719bSwdenk
1134c609719bSwdenk		CONFIG_NATSEMI
1135c609719bSwdenk		Support for National dp83815 chips.
1136c609719bSwdenk
1137c609719bSwdenk		CONFIG_NS8382X
1138c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1139c609719bSwdenk
114045219c46Swdenk- NETWORK Support (other):
114145219c46Swdenk
1142c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1143c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1144c041e9d2SJens Scharsig
1145c041e9d2SJens Scharsig			CONFIG_RMII
1146c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1147c041e9d2SJens Scharsig
1148c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1149c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1150c041e9d2SJens Scharsig			The driver doen't show link status messages.
1151c041e9d2SJens Scharsig
1152efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1153efdd7319SRob Herring		Support for the Calxeda XGMAC device
1154efdd7319SRob Herring
11553bb46d23SAshok		CONFIG_LAN91C96
115645219c46Swdenk		Support for SMSC's LAN91C96 chips.
115745219c46Swdenk
115845219c46Swdenk			CONFIG_LAN91C96_BASE
115945219c46Swdenk			Define this to hold the physical address
116045219c46Swdenk			of the LAN91C96's I/O space
116145219c46Swdenk
116245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
116345219c46Swdenk			Define this to enable 32 bit addressing
116445219c46Swdenk
11653bb46d23SAshok		CONFIG_SMC91111
1166f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1167f39748aeSwdenk
1168f39748aeSwdenk			CONFIG_SMC91111_BASE
1169f39748aeSwdenk			Define this to hold the physical address
1170f39748aeSwdenk			of the device (I/O space)
1171f39748aeSwdenk
1172f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1173f39748aeSwdenk			Define this if data bus is 32 bits
1174f39748aeSwdenk
1175f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1176f39748aeSwdenk			Define this to use i/o functions instead of macros
1177f39748aeSwdenk			(some hardware wont work with macros)
1178f39748aeSwdenk
1179dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1180dc02badaSHeiko Schocher		Support for davinci emac
1181dc02badaSHeiko Schocher
1182dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1183dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1184dc02badaSHeiko Schocher
1185b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1186b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1187b3dbf4a5SMacpaul Lin
1188b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1189b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1190b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1191b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1192b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1193b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1194b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1195b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1196b3dbf4a5SMacpaul Lin
1197c2fff331SMike Rapoport		CONFIG_SMC911X
1198557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1199557b377dSJens Gehrlein
1200c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1201557b377dSJens Gehrlein			Define this to hold the physical address
1202557b377dSJens Gehrlein			of the device (I/O space)
1203557b377dSJens Gehrlein
1204c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1205557b377dSJens Gehrlein			Define this if data bus is 32 bits
1206557b377dSJens Gehrlein
1207c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1208557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1209557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1210c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1211557b377dSJens Gehrlein
12123d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
12133d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
12143d0075faSYoshihiro Shimoda
12153d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
12163d0075faSYoshihiro Shimoda			Define the number of ports to be used
12173d0075faSYoshihiro Shimoda
12183d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
12193d0075faSYoshihiro Shimoda			Define the ETH PHY's address
12203d0075faSYoshihiro Shimoda
122168260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
122268260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
122368260aabSYoshihiro Shimoda
12245e124724SVadim Bendebury- TPM Support:
122590899cc0SChe-liang Chiou		CONFIG_TPM
122690899cc0SChe-liang Chiou		Support TPM devices.
122790899cc0SChe-liang Chiou
12281b393db5STom Wai-Hong Tam		CONFIG_TPM_TIS_I2C
12291b393db5STom Wai-Hong Tam		Support for i2c bus TPM devices. Only one device
12301b393db5STom Wai-Hong Tam		per system is supported at this time.
12311b393db5STom Wai-Hong Tam
12321b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BUS_NUMBER
12331b393db5STom Wai-Hong Tam			Define the the i2c bus number for the TPM device
12341b393db5STom Wai-Hong Tam
12351b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
12361b393db5STom Wai-Hong Tam			Define the TPM's address on the i2c bus
12371b393db5STom Wai-Hong Tam
12381b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12391b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12401b393db5STom Wai-Hong Tam
1241c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1242c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1243c01939c7SDirk Eibach
124490899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12455e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12465e124724SVadim Bendebury		per system is supported at this time.
12475e124724SVadim Bendebury
12485e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12495e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12505e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12515e124724SVadim Bendebury			0xfed40000.
12525e124724SVadim Bendebury
1253be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1254be6c1529SReinhard Pfau		Add tpm monitor functions.
1255be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1256be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1257be6c1529SReinhard Pfau
1258be6c1529SReinhard Pfau		CONFIG_TPM
1259be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1260be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1261be6c1529SReinhard Pfau		Requires support for a TPM device.
1262be6c1529SReinhard Pfau
1263be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1264be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1265be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1266be6c1529SReinhard Pfau
1267c609719bSwdenk- USB Support:
1268c609719bSwdenk		At the moment only the UHCI host controller is
12694d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1270c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1271c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
127230d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1273c609719bSwdenk		storage devices.
1274c609719bSwdenk		Note:
1275c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1276c609719bSwdenk		(TEAC FD-05PUB).
12774d13cbadSwdenk		MPC5200 USB requires additional defines:
12784d13cbadSwdenk			CONFIG_USB_CLOCK
12794d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1280307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1281307ecb6dSEric Millbrandt				for USB on PSC3
12824d13cbadSwdenk			CONFIG_USB_CONFIG
12834d13cbadSwdenk				for differential drivers: 0x00001000
12844d13cbadSwdenk				for single ended drivers: 0x00005000
1285307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1286307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1288fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1289fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12904d13cbadSwdenk
12919ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12929ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12939ab4ce22SSimon Glass
1294aa155058SKuo-Jung Su		CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum
1295aa155058SKuo-Jung Su		interval for usb hub power-on delay.(minimum 100msec)
1296aa155058SKuo-Jung Su
129716c8d5e7SWolfgang Denk- USB Device:
129816c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
129916c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
130016c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
130111ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
130216c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
130316c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
130416c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
130516c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
130616c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
130716c8d5e7SWolfgang Denk		a Linux host by
130816c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
130916c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
131016c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
131116c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
131216c8d5e7SWolfgang Denk
131316c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
131416c8d5e7SWolfgang Denk			Define this to build a UDC device
131516c8d5e7SWolfgang Denk
131616c8d5e7SWolfgang Denk			CONFIG_USB_TTY
131716c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
131816c8d5e7SWolfgang Denk			talk to the UDC device
131916c8d5e7SWolfgang Denk
1320f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1321f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1322f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1323f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1324f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1325f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1326f9da0f89SVipin KUMAR			speed.
1327f9da0f89SVipin KUMAR
13286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
132916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
133016c8d5e7SWolfgang Denk			be set to usbtty.
133116c8d5e7SWolfgang Denk
133216c8d5e7SWolfgang Denk			mpc8xx:
13336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
133416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
13356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
133616c8d5e7SWolfgang Denk
13376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
133816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
13396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
134016c8d5e7SWolfgang Denk
134116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
134216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
134316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
134416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
134516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
134616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
134716c8d5e7SWolfgang Denk
134816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
134916c8d5e7SWolfgang Denk			Define this string as the name of your company for
135016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
135116c8d5e7SWolfgang Denk
135216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
135316c8d5e7SWolfgang Denk			Define this string as the name of your product
135416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
135516c8d5e7SWolfgang Denk
135616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
135716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
135816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
135916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
136016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
136116c8d5e7SWolfgang Denk
136216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
136316c8d5e7SWolfgang Denk			Define this as the unique Product ID
136416c8d5e7SWolfgang Denk			for your device
136516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1366c609719bSwdenk
1367d70a560fSIgor Grinberg- ULPI Layer Support:
1368d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1369d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1370d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1371d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1372d70a560fSIgor Grinberg		viewport is supported.
1373d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1374d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13756d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13766d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13776d365ea0SLucas Stach		the appropriate value in Hz.
1378c609719bSwdenk
1379c609719bSwdenk- MMC Support:
1380c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1381c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1382c609719bSwdenk		accessed from the boot prompt by mapping the device
1383c609719bSwdenk		to physical memory similar to flash. Command line is
1384602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1385602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1386c609719bSwdenk
1387afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1388afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1389afb35666SYoshihiro Shimoda
1390afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1391afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1392afb35666SYoshihiro Shimoda
1393afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1394afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1395afb35666SYoshihiro Shimoda
1396b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
1397b3ba6e94STom Rini		CONFIG_DFU_FUNCTION
1398b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1399b3ba6e94STom Rini
1400b3ba6e94STom Rini		CONFIG_CMD_DFU
1401b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1402b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1403b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1404b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1405b3ba6e94STom Rini
1406b3ba6e94STom Rini		CONFIG_DFU_MMC
1407b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1408b3ba6e94STom Rini
1409c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1410c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1411c6631764SPantelis Antoniou
1412e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1413e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1414e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1415e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1416e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1417e7e75c70SHeiko Schocher
1418ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1419ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1420ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1421ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1422ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1423ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1424ea2453d5SPantelis Antoniou
14256705d81eSwdenk- Journaling Flash filesystem support:
14266705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
14276705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
14286705d81eSwdenk		Define these for a default partition on a NAND device
14296705d81eSwdenk
14306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14326705d81eSwdenk		Define these for a default partition on a NOR device
14336705d81eSwdenk
14346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
14356705d81eSwdenk		Define this to create an own partition. You have to provide a
14366705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
14376705d81eSwdenk
14386705d81eSwdenk		If you define only one JFFS2 partition you may also want to
14396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
14406705d81eSwdenk		to disable the command chpart. This is the default when you
14416705d81eSwdenk		have not defined a custom partition
14426705d81eSwdenk
1443c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1444c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1445656f4c65SDonggeun Kim
1446656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1447656f4c65SDonggeun Kim		file in FAT formatted partition.
1448656f4c65SDonggeun Kim
1449656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1450656f4c65SDonggeun Kim		user to write files to FAT.
1451c30a15e5SDonggeun Kim
145284cd9327SGabe BlackCBFS (Coreboot Filesystem) support
145384cd9327SGabe Black		CONFIG_CMD_CBFS
145484cd9327SGabe Black
145584cd9327SGabe Black		Define this to enable support for reading from a Coreboot
145684cd9327SGabe Black		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
145784cd9327SGabe Black		and cbfsload.
145884cd9327SGabe Black
1459c609719bSwdenk- Keyboard Support:
1460c609719bSwdenk		CONFIG_ISA_KEYBOARD
1461c609719bSwdenk
1462c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1463c609719bSwdenk		support
1464c609719bSwdenk
1465c609719bSwdenk		CONFIG_I8042_KBD
1466c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1467c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1468c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1469c609719bSwdenk		for cfb_console. Supports cursor blinking.
1470c609719bSwdenk
1471713cb680SHung-ying Tyan		CONFIG_CROS_EC_KEYB
1472713cb680SHung-ying Tyan		Enables a Chrome OS keyboard using the CROS_EC interface.
1473713cb680SHung-ying Tyan		This uses CROS_EC to communicate with a second microcontroller
1474713cb680SHung-ying Tyan		which provides key scans on request.
1475713cb680SHung-ying Tyan
1476c609719bSwdenk- Video support:
1477c609719bSwdenk		CONFIG_VIDEO
1478c609719bSwdenk
1479c609719bSwdenk		Define this to enable video support (for output to
1480c609719bSwdenk		video).
1481c609719bSwdenk
1482c609719bSwdenk		CONFIG_VIDEO_CT69000
1483c609719bSwdenk
1484c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1485c609719bSwdenk
1486c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1487eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1488eeb1b77bSwdenk		video output is selected via environment 'videoout'
1489eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1490eeb1b77bSwdenk		assumed.
1491c609719bSwdenk
1492eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
149311ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1494eeb1b77bSwdenk		are possible:
1495eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1496eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1497eeb1b77bSwdenk
1498eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1499eeb1b77bSwdenk		-------------+---------------------------------------------
1500eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1501eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1502eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1503eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1504eeb1b77bSwdenk		-------------+---------------------------------------------
1505c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1506c609719bSwdenk
1507eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
15087817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1509eeb1b77bSwdenk
1510eeb1b77bSwdenk
1511a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1512a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1513a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1514a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1515a6c7ad2fSwdenk
15167d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
15177d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
15187d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
15197d3053fbSTimur Tabi		support, and should also define these other macros:
15207d3053fbSTimur Tabi
15217d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
15227d3053fbSTimur Tabi			CONFIG_VIDEO
15237d3053fbSTimur Tabi			CONFIG_CMD_BMP
15247d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
15257d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
15267d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
15277d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
15287d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
15297d3053fbSTimur Tabi
1530ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1531ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1532ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1533ba8e76bdSTimur Tabi		description of this variable.
15347d3053fbSTimur Tabi
1535058d59b0SSimon Glass		CONFIG_VIDEO_VGA
1536058d59b0SSimon Glass
1537058d59b0SSimon Glass		Enable the VGA video / BIOS for x86. The alternative if you
1538058d59b0SSimon Glass		are using coreboot is to use the coreboot frame buffer
1539058d59b0SSimon Glass		driver.
1540058d59b0SSimon Glass
1541058d59b0SSimon Glass
1542682011ffSwdenk- Keyboard Support:
1543682011ffSwdenk		CONFIG_KEYBOARD
1544682011ffSwdenk
1545682011ffSwdenk		Define this to enable a custom keyboard support.
1546682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1547682011ffSwdenk		defined in your board-specific files.
1548682011ffSwdenk		The only board using this so far is RBC823.
1549a6c7ad2fSwdenk
1550c609719bSwdenk- LCD Support:	CONFIG_LCD
1551c609719bSwdenk
1552c609719bSwdenk		Define this to enable LCD support (for output to LCD
1553c609719bSwdenk		display); also select one of the supported displays
1554c609719bSwdenk		by defining one of these:
1555c609719bSwdenk
155639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
155739cf4804SStelian Pop
155839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
155939cf4804SStelian Pop
1560fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1561c609719bSwdenk
1562fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1563c609719bSwdenk
1564fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1565c609719bSwdenk
1566fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1567fd3103bbSwdenk			Active, color, single scan.
1568fd3103bbSwdenk
1569fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1570fd3103bbSwdenk
1571fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1572c609719bSwdenk			Active, color, single scan.
1573c609719bSwdenk
1574c609719bSwdenk		CONFIG_SHARP_16x9
1575c609719bSwdenk
1576c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1577c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1578c609719bSwdenk
1579c609719bSwdenk		CONFIG_SHARP_LQ64D341
1580c609719bSwdenk
1581c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1582c609719bSwdenk			Active, color, single scan.
1583c609719bSwdenk
1584c609719bSwdenk		CONFIG_HLD1045
1585c609719bSwdenk
1586c609719bSwdenk			HLD1045 display, 640x480.
1587c609719bSwdenk			Active, color, single scan.
1588c609719bSwdenk
1589c609719bSwdenk		CONFIG_OPTREX_BW
1590c609719bSwdenk
1591c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1592c609719bSwdenk			or
1593c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1594c609719bSwdenk			or
1595c609719bSwdenk			Hitachi	 SP14Q002
1596c609719bSwdenk
1597c609719bSwdenk			320x240. Black & white.
1598c609719bSwdenk
1599c609719bSwdenk		Normally display is black on white background; define
16006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1601c609719bSwdenk
1602676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1603676d319eSSimon Glass
1604676d319eSSimon Glass		Normally the LCD is page-aligned (tyically 4KB). If this is
1605676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1606676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1607676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1608676d319eSSimon Glass		a per-section basis.
1609676d319eSSimon Glass
16100d89efefSSimon Glass		CONFIG_CONSOLE_SCROLL_LINES
16110d89efefSSimon Glass
16120d89efefSSimon Glass		When the console need to be scrolled, this is the number of
16130d89efefSSimon Glass		lines to scroll by. It defaults to 1. Increasing this makes
16140d89efefSSimon Glass		the console jump but can help speed up operation when scrolling
16150d89efefSSimon Glass		is slow.
1616676d319eSSimon Glass
161745d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
161845d7f525STom Wai-Hong Tam
161945d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
162045d7f525STom Wai-Hong Tam
1621735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1622735987c5STom Wai-Hong Tam
1623735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1624735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1625735987c5STom Wai-Hong Tam
16267152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1627d791b1dcSwdenk
1628d791b1dcSwdenk		If this option is set, the environment is checked for
1629d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1630d791b1dcSwdenk		of logo, copyright and system information on the LCD
1631e94d2cd9Swdenk		is suppressed and the BMP image at the address
1632d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1633d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1634d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1635d791b1dcSwdenk		loaded very quickly after power-on.
1636d791b1dcSwdenk
1637c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1638c0880485SNikita Kiryanov
1639c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1640c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1641c0880485SNikita Kiryanov		(see README.displaying-bmps and README.arm-unaligned-accesses).
1642c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1643c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1644c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1645c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1646c0880485SNikita Kiryanov		there is no need to set this option.
1647c0880485SNikita Kiryanov
16481ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16491ca298ceSMatthias Weisser
16501ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16511ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16521ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16531ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16541ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16551ca298ceSMatthias Weisser		specify 'm' for centering the image.
16561ca298ceSMatthias Weisser
16571ca298ceSMatthias Weisser		Example:
16581ca298ceSMatthias Weisser		setenv splashpos m,m
16591ca298ceSMatthias Weisser			=> image at center of screen
16601ca298ceSMatthias Weisser
16611ca298ceSMatthias Weisser		setenv splashpos 30,20
16621ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16631ca298ceSMatthias Weisser
16641ca298ceSMatthias Weisser		setenv splashpos -10,m
16651ca298ceSMatthias Weisser			=> vertically centered image
16661ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16671ca298ceSMatthias Weisser
166898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
166998f4a3dfSStefan Roese
167098f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
167198f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
167298f4a3dfSStefan Roese		splashscreen support or the bmp command.
167398f4a3dfSStefan Roese
1674d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1675d5011762SAnatolij Gustschin
1676d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1677d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1678d5011762SAnatolij Gustschin		bmp command.
1679d5011762SAnatolij Gustschin
1680f2b96dfbSLei Wen- Do compresssing for memory range:
1681f2b96dfbSLei Wen		CONFIG_CMD_ZIP
1682f2b96dfbSLei Wen
1683f2b96dfbSLei Wen		If this option is set, it would use zlib deflate method
1684f2b96dfbSLei Wen		to compress the specified memory at its best effort.
1685f2b96dfbSLei Wen
1686c29fdfc1Swdenk- Compression support:
1687c29fdfc1Swdenk		CONFIG_BZIP2
1688c29fdfc1Swdenk
1689c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1690c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1691c29fdfc1Swdenk		compressed images are supported.
1692c29fdfc1Swdenk
1693c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1695c29fdfc1Swdenk		be at least 4MB.
1696d791b1dcSwdenk
1697fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1698fc9c1727SLuigi 'Comio' Mantellini
1699fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1700fc9c1727SLuigi 'Comio' Mantellini		images is included.
1701fc9c1727SLuigi 'Comio' Mantellini
1702fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1703fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1704fc9c1727SLuigi 'Comio' Mantellini		formula:
1705fc9c1727SLuigi 'Comio' Mantellini
1706fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1707fc9c1727SLuigi 'Comio' Mantellini
1708fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1709fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1710fc9c1727SLuigi 'Comio' Mantellini
1711fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1712fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1713fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1714fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1715fc9c1727SLuigi 'Comio' Mantellini
1716fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1717fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
17186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1719fc9c1727SLuigi 'Comio' Mantellini
172017ea1177Swdenk- MII/PHY support:
172117ea1177Swdenk		CONFIG_PHY_ADDR
172217ea1177Swdenk
172317ea1177Swdenk		The address of PHY on MII bus.
172417ea1177Swdenk
172517ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
172617ea1177Swdenk
172717ea1177Swdenk		The clock frequency of the MII bus
172817ea1177Swdenk
172917ea1177Swdenk		CONFIG_PHY_GIGE
173017ea1177Swdenk
173117ea1177Swdenk		If this option is set, support for speed/duplex
173211ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
173317ea1177Swdenk
173417ea1177Swdenk		CONFIG_PHY_RESET_DELAY
173517ea1177Swdenk
173617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
173717ea1177Swdenk		reset before any MII register access is possible.
173817ea1177Swdenk		For such PHY, set this option to the usec delay
173917ea1177Swdenk		required. (minimum 300usec for LXT971A)
174017ea1177Swdenk
174117ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
174217ea1177Swdenk
174317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
174417ea1177Swdenk		command issued before MII status register can be read
174517ea1177Swdenk
1746c609719bSwdenk- Ethernet address:
1747c609719bSwdenk		CONFIG_ETHADDR
1748c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1749c609719bSwdenk		CONFIG_ETH2ADDR
1750c609719bSwdenk		CONFIG_ETH3ADDR
1751c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1752c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1753c609719bSwdenk
175411ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
175511ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1756c609719bSwdenk		is not determined automatically.
1757c609719bSwdenk
1758c609719bSwdenk- IP address:
1759c609719bSwdenk		CONFIG_IPADDR
1760c609719bSwdenk
1761c609719bSwdenk		Define a default value for the IP address to use for
176211ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1763c609719bSwdenk		determined through e.g. bootp.
17641ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1765c609719bSwdenk
1766c609719bSwdenk- Server IP address:
1767c609719bSwdenk		CONFIG_SERVERIP
1768c609719bSwdenk
1769c609719bSwdenk		Defines a default value for the IP address of a TFTP
1770c609719bSwdenk		server to contact when using the "tftboot" command.
17711ebcd654SWolfgang Denk		(Environment variable "serverip")
1772c609719bSwdenk
177397cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
177497cfe861SRobin Getz
177597cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
177697cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
177797cfe861SRobin Getz
17781ebcd654SWolfgang Denk- Gateway IP address:
17791ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17801ebcd654SWolfgang Denk
17811ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17821ebcd654SWolfgang Denk		default router where packets to other networks are
17831ebcd654SWolfgang Denk		sent to.
17841ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17851ebcd654SWolfgang Denk
17861ebcd654SWolfgang Denk- Subnet mask:
17871ebcd654SWolfgang Denk		CONFIG_NETMASK
17881ebcd654SWolfgang Denk
17891ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
17901ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
17911ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
17921ebcd654SWolfgang Denk		forwarded through a router.
17931ebcd654SWolfgang Denk		(Environment variable "netmask")
17941ebcd654SWolfgang Denk
179553a5c424SDavid Updegraff- Multicast TFTP Mode:
179653a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
179753a5c424SDavid Updegraff
179853a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
179953a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
180011ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
180153a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
180253a5c424SDavid Updegraff		multicast group.
180353a5c424SDavid Updegraff
1804c609719bSwdenk- BOOTP Recovery Mode:
1805c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1806c609719bSwdenk
1807c609719bSwdenk		If you have many targets in a network that try to
1808c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1809c609719bSwdenk		systems send out BOOTP requests at precisely the same
1810c609719bSwdenk		moment (which would happen for instance at recovery
1811c609719bSwdenk		from a power failure, when all systems will try to
1812c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1813c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1814c609719bSwdenk		inserted before sending out BOOTP requests. The
18156c33c785SWolfgang Denk		following delays are inserted then:
1816c609719bSwdenk
1817c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1818c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1819c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1820c609719bSwdenk		4th and following
1821c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1822c609719bSwdenk
1823fe389a82Sstroese- DHCP Advanced Options:
18241fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
18251fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1826fe389a82Sstroese
18271fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
18281fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
18291fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
18301fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
18311fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
18321fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
18331fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
18341fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
18351fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
18361fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
18371fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
18381fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
18392c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1840fe389a82Sstroese
18415d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
18425d110f0aSWilson Callan		environment variable, not the BOOTP server.
1843fe389a82Sstroese
18442c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
18452c00e099SJoe Hershberger		after the configured retry count, the call will fail
18462c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
18472c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
18482c00e099SJoe Hershberger		is not available.
18492c00e099SJoe Hershberger
1850fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1851fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1852fe389a82Sstroese		than one DNS serverip is offered to the client.
1853fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1854fe389a82Sstroese		serverip will be stored in the additional environment
1855fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1856fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18571fe80d79SJon Loeliger		is defined.
1858fe389a82Sstroese
1859fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1860fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1861fe389a82Sstroese		need the hostname of the DHCP requester.
18625d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18631fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18641fe80d79SJon Loeliger		option 12 to the DHCP server.
1865fe389a82Sstroese
1866d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1867d9a2f416SAras Vaichas
1868d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1869d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1870d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1871d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1872d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1873d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1874d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1875d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1876d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1877d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1878d9a2f416SAras Vaichas		this delay.
1879d9a2f416SAras Vaichas
1880d22c338eSJoe Hershberger - Link-local IP address negotiation:
1881d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1882d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1883d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1884d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1885d22c338eSJoe Hershberger
1886d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1887d22c338eSJoe Hershberger
1888a3d991bdSwdenk - CDP Options:
1889a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1890a3d991bdSwdenk
1891a3d991bdSwdenk		The device id used in CDP trigger frames.
1892a3d991bdSwdenk
1893a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1894a3d991bdSwdenk
1895a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1896a3d991bdSwdenk		of the device.
1897a3d991bdSwdenk
1898a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1899a3d991bdSwdenk
1900a3d991bdSwdenk		A printf format string which contains the ascii name of
1901a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
190211ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1903a3d991bdSwdenk
1904a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1905a3d991bdSwdenk
1906a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1907a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1908a3d991bdSwdenk
1909a3d991bdSwdenk		CONFIG_CDP_VERSION
1910a3d991bdSwdenk
1911a3d991bdSwdenk		An ascii string containing the version of the software.
1912a3d991bdSwdenk
1913a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1914a3d991bdSwdenk
1915a3d991bdSwdenk		An ascii string containing the name of the platform.
1916a3d991bdSwdenk
1917a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1918a3d991bdSwdenk
1919a3d991bdSwdenk		A 32bit integer sent on the trigger.
1920a3d991bdSwdenk
1921a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1922a3d991bdSwdenk
1923a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1924a3d991bdSwdenk		device in .1 of milliwatts.
1925a3d991bdSwdenk
1926a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1927a3d991bdSwdenk
1928a3d991bdSwdenk		A byte containing the id of the VLAN.
1929a3d991bdSwdenk
1930c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1931c609719bSwdenk
1932c609719bSwdenk		Several configurations allow to display the current
1933c609719bSwdenk		status using a LED. For instance, the LED will blink
1934c609719bSwdenk		fast while running U-Boot code, stop blinking as
1935c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1936c609719bSwdenk		start blinking slow once the Linux kernel is running
1937c609719bSwdenk		(supported by a status LED driver in the Linux
1938c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1939c609719bSwdenk		feature in U-Boot.
1940c609719bSwdenk
1941c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1942c609719bSwdenk
1943c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1944c609719bSwdenk		on those systems that support this (optional)
1945c609719bSwdenk		feature, like the TQM8xxL modules.
1946c609719bSwdenk
19473f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1948c609719bSwdenk
19493f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19503f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19513f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19523f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19533f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19543f4978c7SHeiko Schocher		interface.
19553f4978c7SHeiko Schocher
19563f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1957ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1958ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1959ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1960ea818dbbSHeiko Schocher		    for defining speed and slave address
1961ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1962ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1963ea818dbbSHeiko Schocher		    for defining speed and slave address
1964ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1965ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1966ea818dbbSHeiko Schocher		    for defining speed and slave address
1967ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1968ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1969ea818dbbSHeiko Schocher		    for defining speed and slave address
19703f4978c7SHeiko Schocher
1971*00f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
1972*00f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
1973*00f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1974*00f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1975*00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1976*00f792e0SHeiko Schocher		    bus.
1977*00f792e0SHeiko Schocher                  - If your board supports a second fsl i2c bus, define
1978*00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1979*00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1980*00f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1981*00f792e0SHeiko Schocher		    second bus.
1982*00f792e0SHeiko Schocher
19833f4978c7SHeiko Schocher		additional defines:
19843f4978c7SHeiko Schocher
19853f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
19863f4978c7SHeiko Schocher		Hold the number of i2c busses you want to use. If you
19873f4978c7SHeiko Schocher		don't use/have i2c muxes on your i2c bus, this
19883f4978c7SHeiko Schocher		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
19893f4978c7SHeiko Schocher		omit this define.
19903f4978c7SHeiko Schocher
19913f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
19923f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
19933f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
19943f4978c7SHeiko Schocher		omit this define.
19953f4978c7SHeiko Schocher
19963f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
19973f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
19983f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
19993f4978c7SHeiko Schocher		define.
20003f4978c7SHeiko Schocher
20013f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
20023f4978c7SHeiko Schocher		hold a list of busses you want to use, only used if
20033f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20043f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20053f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20063f4978c7SHeiko Schocher
20073f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20083f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20093f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20103f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20113f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20123f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20133f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20143f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20153f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20163f4978c7SHeiko Schocher					}
20173f4978c7SHeiko Schocher
20183f4978c7SHeiko Schocher		which defines
20193f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2020ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2021ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2022ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2023ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2024ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20253f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2026ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2027ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20283f4978c7SHeiko Schocher
20293f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20303f4978c7SHeiko Schocher
2031ea818dbbSHeiko Schocher- Legacy I2C Support:	CONFIG_HARD_I2C
20323f4978c7SHeiko Schocher
20333f4978c7SHeiko Schocher		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
20343f4978c7SHeiko Schocher		provides the following compelling advantages:
20353f4978c7SHeiko Schocher
20363f4978c7SHeiko Schocher		- more than one i2c adapter is usable
20373f4978c7SHeiko Schocher		- approved multibus support
20383f4978c7SHeiko Schocher		- better i2c mux support
20393f4978c7SHeiko Schocher
20403f4978c7SHeiko Schocher		** Please consider updating your I2C driver now. **
20413f4978c7SHeiko Schocher
2042ea818dbbSHeiko Schocher		These enable legacy I2C serial bus commands. Defining
2043ea818dbbSHeiko Schocher		CONFIG_HARD_I2C will include the appropriate I2C driver
2044ea818dbbSHeiko Schocher		for the selected CPU.
2045c609719bSwdenk
2046b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
2047602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
2048b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
2049b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
2050c609719bSwdenk		command line interface.
2051c609719bSwdenk
2052bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
2053c609719bSwdenk
2054b37c7e5eSwdenk		There are several other quantities that must also be
2055ea818dbbSHeiko Schocher		defined when you define CONFIG_HARD_I2C.
2056c609719bSwdenk
20576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2058b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
20596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
206011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
2061c609719bSwdenk
20628d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
2063a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
20648d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
20658d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
20668d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
2067b37c7e5eSwdenk
20685da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
20695da71efaSEric Millbrandt
20705da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
20715da71efaSEric Millbrandt		chips might think that the current transfer is still
20725da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
20735da71efaSEric Millbrandt		commands until the slave device responds.
20745da71efaSEric Millbrandt
2075b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
2076b37c7e5eSwdenk
2077ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2078b37c7e5eSwdenk		then the following macros need to be defined (examples are
2079b37c7e5eSwdenk		from include/configs/lwmon.h):
2080c609719bSwdenk
2081c609719bSwdenk		I2C_INIT
2082c609719bSwdenk
2083b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2084c609719bSwdenk		controller or configure ports.
2085c609719bSwdenk
2086b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2087b37c7e5eSwdenk
2088c609719bSwdenk		I2C_PORT
2089c609719bSwdenk
2090c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2091c609719bSwdenk		assumes both bits are on the same port). Valid values
2092c609719bSwdenk		are 0..3 for ports A..D.
2093c609719bSwdenk
2094c609719bSwdenk		I2C_ACTIVE
2095c609719bSwdenk
2096c609719bSwdenk		The code necessary to make the I2C data line active
2097c609719bSwdenk		(driven).  If the data line is open collector, this
2098c609719bSwdenk		define can be null.
2099c609719bSwdenk
2100b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2101b37c7e5eSwdenk
2102c609719bSwdenk		I2C_TRISTATE
2103c609719bSwdenk
2104c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2105c609719bSwdenk		(inactive).  If the data line is open collector, this
2106c609719bSwdenk		define can be null.
2107c609719bSwdenk
2108b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2109b37c7e5eSwdenk
2110c609719bSwdenk		I2C_READ
2111c609719bSwdenk
2112472d5460SYork Sun		Code that returns true if the I2C data line is high,
2113472d5460SYork Sun		false if it is low.
2114c609719bSwdenk
2115b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2116b37c7e5eSwdenk
2117c609719bSwdenk		I2C_SDA(bit)
2118c609719bSwdenk
2119472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2120472d5460SYork Sun		is false, it clears it (low).
2121c609719bSwdenk
2122b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2123b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2124b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2125b37c7e5eSwdenk
2126c609719bSwdenk		I2C_SCL(bit)
2127c609719bSwdenk
2128472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2129472d5460SYork Sun		is false, it clears it (low).
2130c609719bSwdenk
2131b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2132b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2133b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2134b37c7e5eSwdenk
2135c609719bSwdenk		I2C_DELAY
2136c609719bSwdenk
2137c609719bSwdenk		This delay is invoked four times per clock cycle so this
2138c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2139b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2140b37c7e5eSwdenk		like:
2141b37c7e5eSwdenk
2142b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2143c609719bSwdenk
2144793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2145793b5726SMike Frysinger
2146793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2147793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2148793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2149793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2150793b5726SMike Frysinger
2151793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2152793b5726SMike Frysinger		the generic GPIO functions.
2153793b5726SMike Frysinger
21546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
215547cd00faSwdenk
215647cd00faSwdenk		When a board is reset during an i2c bus transfer
215747cd00faSwdenk		chips might think that the current transfer is still
215847cd00faSwdenk		in progress. On some boards it is possible to access
215947cd00faSwdenk		the i2c SCLK line directly, either by using the
216047cd00faSwdenk		processor pin as a GPIO or by having a second pin
216147cd00faSwdenk		connected to the bus. If this option is defined a
216247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
216347cd00faSwdenk		is run early in the boot sequence.
216447cd00faSwdenk
216526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
216626a33504SRichard Retanubun
216726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
216826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
216926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
217026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
217126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
217226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
217326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
217426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
217526a33504SRichard Retanubun
217617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
217717ea1177Swdenk
217817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
217917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
218017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
218117ea1177Swdenk
2182bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2183bb99ad6dSBen Warren
2184bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2185bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2186bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2187bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2188bb99ad6dSBen Warren
21896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2190bb99ad6dSBen Warren
2191bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
21920f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
21930f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
21940f89c54bSPeter Tyser		a 1D array of device addresses
2195bb99ad6dSBen Warren
2196bb99ad6dSBen Warren		e.g.
2197bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
21986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2199bb99ad6dSBen Warren
2200bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2201bb99ad6dSBen Warren
2202bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
22036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2204bb99ad6dSBen Warren
2205bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2206bb99ad6dSBen Warren
22076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2208be5e6181STimur Tabi
2209be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2210be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2211be5e6181STimur Tabi
22126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
22130dc018ecSStefan Roese
22140dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
22150dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
22160dc018ecSStefan Roese
22176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
22180dc018ecSStefan Roese
22190dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
22200dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
22210dc018ecSStefan Roese
22226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
22239ebbb54fSVictor Gallardo
22249ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
22259ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
22269ebbb54fSVictor Gallardo		specified DTT device.
22279ebbb54fSVictor Gallardo
222867b23a32SHeiko Schocher		CONFIG_I2C_MUX
222967b23a32SHeiko Schocher
223067b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
223167b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
223267b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
223367b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
223467b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
223567b23a32SHeiko Schocher		the muxes to activate this new "bus".
223667b23a32SHeiko Schocher
223767b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
223867b23a32SHeiko Schocher		feature!
223967b23a32SHeiko Schocher
224067b23a32SHeiko Schocher		Example:
224167b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
224267b23a32SHeiko Schocher			The First mux with address 70 and channel 6
224367b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
224467b23a32SHeiko Schocher
224567b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
224667b23a32SHeiko Schocher
224767b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
224867b23a32SHeiko Schocher		of I2C Busses with muxes:
224967b23a32SHeiko Schocher
225067b23a32SHeiko Schocher		=> i2c bus
225167b23a32SHeiko Schocher		Busses reached over muxes:
225267b23a32SHeiko Schocher		Bus ID: 2
225367b23a32SHeiko Schocher		  reached over Mux(es):
225467b23a32SHeiko Schocher		    pca9544a@70 ch: 4
225567b23a32SHeiko Schocher		Bus ID: 3
225667b23a32SHeiko Schocher		  reached over Mux(es):
225767b23a32SHeiko Schocher		    pca9544a@70 ch: 6
225867b23a32SHeiko Schocher		    pca9544a@71 ch: 4
225967b23a32SHeiko Schocher		=>
226067b23a32SHeiko Schocher
226167b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
2262f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
2263f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
226467b23a32SHeiko Schocher		the channel 4.
226567b23a32SHeiko Schocher
226667b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
2267f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
226867b23a32SHeiko Schocher		the 2 muxes.
226967b23a32SHeiko Schocher
227067b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
227167b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
227267b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
227367b23a32SHeiko Schocher		to add this option to other architectures.
227467b23a32SHeiko Schocher
22752ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
22762ac6985aSAndrew Dyer
22772ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
22782ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
22792ac6985aSAndrew Dyer		between writing the address pointer and reading the
22802ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
22812ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
22822ac6985aSAndrew Dyer		devices can use either method, but some require one or
22832ac6985aSAndrew Dyer		the other.
2284be5e6181STimur Tabi
2285c609719bSwdenk- SPI Support:	CONFIG_SPI
2286c609719bSwdenk
2287c609719bSwdenk		Enables SPI driver (so far only tested with
2288c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2289c609719bSwdenk		D/As on the SACSng board)
2290c609719bSwdenk
22916639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22926639562eSYoshihiro Shimoda
22936639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
22946639562eSYoshihiro Shimoda		only SH7757 is supported.
22956639562eSYoshihiro Shimoda
2296c609719bSwdenk		CONFIG_SPI_X
2297c609719bSwdenk
2298c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
2299c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
2300c609719bSwdenk
2301c609719bSwdenk		CONFIG_SOFT_SPI
2302c609719bSwdenk
2303c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2304c609719bSwdenk		using hardware support. This is a general purpose
2305c609719bSwdenk		driver that only requires three general I/O port pins
2306c609719bSwdenk		(two outputs, one input) to function. If this is
2307c609719bSwdenk		defined, the board configuration must define several
2308c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2309c609719bSwdenk		an example, see include/configs/sacsng.h.
2310c609719bSwdenk
231104a9e118SBen Warren		CONFIG_HARD_SPI
231204a9e118SBen Warren
231304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
231404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
231504a9e118SBen Warren		must define a list of chip-select function pointers.
231604a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
231704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
231804a9e118SBen Warren
231938254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
232038254f45SGuennadi Liakhovetski
232138254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
23222e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
232338254f45SGuennadi Liakhovetski
23240133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
23250133502eSMatthias Fuchs
23260133502eSMatthias Fuchs		Enables FPGA subsystem.
23270133502eSMatthias Fuchs
23280133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
23290133502eSMatthias Fuchs
23300133502eSMatthias Fuchs		Enables support for specific chip vendors.
23310133502eSMatthias Fuchs		(ALTERA, XILINX)
23320133502eSMatthias Fuchs
23330133502eSMatthias Fuchs		CONFIG_FPGA_<family>
23340133502eSMatthias Fuchs
23350133502eSMatthias Fuchs		Enables support for FPGA family.
23360133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
23370133502eSMatthias Fuchs
23380133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2339c609719bSwdenk
2340c609719bSwdenk		Specify the number of FPGA devices to support.
2341c609719bSwdenk
23426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2343c609719bSwdenk
2344c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2345c609719bSwdenk
23466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2347c609719bSwdenk
2348c609719bSwdenk		Enable checks on FPGA configuration interface busy
2349c609719bSwdenk		status by the configuration function. This option
2350c609719bSwdenk		will require a board or device specific function to
2351c609719bSwdenk		be written.
2352c609719bSwdenk
2353c609719bSwdenk		CONFIG_FPGA_DELAY
2354c609719bSwdenk
2355c609719bSwdenk		If defined, a function that provides delays in the FPGA
2356c609719bSwdenk		configuration driver.
2357c609719bSwdenk
23586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2359c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2360c609719bSwdenk
23616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2362c609719bSwdenk
2363c609719bSwdenk		Check for configuration errors during FPGA bitfile
2364c609719bSwdenk		loading. For example, abort during Virtex II
2365c609719bSwdenk		configuration if the INIT_B line goes low (which
2366c609719bSwdenk		indicated a CRC error).
2367c609719bSwdenk
23686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2369c609719bSwdenk
2370c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2371c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2372c609719bSwdenk		FPGA configuration sequence. The default time is 500
237311ccc33fSMarcel Ziswiler		ms.
2374c609719bSwdenk
23756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2376c609719bSwdenk
2377c609719bSwdenk		Maximum time to wait for BUSY to deassert during
237811ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2379c609719bSwdenk
23806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2381c609719bSwdenk
2382c609719bSwdenk		Time to wait after FPGA configuration. The default is
238311ccc33fSMarcel Ziswiler		200 ms.
2384c609719bSwdenk
2385c609719bSwdenk- Configuration Management:
2386c609719bSwdenk		CONFIG_IDENT_STRING
2387c609719bSwdenk
2388c609719bSwdenk		If defined, this string will be added to the U-Boot
2389c609719bSwdenk		version information (U_BOOT_VERSION)
2390c609719bSwdenk
2391c609719bSwdenk- Vendor Parameter Protection:
2392c609719bSwdenk
2393c609719bSwdenk		U-Boot considers the values of the environment
2394c609719bSwdenk		variables "serial#" (Board Serial Number) and
23957152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2396c609719bSwdenk		are set once by the board vendor / manufacturer, and
2397c609719bSwdenk		protects these variables from casual modification by
2398c609719bSwdenk		the user. Once set, these variables are read-only,
2399c609719bSwdenk		and write or delete attempts are rejected. You can
240011ccc33fSMarcel Ziswiler		change this behaviour:
2401c609719bSwdenk
2402c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2403c609719bSwdenk		file, the write protection for vendor parameters is
240447cd00faSwdenk		completely disabled. Anybody can change or delete
2405c609719bSwdenk		these parameters.
2406c609719bSwdenk
2407c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2408c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
240911ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2410c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2411c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2412c609719bSwdenk		read-only.]
2413c609719bSwdenk
24142598090bSJoe Hershberger		The same can be accomplished in a more flexible way
24152598090bSJoe Hershberger		for any variable by configuring the type of access
24162598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
24172598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
24182598090bSJoe Hershberger
2419c609719bSwdenk- Protected RAM:
2420c609719bSwdenk		CONFIG_PRAM
2421c609719bSwdenk
2422c609719bSwdenk		Define this variable to enable the reservation of
2423c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2424c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2425c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2426c609719bSwdenk		this default value by defining an environment
2427c609719bSwdenk		variable "pram" to the number of kB you want to
2428c609719bSwdenk		reserve. Note that the board info structure will
2429c609719bSwdenk		still show the full amount of RAM. If pRAM is
2430c609719bSwdenk		reserved, a new environment variable "mem" will
2431c609719bSwdenk		automatically be defined to hold the amount of
2432c609719bSwdenk		remaining RAM in a form that can be passed as boot
2433c609719bSwdenk		argument to Linux, for instance like that:
2434c609719bSwdenk
2435fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2436c609719bSwdenk			saveenv
2437c609719bSwdenk
2438c609719bSwdenk		This way you can tell Linux not to use this memory,
2439c609719bSwdenk		either, which results in a memory region that will
2440c609719bSwdenk		not be affected by reboots.
2441c609719bSwdenk
2442c609719bSwdenk		*WARNING* If your board configuration uses automatic
2443c609719bSwdenk		detection of the RAM size, you must make sure that
2444c609719bSwdenk		this memory test is non-destructive. So far, the
2445c609719bSwdenk		following board configurations are known to be
2446c609719bSwdenk		"pRAM-clean":
2447c609719bSwdenk
24481b0757ecSWolfgang Denk			IVMS8, IVML24, SPD8xx, TQM8xxL,
24491b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2450544d97e9SWolfgang Denk			FLAGADM, TQM8260
2451c609719bSwdenk
245240fef049SGabe Black- Access to physical memory region (> 4GB)
245340fef049SGabe Black		Some basic support is provided for operations on memory not
245440fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
245540fef049SGabe Black		support access to more than 4GB of memory on 32-bit
245640fef049SGabe Black		machines using physical address extension or similar.
245740fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
245840fef049SGabe Black		currently only supports clearing the memory.
245940fef049SGabe Black
2460c609719bSwdenk- Error Recovery:
2461c609719bSwdenk		CONFIG_PANIC_HANG
2462c609719bSwdenk
2463c609719bSwdenk		Define this variable to stop the system in case of a
2464c609719bSwdenk		fatal error, so that you have to reset it manually.
2465c609719bSwdenk		This is probably NOT a good idea for an embedded
246611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2467c609719bSwdenk		automatically as fast as possible, but it may be
2468c609719bSwdenk		useful during development since you can try to debug
2469c609719bSwdenk		the conditions that lead to the situation.
2470c609719bSwdenk
2471c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2472c609719bSwdenk
2473c609719bSwdenk		This variable defines the number of retries for
2474c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2475c609719bSwdenk		before giving up the operation. If not defined, a
2476c609719bSwdenk		default value of 5 is used.
2477c609719bSwdenk
247840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
247940cb90eeSGuennadi Liakhovetski
248040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
248140cb90eeSGuennadi Liakhovetski
248248a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
248348a3e999STetsuyuki Kobayashi
248448a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
248548a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
248648a3e999STetsuyuki Kobayashi		try longer timeout such as
248748a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
248848a3e999STetsuyuki Kobayashi
2489c609719bSwdenk- Command Interpreter:
24908078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
249104a85b3bSwdenk
249204a85b3bSwdenk		Enable auto completion of commands using TAB.
249304a85b3bSwdenk
24948078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
24958078f1a5SWolfgang Denk		for the "hush" shell.
24968078f1a5SWolfgang Denk
24978078f1a5SWolfgang Denk
24986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2499c609719bSwdenk
2500c609719bSwdenk		Define this variable to enable the "hush" shell (from
2501c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2502c609719bSwdenk		powerful command line syntax like
2503c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2504c609719bSwdenk		constructs ("shell scripts").
2505c609719bSwdenk
2506c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2507c609719bSwdenk		with a somewhat smaller memory footprint.
2508c609719bSwdenk
2509c609719bSwdenk
25106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2511c609719bSwdenk
2512c609719bSwdenk		This defines the secondary prompt string, which is
2513c609719bSwdenk		printed when the command interpreter needs more input
2514c609719bSwdenk		to complete a command. Usually "> ".
2515c609719bSwdenk
2516c609719bSwdenk	Note:
2517c609719bSwdenk
2518c609719bSwdenk		In the current implementation, the local variables
2519c609719bSwdenk		space and global environment variables space are
2520c609719bSwdenk		separated. Local variables are those you define by
25213b57fe0aSwdenk		simply typing `name=value'. To access a local
2522c609719bSwdenk		variable later on, you have write `$name' or
25233b57fe0aSwdenk		`${name}'; to execute the contents of a variable
25243b57fe0aSwdenk		directly type `$name' at the command prompt.
2525c609719bSwdenk
2526c609719bSwdenk		Global environment variables are those you use
2527c609719bSwdenk		setenv/printenv to work with. To run a command stored
2528c609719bSwdenk		in such a variable, you need to use the run command,
2529c609719bSwdenk		and you must not use the '$' sign to access them.
2530c609719bSwdenk
2531c609719bSwdenk		To store commands and special characters in a
2532c609719bSwdenk		variable, please use double quotation marks
2533c609719bSwdenk		surrounding the whole text of the variable, instead
2534c609719bSwdenk		of the backslashes before semicolons and special
2535c609719bSwdenk		symbols.
2536c609719bSwdenk
2537aa0c71acSWolfgang Denk- Commandline Editing and History:
2538aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2539aa0c71acSWolfgang Denk
254011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2541aa0c71acSWolfgang Denk		commandline input operations
2542aa0c71acSWolfgang Denk
2543a8c7c708Swdenk- Default Environment:
2544c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2545c609719bSwdenk
2546c609719bSwdenk		Define this to contain any number of null terminated
2547c609719bSwdenk		strings (variable = value pairs) that will be part of
25487152b1d0Swdenk		the default environment compiled into the boot image.
25492262cfeeSwdenk
2550c609719bSwdenk		For example, place something like this in your
2551c609719bSwdenk		board's config file:
2552c609719bSwdenk
2553c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2554c609719bSwdenk			"myvar1=value1\0" \
2555c609719bSwdenk			"myvar2=value2\0"
2556c609719bSwdenk
2557c609719bSwdenk		Warning: This method is based on knowledge about the
2558c609719bSwdenk		internal format how the environment is stored by the
25592262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2560c609719bSwdenk		interface! Although it is unlikely that this format
25617152b1d0Swdenk		will change soon, there is no guarantee either.
2562c609719bSwdenk		You better know what you are doing here.
2563c609719bSwdenk
2564c609719bSwdenk		Note: overly (ab)use of the default environment is
2565c609719bSwdenk		discouraged. Make sure to check other ways to preset
256674de7aefSWolfgang Denk		the environment like the "source" command or the
2567c609719bSwdenk		boot command first.
2568c609719bSwdenk
25695e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
25705e724ca2SStephen Warren
25715e724ca2SStephen Warren		Define this in order to add variables describing the
25725e724ca2SStephen Warren		U-Boot build configuration to the default environment.
25735e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
25745e724ca2SStephen Warren
25755e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
25765e724ca2SStephen Warren
25775e724ca2SStephen Warren		- CONFIG_SYS_ARCH
25785e724ca2SStephen Warren		- CONFIG_SYS_CPU
25795e724ca2SStephen Warren		- CONFIG_SYS_BOARD
25805e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
25815e724ca2SStephen Warren		- CONFIG_SYS_SOC
25825e724ca2SStephen Warren
25837e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
25847e27f89fSTom Rini
25857e27f89fSTom Rini		Define this in order to add variables describing certain
25867e27f89fSTom Rini		run-time determined information about the hardware to the
25877e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
25887e27f89fSTom Rini
258906fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
259006fd8538SSimon Glass
259106fd8538SSimon Glass		Normally the environment is loaded when the board is
259206fd8538SSimon Glass		intialised so that it is available to U-Boot. This inhibits
259306fd8538SSimon Glass		that so that the environment is not available until
259406fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
259506fd8538SSimon Glass		this is instead controlled by the value of
259606fd8538SSimon Glass		/config/load-environment.
259706fd8538SSimon Glass
2598a8c7c708Swdenk- DataFlash Support:
25992abbe075Swdenk		CONFIG_HAS_DATAFLASH
26002abbe075Swdenk
26012abbe075Swdenk		Defining this option enables DataFlash features and
26022abbe075Swdenk		allows to read/write in Dataflash via the standard
26032abbe075Swdenk		commands cp, md...
26042abbe075Swdenk
2605f61ec45eSEric Nelson- Serial Flash support
2606f61ec45eSEric Nelson		CONFIG_CMD_SF
2607f61ec45eSEric Nelson
2608f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2609f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2610f61ec45eSEric Nelson
2611f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2612f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2613f61ec45eSEric Nelson		commands.
2614f61ec45eSEric Nelson
2615f61ec45eSEric Nelson		The following defaults may be provided by the platform
2616f61ec45eSEric Nelson		to handle the common case when only a single serial
2617f61ec45eSEric Nelson		flash is present on the system.
2618f61ec45eSEric Nelson
2619f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2620f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2621f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2622f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2623f61ec45eSEric Nelson
262424007273SSimon Glass		CONFIG_CMD_SF_TEST
262524007273SSimon Glass
262624007273SSimon Glass		Define this option to include a destructive SPI flash
262724007273SSimon Glass		test ('sf test').
262824007273SSimon Glass
26291dcd6d03SJagannadha Sutradharudu Teki		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
26301dcd6d03SJagannadha Sutradharudu Teki
26311dcd6d03SJagannadha Sutradharudu Teki		Define this option to use the Bank addr/Extended addr
26321dcd6d03SJagannadha Sutradharudu Teki		support on SPI flashes which has size > 16Mbytes.
26331dcd6d03SJagannadha Sutradharudu Teki
26343f85ce27Swdenk- SystemACE Support:
26353f85ce27Swdenk		CONFIG_SYSTEMACE
26363f85ce27Swdenk
26373f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
26383f85ce27Swdenk		chips attached via some sort of local bus. The address
263911ccc33fSMarcel Ziswiler		of the chip must also be defined in the
26406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
26413f85ce27Swdenk
26423f85ce27Swdenk		#define CONFIG_SYSTEMACE
26436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
26443f85ce27Swdenk
26453f85ce27Swdenk		When SystemACE support is added, the "ace" device type
26463f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
26473f85ce27Swdenk
2648ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2649ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2650ecb0ccd9SWolfgang Denk
265128cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2652ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
265328cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2654ecb0ccd9SWolfgang Denk		number generator is used.
2655ecb0ccd9SWolfgang Denk
265628cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
265728cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
265828cb9375SWolfgang Denk		defined, the normal port 69 is used.
265928cb9375SWolfgang Denk
266028cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2661ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2662ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2663ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2664ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2665ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2666ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2667ecb0ccd9SWolfgang Denk
2668bf36c5d5SSimon Glass- Hashing support:
2669bf36c5d5SSimon Glass		CONFIG_CMD_HASH
2670bf36c5d5SSimon Glass
2671bf36c5d5SSimon Glass		This enables a generic 'hash' command which can produce
2672bf36c5d5SSimon Glass		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2673bf36c5d5SSimon Glass
2674bf36c5d5SSimon Glass		CONFIG_HASH_VERIFY
2675bf36c5d5SSimon Glass
2676bf36c5d5SSimon Glass		Enable the hash verify command (hash -v). This adds to code
2677bf36c5d5SSimon Glass		size a little.
2678bf36c5d5SSimon Glass
2679bf36c5d5SSimon Glass		CONFIG_SHA1 - support SHA1 hashing
2680bf36c5d5SSimon Glass		CONFIG_SHA256 - support SHA256 hashing
2681bf36c5d5SSimon Glass
2682bf36c5d5SSimon Glass		Note: There is also a sha1sum command, which should perhaps
2683bf36c5d5SSimon Glass		be deprecated in favour of 'hash sha1'.
2684bf36c5d5SSimon Glass
268519c402afSSimon Glass- Signing support:
268619c402afSSimon Glass		CONFIG_RSA
268719c402afSSimon Glass
268819c402afSSimon Glass		This enables the RSA algorithm used for FIT image verification
268919c402afSSimon Glass		in U-Boot. See doc/uImage/signature for more information.
269019c402afSSimon Glass
269119c402afSSimon Glass		The signing part is build into mkimage regardless of this
269219c402afSSimon Glass		option.
269319c402afSSimon Glass
269419c402afSSimon Glass
2695a8c7c708Swdenk- Show boot progress:
2696c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2697c609719bSwdenk
2698c609719bSwdenk		Defining this option allows to add some board-
2699c609719bSwdenk		specific code (calling a user-provided function
2700c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2701c609719bSwdenk		the system's boot progress on some display (for
2702c609719bSwdenk		example, some LED's) on your board. At the moment,
2703c609719bSwdenk		the following checkpoints are implemented:
2704c609719bSwdenk
27053a608ca0SSimon Glass- Detailed boot stage timing
27063a608ca0SSimon Glass		CONFIG_BOOTSTAGE
27073a608ca0SSimon Glass		Define this option to get detailed timing of each stage
27083a608ca0SSimon Glass		of the boot process.
27093a608ca0SSimon Glass
27103a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
27113a608ca0SSimon Glass		This is the number of available user bootstage records.
27123a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
27133a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
27143a608ca0SSimon Glass		the limit, recording will stop.
27153a608ca0SSimon Glass
27163a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
27173a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
27183a608ca0SSimon Glass
27193a608ca0SSimon Glass		Timer summary in microseconds:
27203a608ca0SSimon Glass		       Mark    Elapsed  Stage
27213a608ca0SSimon Glass			  0          0  reset
27223a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
27233a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
27243a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
27253a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
27263a608ca0SSimon Glass		  3,910,375    250,777  main_loop
27273a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
27283a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
27293a608ca0SSimon Glass
27302eba38cfSSimon Glass		CONFIG_CMD_BOOTSTAGE
27312eba38cfSSimon Glass		Add a 'bootstage' command which supports printing a report
27322eba38cfSSimon Glass		and un/stashing of bootstage data.
27332eba38cfSSimon Glass
273494fd1316SSimon Glass		CONFIG_BOOTSTAGE_FDT
273594fd1316SSimon Glass		Stash the bootstage information in the FDT. A root 'bootstage'
273694fd1316SSimon Glass		node is created with each bootstage id as a child. Each child
273794fd1316SSimon Glass		has a 'name' property and either 'mark' containing the
273894fd1316SSimon Glass		mark time in microsecond, or 'accum' containing the
273994fd1316SSimon Glass		accumulated time for that bootstage id in microseconds.
274094fd1316SSimon Glass		For example:
274194fd1316SSimon Glass
274294fd1316SSimon Glass		bootstage {
274394fd1316SSimon Glass			154 {
274494fd1316SSimon Glass				name = "board_init_f";
274594fd1316SSimon Glass				mark = <3575678>;
274694fd1316SSimon Glass			};
274794fd1316SSimon Glass			170 {
274894fd1316SSimon Glass				name = "lcd";
274994fd1316SSimon Glass				accum = <33482>;
275094fd1316SSimon Glass			};
275194fd1316SSimon Glass		};
275294fd1316SSimon Glass
275394fd1316SSimon Glass		Code in the Linux kernel can find this in /proc/devicetree.
275494fd1316SSimon Glass
27551372cce2SMarian BalakowiczLegacy uImage format:
27561372cce2SMarian Balakowicz
2757c609719bSwdenk  Arg	Where			When
2758c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2759c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2760c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2761c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2762c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2763c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2764c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2765c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2766c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
27671372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2768c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2769c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2770c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2771c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
27721372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2773c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
27741372cce2SMarian Balakowicz
27751372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
27761372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
27771372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
27781372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
27791372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
27801372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
27811372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
278211ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
27831372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
27841372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
27851372cce2SMarian Balakowicz
2786ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2787c609719bSwdenk
2788a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
278963e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
279063e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
279163e73c9aSwdenk
2792566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2793566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2794566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2795566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2796566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2797566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2798566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2799566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2800566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2801566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2802566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2803566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2804566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2805566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2806566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2807566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2808566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2809566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2810566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2811566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2812566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2813566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2814566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2815566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2816566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2817566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2818566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2819566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2820566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2821566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2822566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2823566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2824566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2825566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2826566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2827566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2828566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2829566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2830566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2831566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2832566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2833566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2834566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2835566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2836566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2837566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2838566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2839c609719bSwdenk
2840566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2841c609719bSwdenk
2842566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2843566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2844566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2845206c60cbSwdenk
2846566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2847566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
284811ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2849566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2850566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2851566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
285274de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
285374de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2854566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2855c609719bSwdenk
28561372cce2SMarian BalakowiczFIT uImage format:
28571372cce2SMarian Balakowicz
28581372cce2SMarian Balakowicz  Arg	Where			When
28591372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
28601372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
28611372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
28621372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
28631372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
28641372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2865f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
28661372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
28671372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
28681372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
28691372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
28701372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
287111ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
287211ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
28731372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
28741372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
28751372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
28761372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
28771372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
28781372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
28791372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
28801372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
28811372cce2SMarian Balakowicz
28821372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
28831372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
28841372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
288511ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
28861372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
28871372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
28881372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
28891372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
28901372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
28911372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
28921372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
28931372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
28941372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
28951372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
28961372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
28971372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
28981372cce2SMarian Balakowicz
289911ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
29001372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
29011372cce2SMarian Balakowicz
290211ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
29031372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
29041372cce2SMarian Balakowicz
290511ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
29061372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
29071372cce2SMarian Balakowicz
2908d95f6ec7SGabe Black- FIT image support:
2909d95f6ec7SGabe Black		CONFIG_FIT
2910d95f6ec7SGabe Black		Enable support for the FIT uImage format.
2911d95f6ec7SGabe Black
2912d95f6ec7SGabe Black		CONFIG_FIT_BEST_MATCH
2913d95f6ec7SGabe Black		When no configuration is explicitly selected, default to the
2914d95f6ec7SGabe Black		one whose fdt's compatibility field best matches that of
2915d95f6ec7SGabe Black		U-Boot itself. A match is considered "best" if it matches the
2916d95f6ec7SGabe Black		most specific compatibility entry of U-Boot's fdt's root node.
2917d95f6ec7SGabe Black		The order of entries in the configuration's fdt is ignored.
2918d95f6ec7SGabe Black
29193e569a6bSSimon Glass		CONFIG_FIT_SIGNATURE
29203e569a6bSSimon Glass		This option enables signature verification of FIT uImages,
29213e569a6bSSimon Glass		using a hash signed and verified using RSA. See
29223e569a6bSSimon Glass		doc/uImage.FIT/signature.txt for more details.
29233e569a6bSSimon Glass
29244cf2609bSWolfgang Denk- Standalone program support:
29254cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
29264cf2609bSWolfgang Denk
29276feff899SWolfgang Denk		This option defines a board specific value for the
29286feff899SWolfgang Denk		address where standalone program gets loaded, thus
29296feff899SWolfgang Denk		overwriting the architecture dependent default
29304cf2609bSWolfgang Denk		settings.
29314cf2609bSWolfgang Denk
29324cf2609bSWolfgang Denk- Frame Buffer Address:
29334cf2609bSWolfgang Denk		CONFIG_FB_ADDR
29344cf2609bSWolfgang Denk
29354cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
293644a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
293744a53b57SWolfgang Denk		when using a graphics controller has separate video
293844a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
293944a53b57SWolfgang Denk		the given address instead of dynamically reserving it
294044a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
294144a53b57SWolfgang Denk		the memory for the frame buffer depending on the
294244a53b57SWolfgang Denk		configured panel size.
29434cf2609bSWolfgang Denk
29444cf2609bSWolfgang Denk		Please see board_init_f function.
29454cf2609bSWolfgang Denk
2946cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2947cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2948cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2949cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2950cccfc2abSDetlev Zundel
2951cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2952cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2953cccfc2abSDetlev Zundel
2954cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2955cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2956cccfc2abSDetlev Zundel
2957cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2958cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2959cccfc2abSDetlev Zundel
2960cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2961cccfc2abSDetlev Zundel
2962cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2963cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2964cccfc2abSDetlev Zundel
296570c219cdSJoe Hershberger- UBI support
296670c219cdSJoe Hershberger		CONFIG_CMD_UBI
296770c219cdSJoe Hershberger
296870c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
296970c219cdSJoe Hershberger		with the UBI flash translation layer
297070c219cdSJoe Hershberger
297170c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
297270c219cdSJoe Hershberger
2973147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2974147162daSJoe Hershberger
2975147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2976147162daSJoe Hershberger		warnings and errors enabled.
2977147162daSJoe Hershberger
297870c219cdSJoe Hershberger- UBIFS support
297970c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
298070c219cdSJoe Hershberger
298170c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
298270c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
298370c219cdSJoe Hershberger
298470c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
298570c219cdSJoe Hershberger
2986147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2987147162daSJoe Hershberger
2988147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2989147162daSJoe Hershberger		warnings and errors enabled.
2990147162daSJoe Hershberger
29916a11cf48SDaniel Schwierzeck- SPL framework
29926a11cf48SDaniel Schwierzeck		CONFIG_SPL
29936a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
29946a11cf48SDaniel Schwierzeck
299595579793STom Rini		CONFIG_SPL_LDSCRIPT
299695579793STom Rini		LDSCRIPT for linking the SPL binary.
299795579793STom Rini
29986ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
29996ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
30006ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
30016ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
30028960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30036ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
30046ebc3461SAlbert ARIBAUD
300595579793STom Rini		CONFIG_SPL_MAX_SIZE
30066ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
30076ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
30086ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
30096ebc3461SAlbert ARIBAUD		not exceed it.
301095579793STom Rini
30116a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
30126a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
30136a11cf48SDaniel Schwierzeck
301494a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
301594a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
301694a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
301794a45bb1SScott Wood
301895579793STom Rini		CONFIG_SPL_BSS_START_ADDR
301995579793STom Rini		Link address for the BSS within the SPL binary.
302095579793STom Rini
302195579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
30226ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
30236ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
30246ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
30258960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
30266ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
302795579793STom Rini
302895579793STom Rini		CONFIG_SPL_STACK
302995579793STom Rini		Adress of the start of the stack SPL will use
303095579793STom Rini
303194a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
303294a45bb1SScott Wood		Adress of the start of the stack SPL will use after
303394a45bb1SScott Wood		relocation.  If unspecified, this is equal to
303494a45bb1SScott Wood		CONFIG_SPL_STACK.
303594a45bb1SScott Wood
303695579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
303795579793STom Rini		Starting address of the malloc pool used in SPL.
303895579793STom Rini
303995579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
304095579793STom Rini		The size of the malloc pool used in SPL.
30416a11cf48SDaniel Schwierzeck
304247f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
304347f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
304447f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
304547f7bcaeSTom Rini		NAND loading of the Linux Kernel.
304647f7bcaeSTom Rini
3047861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3048861a86f4STom Rini		For ARM, enable an optional function to print more information
3049861a86f4STom Rini		about the running system.
3050861a86f4STom Rini
30514b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
30524b919725SScott Wood		Arch init code should be built for a very small image
30534b919725SScott Wood
30546a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
30556a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
30566a11cf48SDaniel Schwierzeck
30576a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
30586a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
30596a11cf48SDaniel Schwierzeck
30606a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
30616a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
30626a11cf48SDaniel Schwierzeck
30636a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
30646a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
30656a11cf48SDaniel Schwierzeck
30666a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
30676a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
30686a11cf48SDaniel Schwierzeck
306995579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
307095579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
307195579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
307295579793STom Rini		Address, size and partition on the MMC to load U-Boot from
307395579793STom Rini		when the MMC is being used in raw mode.
307495579793STom Rini
30752b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
30762b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
30772b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
30782b75b0adSPeter Korsgaard
30792b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
30802b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
30812b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
30822b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
30832b75b0adSPeter Korsgaard		(for falcon mode)
30842b75b0adSPeter Korsgaard
308595579793STom Rini		CONFIG_SPL_FAT_SUPPORT
308695579793STom Rini		Support for fs/fat/libfat.o in SPL binary
308795579793STom Rini
308895579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
308995579793STom Rini		Filename to read to load U-Boot when reading from FAT
309095579793STom Rini
30917ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_KERNEL_NAME
30927ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
30937ad2cc79SPeter Korsgaard		from FAT (for Falcon mode)
30947ad2cc79SPeter Korsgaard
30957ad2cc79SPeter Korsgaard		CONFIG_SPL_FAT_LOAD_ARGS_NAME
30967ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
30977ad2cc79SPeter Korsgaard		when reading from FAT (for Falcon mode)
30987ad2cc79SPeter Korsgaard
309906f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
310006f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
310106f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
310206f60ae3SScott Wood		continuing (the hardware starts execution after just
310306f60ae3SScott Wood		loading the first page rather than the full 4K).
310406f60ae3SScott Wood
31056f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
31066f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
31076f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
31086f2f01b9SScott Wood
31096f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
31106f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
31116f2f01b9SScott Wood
31126f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
31136f2f01b9SScott Wood		Include standard software ECC in the SPL
31146f2f01b9SScott Wood
311595579793STom Rini		CONFIG_SPL_NAND_SIMPLE
31167d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
31177d4b7955SScott Wood		expose the cmd_ctrl() interface.
311895579793STom Rini
311995579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
312095579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
312195579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
312295579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
312395579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
312495579793STom Rini		Defines the size and behavior of the NAND that SPL uses
31257d4b7955SScott Wood		to read U-Boot
312695579793STom Rini
312795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
31287d4b7955SScott Wood		Location in NAND to read U-Boot from
31297d4b7955SScott Wood
31307d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
31317d4b7955SScott Wood		Location in memory to load U-Boot to
31327d4b7955SScott Wood
31337d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
31347d4b7955SScott Wood		Size of image to load
313595579793STom Rini
313695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
31377d4b7955SScott Wood		Entry point in loaded image to jump to
313895579793STom Rini
313995579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
314095579793STom Rini		Define this if you need to first read the OOB and then the
314195579793STom Rini		data. This is used for example on davinci plattforms.
314295579793STom Rini
314395579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
314495579793STom Rini		Support for an OMAP3-specific set of functions to return the
314595579793STom Rini		ID and MFR of the first attached NAND chip, if present.
314695579793STom Rini
31476a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
31486a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
31496a11cf48SDaniel Schwierzeck
31506a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
31516a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
31526a11cf48SDaniel Schwierzeck
31536a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
31546a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
31556a11cf48SDaniel Schwierzeck
3156c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3157c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3158c57b953dSPavel Machek
31596a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
31606a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
31611372cce2SMarian Balakowicz
3162ba1bee43SYing Zhang		CONFIG_SPL_ENV_SUPPORT
3163ba1bee43SYing Zhang		Support for the environment operating in SPL binary
3164ba1bee43SYing Zhang
3165ba1bee43SYing Zhang		CONFIG_SPL_NET_SUPPORT
3166ba1bee43SYing Zhang		Support for the net/libnet.o in SPL binary.
3167ba1bee43SYing Zhang		It conflicts with SPL env from storage medium specified by
3168ba1bee43SYing Zhang		CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3169ba1bee43SYing Zhang
317074752baaSScott Wood		CONFIG_SPL_PAD_TO
31716113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
31726113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
31736113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31746113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31756113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
317674752baaSScott Wood
3177ca2fca22SScott Wood		CONFIG_SPL_TARGET
3178ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3179ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3180ca2fca22SScott Wood		example if more than one image needs to be produced.
3181ca2fca22SScott Wood
318287ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
318387ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
318487ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
318587ebee39SSimon Glass		option to re-enable it. This will affect the output of the
318687ebee39SSimon Glass		bootm command when booting a FIT image.
318787ebee39SSimon Glass
3188c609719bSwdenkModem Support:
3189c609719bSwdenk--------------
3190c609719bSwdenk
3191566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
3192c609719bSwdenk
319311ccc33fSMarcel Ziswiler- Modem support enable:
3194c609719bSwdenk		CONFIG_MODEM_SUPPORT
3195c609719bSwdenk
3196c609719bSwdenk- RTS/CTS Flow control enable:
3197c609719bSwdenk		CONFIG_HWFLOW
3198c609719bSwdenk
3199c609719bSwdenk- Modem debug support:
3200c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
3201c609719bSwdenk
3202c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
3203c609719bSwdenk		for modem support. Useful only with BDI2000.
3204c609719bSwdenk
3205a8c7c708Swdenk- Interrupt support (PPC):
3206a8c7c708Swdenk
3207a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3208a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
320911ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3210a8c7c708Swdenk		should set decrementer_count to appropriate value. If
321111ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3212a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
321311ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3214a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3215a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3216a8c7c708Swdenk		general timer_interrupt().
3217a8c7c708Swdenk
3218c609719bSwdenk- General:
3219c609719bSwdenk
3220c609719bSwdenk		In the target system modem support is enabled when a
3221c609719bSwdenk		specific key (key combination) is pressed during
3222c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
322311ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
3224c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
3225c609719bSwdenk		function, returning 1 and thus enabling modem
3226c609719bSwdenk		initialization.
3227c609719bSwdenk
3228c609719bSwdenk		If there are no modem init strings in the
3229c609719bSwdenk		environment, U-Boot proceed to autoboot; the
3230c609719bSwdenk		previous output (banner, info printfs) will be
323111ccc33fSMarcel Ziswiler		suppressed, though.
3232c609719bSwdenk
3233c609719bSwdenk		See also: doc/README.Modem
3234c609719bSwdenk
32359660e442SHelmut RaigerBoard initialization settings:
32369660e442SHelmut Raiger------------------------------
32379660e442SHelmut Raiger
32389660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
32399660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
32409660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
32419660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
32429660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
32439660e442SHelmut Raigertypically in board_init_f() and board_init_r().
32449660e442SHelmut Raiger
32459660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
32469660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
32479660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
32489660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3249c609719bSwdenk
3250c609719bSwdenkConfiguration Settings:
3251c609719bSwdenk-----------------------
3252c609719bSwdenk
32536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3254c609719bSwdenk		undefine this when you're short of memory.
3255c609719bSwdenk
32562fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
32572fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
32582fb2604dSPeter Tyser
32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3260c609719bSwdenk		prompt for user input.
3261c609719bSwdenk
32626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3263c609719bSwdenk
32646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3265c609719bSwdenk
32666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3267c609719bSwdenk
32686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3269c609719bSwdenk		the application (usually a Linux kernel) when it is
3270c609719bSwdenk		booted
3271c609719bSwdenk
32726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3273c609719bSwdenk		List of legal baudrate settings for this board.
3274c609719bSwdenk
32756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
3276c609719bSwdenk		Suppress display of console information at boot.
3277c609719bSwdenk
32786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
3279c609719bSwdenk		If the board specific function
3280c609719bSwdenk			extern int overwrite_console (void);
3281c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
3282c609719bSwdenk		serial port, else the settings in the environment are used.
3283c609719bSwdenk
32846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
3285c609719bSwdenk		Enable the call to overwrite_console().
3286c609719bSwdenk
32876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
3288c609719bSwdenk		Enable overwrite of previous console environment settings.
3289c609719bSwdenk
32906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3291c609719bSwdenk		Begin and End addresses of the area used by the
3292c609719bSwdenk		simple memory test.
3293c609719bSwdenk
32946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3295c609719bSwdenk		Enable an alternate, more extensive memory test.
3296c609719bSwdenk
32976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
32985f535fe1Swdenk		Scratch address used by the alternate memory test
32995f535fe1Swdenk		You only need to set this if address zero isn't writeable
33005f535fe1Swdenk
33016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
330314f73ca6SStefan Roese		this specified memory area will get subtracted from the top
330411ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
330514f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
330614f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
330714f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
33085e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
330914f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
33105e12e75dSStefan Roese		will have to get fixed in Linux additionally.
331114f73ca6SStefan Roese
331214f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
331314f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
331414f73ca6SStefan Roese		be touched.
331514f73ca6SStefan Roese
331614f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
331714f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
331814f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
331914f73ca6SStefan Roese		non page size aligned address and this could cause major
332014f73ca6SStefan Roese		problems.
332114f73ca6SStefan Roese
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3323c609719bSwdenk		Enable temporary baudrate change while serial download
3324c609719bSwdenk
33256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3326c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3327c609719bSwdenk
33286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
3329c609719bSwdenk		Physical start address of Motherboard I/O (if using a
3330c609719bSwdenk		Cogent motherboard)
3331c609719bSwdenk
33326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3333c609719bSwdenk		Physical start address of Flash memory.
3334c609719bSwdenk
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3336c609719bSwdenk		Physical start address of boot monitor code (set by
3337c609719bSwdenk		make config files to be same as the text base address
333814d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
33396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3340c609719bSwdenk
33416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
33423b57fe0aSwdenk		Size of memory reserved for monitor code, used to
33433b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
33443b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
33453b57fe0aSwdenk		flash sector.
3346c609719bSwdenk
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3348c609719bSwdenk		Size of DRAM reserved for malloc() use.
3349c609719bSwdenk
33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
335115940c9aSStefan Roese		Normally compressed uImages are limited to an
335215940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
33536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
335415940c9aSStefan Roese		to adjust this setting to your needs.
3355c609719bSwdenk
33566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3357c609719bSwdenk		Maximum size of memory mapped by the startup code of
3358c609719bSwdenk		the Linux kernel; all data that must be processed by
33597d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
33607d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
33617d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
33627d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3363c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3364c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3365c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3366c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3367c609719bSwdenk
3368fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3369fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3370fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3371fca43cc8SJohn Rigby		is enabled.
3372fca43cc8SJohn Rigby
3373fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3374fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3375fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3376fca43cc8SJohn Rigby
3377fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3378fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3379fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3380fca43cc8SJohn Rigby
33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3382c609719bSwdenk		Max number of Flash memory banks
3383c609719bSwdenk
33846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3385c609719bSwdenk		Max number of sectors on a Flash chip
3386c609719bSwdenk
33876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3388c609719bSwdenk		Timeout for Flash erase operations (in ms)
3389c609719bSwdenk
33906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3391c609719bSwdenk		Timeout for Flash write operations (in ms)
3392c609719bSwdenk
33936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
33948564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
33958564acf9Swdenk
33966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
33978564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
33988564acf9Swdenk
33996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
34008564acf9Swdenk		If defined, hardware flash sectors protection is used
34018564acf9Swdenk		instead of U-Boot software protection.
34028564acf9Swdenk
34036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3404c609719bSwdenk
3405c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3406c609719bSwdenk		without this option such a download has to be
3407c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3408c609719bSwdenk		copy from RAM to flash.
3409c609719bSwdenk
3410c609719bSwdenk		The two-step approach is usually more reliable, since
3411c609719bSwdenk		you can check if the download worked before you erase
341211ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
341311ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3414c609719bSwdenk		downloaded image) this option may be very useful.
3415c609719bSwdenk
34166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3417c609719bSwdenk		Define if the flash driver uses extra elements in the
34185653fc33Swdenk		common flash structure for storing flash geometry.
34195653fc33Swdenk
342000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
34215653fc33Swdenk		This option also enables the building of the cfi_flash driver
34225653fc33Swdenk		in the drivers directory
342353cf9435Sstroese
342491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
342591809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
342691809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
342791809ed5SPiotr Ziecik		to the MTD layer.
342891809ed5SPiotr Ziecik
34296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
343096ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
343196ef831fSGuennadi Liakhovetski
343296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
343396ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
343496ef831fSGuennadi Liakhovetski		write commands.
343596ef831fSGuennadi Liakhovetski
34366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
34375568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
34385568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
34395568e613SStefan Roese		is useful, if some of the configured banks are only
34405568e613SStefan Roese		optionally available.
34415568e613SStefan Roese
34429a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
34439a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
34449a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
34459a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
34469a042e9cSJerry Van Baren
3447352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3448352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3449352ef3f1SStefan Roese		against the source after the write operation. An error message
3450352ef3f1SStefan Roese		will be printed when the contents are not identical.
3451352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3452352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3453352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3454352ef3f1SStefan Roese		this option if you really know what you are doing.
3455352ef3f1SStefan Roese
34566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
345711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
345811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
345953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
346053cf9435Sstroese		buffers can be full shortly after enabling the interface
346111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
346253cf9435Sstroese		Defaults to 4 if not defined.
3463c609719bSwdenk
3464ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3465ea882bafSWolfgang Denk
3466ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3467ea882bafSWolfgang Denk	internally to store the environment settings. The default
3468ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3469ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3470ea882bafSWolfgang Denk	lib/hashtable.c for details.
3471ea882bafSWolfgang Denk
34722598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
34732598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
34742598090bSJoe Hershberger	Enable validation of the values given to enviroment variables when
34752598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
34762598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
34772598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
34782598090bSJoe Hershberger
34792598090bSJoe Hershberger	The format of the list is:
34802598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3481267541f7SJoe Hershberger		access_atribute = [a|r|o|c]
3482267541f7SJoe Hershberger		attributes = type_attribute[access_atribute]
34832598090bSJoe Hershberger		entry = variable_name[:attributes]
34842598090bSJoe Hershberger		list = entry[,list]
34852598090bSJoe Hershberger
34862598090bSJoe Hershberger	The type attributes are:
34872598090bSJoe Hershberger		s - String (default)
34882598090bSJoe Hershberger		d - Decimal
34892598090bSJoe Hershberger		x - Hexadecimal
34902598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
34912598090bSJoe Hershberger		i - IP address
34922598090bSJoe Hershberger		m - MAC address
34932598090bSJoe Hershberger
3494267541f7SJoe Hershberger	The access attributes are:
3495267541f7SJoe Hershberger		a - Any (default)
3496267541f7SJoe Hershberger		r - Read-only
3497267541f7SJoe Hershberger		o - Write-once
3498267541f7SJoe Hershberger		c - Change-default
3499267541f7SJoe Hershberger
35002598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
35012598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
35022598090bSJoe Hershberger		envirnoment variable in the default or embedded environment.
35032598090bSJoe Hershberger
35042598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
35052598090bSJoe Hershberger		Define this to a list (string) to define validation that
35062598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
35072598090bSJoe Hershberger		environment variable.  To override a setting in the static
35082598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
35092598090bSJoe Hershberger		".flags" variable.
35102598090bSJoe Hershberger
3511267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3512267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3513267541f7SJoe Hershberger	access flags.
3514267541f7SJoe Hershberger
35155c1a7ea6SSimon Glass- CONFIG_SYS_GENERIC_BOARD
35165c1a7ea6SSimon Glass	This selects the architecture-generic board system instead of the
35175c1a7ea6SSimon Glass	architecture-specific board files. It is intended to move boards
35185c1a7ea6SSimon Glass	to this new framework over time. Defining this will disable the
35195c1a7ea6SSimon Glass	arch/foo/lib/board.c file and use common/board_f.c and
35205c1a7ea6SSimon Glass	common/board_r.c instead. To use this option your architecture
35215c1a7ea6SSimon Glass	must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in
35225c1a7ea6SSimon Glass	its config.mk file). If you find problems enabling this option on
35235c1a7ea6SSimon Glass	your board please report the problem and send patches!
35245c1a7ea6SSimon Glass
3525632efa74SSimon Glass- CONFIG_SYS_SYM_OFFSETS
3526632efa74SSimon Glass	This is set by architectures that use offsets for link symbols
3527632efa74SSimon Glass	instead of absolute values. So bss_start is obtained using an
3528632efa74SSimon Glass	offset _bss_start_ofs from CONFIG_SYS_TEXT_BASE, rather than
3529632efa74SSimon Glass	directly. You should not need to touch this setting.
3530632efa74SSimon Glass
35310b1b60c7SLokesh Vutla- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
35320b1b60c7SLokesh Vutla	This is set by OMAP boards for the max time that reset should
35330b1b60c7SLokesh Vutla	be asserted. See doc/README.omap-reset-time for details on how
35340b1b60c7SLokesh Vutla	the value can be calulated on a given board.
3535632efa74SSimon Glass
3536c609719bSwdenkThe following definitions that deal with the placement and management
3537c609719bSwdenkof environment data (variable area); in general, we support the
3538c609719bSwdenkfollowing configurations:
3539c609719bSwdenk
3540c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3541c3eb3fe4SMike Frysinger
3542c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3543c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3544c3eb3fe4SMike Frysinger
35455a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3546c609719bSwdenk
3547c609719bSwdenk	Define this if the environment is in flash memory.
3548c609719bSwdenk
3549c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3550c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3551c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3552c609719bSwdenk	   sector" type flash chips, which have several smaller
3553c609719bSwdenk	   sectors at the start or the end. For instance, such a
3554c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3555c609719bSwdenk	   such a case you would place the environment in one of the
3556c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3557c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3558c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3559c609719bSwdenk	   between U-Boot and the environment.
3560c609719bSwdenk
35610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3562c609719bSwdenk
3563c609719bSwdenk	   Offset of environment data (variable area) to the
3564c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3565c609719bSwdenk	   type flash chips the second sector can be used: the offset
3566c609719bSwdenk	   for this sector is given here.
3567c609719bSwdenk
35686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3569c609719bSwdenk
35700e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3571c609719bSwdenk
3572c609719bSwdenk	   This is just another way to specify the start address of
3573c609719bSwdenk	   the flash sector containing the environment (instead of
35740e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3575c609719bSwdenk
35760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3577c609719bSwdenk
3578c609719bSwdenk	   Size of the sector containing the environment.
3579c609719bSwdenk
3580c609719bSwdenk
3581c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3582c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3583c609719bSwdenk	   the environment.
3584c609719bSwdenk
35850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3586c609719bSwdenk
35875a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
35880e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3589c609719bSwdenk	   of this flash sector for the environment. This saves
3590c609719bSwdenk	   memory for the RAM copy of the environment.
3591c609719bSwdenk
3592c609719bSwdenk	   It may also save flash memory if you decide to use this
3593c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3594c609719bSwdenk	   since then the remainder of the flash sector could be used
3595c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3596c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3597c609719bSwdenk	   updating the environment in flash makes it always
3598c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3599c609719bSwdenk	   wrong before the contents has been restored from a copy in
3600c609719bSwdenk	   RAM, your target system will be dead.
3601c609719bSwdenk
36020e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
36030e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3604c609719bSwdenk
3605c609719bSwdenk	   These settings describe a second storage area used to hold
360611ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
36073e38691eSwdenk	   a valid backup copy in case there is a power failure during
3608c609719bSwdenk	   a "saveenv" operation.
3609c609719bSwdenk
3610c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3611c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3612c609719bSwdenkaccordingly!
3613c609719bSwdenk
3614c609719bSwdenk
36159314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3616c609719bSwdenk
3617c609719bSwdenk	Define this if you have some non-volatile memory device
3618c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3619c609719bSwdenk	environment.
3620c609719bSwdenk
36210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36220e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3623c609719bSwdenk
362411ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3625c609719bSwdenk	  want to use for environment. It is assumed that this memory
3626c609719bSwdenk	  can just be read and written to, without any special
3627c609719bSwdenk	  provision.
3628c609719bSwdenk
3629c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3630c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
363111ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3632c609719bSwdenkU-Boot will hang.
3633c609719bSwdenk
3634c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3635c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3636c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3637c609719bSwdenkto save the current settings.
3638c609719bSwdenk
3639c609719bSwdenk
3640bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3641c609719bSwdenk
3642c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3643c609719bSwdenk	device and a driver for it.
3644c609719bSwdenk
36450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36460e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3647c609719bSwdenk
3648c609719bSwdenk	  These two #defines specify the offset and size of the
3649c609719bSwdenk	  environment area within the total memory of your EEPROM.
3650c609719bSwdenk
36516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3652c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3653c609719bSwdenk	  The default address is zero.
3654c609719bSwdenk
36556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3656c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3657c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3658c609719bSwdenk	  would require six bits.
3659c609719bSwdenk
36606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3661c609719bSwdenk	  If defined, the number of milliseconds to delay between
3662c609719bSwdenk	  page writes.	The default is zero milliseconds.
3663c609719bSwdenk
36646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3665c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3666c609719bSwdenk	  that this is NOT the chip address length!
3667c609719bSwdenk
36686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
36695cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
36705cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
36715cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
36725cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
36735cf91d6bSwdenk	  byte chips.
36745cf91d6bSwdenk
36755cf91d6bSwdenk	  Note that we consider the length of the address field to
36765cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
36775cf91d6bSwdenk	  in the chip address.
36785cf91d6bSwdenk
36796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3680c609719bSwdenk	  The size in bytes of the EEPROM device.
3681c609719bSwdenk
3682548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3683548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3684548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3685548738b4SHeiko Schocher
3686548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3687548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3688548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3689548738b4SHeiko Schocher	  EEPROM. For example:
3690548738b4SHeiko Schocher
3691ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3692548738b4SHeiko Schocher
3693548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3694548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3695c609719bSwdenk
3696057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
36975779d8d9Swdenk
36985779d8d9Swdenk	Define this if you have a DataFlash memory device which you
36995779d8d9Swdenk	want to use for the environment.
37005779d8d9Swdenk
37010e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37020e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
37030e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
37045779d8d9Swdenk
37055779d8d9Swdenk	  These three #defines specify the offset and size of the
37065779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
37075779d8d9Swdenk	  at the specified address.
37085779d8d9Swdenk
37090a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
37100a85a9e7SLiu Gang
37110a85a9e7SLiu Gang	Define this if you have a remote memory space which you
37120a85a9e7SLiu Gang	want to use for the local device's environment.
37130a85a9e7SLiu Gang
37140a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
37150a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
37160a85a9e7SLiu Gang
37170a85a9e7SLiu Gang	  These two #defines specify the address and size of the
37180a85a9e7SLiu Gang	  environment area within the remote memory space. The
37190a85a9e7SLiu Gang	  local device can get the environment from remote memory
3720fc54c7faSLiu Gang	  space by SRIO or PCIE links.
37210a85a9e7SLiu Gang
37220a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
37230a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3724fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3725fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
37260a85a9e7SLiu Gang
372751bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
372813a5695bSwdenk
372913a5695bSwdenk	Define this if you have a NAND device which you want to use
373013a5695bSwdenk	for the environment.
373113a5695bSwdenk
37320e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37330e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
373413a5695bSwdenk
373513a5695bSwdenk	  These two #defines specify the offset and size of the environment
3736fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3737fdd813deSScott Wood	  aligned to an erase block boundary.
37385779d8d9Swdenk
3739fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3740e443c944SMarkus Klotzbuecher
37410e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3742fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3743fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3744fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3745fdd813deSScott Wood	  aligned to an erase block boundary.
3746e443c944SMarkus Klotzbuecher
3747fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3748fdd813deSScott Wood
3749fdd813deSScott Wood	  Specifies the length of the region in which the environment
3750fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3751fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3752fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3753fdd813deSScott Wood	  the range to be avoided.
3754fdd813deSScott Wood
3755fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3756fdd813deSScott Wood
3757fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3758fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3759fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3760fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3761fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3762e443c944SMarkus Klotzbuecher
3763b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3764b74ab737SGuennadi Liakhovetski
3765b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3766b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3767b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3768b74ab737SGuennadi Liakhovetski
37692b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37702b74433fSJoe Hershberger
37712b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37722b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37732b74433fSJoe Hershberger	accesses, which is important on NAND.
37742b74433fSJoe Hershberger
37752b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37762b74433fSJoe Hershberger
37772b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37782b74433fSJoe Hershberger
37792b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
37802b74433fSJoe Hershberger
37812b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
37822b74433fSJoe Hershberger	  environment in.
37832b74433fSJoe Hershberger
3784785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3785785881f7SJoe Hershberger
3786785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3787785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3788785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3789785881f7SJoe Hershberger
37902b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
37912b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
37922b74433fSJoe Hershberger
37932b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
37942b74433fSJoe Hershberger	  when storing the env in UBI.
37952b74433fSJoe Hershberger
379606e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
379706e4ae5fSStephen Warren
379806e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
379906e4ae5fSStephen Warren	environment.
380006e4ae5fSStephen Warren
380106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
380206e4ae5fSStephen Warren
380306e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
380406e4ae5fSStephen Warren
380506e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
380606e4ae5fSStephen Warren
380706e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
380806e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
380906e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
381006e4ae5fSStephen Warren
381106e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
381206e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
381306e4ae5fSStephen Warren
381406e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
381506e4ae5fSStephen Warren	  area within the specified MMC device.
381606e4ae5fSStephen Warren
38175c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
38185c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
38195c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
38205c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
38215c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
38225c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
38235c088ee8SStephen Warren	  maximum possible space before it, to store other data.
38245c088ee8SStephen Warren
382506e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
382606e4ae5fSStephen Warren	  MMC sector boundary.
382706e4ae5fSStephen Warren
382806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
382906e4ae5fSStephen Warren
383006e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
383106e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
383206e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
383306e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
383406e4ae5fSStephen Warren
38355c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38365c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38375c088ee8SStephen Warren
383806e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
383906e4ae5fSStephen Warren	  an MMC sector boundary.
384006e4ae5fSStephen Warren
384106e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
384206e4ae5fSStephen Warren
384306e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
384406e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
384506e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
384606e4ae5fSStephen Warren
38476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3848c609719bSwdenk
3849c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3850c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3851c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3852c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3853c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3854c609719bSwdenk	to be a good choice since it makes it far enough from the
3855c609719bSwdenk	start of the data area as well as from the stack pointer.
3856c609719bSwdenk
3857e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3858c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3859cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3860c609719bSwdenkuntil then to read environment variables.
3861c609719bSwdenk
386285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
386385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
386485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
386585ec0bccSwdenknecessary, because the first environment variable we need is the
386685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
386785ec0bccSwdenkhave any device yet where we could complain.]
3868c609719bSwdenk
3869c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3870c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
387185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3872c609719bSwdenk
38736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3874fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3875fc3e2165Swdenk
38766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3877fc3e2165Swdenk		      also needs to be defined.
3878fc3e2165Swdenk
38796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3880fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3881c609719bSwdenk
3882f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3883f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3884f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3885f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3886f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3887f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3888f5675aa5SRon Madrid
3889b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3890b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3891b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3892b2b92f53SSimon Glass		to do this.
3893b2b92f53SSimon Glass
3894e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3895e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3896e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3897e2e3e2b1SSimon Glass		present.
3898e2e3e2b1SSimon Glass
3899c609719bSwdenkLow Level (hardware related) configuration options:
3900dc7c9a1aSwdenk---------------------------------------------------
3901c609719bSwdenk
39026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3903c609719bSwdenk		Cache Line Size of the CPU.
3904c609719bSwdenk
39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3906c609719bSwdenk		Default address of the IMMR after system reset.
39072535d602Swdenk
39082535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
39092535d602Swdenk		and RPXsuper) to be able to adjust the position of
39102535d602Swdenk		the IMMR register after a reset.
3911c609719bSwdenk
3912e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3913e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3914e46fedfeSTimur Tabi		PowerPC SOCs.
3915e46fedfeSTimur Tabi
3916e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3917e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3918e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3919e46fedfeSTimur Tabi
3920e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3921e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3922e46fedfeSTimur Tabi
3923e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3924e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3925e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3926e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3927e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3928e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3929e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3930e46fedfeSTimur Tabi
3931e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3932e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3933e46fedfeSTimur Tabi
3934e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3935e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3936e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3937e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3938e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3939e46fedfeSTimur Tabi
3940e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3941e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3942e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3943e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3944e46fedfeSTimur Tabi
3945e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3946e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3947e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3948e46fedfeSTimur Tabi
39497f6c2cbcSwdenk- Floppy Disk Support:
39506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39517f6c2cbcSwdenk
39527f6c2cbcSwdenk		the default drive number (default value 0)
39537f6c2cbcSwdenk
39546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39557f6c2cbcSwdenk
395611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39577f6c2cbcSwdenk		(default value 1)
39587f6c2cbcSwdenk
39596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39607f6c2cbcSwdenk
39617f6c2cbcSwdenk		defines the offset of register from address. It
39627f6c2cbcSwdenk		depends on which part of the data bus is connected to
396311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39647f6c2cbcSwdenk
39656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39677f6c2cbcSwdenk		default value.
39687f6c2cbcSwdenk
39696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39707f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39717f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
39727f6c2cbcSwdenk		source code. It is used to make hardware dependant
39737f6c2cbcSwdenk		initializations.
39747f6c2cbcSwdenk
39750abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39760abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39770abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39780abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
39790abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
39800abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
39810abddf82SMacpaul Lin		is requierd.
39820abddf82SMacpaul Lin
39836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
398425d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
398525d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3986c609719bSwdenk
39876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3988c609719bSwdenk
39897152b1d0Swdenk		Start address of memory area that can be used for
3990c609719bSwdenk		initial data and stack; please note that this must be
3991c609719bSwdenk		writable memory that is working WITHOUT special
3992c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3993c609719bSwdenk		will become available only after programming the
3994c609719bSwdenk		memory controller and running certain initialization
3995c609719bSwdenk		sequences.
3996c609719bSwdenk
3997c609719bSwdenk		U-Boot uses the following memory types:
3998c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3999c609719bSwdenk		- MPC824X: data cache
4000c609719bSwdenk		- PPC4xx:  data cache
4001c609719bSwdenk
40026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4003c609719bSwdenk
4004c609719bSwdenk		Offset of the initial data structure in the memory
40056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
40066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4007c609719bSwdenk		data is located at the end of the available space
4008553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
40096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
40106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
40116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4012c609719bSwdenk
4013c609719bSwdenk	Note:
4014c609719bSwdenk		On the MPC824X (or other systems that use the data
4015c609719bSwdenk		cache for initial memory) the address chosen for
40166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4017c609719bSwdenk		point to an otherwise UNUSED address space between
4018c609719bSwdenk		the top of RAM and the start of the PCI space.
4019c609719bSwdenk
40206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4021c609719bSwdenk
40226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4023c609719bSwdenk
40246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4025c609719bSwdenk
40266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4027c609719bSwdenk
40286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4029c609719bSwdenk
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4031c609719bSwdenk
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4033c609719bSwdenk		SDRAM timing
4034c609719bSwdenk
40356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4036c609719bSwdenk		periodic timer for refresh
4037c609719bSwdenk
40386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4039c609719bSwdenk
40406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
40416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
40426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4044c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4045c609719bSwdenk
4046c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
40486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4049c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4050c609719bSwdenk
40516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
40526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4053c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4054c609719bSwdenk		Prescaler definitions (SDRAM timing)
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
4057c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
4058c609719bSwdenk		define relocation offset in DPRAM [DSP2]
4059c609719bSwdenk
40606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4061b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
4062b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
4063b423d055SHeiko Schocher
40646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
4065c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
4066c609719bSwdenk		define relocation offset in DPRAM [SCC4]
4067c609719bSwdenk
40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
4069c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
4070c609719bSwdenk		wrong setting might damage your board. Read
4071c609719bSwdenk		doc/README.MBX before setting this variable!
4072c609719bSwdenk
40736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
4074ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4075ea909b76Swdenk		(Power On Self Tests). This definition overrides
4076ea909b76Swdenk		#define'd default value in commproc.h resp.
4077ea909b76Swdenk		cpm_8260.h.
4078ea909b76Swdenk
40796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
40806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
40816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
40826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
40856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
40866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4087a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
40885d232d0eSwdenk
40899cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
40909cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
40919cacf4fcSDirk Eibach		required.
40929cacf4fcSDirk Eibach
409369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
409469fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
409569fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
409669fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
409769fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
409869fd2d3bSAndrew Sharp		by coreboot or similar.
409969fd2d3bSAndrew Sharp
4100842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4101842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4102842033e6SGabor Juhos
4103a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4104a09b9b68SKumar Gala		Chip has SRIO or not
4105a09b9b68SKumar Gala
4106a09b9b68SKumar Gala- CONFIG_SRIO1:
4107a09b9b68SKumar Gala		Board has SRIO 1 port available
4108a09b9b68SKumar Gala
4109a09b9b68SKumar Gala- CONFIG_SRIO2:
4110a09b9b68SKumar Gala		Board has SRIO 2 port available
4111a09b9b68SKumar Gala
4112c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4113c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4114c8b28152SLiu Gang
4115a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4116a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4117a09b9b68SKumar Gala
4118a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4119a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4120a09b9b68SKumar Gala
4121a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4122a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4123a09b9b68SKumar Gala
412466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
412566bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
412666bd1846SFabio Estevam		a 16 bit bus.
412766bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4128a430e916SFabio Estevam		Example of drivers that use it:
412966bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4130a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4131eced4626SAlex Waterman
4132eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4133eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4134eced4626SAlex Waterman		a default value will be used.
4135eced4626SAlex Waterman
4136bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4137218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4138218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4139218ca724SWolfgang Denk
4140bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4141bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4142bb99ad6dSBen Warren
41436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4144218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4145218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4146218ca724SWolfgang Denk		to something your driver can deal with.
4147bb99ad6dSBen Warren
41481b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
41491b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
41501b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
41511b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
41521b3e3c4fSYork Sun		header files or board specific files.
41531b3e3c4fSYork Sun
41546f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
41556f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
41566f5e1dc5SYork Sun
41576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4158218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4159218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
41602ad6b513STimur Tabi
4161c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
4162c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
4163c26e454dSwdenk
4164c26e454dSwdenk- CONFIG_FEC[12]_PHY
4165c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
41666e592385Swdenk		to the given FEC; i. e.
4167c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
4168c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
4169c26e454dSwdenk
4170c26e454dSwdenk		When set to -1, means to probe for first available.
4171c26e454dSwdenk
4172c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
4173c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
4174c26e454dSwdenk		(so program the FEC to ignore it).
4175c26e454dSwdenk
4176c26e454dSwdenk- CONFIG_RMII
4177c26e454dSwdenk		Enable RMII mode for all FECs.
4178c26e454dSwdenk		Note that this is a global option, we can't
4179c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4180c26e454dSwdenk
41815cf91d6bSwdenk- CONFIG_CRC32_VERIFY
41825cf91d6bSwdenk		Add a verify option to the crc32 command.
41835cf91d6bSwdenk		The syntax is:
41845cf91d6bSwdenk
41855cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
41865cf91d6bSwdenk
41875cf91d6bSwdenk		Where address/count indicate a memory area
41885cf91d6bSwdenk		and crc32 is the correct crc32 which the
41895cf91d6bSwdenk		area should have.
41905cf91d6bSwdenk
419156523f12Swdenk- CONFIG_LOOPW
419256523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4193602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
419456523f12Swdenk
41957b466641Sstroese- CONFIG_MX_CYCLIC
41967b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
41977b466641Sstroese		"md/mw" commands.
41987b466641Sstroese		Examples:
41997b466641Sstroese
42007b466641Sstroese		=> mdc.b 10 4 500
42017b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
42027b466641Sstroese
42037b466641Sstroese		=> mwc.l 100 12345678 10
42047b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
42057b466641Sstroese
42067b466641Sstroese		This only takes effect if the memory commands are activated
4207602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
42087b466641Sstroese
42098aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4210afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4211e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4212e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4213e03f3169SWolfgang Denk		relocate itself into RAM.
42148aa1a2d1Swdenk
4215e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4216e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4217e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4218e03f3169SWolfgang Denk		these initializations itself.
42198aa1a2d1Swdenk
4220401bb30bSAneesh V- CONFIG_SPL_BUILD
4221df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4222df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4223df81238bSMagnus Lilja		compiling a NAND SPL.
4224400558b5Swdenk
42255df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
42265df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
42275df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
42285df572f0SYing Zhang		previous 4k of the .text section.
42295df572f0SYing Zhang
42304213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
42314213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
42324213fc29SSimon Glass		effective address. It is therefore not necessary to regard
42334213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
42344213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
42354213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
42364213fc29SSimon Glass		addressable memory. This option causes some memory accesses
42374213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
42384213fc29SSimon Glass
4239d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
4240d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
4241d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
4242d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
4243d8834a13SMatthias Weisser		conditions but may increase the binary size.
4244d8834a13SMatthias Weisser
4245588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4246588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4247588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4248b16f521aSGabe Black
4249fc33705eSMark Jackson- CONFIG_SYS_MPUCLK
4250fc33705eSMark Jackson		Defines the MPU clock speed (in MHz).
4251fc33705eSMark Jackson
4252fc33705eSMark Jackson		NOTE : currently only supported on AM335x platforms.
42535b5ece9eSGabe Black
4254f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4255f2717b47STimur Tabi-----------------------------------
4256f2717b47STimur Tabi
4257f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4258f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4259f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4260f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4261f2717b47STimur Tabiwithin that device.
4262f2717b47STimur Tabi
4263f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
4264f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
4265f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4266f2717b47STimur Tabi	is also specified.
4267f2717b47STimur Tabi
4268f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4269f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4270f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4271f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4272f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4273f2717b47STimur Tabi
4274f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4275f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4276f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4277f2717b47STimur Tabi	virtual address in NOR flash.
4278f2717b47STimur Tabi
4279f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4280f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4281f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4282f2717b47STimur Tabi
4283f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4284f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4285f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4286f2717b47STimur Tabi
4287f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4288f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
4289f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4290f2717b47STimur Tabi
4291292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4292292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4293292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4294fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4295fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4296fc54c7faSLiu Gang	master's memory space.
4297f2717b47STimur Tabi
4298c609719bSwdenkBuilding the Software:
4299c609719bSwdenk======================
4300c609719bSwdenk
4301218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4302218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4303218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4304218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4305218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4306218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4307c609719bSwdenk
4308218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4309218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4310218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4311218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4312218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4313c609719bSwdenk
4314218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4315218ca724SWolfgang Denk	$ export CROSS_COMPILE
4316c609719bSwdenk
43172f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
43182f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
43192f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
43202f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
43212f8d396bSPeter Tyser
43222f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
43232f8d396bSPeter Tyser
43242f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
43252f8d396bSPeter Tyser      be executed on computers running Windows.
43262f8d396bSPeter Tyser
4327c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4328c609719bSwdenksources you must configure U-Boot for one specific board type. This
4329c609719bSwdenkis done by typing:
4330c609719bSwdenk
4331c609719bSwdenk	make NAME_config
4332c609719bSwdenk
4333218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
43344d675ae6SMichael Jonesrations; see boards.cfg for supported names.
433554387ac9Swdenk
4336c609719bSwdenkNote: for some board special configuration names may exist; check if
4337c609719bSwdenk      additional information is available from the board vendor; for
43382729af9dSwdenk      instance, the TQM823L systems are available without (standard)
43392729af9dSwdenk      or with LCD support. You can select such additional "features"
434011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4341c609719bSwdenk
43422729af9dSwdenk      make TQM823L_config
43432729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4344c609719bSwdenk
4345c609719bSwdenk      make TQM823L_LCD_config
4346c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4347c609719bSwdenk
4348c609719bSwdenk      etc.
4349c609719bSwdenk
4350c609719bSwdenk
4351c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
43527152b1d0Swdenkimages ready for download to / installation on your system:
4353c609719bSwdenk
4354c609719bSwdenk- "u-boot.bin" is a raw binary image
4355c609719bSwdenk- "u-boot" is an image in ELF binary format
4356c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4357c609719bSwdenk
4358baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4359baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4360baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4361baf31249SMarian Balakowicz
4362baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4363baf31249SMarian Balakowicz
4364baf31249SMarian Balakowicz	make O=/tmp/build distclean
4365baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
4366baf31249SMarian Balakowicz	make O=/tmp/build all
4367baf31249SMarian Balakowicz
4368baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
4369baf31249SMarian Balakowicz
4370baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4371baf31249SMarian Balakowicz	make distclean
4372baf31249SMarian Balakowicz	make NAME_config
4373baf31249SMarian Balakowicz	make all
4374baf31249SMarian Balakowicz
4375baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
4376baf31249SMarian Balakowiczvariable.
4377baf31249SMarian Balakowicz
4378c609719bSwdenk
4379c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4380c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4381c609719bSwdenknative "make".
4382c609719bSwdenk
4383c609719bSwdenk
4384c609719bSwdenkIf the system board that you have is not listed, then you will need
4385c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4386c609719bSwdenksteps:
4387c609719bSwdenk
4388c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
43894d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
43904d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
4391c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
439285ec0bccSwdenk    files you need. In your board directory, you will need at least
439385ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
439485ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
439585ec0bccSwdenk    your board
4396c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4397c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
439885ec0bccSwdenk4.  Run "make <board>_config" with your new name.
4399c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4400c609719bSwdenk    to be installed on your target system.
440185ec0bccSwdenk6.  Debug and solve any problems that might arise.
4402c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4403c609719bSwdenk
4404c609719bSwdenk
4405c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4406c609719bSwdenk==============================================================
4407c609719bSwdenk
4408c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4409c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4410c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4411c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4412218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4413c609719bSwdenk
4414c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4415c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4416c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
4417c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
4418c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
44197152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
4420218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
4421218ca724SWolfgang Denkyou can type
4422c609719bSwdenk
4423c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
4424c609719bSwdenk
4425c609719bSwdenkor to build on a native PowerPC system you can type
4426c609719bSwdenk
4427c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
4428c609719bSwdenk
4429218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
4430218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
4431218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
4432218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
4433218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
4434218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
4435218ca724SWolfgang Denkvariable. For example:
4436baf31249SMarian Balakowicz
4437baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
4438baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
4439baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
4440baf31249SMarian Balakowicz
4441218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
4442218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
4443218ca724SWolfgang Denkduring the whole build process.
4444baf31249SMarian Balakowicz
4445baf31249SMarian Balakowicz
4446c609719bSwdenkSee also "U-Boot Porting Guide" below.
4447c609719bSwdenk
4448c609719bSwdenk
4449c609719bSwdenkMonitor Commands - Overview:
4450c609719bSwdenk============================
4451c609719bSwdenk
4452c609719bSwdenkgo	- start application at address 'addr'
4453c609719bSwdenkrun	- run commands in an environment variable
4454c609719bSwdenkbootm	- boot application image from memory
4455c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
445644f074c7SMarek Vasutbootz   - boot zImage from memory
4457c609719bSwdenktftpboot- boot image via network using TFTP protocol
4458c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4459c609719bSwdenk	       (and eventually "gatewayip")
44601fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4461c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4462c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4463c609719bSwdenkloads	- load S-Record file over serial line
4464c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4465c609719bSwdenkmd	- memory display
4466c609719bSwdenkmm	- memory modify (auto-incrementing)
4467c609719bSwdenknm	- memory modify (constant address)
4468c609719bSwdenkmw	- memory write (fill)
4469c609719bSwdenkcp	- memory copy
4470c609719bSwdenkcmp	- memory compare
4471c609719bSwdenkcrc32	- checksum calculation
44720f89c54bSPeter Tyseri2c	- I2C sub-system
4473c609719bSwdenksspi	- SPI utility commands
4474c609719bSwdenkbase	- print or set address offset
4475c609719bSwdenkprintenv- print environment variables
4476c609719bSwdenksetenv	- set environment variables
4477c609719bSwdenksaveenv - save environment variables to persistent storage
4478c609719bSwdenkprotect - enable or disable FLASH write protection
4479c609719bSwdenkerase	- erase FLASH memory
4480c609719bSwdenkflinfo	- print FLASH memory information
448110635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4482c609719bSwdenkbdinfo	- print Board Info structure
4483c609719bSwdenkiminfo	- print header information for application image
4484c609719bSwdenkconinfo - print console devices and informations
4485c609719bSwdenkide	- IDE sub-system
4486c609719bSwdenkloop	- infinite loop on address range
448756523f12Swdenkloopw	- infinite write loop on address range
4488c609719bSwdenkmtest	- simple RAM test
4489c609719bSwdenkicache	- enable or disable instruction cache
4490c609719bSwdenkdcache	- enable or disable data cache
4491c609719bSwdenkreset	- Perform RESET of the CPU
4492c609719bSwdenkecho	- echo args to console
4493c609719bSwdenkversion - print monitor version
4494c609719bSwdenkhelp	- print online help
4495c609719bSwdenk?	- alias for 'help'
4496c609719bSwdenk
4497c609719bSwdenk
4498c609719bSwdenkMonitor Commands - Detailed Description:
4499c609719bSwdenk========================================
4500c609719bSwdenk
4501c609719bSwdenkTODO.
4502c609719bSwdenk
4503c609719bSwdenkFor now: just type "help <command>".
4504c609719bSwdenk
4505c609719bSwdenk
4506c609719bSwdenkEnvironment Variables:
4507c609719bSwdenk======================
4508c609719bSwdenk
4509c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4510c609719bSwdenkcan be made persistent by saving to Flash memory.
4511c609719bSwdenk
4512c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4513c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4514c609719bSwdenkwithout a value can be used to delete a variable from the
4515c609719bSwdenkenvironment. As long as you don't save the environment you are
4516c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4517c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4518c609719bSwdenk
4519c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4520c96f86eeSWolfgang Denk
4521c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4522c609719bSwdenk
4523c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4524c609719bSwdenk
4525c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4526c609719bSwdenk
4527c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4528c609719bSwdenk
4529c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4530c609719bSwdenk
4531c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4532c609719bSwdenk
45337d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
45347d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45357d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
45367d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
45377d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
45387d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4539c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4540c3624e6eSGrant Likely		  bootm_mapsize.
4541c3624e6eSGrant Likely
4542c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4543c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4544c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4545c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4546c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4547c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4548c3624e6eSGrant Likely		  used otherwise.
45497d721e34SBartlomiej Sieka
45507d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
45517d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45527d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
45537d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
45547d721e34SBartlomiej Sieka		  environment variable.
45557d721e34SBartlomiej Sieka
45564bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
45574bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
45584bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
45594bae9090SBartlomiej Sieka
4560c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4561c609719bSwdenk		  "bootp" will just load perform a lookup of the
4562c609719bSwdenk		  configuration from the BOOTP server, but not try to
4563c609719bSwdenk		  load any image using TFTP
4564c609719bSwdenk
4565c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4566c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4567c609719bSwdenk		  be automatically started (by internally calling
4568c609719bSwdenk		  "bootm")
4569c609719bSwdenk
45704a6fd34bSwdenk		  If set to "no", a standalone image passed to the
45714a6fd34bSwdenk		  "bootm" command will be copied to the load address
45724a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
45734a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
45744a6fd34bSwdenk		  data.
45754a6fd34bSwdenk
4576a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4577a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4578fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4579fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4580fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4581fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4582fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4583fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4584fa34f6b2SShawn Guo		  access it during the boot procedure.
4585fa34f6b2SShawn Guo
4586a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4587a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4588a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4589a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4590a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4591a28afca5SDavid A. Long		  must be accessible by the kernel.
4592a28afca5SDavid A. Long
4593eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4594eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4595eea63e05SSimon Glass		  defined.
4596eea63e05SSimon Glass
459717ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
459817ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
459917ea1177Swdenk		  mode (400kHZ). This environment variable is used in
460017ea1177Swdenk		  initialization code. So, for changes to be effective
460117ea1177Swdenk		  it must be saved and board must be reset.
460217ea1177Swdenk
4603c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4604c609719bSwdenk		  If this variable is not set, initrd images will be
4605c609719bSwdenk		  copied to the highest possible address in RAM; this
4606c609719bSwdenk		  is usually what you want since it allows for
4607c609719bSwdenk		  maximum initrd size. If for some reason you want to
4608c609719bSwdenk		  make sure that the initrd image is loaded below the
46096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4610c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4611c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4612c609719bSwdenk		  address to use (U-Boot will still check that it
4613c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4614c609719bSwdenk
4615c609719bSwdenk		  For instance, when you have a system with 16 MB
46167152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4617c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4618c609719bSwdenk		  the "bootargs" variable. However, now you must make
46197152b1d0Swdenk		  sure that the initrd image is placed in the first
4620c609719bSwdenk		  12 MB as well - this can be done with
4621c609719bSwdenk
4622c609719bSwdenk		  setenv initrd_high 00c00000
4623c609719bSwdenk
462438b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
462538b99261Swdenk		  indication to U-Boot that all addresses are legal
462638b99261Swdenk		  for the Linux kernel, including addresses in flash
462738b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
462838b99261Swdenk		  ramdisk at all. This may be useful to reduce the
462938b99261Swdenk		  boot time on your system, but requires that this
463038b99261Swdenk		  feature is supported by your Linux kernel.
463138b99261Swdenk
4632c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4633c609719bSwdenk
4634c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4635dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4636c609719bSwdenk
4637c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4638c609719bSwdenk
4639c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4640c609719bSwdenk
4641c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4642c609719bSwdenk
4643c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4644c609719bSwdenk
4645c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4646c609719bSwdenk
4647e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4648a3d991bdSwdenk
4649e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4650e2a53458SMike Frysinger		  For example you can do the following
4651a3d991bdSwdenk
465248690d80SHeiko Schocher		  => setenv ethact FEC
465348690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
465448690d80SHeiko Schocher		  => setenv ethact SCC
465548690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4656a3d991bdSwdenk
4657e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4658e1692577SMatthias Fuchs		  available network interfaces.
4659e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4660e1692577SMatthias Fuchs
4661a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4662a3d991bdSwdenk		  either succeed or fail without retrying.
46636e592385Swdenk		  When set to "once" the network operation will
46646e592385Swdenk		  fail when all the available network interfaces
46656e592385Swdenk		  are tried once without success.
4666a3d991bdSwdenk		  Useful on scripts which control the retry operation
4667a3d991bdSwdenk		  themselves.
4668a3d991bdSwdenk
4669b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4670a1cf027aSJean-Christophe PLAGNIOL-VILLARD
467128cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
4672ecb0ccd9SWolfgang Denk		  UDP source port.
4673ecb0ccd9SWolfgang Denk
467428cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
467528cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
467628cb9375SWolfgang Denk
4677c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4678c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4679c96f86eeSWolfgang Denk
4680c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4681c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4682c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4683c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4684c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4685c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4686c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4687c96f86eeSWolfgang Denk
4688a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
468911ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4690a3d991bdSwdenk		  VLAN tagged frames.
4691c609719bSwdenk
4692dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4693dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4694dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4695dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4696dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4697dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4698dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4699dc0b7b0eSJason Hobbs
4700dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4701dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
4702dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4703dc0b7b0eSJason Hobbs
4704dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4705dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4706dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4707dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4708dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4709dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4710dc0b7b0eSJason Hobbs
4711c609719bSwdenkThe following environment variables may be used and automatically
4712c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4713c609719bSwdenkdepending the information provided by your boot server:
4714c609719bSwdenk
4715c609719bSwdenk  bootfile	- see above
4716c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4717fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4718c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4719c609719bSwdenk  hostname	- Target hostname
4720c609719bSwdenk  ipaddr	- see above
4721c609719bSwdenk  netmask	- Subnet Mask
4722c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4723c609719bSwdenk  serverip	- see above
4724c609719bSwdenk
4725c609719bSwdenk
4726c609719bSwdenkThere are two special Environment Variables:
4727c609719bSwdenk
4728c609719bSwdenk  serial#	- contains hardware identification information such
4729c609719bSwdenk		  as type string and/or serial number
4730c609719bSwdenk  ethaddr	- Ethernet address
4731c609719bSwdenk
4732c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4733c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4734c609719bSwdenkonce they have been set once.
4735c609719bSwdenk
4736c609719bSwdenk
4737c1551ea8SstroeseFurther special Environment Variables:
4738c1551ea8Sstroese
4739c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4740c1551ea8Sstroese		  with the "version" command. This variable is
4741c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4742c1551ea8Sstroese
4743c1551ea8Sstroese
4744c609719bSwdenkPlease note that changes to some configuration parameters may take
4745c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4746c609719bSwdenk
4747c609719bSwdenk
4748170ab110SJoe HershbergerCallback functions for environment variables:
4749170ab110SJoe Hershberger---------------------------------------------
4750170ab110SJoe Hershberger
4751170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4752170ab110SJoe Hershbergerwhen their values are changed.  This functionailty allows functions to
4753170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4754170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4755170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4756170ab110SJoe Hershberger
4757170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4758170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4759170ab110SJoe Hershberger
4760170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4761170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4762170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4763170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4764170ab110SJoe Hershberger
4765170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4766170ab110SJoe Hershberger	list = entry[,list]
4767170ab110SJoe Hershberger
4768170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4769170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4770170ab110SJoe Hershberger
4771170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4772170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4773170ab110SJoe Hershbergeroverride any association in the static list. You can define
4774170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4775170ab110SJoe Hershberger".callbacks" envirnoment variable in the default or embedded environment.
4776170ab110SJoe Hershberger
4777170ab110SJoe Hershberger
4778f07771ccSwdenkCommand Line Parsing:
4779f07771ccSwdenk=====================
4780f07771ccSwdenk
4781f07771ccSwdenkThere are two different command line parsers available with U-Boot:
47827152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4783f07771ccSwdenk
4784f07771ccSwdenkOld, simple command line parser:
4785f07771ccSwdenk--------------------------------
4786f07771ccSwdenk
4787f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4788f07771ccSwdenk- several commands on one line, separated by ';'
4789fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4790f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4791f07771ccSwdenk  for example:
4792fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4793f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4794f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4795f07771ccSwdenk
4796f07771ccSwdenkHush shell:
4797f07771ccSwdenk-----------
4798f07771ccSwdenk
4799f07771ccSwdenk- similar to Bourne shell, with control structures like
4800f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4801f07771ccSwdenk  until...do...done, ...
4802f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4803f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4804f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4805f07771ccSwdenk  command
4806f07771ccSwdenk
4807f07771ccSwdenkGeneral rules:
4808f07771ccSwdenk--------------
4809f07771ccSwdenk
4810f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4811f07771ccSwdenk    command) contains several commands separated by semicolon, and
4812f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4813f07771ccSwdenk    executed anyway.
4814f07771ccSwdenk
4815f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
481611ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4817f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4818f07771ccSwdenk    variables are not executed.
4819f07771ccSwdenk
4820c609719bSwdenkNote for Redundant Ethernet Interfaces:
4821c609719bSwdenk=======================================
4822c609719bSwdenk
482311ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4824c609719bSwdenksuch configurations and is capable of automatic selection of a
48257152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4826c609719bSwdenk
4827c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4828c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4829c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4830c609719bSwdenk
4831c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4832c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4833c609719bSwdenkding setting in the environment; if the corresponding environment
4834c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4835c609719bSwdenk
4836c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4837c609719bSwdenk  environment, the SROM's address is used.
4838c609719bSwdenk
4839c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4840c609719bSwdenk  environment exists, then the value from the environment variable is
4841c609719bSwdenk  used.
4842c609719bSwdenk
4843c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4844c609719bSwdenk  both addresses are the same, this MAC address is used.
4845c609719bSwdenk
4846c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4847c609719bSwdenk  addresses differ, the value from the environment is used and a
4848c609719bSwdenk  warning is printed.
4849c609719bSwdenk
4850c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4851c609719bSwdenk  is raised.
4852c609719bSwdenk
4853ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4854ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4855ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4856ecee9324SBen WarrenThe naming convention is as follows:
4857ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4858c609719bSwdenk
4859c609719bSwdenkImage Formats:
4860c609719bSwdenk==============
4861c609719bSwdenk
48623310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
48633310c549SMarian Balakowiczimages in two formats:
48643310c549SMarian Balakowicz
48653310c549SMarian BalakowiczNew uImage format (FIT)
48663310c549SMarian Balakowicz-----------------------
48673310c549SMarian Balakowicz
48683310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
48693310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
48703310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
48713310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
48723310c549SMarian Balakowicz
48733310c549SMarian Balakowicz
48743310c549SMarian BalakowiczOld uImage format
48753310c549SMarian Balakowicz-----------------
48763310c549SMarian Balakowicz
48773310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
48783310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
48793310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4880c609719bSwdenk
4881c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4882c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4883f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4884f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4885f5ed9e39SPeter Tyser  INTEGRITY).
48867b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4887afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4888afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4889c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4890c609719bSwdenk* Load Address
4891c609719bSwdenk* Entry Point
4892c609719bSwdenk* Image Name
4893c609719bSwdenk* Image Timestamp
4894c609719bSwdenk
4895c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4896c609719bSwdenkand the data portions of the image are secured against corruption by
4897c609719bSwdenkCRC32 checksums.
4898c609719bSwdenk
4899c609719bSwdenk
4900c609719bSwdenkLinux Support:
4901c609719bSwdenk==============
4902c609719bSwdenk
4903c609719bSwdenkAlthough U-Boot should support any OS or standalone application
49047152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4905c609719bSwdenkU-Boot.
4906c609719bSwdenk
4907c609719bSwdenkU-Boot includes many features that so far have been part of some
4908c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4909c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4910c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
49117152b1d0Swdenkserves several purposes:
4912c609719bSwdenk
4913c609719bSwdenk- the same features can be used for other OS or standalone
4914c609719bSwdenk  applications (for instance: using compressed images to reduce the
4915c609719bSwdenk  Flash memory footprint)
4916c609719bSwdenk
4917c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
49187152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4919c609719bSwdenk
4920c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4921c609719bSwdenk  images; of course this also means that different kernel images can
4922c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4923c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4924c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4925c609719bSwdenk  software is easier now.
4926c609719bSwdenk
4927c609719bSwdenk
4928c609719bSwdenkLinux HOWTO:
4929c609719bSwdenk============
4930c609719bSwdenk
4931c609719bSwdenkPorting Linux to U-Boot based systems:
4932c609719bSwdenk---------------------------------------
4933c609719bSwdenk
4934c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4935c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4936c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4937c609719bSwdenkLinux :-).
4938c609719bSwdenk
4939a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4940c609719bSwdenk
4941c609719bSwdenkJust make sure your machine specific header file (for instance
4942c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
49431dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
49441dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
49456d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4946c609719bSwdenk
4947c609719bSwdenk
4948c609719bSwdenkConfiguring the Linux kernel:
4949c609719bSwdenk-----------------------------
4950c609719bSwdenk
4951c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4952c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4953c609719bSwdenk
4954c609719bSwdenk
4955c609719bSwdenkBuilding a Linux Image:
4956c609719bSwdenk-----------------------
4957c609719bSwdenk
495824ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
495924ee89b9Swdenknot used. If you use recent kernel source, a new build target
496024ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
496124ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
496224ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
496324ee89b9Swdenk100% compatible format.
4964c609719bSwdenk
4965c609719bSwdenkExample:
4966c609719bSwdenk
4967c609719bSwdenk	make TQM850L_config
4968c609719bSwdenk	make oldconfig
4969c609719bSwdenk	make dep
497024ee89b9Swdenk	make uImage
4971c609719bSwdenk
497224ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
497324ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
497424ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4975c609719bSwdenk
497624ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
497724ee89b9Swdenk
497824ee89b9Swdenk* convert the kernel into a raw binary image:
497924ee89b9Swdenk
498024ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
498124ee89b9Swdenk				 -R .note -R .comment \
498224ee89b9Swdenk				 -S vmlinux linux.bin
498324ee89b9Swdenk
498424ee89b9Swdenk* compress the binary image:
498524ee89b9Swdenk
498624ee89b9Swdenk	gzip -9 linux.bin
498724ee89b9Swdenk
498824ee89b9Swdenk* package compressed binary image for U-Boot:
498924ee89b9Swdenk
499024ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
499124ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
499224ee89b9Swdenk		-d linux.bin.gz uImage
499324ee89b9Swdenk
499424ee89b9Swdenk
499524ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
499624ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
499724ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
499824ee89b9Swdenkbyte header containing information about target architecture,
499924ee89b9Swdenkoperating system, image type, compression method, entry points, time
500024ee89b9Swdenkstamp, CRC32 checksums, etc.
500124ee89b9Swdenk
500224ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
500324ee89b9Swdenkprint the header information, or to build new images.
5004c609719bSwdenk
5005c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5006c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5007c609719bSwdenkchecksum verification:
5008c609719bSwdenk
5009c609719bSwdenk	tools/mkimage -l image
5010c609719bSwdenk	  -l ==> list image header information
5011c609719bSwdenk
5012c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5013c609719bSwdenkfrom a "data file" which is used as image payload:
5014c609719bSwdenk
5015c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5016c609719bSwdenk		      -n name -d data_file image
5017c609719bSwdenk	  -A ==> set architecture to 'arch'
5018c609719bSwdenk	  -O ==> set operating system to 'os'
5019c609719bSwdenk	  -T ==> set image type to 'type'
5020c609719bSwdenk	  -C ==> set compression type 'comp'
5021c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5022c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5023c609719bSwdenk	  -n ==> set image name to 'name'
5024c609719bSwdenk	  -d ==> use image data from 'datafile'
5025c609719bSwdenk
502669459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
502769459791Swdenkaddress (0x00000000), but the entry point address depends on the
502869459791Swdenkkernel version:
5029c609719bSwdenk
5030c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
503124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5032c609719bSwdenk
5033c609719bSwdenkSo a typical call to build a U-Boot image would read:
5034c609719bSwdenk
503524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
503624ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5037a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
503824ee89b9Swdenk	> examples/uImage.TQM850L
503924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5040c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5041c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5042c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5043c609719bSwdenk	Load Address: 0x00000000
504424ee89b9Swdenk	Entry Point:  0x00000000
5045c609719bSwdenk
5046c609719bSwdenkTo verify the contents of the image (or check for corruption):
5047c609719bSwdenk
504824ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
504924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5050c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5051c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5052c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5053c609719bSwdenk	Load Address: 0x00000000
505424ee89b9Swdenk	Entry Point:  0x00000000
5055c609719bSwdenk
5056c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5057c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5058c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5059c609719bSwdenkneed to be uncompressed:
5060c609719bSwdenk
5061a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
506224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
506324ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5064a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
506524ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
506624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5067c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5068c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5069c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5070c609719bSwdenk	Load Address: 0x00000000
507124ee89b9Swdenk	Entry Point:  0x00000000
5072c609719bSwdenk
5073c609719bSwdenk
5074c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5075c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5076c609719bSwdenk
5077c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5078c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5079c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5080c609719bSwdenk	Image Name:   Simple Ramdisk Image
5081c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5082c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5083c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5084c609719bSwdenk	Load Address: 0x00000000
5085c609719bSwdenk	Entry Point:  0x00000000
5086c609719bSwdenk
5087c609719bSwdenk
5088c609719bSwdenkInstalling a Linux Image:
5089c609719bSwdenk-------------------------
5090c609719bSwdenk
5091c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5092c609719bSwdenkyou must convert the image to S-Record format:
5093c609719bSwdenk
5094c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5095c609719bSwdenk
5096c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5097c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5098c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5099c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5100c609719bSwdenkcommand.
5101c609719bSwdenk
5102c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5103c609719bSwdenkTQM8xxL is in the first Flash bank):
5104c609719bSwdenk
5105c609719bSwdenk	=> erase 40100000 401FFFFF
5106c609719bSwdenk
5107c609719bSwdenk	.......... done
5108c609719bSwdenk	Erased 8 sectors
5109c609719bSwdenk
5110c609719bSwdenk	=> loads 40100000
5111c609719bSwdenk	## Ready for S-Record download ...
5112c609719bSwdenk	~>examples/image.srec
5113c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5114c609719bSwdenk	...
5115c609719bSwdenk	15989 15990 15991 15992
5116c609719bSwdenk	[file transfer complete]
5117c609719bSwdenk	[connected]
5118c609719bSwdenk	## Start Addr = 0x00000000
5119c609719bSwdenk
5120c609719bSwdenk
5121c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5122c609719bSwdenkthis includes a checksum verification so you can be sure no data
5123c609719bSwdenkcorruption happened:
5124c609719bSwdenk
5125c609719bSwdenk	=> imi 40100000
5126c609719bSwdenk
5127c609719bSwdenk	## Checking Image at 40100000 ...
5128c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5129c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5130c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5131c609719bSwdenk	   Load Address: 00000000
5132c609719bSwdenk	   Entry Point:	 0000000c
5133c609719bSwdenk	   Verifying Checksum ... OK
5134c609719bSwdenk
5135c609719bSwdenk
5136c609719bSwdenkBoot Linux:
5137c609719bSwdenk-----------
5138c609719bSwdenk
5139c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5140c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5141c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5142c609719bSwdenkparameters. You can check and modify this variable using the
5143c609719bSwdenk"printenv" and "setenv" commands:
5144c609719bSwdenk
5145c609719bSwdenk
5146c609719bSwdenk	=> printenv bootargs
5147c609719bSwdenk	bootargs=root=/dev/ram
5148c609719bSwdenk
5149c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5150c609719bSwdenk
5151c609719bSwdenk	=> printenv bootargs
5152c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5153c609719bSwdenk
5154c609719bSwdenk	=> bootm 40020000
5155c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5156c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5157c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5158c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5159c609719bSwdenk	   Load Address: 00000000
5160c609719bSwdenk	   Entry Point:	 0000000c
5161c609719bSwdenk	   Verifying Checksum ... OK
5162c609719bSwdenk	   Uncompressing Kernel Image ... OK
5163c609719bSwdenk	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
5164c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5165c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5166c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5167c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5168c609719bSwdenk	...
5169c609719bSwdenk
517011ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
51717152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5172c609719bSwdenkformat!) to the "bootm" command:
5173c609719bSwdenk
5174c609719bSwdenk	=> imi 40100000 40200000
5175c609719bSwdenk
5176c609719bSwdenk	## Checking Image at 40100000 ...
5177c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5178c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5179c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5180c609719bSwdenk	   Load Address: 00000000
5181c609719bSwdenk	   Entry Point:	 0000000c
5182c609719bSwdenk	   Verifying Checksum ... OK
5183c609719bSwdenk
5184c609719bSwdenk	## Checking Image at 40200000 ...
5185c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5186c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5187c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5188c609719bSwdenk	   Load Address: 00000000
5189c609719bSwdenk	   Entry Point:	 00000000
5190c609719bSwdenk	   Verifying Checksum ... OK
5191c609719bSwdenk
5192c609719bSwdenk	=> bootm 40100000 40200000
5193c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5194c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5195c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5196c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5197c609719bSwdenk	   Load Address: 00000000
5198c609719bSwdenk	   Entry Point:	 0000000c
5199c609719bSwdenk	   Verifying Checksum ... OK
5200c609719bSwdenk	   Uncompressing Kernel Image ... OK
5201c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5202c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5203c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5204c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5205c609719bSwdenk	   Load Address: 00000000
5206c609719bSwdenk	   Entry Point:	 00000000
5207c609719bSwdenk	   Verifying Checksum ... OK
5208c609719bSwdenk	   Loading Ramdisk ... OK
5209c609719bSwdenk	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
5210c609719bSwdenk	Boot arguments: root=/dev/ram
5211c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5212c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5213c609719bSwdenk	...
5214c609719bSwdenk	RAMDISK: Compressed image found at block 0
5215c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5216c609719bSwdenk
5217c609719bSwdenk	bash#
5218c609719bSwdenk
52190267768eSMatthew McClintockBoot Linux and pass a flat device tree:
52200267768eSMatthew McClintock-----------
52210267768eSMatthew McClintock
52220267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
52230267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
52240267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
52250267768eSMatthew McClintockflat device tree:
52260267768eSMatthew McClintock
52270267768eSMatthew McClintock=> print oftaddr
52280267768eSMatthew McClintockoftaddr=0x300000
52290267768eSMatthew McClintock=> print oft
52300267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
52310267768eSMatthew McClintock=> tftp $oftaddr $oft
52320267768eSMatthew McClintockSpeed: 1000, full duplex
52330267768eSMatthew McClintockUsing TSEC0 device
52340267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
52350267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
52360267768eSMatthew McClintockLoad address: 0x300000
52370267768eSMatthew McClintockLoading: #
52380267768eSMatthew McClintockdone
52390267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
52400267768eSMatthew McClintock=> tftp $loadaddr $bootfile
52410267768eSMatthew McClintockSpeed: 1000, full duplex
52420267768eSMatthew McClintockUsing TSEC0 device
52430267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
52440267768eSMatthew McClintockFilename 'uImage'.
52450267768eSMatthew McClintockLoad address: 0x200000
52460267768eSMatthew McClintockLoading:############
52470267768eSMatthew McClintockdone
52480267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
52490267768eSMatthew McClintock=> print loadaddr
52500267768eSMatthew McClintockloadaddr=200000
52510267768eSMatthew McClintock=> print oftaddr
52520267768eSMatthew McClintockoftaddr=0x300000
52530267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
52540267768eSMatthew McClintock## Booting image at 00200000 ...
52550267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
52560267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
52570267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
52580267768eSMatthew McClintock   Load Address: 00000000
52590267768eSMatthew McClintock   Entry Point:	 00000000
52600267768eSMatthew McClintock   Verifying Checksum ... OK
52610267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
52620267768eSMatthew McClintockBooting using flat device tree at 0x300000
52630267768eSMatthew McClintockUsing MPC85xx ADS machine description
52640267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
52650267768eSMatthew McClintock[snip]
52660267768eSMatthew McClintock
52670267768eSMatthew McClintock
52686069ff26SwdenkMore About U-Boot Image Types:
52696069ff26Swdenk------------------------------
52706069ff26Swdenk
52716069ff26SwdenkU-Boot supports the following image types:
52726069ff26Swdenk
52736069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
52746069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
52756069ff26Swdenk	well) you can continue to work in U-Boot after return from
52766069ff26Swdenk	the Standalone Program.
52776069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
52786069ff26Swdenk	will take over control completely. Usually these programs
52796069ff26Swdenk	will install their own set of exception handlers, device
52806069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
52816069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
52826069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
52836069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
52846069ff26Swdenk	being started.
52856069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
52866069ff26Swdenk	(Linux) kernel image and one or more data images like
52876069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
52886069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
52896069ff26Swdenk	server provides just a single image file, but you want to get
52906069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
52916069ff26Swdenk
52926069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
52936069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
52946069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
52956069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
52966069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
52976069ff26Swdenk	a multiple of 4 bytes).
52986069ff26Swdenk
52996069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
53006069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
53016069ff26Swdenk	flash memory.
53026069ff26Swdenk
53036069ff26Swdenk   "Script files" are command sequences that will be executed by
53046069ff26Swdenk	U-Boot's command interpreter; this feature is especially
53056069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
53066069ff26Swdenk	as command interpreter.
53076069ff26Swdenk
530844f074c7SMarek VasutBooting the Linux zImage:
530944f074c7SMarek Vasut-------------------------
531044f074c7SMarek Vasut
531144f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
531244f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
531344f074c7SMarek Vasutas the syntax of "bootm" command.
531444f074c7SMarek Vasut
53158ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5316017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5317017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5318017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5319017e1f3fSMarek Vasut
5320c609719bSwdenk
5321c609719bSwdenkStandalone HOWTO:
5322c609719bSwdenk=================
5323c609719bSwdenk
5324c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5325c609719bSwdenkrun "standalone" applications, which can use some resources of
5326c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5327c609719bSwdenk
5328c609719bSwdenkTwo simple examples are included with the sources:
5329c609719bSwdenk
5330c609719bSwdenk"Hello World" Demo:
5331c609719bSwdenk-------------------
5332c609719bSwdenk
5333c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5334c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5335c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5336c609719bSwdenklike that:
5337c609719bSwdenk
5338c609719bSwdenk	=> loads
5339c609719bSwdenk	## Ready for S-Record download ...
5340c609719bSwdenk	~>examples/hello_world.srec
5341c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5342c609719bSwdenk	[file transfer complete]
5343c609719bSwdenk	[connected]
5344c609719bSwdenk	## Start Addr = 0x00040004
5345c609719bSwdenk
5346c609719bSwdenk	=> go 40004 Hello World! This is a test.
5347c609719bSwdenk	## Starting application at 0x00040004 ...
5348c609719bSwdenk	Hello World
5349c609719bSwdenk	argc = 7
5350c609719bSwdenk	argv[0] = "40004"
5351c609719bSwdenk	argv[1] = "Hello"
5352c609719bSwdenk	argv[2] = "World!"
5353c609719bSwdenk	argv[3] = "This"
5354c609719bSwdenk	argv[4] = "is"
5355c609719bSwdenk	argv[5] = "a"
5356c609719bSwdenk	argv[6] = "test."
5357c609719bSwdenk	argv[7] = "<NULL>"
5358c609719bSwdenk	Hit any key to exit ...
5359c609719bSwdenk
5360c609719bSwdenk	## Application terminated, rc = 0x0
5361c609719bSwdenk
5362c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5363c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5364c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5365c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5366c609719bSwdenkcharacter, but this is just a demo program. The application can be
5367c609719bSwdenkcontrolled by the following keys:
5368c609719bSwdenk
5369c609719bSwdenk	? - print current values og the CPM Timer registers
5370c609719bSwdenk	b - enable interrupts and start timer
5371c609719bSwdenk	e - stop timer and disable interrupts
5372c609719bSwdenk	q - quit application
5373c609719bSwdenk
5374c609719bSwdenk	=> loads
5375c609719bSwdenk	## Ready for S-Record download ...
5376c609719bSwdenk	~>examples/timer.srec
5377c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5378c609719bSwdenk	[file transfer complete]
5379c609719bSwdenk	[connected]
5380c609719bSwdenk	## Start Addr = 0x00040004
5381c609719bSwdenk
5382c609719bSwdenk	=> go 40004
5383c609719bSwdenk	## Starting application at 0x00040004 ...
5384c609719bSwdenk	TIMERS=0xfff00980
5385c609719bSwdenk	Using timer 1
5386c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5387c609719bSwdenk
5388c609719bSwdenkHit 'b':
5389c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5390c609719bSwdenk	Enabling timer
5391c609719bSwdenkHit '?':
5392c609719bSwdenk	[q, b, e, ?] ........
5393c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5394c609719bSwdenkHit '?':
5395c609719bSwdenk	[q, b, e, ?] .
5396c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5397c609719bSwdenkHit '?':
5398c609719bSwdenk	[q, b, e, ?] .
5399c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5400c609719bSwdenkHit '?':
5401c609719bSwdenk	[q, b, e, ?] .
5402c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5403c609719bSwdenkHit 'e':
5404c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5405c609719bSwdenkHit 'q':
5406c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5407c609719bSwdenk
5408c609719bSwdenk
540985ec0bccSwdenkMinicom warning:
541085ec0bccSwdenk================
541185ec0bccSwdenk
54127152b1d0SwdenkOver time, many people have reported problems when trying to use the
541385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
541485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5415f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
541685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5417e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5418e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5419e53515a2SKarl O. Pincfor help with kermit.
5420e53515a2SKarl O. Pinc
542185ec0bccSwdenk
542252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
542352f52c14Swdenkconfiguration to your "File transfer protocols" section:
542452f52c14Swdenk
542552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
542652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
542752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
542852f52c14Swdenk
542952f52c14Swdenk
5430c609719bSwdenkNetBSD Notes:
5431c609719bSwdenk=============
5432c609719bSwdenk
5433c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5434c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5435c609719bSwdenk
5436c609719bSwdenkBuilding requires a cross environment; it is known to work on
5437c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5438c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5439c609719bSwdenkNote that the cross-powerpc package does not install include files;
5440c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5441c609719bSwdenkmissing.  This file has to be installed and patched manually:
5442c609719bSwdenk
5443c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5444c609719bSwdenk	# mkdir powerpc
5445c609719bSwdenk	# ln -s powerpc machine
5446c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5447c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5448c609719bSwdenk
5449c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5450c609719bSwdenkand U-Boot include files.
5451c609719bSwdenk
5452c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5453c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5454c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5455c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
54562a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5457c609719bSwdenk
5458c609719bSwdenk
5459c609719bSwdenkImplementation Internals:
5460c609719bSwdenk=========================
5461c609719bSwdenk
5462c609719bSwdenkThe following is not intended to be a complete description of every
5463c609719bSwdenkimplementation detail. However, it should help to understand the
5464c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5465c609719bSwdenkhardware.
5466c609719bSwdenk
5467c609719bSwdenk
5468c609719bSwdenkInitial Stack, Global Data:
5469c609719bSwdenk---------------------------
5470c609719bSwdenk
5471c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5472c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5473c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5474c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5475c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5476c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5477c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5478c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5479c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5480c609719bSwdenklocked as (mis-) used as memory, etc.
5481c609719bSwdenk
54827152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
54830668236bSWolfgang Denk	U-Boot mailing list:
548443d9616cSwdenk
548543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
548643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
548743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
548843d9616cSwdenk	...
548943d9616cSwdenk
549043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
549143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
549243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
549343d9616cSwdenk	is that the cache is being used as a temporary supply of
549443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
549511ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
549643d9616cSwdenk	can see how this works by studying the cache architecture and
549743d9616cSwdenk	operation in the architecture and processor-specific manuals.
549843d9616cSwdenk
549943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
550043d9616cSwdenk	is another option for the system designer to use as an
550111ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
550243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
550343d9616cSwdenk	board designers haven't used it for something that would
550443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
550543d9616cSwdenk	used.
550643d9616cSwdenk
55076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
550843d9616cSwdenk	with your processor/board/system design. The default value
550943d9616cSwdenk	you will find in any recent u-boot distribution in
55108a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
551143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
551243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
551343d9616cSwdenk	that are supposed to respond to that address! That code in
551443d9616cSwdenk	start.S has been around a while and should work as is when
551543d9616cSwdenk	you get the config right.
551643d9616cSwdenk
551743d9616cSwdenk	-Chris Hallinan
551843d9616cSwdenk	DS4.COM, Inc.
551943d9616cSwdenk
5520c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5521c609719bSwdenkcode for the initialization procedures:
5522c609719bSwdenk
5523c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5524c609719bSwdenk  to write it.
5525c609719bSwdenk
552611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
5527c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
55287152b1d0Swdenk  zation is performed later (when relocating to RAM).
5529c609719bSwdenk
5530c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5531c609719bSwdenk  that.
5532c609719bSwdenk
5533c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5534c609719bSwdenknormal global data to share information beween the code. But it
5535c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5536c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5537c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5538c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5539c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5540c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5541c609719bSwdenkreserve for this purpose.
5542c609719bSwdenk
55437152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5544c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5545c609719bSwdenkGCC's implementation.
5546c609719bSwdenk
5547c609719bSwdenkFor PowerPC, the following registers have specific use:
5548c609719bSwdenk	R1:	stack pointer
5549e7670f6cSWolfgang Denk	R2:	reserved for system use
5550c609719bSwdenk	R3-R4:	parameter passing and return values
5551c609719bSwdenk	R5-R10: parameter passing
5552c609719bSwdenk	R13:	small data area pointer
5553c609719bSwdenk	R30:	GOT pointer
5554c609719bSwdenk	R31:	frame pointer
5555c609719bSwdenk
5556e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5557e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5558e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5559c609719bSwdenk
5560e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5561c609719bSwdenk
5562c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5563c609719bSwdenk    address of the global data structure is known at compile time),
5564c609719bSwdenk    but it turned out that reserving a register results in somewhat
5565c609719bSwdenk    smaller code - although the code savings are not that big (on
5566c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5567c609719bSwdenk    624 text + 127 data).
5568c609719bSwdenk
5569c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
55704c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
55714c58eb55SMike Frysinger
5572c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
55734c58eb55SMike Frysinger
5574c609719bSwdenkOn ARM, the following registers are used:
5575c609719bSwdenk
5576c609719bSwdenk	R0:	function argument word/integer result
5577c609719bSwdenk	R1-R3:	function argument word
5578c609719bSwdenk	R9:	GOT pointer
5579c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
5580c609719bSwdenk	R11:	argument (frame) pointer
5581c609719bSwdenk	R12:	temporary workspace
5582c609719bSwdenk	R13:	stack pointer
5583c609719bSwdenk	R14:	link register
5584c609719bSwdenk	R15:	program counter
5585c609719bSwdenk
5586c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
5587c609719bSwdenk
55880df01fd3SThomas ChouOn Nios II, the ABI is documented here:
55890df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
55900df01fd3SThomas Chou
55910df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
55920df01fd3SThomas Chou
55930df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
55940df01fd3SThomas Chou    to access small data sections, so gp is free.
55950df01fd3SThomas Chou
5596afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5597afc1ce82SMacpaul Lin
5598afc1ce82SMacpaul Lin	R0-R1:	argument/return
5599afc1ce82SMacpaul Lin	R2-R5:	argument
5600afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5601afc1ce82SMacpaul Lin	R16:	trampoline register
5602afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5603afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5604afc1ce82SMacpaul Lin	R30:	link register (LP)
5605afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5606afc1ce82SMacpaul Lin	PC:	program counter (PC)
5607afc1ce82SMacpaul Lin
5608afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5609afc1ce82SMacpaul Lin
5610d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5611d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5612c609719bSwdenk
5613c609719bSwdenkMemory Management:
5614c609719bSwdenk------------------
5615c609719bSwdenk
5616c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5617c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5618c609719bSwdenk
5619c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5620c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5621c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5622c609719bSwdenkphysical memory banks.
5623c609719bSwdenk
5624c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5625c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5626c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5627c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
56286d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5629c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5630c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5631c609719bSwdenk
5632c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5633c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5634c609719bSwdenk
5635c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5636c609719bSwdenkthis:
5637c609719bSwdenk
5638c609719bSwdenk	0x0000 0000	Exception Vector code
5639c609719bSwdenk	      :
5640c609719bSwdenk	0x0000 1FFF
5641c609719bSwdenk	0x0000 2000	Free for Application Use
5642c609719bSwdenk	      :
5643c609719bSwdenk	      :
5644c609719bSwdenk
5645c609719bSwdenk	      :
5646c609719bSwdenk	      :
5647c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5648c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5649c609719bSwdenk	0x00FC 0000	Malloc Arena
5650c609719bSwdenk	      :
5651c609719bSwdenk	0x00FD FFFF
5652c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5653c609719bSwdenk	...		eventually: LCD or video framebuffer
5654c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5655c609719bSwdenk	0x00FF FFFF	[End of RAM]
5656c609719bSwdenk
5657c609719bSwdenk
5658c609719bSwdenkSystem Initialization:
5659c609719bSwdenk----------------------
5660c609719bSwdenk
5661c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
566211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5663c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
56647152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5665c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5666c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5667c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5668c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5669c609719bSwdenkthe caches and the SIU.
5670c609719bSwdenk
5671c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5672c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5673c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5674c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5675c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5676c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5677c609719bSwdenkbanks.
5678c609719bSwdenk
5679c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
56807152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5681c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5682c609719bSwdenk0x00000000, with any additional banks following immediately to create
5683c609719bSwdenkcontiguous memory starting from 0.
5684c609719bSwdenk
5685c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5686c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5687c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5688c609719bSwdenkpages, and the final stack is set up.
5689c609719bSwdenk
5690c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5691c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5692c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5693c609719bSwdenknew address in RAM.
5694c609719bSwdenk
5695c609719bSwdenk
5696c609719bSwdenkU-Boot Porting Guide:
5697c609719bSwdenk----------------------
5698c609719bSwdenk
5699c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
57006aff3115Swdenklist, October 2002]
5701c609719bSwdenk
5702c609719bSwdenk
5703c609719bSwdenkint main(int argc, char *argv[])
5704c609719bSwdenk{
5705c609719bSwdenk	sighandler_t no_more_time;
5706c609719bSwdenk
5707c609719bSwdenk	signal(SIGALRM, no_more_time);
5708c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5709c609719bSwdenk
5710c609719bSwdenk	if (available_money > available_manpower) {
57116c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5712c609719bSwdenk		return 0;
5713c609719bSwdenk	}
5714c609719bSwdenk
5715c609719bSwdenk	Download latest U-Boot source;
5716c609719bSwdenk
57170668236bSWolfgang Denk	Subscribe to u-boot mailing list;
57186aff3115Swdenk
57196c3fef28SJerry Van Baren	if (clueless)
5720c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5721c609719bSwdenk
5722c609719bSwdenk	while (learning) {
5723c609719bSwdenk		Read the README file in the top level directory;
57247cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
57256c3fef28SJerry Van Baren		Read applicable doc/*.README;
5726c609719bSwdenk		Read the source, Luke;
57276c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5728c609719bSwdenk	}
5729c609719bSwdenk
57306c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
57316c3fef28SJerry Van Baren		Buy a BDI3000;
57326c3fef28SJerry Van Baren	else
5733c609719bSwdenk		Add a lot of aggravation and time;
5734c609719bSwdenk
57356c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
57366c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
57376c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
57386c3fef28SJerry Van Baren	} else {
5739c609719bSwdenk		Create your own board support subdirectory;
57406c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
57416c3fef28SJerry Van Baren	}
57426c3fef28SJerry Van Baren	Edit new board/<myboard> files
57436c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5744c609719bSwdenk
57456c3fef28SJerry Van Baren	while (!accepted) {
5746c609719bSwdenk		while (!running) {
5747c609719bSwdenk			do {
5748c609719bSwdenk				Add / modify source code;
5749c609719bSwdenk			} until (compiles);
5750c609719bSwdenk			Debug;
5751c609719bSwdenk			if (clueless)
5752c609719bSwdenk				email("Hi, I am having problems...");
5753c609719bSwdenk		}
57546c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
57556c3fef28SJerry Van Baren		if (reasonable critiques)
57566c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
57576c3fef28SJerry Van Baren		else
57586c3fef28SJerry Van Baren			Defend code as written;
57596c3fef28SJerry Van Baren	}
5760c609719bSwdenk
5761c609719bSwdenk	return 0;
5762c609719bSwdenk}
5763c609719bSwdenk
5764c609719bSwdenkvoid no_more_time (int sig)
5765c609719bSwdenk{
5766c609719bSwdenk      hire_a_guru();
5767c609719bSwdenk}
5768c609719bSwdenk
5769c609719bSwdenk
5770c609719bSwdenkCoding Standards:
5771c609719bSwdenk-----------------
5772c609719bSwdenk
5773c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
57742c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
57757ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5776c609719bSwdenk
57772c051651SDetlev ZundelSource files originating from a different project (for example the
57782c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
57792c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
57802c051651SDetlev Zundelsources.
57812c051651SDetlev Zundel
57822c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
57832c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
57842c051651SDetlev Zundelin your code.
5785c609719bSwdenk
5786c178d3daSwdenkPlease also stick to the following formatting rules:
5787180d3f74Swdenk- remove any trailing white space
57887ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5789180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
57907ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5791180d3f74Swdenk- do not add trailing empty lines to source files
5792180d3f74Swdenk
5793c609719bSwdenkSubmissions which do not conform to the standards may be returned
5794c609719bSwdenkwith a request to reformat the changes.
5795c609719bSwdenk
5796c609719bSwdenk
5797c609719bSwdenkSubmitting Patches:
5798c609719bSwdenk-------------------
5799c609719bSwdenk
5800c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5801c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5802c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5803c609719bSwdenk
58040d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5805218ca724SWolfgang Denk
58060668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
58070668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
58080668236bSWolfgang Denk
5809c609719bSwdenkWhen you send a patch, please include the following information with
5810c609719bSwdenkit:
5811c609719bSwdenk
5812c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5813c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5814c609719bSwdenk  patch actually fixes something.
5815c609719bSwdenk
5816c609719bSwdenk* For new features: a description of the feature and your
5817c609719bSwdenk  implementation.
5818c609719bSwdenk
5819c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5820c609719bSwdenk
5821c609719bSwdenk* For major contributions, your entry to the CREDITS file
5822c609719bSwdenk
5823c609719bSwdenk* When you add support for a new board, don't forget to add this
58247ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5825c609719bSwdenk
5826c609719bSwdenk* If your patch adds new configuration options, don't forget to
5827c609719bSwdenk  document these in the README file.
5828c609719bSwdenk
5829218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5830218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
58317ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5832218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5833218ca724SWolfgang Denk  with some other mail clients.
5834c609719bSwdenk
5835218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5836218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5837218ca724SWolfgang Denk  GNU diff.
58386dff5529Swdenk
5839218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5840218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5841218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5842218ca724SWolfgang Denk  affected files).
5843218ca724SWolfgang Denk
5844218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5845218ca724SWolfgang Denk  and compressed attachments must not be used.
5846c609719bSwdenk
584752f52c14Swdenk* If one logical set of modifications affects or creates several
584852f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
584952f52c14Swdenk
585052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
585152f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
585252f52c14Swdenk
585352f52c14Swdenk
5854c609719bSwdenkNotes:
5855c609719bSwdenk
5856c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5857c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5858c609719bSwdenk  for any of the boards.
5859c609719bSwdenk
5860c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5861c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5862c609719bSwdenk  returned with a request to re-formatting / split it.
5863c609719bSwdenk
5864c609719bSwdenk* If you modify existing code, make sure that your new code does not
5865c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5866c609719bSwdenk  When adding new features, these should compile conditionally only
5867c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5868c609719bSwdenk  disabled must not need more memory than the old code without your
5869c609719bSwdenk  modification.
587090dc6704Swdenk
58710668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
58720668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
58730668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
58740668236bSWolfgang Denk  bigger than the size limit should be avoided.
5875