xref: /openbmc/u-boot/README (revision 923c46f9)
1c609719bSwdenk#
2b75190deSWolfgang Denk# (C) Copyright 2000 - 2012
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
129360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
130360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
131360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
132360d883aSThomas Webernames consisting of the calendar year and month of the release date.
133360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
134360d883aSThomas Weberreleases in "stable" maintenance trees.
13593f19cc0Swdenk
136360d883aSThomas WeberExamples:
137360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
138360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
139360d883aSThomas Weber	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
14093f19cc0Swdenk
14193f19cc0Swdenk
142c609719bSwdenkDirectory Hierarchy:
143c609719bSwdenk====================
144c609719bSwdenk
1458d321b81SPeter Tyser/arch			Architecture specific files
1468d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1478d321b81SPeter Tyser    /cpu		CPU specific files
1488d321b81SPeter Tyser      /arm720t		Files specific to ARM 720 CPUs
1498d321b81SPeter Tyser      /arm920t		Files specific to ARM 920 CPUs
1506eb0921aSAndreas Bießmann	/at91		Files specific to Atmel AT91RM9200 CPU
1518d321b81SPeter Tyser	/imx		Files specific to Freescale MC9328 i.MX CPUs
1528d321b81SPeter Tyser	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
1538d321b81SPeter Tyser      /arm925t		Files specific to ARM 925 CPUs
1548d321b81SPeter Tyser      /arm926ejs	Files specific to ARM 926 CPUs
1558d321b81SPeter Tyser      /arm1136		Files specific to ARM 1136 CPUs
1568d321b81SPeter Tyser      /ixp		Files specific to Intel XScale IXP CPUs
1578d321b81SPeter Tyser      /pxa		Files specific to Intel XScale PXA CPUs
1588d321b81SPeter Tyser      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
1598d321b81SPeter Tyser      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
1608d321b81SPeter Tyser    /lib		Architecture specific library files
1618d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1628d321b81SPeter Tyser    /cpu		CPU specific files
1638d321b81SPeter Tyser    /lib		Architecture specific library files
1648d321b81SPeter Tyser  /blackfin		Files generic to Analog Devices Blackfin architecture
1658d321b81SPeter Tyser    /cpu		CPU specific files
1668d321b81SPeter Tyser    /lib		Architecture specific library files
167fea25720SGraeme Russ  /x86			Files generic to x86 architecture
1688d321b81SPeter Tyser    /cpu		CPU specific files
1698d321b81SPeter Tyser    /lib		Architecture specific library files
1708d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1718d321b81SPeter Tyser    /cpu		CPU specific files
1728d321b81SPeter Tyser      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
1738d321b81SPeter Tyser      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
1748d321b81SPeter Tyser      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
1758d321b81SPeter Tyser      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
1768d321b81SPeter Tyser      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
1778d321b81SPeter Tyser    /lib		Architecture specific library files
1788d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1798d321b81SPeter Tyser    /cpu		CPU specific files
1808d321b81SPeter Tyser    /lib		Architecture specific library files
1818d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
1828d321b81SPeter Tyser    /cpu		CPU specific files
18392bbd64eSDaniel Schwierzeck      /mips32		Files specific to MIPS32 CPUs
18480421fccSXiangfu Liu      /xburst		Files specific to Ingenic XBurst CPUs
1858d321b81SPeter Tyser    /lib		Architecture specific library files
186afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
187afc1ce82SMacpaul Lin    /cpu		CPU specific files
188afc1ce82SMacpaul Lin      /n1213		Files specific to Andes Technology N1213 CPUs
189afc1ce82SMacpaul Lin    /lib		Architecture specific library files
1908d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1918d321b81SPeter Tyser    /cpu		CPU specific files
1928d321b81SPeter Tyser    /lib		Architecture specific library files
193a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1948d321b81SPeter Tyser    /cpu		CPU specific files
1958d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1968d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1978d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1988d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1998d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
2008d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
2018d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
2028d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
2038d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
2048d321b81SPeter Tyser    /lib		Architecture specific library files
2058d321b81SPeter Tyser  /sh			Files generic to SH architecture
2068d321b81SPeter Tyser    /cpu		CPU specific files
2078d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2088d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2098d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2108d321b81SPeter Tyser    /lib		Architecture specific library files
2118d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2128d321b81SPeter Tyser    /cpu		CPU specific files
2138d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2148d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2158d321b81SPeter Tyser    /lib		Architecture specific library files
2168d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2178d321b81SPeter Tyser/board			Board dependent files
2188d321b81SPeter Tyser/common			Misc architecture independent functions
2198d321b81SPeter Tyser/disk			Code for disk drive partition handling
2208d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2218d321b81SPeter Tyser/drivers		Commonly used device drivers
2228d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2238d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2248d321b81SPeter Tyser/include		Header Files
2258d321b81SPeter Tyser/lib			Files generic to all architectures
2268d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2278d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2288d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2298d321b81SPeter Tyser/net			Networking code
2308d321b81SPeter Tyser/post			Power On Self Test
2318d321b81SPeter Tyser/rtc			Real Time Clock drivers
2328d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
233c609719bSwdenk
234c609719bSwdenkSoftware Configuration:
235c609719bSwdenk=======================
236c609719bSwdenk
237c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
238c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
239c609719bSwdenk
240c609719bSwdenkThere are two classes of configuration variables:
241c609719bSwdenk
242c609719bSwdenk* Configuration _OPTIONS_:
243c609719bSwdenk  These are selectable by the user and have names beginning with
244c609719bSwdenk  "CONFIG_".
245c609719bSwdenk
246c609719bSwdenk* Configuration _SETTINGS_:
247c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
248c609719bSwdenk  you don't know what you're doing; they have names beginning with
2496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
250c609719bSwdenk
251c609719bSwdenkLater we will add a configuration tool - probably similar to or even
252c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
253c609719bSwdenkdo the configuration by hand, which means creating some symbolic
254c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
255c609719bSwdenkas an example here.
256c609719bSwdenk
257c609719bSwdenk
258c609719bSwdenkSelection of Processor Architecture and Board Type:
259c609719bSwdenk---------------------------------------------------
260c609719bSwdenk
261c609719bSwdenkFor all supported boards there are ready-to-use default
262c609719bSwdenkconfigurations available; just type "make <board_name>_config".
263c609719bSwdenk
264c609719bSwdenkExample: For a TQM823L module type:
265c609719bSwdenk
266c609719bSwdenk	cd u-boot
267c609719bSwdenk	make TQM823L_config
268c609719bSwdenk
26911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
270c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
271c609719bSwdenkdirectory according to the instructions in cogent/README.
272c609719bSwdenk
273c609719bSwdenk
274c609719bSwdenkConfiguration Options:
275c609719bSwdenk----------------------
276c609719bSwdenk
277c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
278c609719bSwdenksuch information is kept in a configuration file
279c609719bSwdenk"include/configs/<board_name>.h".
280c609719bSwdenk
281c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
282c609719bSwdenk"include/configs/TQM823L.h".
283c609719bSwdenk
284c609719bSwdenk
2857f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2867f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2877f6c2cbcSwdenkbuild a config tool - later.
2887f6c2cbcSwdenk
2897f6c2cbcSwdenk
290c609719bSwdenkThe following options need to be configured:
291c609719bSwdenk
2922628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
293c609719bSwdenk
2942628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2956ccec449SWolfgang Denk
2966ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
298c609719bSwdenk
299c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
300c609719bSwdenk		Define exactly one of
301c609719bSwdenk		CONFIG_CMA286_60_OLD
302c609719bSwdenk--- FIXME --- not tested yet:
303c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
304c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
305c609719bSwdenk
306c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
307c609719bSwdenk		Define exactly one of
308c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
309c609719bSwdenk
310c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
311c609719bSwdenk		Define one or more of
312c609719bSwdenk		CONFIG_CMA302
313c609719bSwdenk
314c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
315c609719bSwdenk		Define one or more of
316c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31711ccc33fSMarcel Ziswiler					  the LCD display every second with
318c609719bSwdenk					  a "rotator" |\-/|\-/
319c609719bSwdenk
3202535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3212535d602Swdenk		CONFIG_ADSTYPE
3222535d602Swdenk		Possible values are:
3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3272535d602Swdenk
328cf946c6dSLei Wen- Marvell Family Member
329cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
330cf946c6dSLei Wen					  multiple fs option at one time
331cf946c6dSLei Wen					  for marvell soc family
332cf946c6dSLei Wen
333c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
334c609719bSwdenk		Define exactly one of
335c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
336c609719bSwdenk
33711ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33966ca92a5Swdenk					  get_gclk_freq() cannot work
3405da627a4Swdenk					  e.g. if there is no 32KHz
3415da627a4Swdenk					  reference PIT/RTC clock
34266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
34366ca92a5Swdenk					  or XTAL/EXTAL)
344c609719bSwdenk
34566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34975d1ea7fSwdenk			See doc/README.MPC866
35075d1ea7fSwdenk
3516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
35275d1ea7fSwdenk
35375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
35475d1ea7fSwdenk		of relying on the correctness of the configured
35575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35975d1ea7fSwdenk
360506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
361506f3918SHeiko Schocher
362506f3918SHeiko Schocher		Define this option if you want to enable the
363506f3918SHeiko Schocher		ICache only when Code runs from RAM.
364506f3918SHeiko Schocher
36566412c63SKumar Gala- 85xx CPU Options:
36666412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36766412c63SKumar Gala
36866412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36966412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
37066412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
37166412c63SKumar Gala
3728f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3738f29084aSKumar Gala
3748f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3758f29084aSKumar Gala		tree nodes for the given platform.
3768f29084aSKumar Gala
377afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
378afa6b551SPrabhakar Kushwaha
379afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
380afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
381afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
382afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
383afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
384afa6b551SPrabhakar Kushwaha		purpose.
385afa6b551SPrabhakar Kushwaha
3866cb461b4SDaniel Schwierzeck- Generic CPU options:
3876cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
3886cb461b4SDaniel Schwierzeck
3896cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
3906cb461b4SDaniel Schwierzeck		values is arch specific.
3916cb461b4SDaniel Schwierzeck
3920b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3940b953ffcSMarkus Klotzbuecher
3950b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3960b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3970b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3980b953ffcSMarkus Klotzbuecher
3996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
4000b953ffcSMarkus Klotzbuecher
4010b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4020b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4030b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4040b953ffcSMarkus Klotzbuecher		by this value.
4050b953ffcSMarkus Klotzbuecher
40692bbd64eSDaniel Schwierzeck- MIPS CPU options:
40792bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
40892bbd64eSDaniel Schwierzeck
40992bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
41092bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
41192bbd64eSDaniel Schwierzeck		relocation.
41292bbd64eSDaniel Schwierzeck
41392bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
41492bbd64eSDaniel Schwierzeck
41592bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
41692bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
41792bbd64eSDaniel Schwierzeck		Possible values are:
41892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
41992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
42092bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
42192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
42292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
42392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
42492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
42592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
42692bbd64eSDaniel Schwierzeck
42792bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
42892bbd64eSDaniel Schwierzeck
42992bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
43092bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
43192bbd64eSDaniel Schwierzeck
43292bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
43392bbd64eSDaniel Schwierzeck
43492bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
43592bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
43692bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
43792bbd64eSDaniel Schwierzeck
438b67d8816SChristian Riesch- ARM options:
439b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
440b67d8816SChristian Riesch
441b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
442b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
443b67d8816SChristian Riesch
4445356f545SAneesh V		CONFIG_SYS_THUMB_BUILD
4455356f545SAneesh V
4465356f545SAneesh V		Use this flag to build U-Boot using the Thumb instruction
4475356f545SAneesh V		set for ARM architectures. Thumb instruction set provides
4485356f545SAneesh V		better code density. For ARM architectures that support
4495356f545SAneesh V		Thumb2 this flag will result in Thumb2 code generated by
4505356f545SAneesh V		GCC.
4515356f545SAneesh V
4525da627a4Swdenk- Linux Kernel Interface:
453c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
454c609719bSwdenk
455c609719bSwdenk		U-Boot stores all clock information in Hz
456c609719bSwdenk		internally. For binary compatibility with older Linux
457c609719bSwdenk		kernels (which expect the clocks passed in the
458c609719bSwdenk		bd_info data to be in MHz) the environment variable
459c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
460c609719bSwdenk		converts clock data to MHZ before passing it to the
461c609719bSwdenk		Linux kernel.
462c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
463c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
464c609719bSwdenk		default environment.
465c609719bSwdenk
4665da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4675da627a4Swdenk
46811ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4695da627a4Swdenk		expect it to be in bytes, others in MB.
4705da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4715da627a4Swdenk
472fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
473f57f70aaSWolfgang Denk
474f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
475213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
476213bf8c8SGerald Van Baren		concepts).
477213bf8c8SGerald Van Baren
478213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
479213bf8c8SGerald Van Baren		 * New libfdt-based support
480213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4813bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
482213bf8c8SGerald Van Baren
483b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
484b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
485b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
486b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
487f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
488c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
489f57f70aaSWolfgang Denk
49011ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
49111ccc33fSMarcel Ziswiler		addresses
4923bb342fcSKim Phillips
4934e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4944e253137SKumar Gala
4954e253137SKumar Gala		Board code has addition modification that it wants to make
4964e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4976705d81eSwdenk
4980267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4990267768eSMatthew McClintock
50011ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
5010267768eSMatthew McClintock		param header, the default value is zero if undefined.
5020267768eSMatthew McClintock
5033887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
5043887c3fbSHeiko Schocher
5053887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
5063887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
5073887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
5083887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
5093887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
5103887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
5113887c3fbSHeiko Schocher
5127eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
5137eb29398SIgor Grinberg
5147eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
5157eb29398SIgor Grinberg		machine type and must be used to specify the machine type
5167eb29398SIgor Grinberg		number as it appears in the ARM machine registry
5177eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
5187eb29398SIgor Grinberg		Only boards that have multiple machine types supported
5197eb29398SIgor Grinberg		in a single configuration file and the machine type is
5207eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
5217eb29398SIgor Grinberg
5220b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5230b2f4ecaSNiklaus Giger
5240b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5250b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5260b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5270b2f4ecaSNiklaus Giger
5280b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5290b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5300b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5310b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5320b2f4ecaSNiklaus Giger
5330b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5340b2f4ecaSNiklaus Giger
5350b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5360b2f4ecaSNiklaus Giger
5370b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5380b2f4ecaSNiklaus Giger		the defaults discussed just above.
5390b2f4ecaSNiklaus Giger
5402c451f78SAneesh V- Cache Configuration:
5412c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5422c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5432c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5442c451f78SAneesh V
54593bc2193SAneesh V- Cache Configuration for ARM:
54693bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
54793bc2193SAneesh V				      controller
54893bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
54993bc2193SAneesh V					controller register space
55093bc2193SAneesh V
5516705d81eSwdenk- Serial Ports:
55248d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5536705d81eSwdenk
5546705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5556705d81eSwdenk
55648d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5576705d81eSwdenk
5586705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5596705d81eSwdenk
5606705d81eSwdenk		CONFIG_PL011_CLOCK
5616705d81eSwdenk
5626705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5636705d81eSwdenk		the clock speed of the UARTs.
5646705d81eSwdenk
5656705d81eSwdenk		CONFIG_PL01x_PORTS
5666705d81eSwdenk
5676705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5686705d81eSwdenk		define this to a list of base addresses for each (supported)
5696705d81eSwdenk		port. See e.g. include/configs/versatile.h
5706705d81eSwdenk
571910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
572910f1ae3SJohn Rigby
573910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
574910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
575910f1ae3SJohn Rigby		this variable to initialize the extra register.
576910f1ae3SJohn Rigby
577910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
578910f1ae3SJohn Rigby
579910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
580910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
581910f1ae3SJohn Rigby		variable to flush the UART at init time.
582910f1ae3SJohn Rigby
5836705d81eSwdenk
584c609719bSwdenk- Console Interface:
585c609719bSwdenk		Depending on board, define exactly one serial port
586c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
587c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
588c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
589c609719bSwdenk
590c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
591c609719bSwdenk		port routines must be defined elsewhere
592c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
593c609719bSwdenk
594c609719bSwdenk		CONFIG_CFB_CONSOLE
595c609719bSwdenk		Enables console device for a color framebuffer. Needs following
596c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
597c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
598c609719bSwdenk						(default big endian)
599c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
600c609719bSwdenk						rectangle fill
601c609719bSwdenk						(cf. smiLynxEM)
602c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
603c609719bSwdenk						bit-blit (cf. smiLynxEM)
604c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
605c609719bSwdenk						(cols=pitch)
606c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
607c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
608c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
609c609719bSwdenk						(0-5, cf. cfb_console.c)
610c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
611c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
612c609719bSwdenk						(i.e. i8042_kbd_init())
613c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
614c609719bSwdenk						(i.e. i8042_tstc)
615c609719bSwdenk			VIDEO_GETC_FCT		get char fct
616c609719bSwdenk						(i.e. i8042_getc)
617c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
618c609719bSwdenk						(requires blink timer
619c609719bSwdenk						cf. i8042.c)
6206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
621c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
622c609719bSwdenk						upper right corner
623602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
624c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
625c609719bSwdenk						upper left corner
626a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
627a6c7ad2fSwdenk						linux_logo.h for logo.
628a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
629c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
63011ccc33fSMarcel Ziswiler						additional board info beside
631c609719bSwdenk						the logo
632c609719bSwdenk
633c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
634c609719bSwdenk		default i/o. Serial console can be forced with
635c609719bSwdenk		environment 'console=serial'.
636c609719bSwdenk
637a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
638a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
639a3ad8e26Swdenk		the "silent" environment variable. See
640a3ad8e26Swdenk		doc/README.silent for more information.
641a3ad8e26Swdenk
642c609719bSwdenk- Console Baudrate:
643c609719bSwdenk		CONFIG_BAUDRATE - in bps
644c609719bSwdenk		Select one of the baudrates listed in
6456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
647c609719bSwdenk
648c92fac91SHeiko Schocher- Console Rx buffer length
649c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
650c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6512b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
652c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
653c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
654c92fac91SHeiko Schocher		the SMC.
655c92fac91SHeiko Schocher
6569558b48aSGraeme Russ- Pre-Console Buffer:
6579558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6589558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6599558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6609558b48aSGraeme Russ		buffer any console messages prior to the console being
6619558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6629558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6639558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6649558b48aSGraeme Russ		bytes are output before the console is initialised, the
6659558b48aSGraeme Russ		earlier bytes are discarded.
6669558b48aSGraeme Russ
6679558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6689558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
6699558b48aSGraeme Russ
670046a37bdSSonny Rao- Safe printf() functions
671046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
672046a37bdSSonny Rao		the printf() functions. These are defined in
673046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
674046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
675046a37bdSSonny Rao		If this option is not given then these functions will
676046a37bdSSonny Rao		silently discard their buffer size argument - this means
677046a37bdSSonny Rao		you are not getting any overflow checking in this case.
678046a37bdSSonny Rao
679c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
680c609719bSwdenk		Delay before automatically booting the default image;
681c609719bSwdenk		set to -1 to disable autoboot.
682c609719bSwdenk
683c609719bSwdenk		See doc/README.autoboot for these options that
684c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
685c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
686c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
687c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
688c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
689c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
690c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
691c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
692c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
693c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
694c609719bSwdenk		CONFIG_RESET_TO_RETRY
695c609719bSwdenk
696c609719bSwdenk- Autoboot Command:
697c609719bSwdenk		CONFIG_BOOTCOMMAND
698c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
699c609719bSwdenk		define a command string that is automatically executed
700c609719bSwdenk		when no character is read on the console interface
701c609719bSwdenk		within "Boot Delay" after reset.
702c609719bSwdenk
703c609719bSwdenk		CONFIG_BOOTARGS
704c609719bSwdenk		This can be used to pass arguments to the bootm
705c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
706c609719bSwdenk		environment value "bootargs".
707c609719bSwdenk
708c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
709c609719bSwdenk		The value of these goes into the environment as
710c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
711c609719bSwdenk		as a convenience, when switching between booting from
71211ccc33fSMarcel Ziswiler		RAM and NFS.
713c609719bSwdenk
714c609719bSwdenk- Pre-Boot Commands:
715c609719bSwdenk		CONFIG_PREBOOT
716c609719bSwdenk
717c609719bSwdenk		When this option is #defined, the existence of the
718c609719bSwdenk		environment variable "preboot" will be checked
719c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
720c609719bSwdenk		countdown and/or running the auto-boot command resp.
721c609719bSwdenk		entering interactive mode.
722c609719bSwdenk
723c609719bSwdenk		This feature is especially useful when "preboot" is
724c609719bSwdenk		automatically generated or modified. For an example
725c609719bSwdenk		see the LWMON board specific code: here "preboot" is
726c609719bSwdenk		modified when the user holds down a certain
727c609719bSwdenk		combination of keys on the (special) keyboard when
728c609719bSwdenk		booting the systems
729c609719bSwdenk
730c609719bSwdenk- Serial Download Echo Mode:
731c609719bSwdenk		CONFIG_LOADS_ECHO
732c609719bSwdenk		If defined to 1, all characters received during a
733c609719bSwdenk		serial download (using the "loads" command) are
734c609719bSwdenk		echoed back. This might be needed by some terminal
735c609719bSwdenk		emulations (like "cu"), but may as well just take
736c609719bSwdenk		time on others. This setting #define's the initial
737c609719bSwdenk		value of the "loads_echo" environment variable.
738c609719bSwdenk
739602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
740c609719bSwdenk		CONFIG_KGDB_BAUDRATE
741c609719bSwdenk		Select one of the baudrates listed in
7426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
743c609719bSwdenk
744c609719bSwdenk- Monitor Functions:
745602ad3b3SJon Loeliger		Monitor commands can be included or excluded
746602ad3b3SJon Loeliger		from the build by using the #include files
747c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
748c6c621bdSStephen Warren		commands, or using <config_cmd_default.h>
749602ad3b3SJon Loeliger		and augmenting with additional #define's
750602ad3b3SJon Loeliger		for wanted commands.
751c609719bSwdenk
752602ad3b3SJon Loeliger		The default command configuration includes all commands
753602ad3b3SJon Loeliger		except those marked below with a "*".
754602ad3b3SJon Loeliger
755602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
756602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
757602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
758602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
759602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
760602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
761602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
762602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
763710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
764602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
765602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
766602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
767a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
768a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
769a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
770a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
771602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
772602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
773246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
774602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
775602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7760c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
777bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
778602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
779602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
780602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
781602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
782602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
783a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
784a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
785602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
786602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
787602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
788602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
789602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
790602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7910c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
792602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
793602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
794602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
795602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7961ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
797d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
798d22c338eSJoe Hershberger					  (169.254.*.*)
799602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
800602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
80102c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
80202c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
803602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
80456523f12Swdenk					  loop, loopw, mtest
805602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
806602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
807602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
80868d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
809602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
810602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
811e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
812e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
813602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
814602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
815602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
816602ad3b3SJon Loeliger					  host
817602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
818602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
819602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
820602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
821602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
822602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
823602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
824602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
825602ad3b3SJon Loeliger					  (4xx only)
826f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
827c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
82802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
82974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
830602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8317a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8321fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
833ca366d0eSChe-liang Chiou		CONFIG_CMD_TIME		* run command and report execution time
834602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
835602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
836c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
837c609719bSwdenk
838c609719bSwdenk
839c609719bSwdenk		EXAMPLE: If you want all functions except of network
840c609719bSwdenk		support you can write:
841c609719bSwdenk
842602ad3b3SJon Loeliger		#include "config_cmd_all.h"
843602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
844c609719bSwdenk
845213bf8c8SGerald Van Baren	Other Commands:
846213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
847c609719bSwdenk
848c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
849602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
850c609719bSwdenk		what you (and your U-Boot users) are doing. Data
851c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
852c609719bSwdenk		8260 (where accesses to the IMMR region must be
853c609719bSwdenk		uncached), and it cannot be disabled on all other
854c609719bSwdenk		systems where we (mis-) use the data cache to hold an
855c609719bSwdenk		initial stack and some data.
856c609719bSwdenk
857c609719bSwdenk
858c609719bSwdenk		XXX - this list needs to get updated!
859c609719bSwdenk
86045ba8077SSimon Glass- Device tree:
86145ba8077SSimon Glass		CONFIG_OF_CONTROL
86245ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
86345ba8077SSimon Glass		to configure its devices, instead of relying on statically
86445ba8077SSimon Glass		compiled #defines in the board file. This option is
86545ba8077SSimon Glass		experimental and only available on a few boards. The device
86645ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
86745ba8077SSimon Glass
8682c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
8692c0f79e4SSimon Glass		be done using one of the two options below:
870bbb0b128SSimon Glass
871bbb0b128SSimon Glass		CONFIG_OF_EMBED
872bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
873bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
874bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
875bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
876bbb0b128SSimon Glass		the global data structure as gd->blob.
87745ba8077SSimon Glass
8782c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
8792c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
8802c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
8812c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
8822c0f79e4SSimon Glass
8832c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
8842c0f79e4SSimon Glass
8852c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
8862c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
8872c0f79e4SSimon Glass		still use the individual files if you need something more
8882c0f79e4SSimon Glass		exotic.
8892c0f79e4SSimon Glass
890c609719bSwdenk- Watchdog:
891c609719bSwdenk		CONFIG_WATCHDOG
892c609719bSwdenk		If this variable is defined, it enables watchdog
8936abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8946abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8956abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8966abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8976abe6fb6SDetlev Zundel		available, then no further board specific code should
8986abe6fb6SDetlev Zundel		be needed to use it.
8996abe6fb6SDetlev Zundel
9006abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9016abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9026abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9036abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
904c609719bSwdenk
905c1551ea8Sstroese- U-Boot Version:
906c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
907c1551ea8Sstroese		If this variable is defined, an environment variable
908c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
909c1551ea8Sstroese		version as printed by the "version" command.
910a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
911a1ea8e51SBenoît Thébaudeau		next reset.
912c1551ea8Sstroese
913c609719bSwdenk- Real-Time Clock:
914c609719bSwdenk
915602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
916c609719bSwdenk		has to be selected, too. Define exactly one of the
917c609719bSwdenk		following options:
918c609719bSwdenk
919c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
920c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9214e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
922c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9231cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
924c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9257f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9263bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9279536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9284c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
93071d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
93171d19f30SHeiko Schocher					  RV3029 RTC.
932c609719bSwdenk
933b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
934b37c7e5eSwdenk		must also be configured. See I2C Support, below.
935b37c7e5eSwdenk
936e92739d3SPeter Tyser- GPIO Support:
937e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
938e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
939e92739d3SPeter Tyser
9405dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9415dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9425dec49caSChris Packham		pins supported by a particular chip.
9435dec49caSChris Packham
944e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
945e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
946e92739d3SPeter Tyser
947c609719bSwdenk- Timestamp Support:
948c609719bSwdenk
949c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
950c609719bSwdenk		(date and time) of an image is printed by image
951c609719bSwdenk		commands like bootm or iminfo. This option is
952602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
953c609719bSwdenk
954*923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
955*923c46f9SKarl O. Pinc		Zero or more of the following:
956*923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
957*923c46f9SKarl O. Pinc		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
958*923c46f9SKarl O. Pinc				       Intel architecture, USB sticks, etc.
959*923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
960*923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
961*923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
962*923c46f9SKarl O. Pinc				       disk/part_efi.c
963*923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
964c609719bSwdenk
965602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
966218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
967*923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
968c609719bSwdenk
969c609719bSwdenk- IDE Reset method:
9704d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9714d13cbadSwdenk		board configurations files but used nowhere!
972c609719bSwdenk
9734d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9744d13cbadSwdenk		be performed by calling the function
9754d13cbadSwdenk			ide_set_reset(int reset)
9764d13cbadSwdenk		which has to be defined in a board specific file
977c609719bSwdenk
978c609719bSwdenk- ATAPI Support:
979c609719bSwdenk		CONFIG_ATAPI
980c609719bSwdenk
981c609719bSwdenk		Set this to enable ATAPI support.
982c609719bSwdenk
983c40b2956Swdenk- LBA48 Support
984c40b2956Swdenk		CONFIG_LBA48
985c40b2956Swdenk
986c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9874b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
988c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
989c40b2956Swdenk		support disks up to 2.1TB.
990c40b2956Swdenk
9916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
992c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
993c40b2956Swdenk			Default is 32bit.
994c40b2956Swdenk
995c609719bSwdenk- SCSI Support:
996c609719bSwdenk		At the moment only there is only support for the
997c609719bSwdenk		SYM53C8XX SCSI controller; define
998c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
999c609719bSwdenk
10006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1003c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1004c609719bSwdenk		devices.
10056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1006c609719bSwdenk
1007c609719bSwdenk- NETWORK Support (PCI):
1008682011ffSwdenk		CONFIG_E1000
1009ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1010ce5207e1SKyle Moffett
1011ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1012ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1013ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1014ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1015ce5207e1SKyle Moffett
1016ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1017ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1018ce5207e1SKyle Moffett		example with the "sspi" command.
1019ce5207e1SKyle Moffett
1020ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1021ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1022ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1023682011ffSwdenk
1024ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
102511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1026ac3315c2SAndre Schwarz
1027c609719bSwdenk		CONFIG_EEPRO100
1028c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
102911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1030c609719bSwdenk		write routine for first time initialisation.
1031c609719bSwdenk
1032c609719bSwdenk		CONFIG_TULIP
1033c609719bSwdenk		Support for Digital 2114x chips.
1034c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1035c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1036c609719bSwdenk
1037c609719bSwdenk		CONFIG_NATSEMI
1038c609719bSwdenk		Support for National dp83815 chips.
1039c609719bSwdenk
1040c609719bSwdenk		CONFIG_NS8382X
1041c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1042c609719bSwdenk
104345219c46Swdenk- NETWORK Support (other):
104445219c46Swdenk
1045c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1046c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1047c041e9d2SJens Scharsig
1048c041e9d2SJens Scharsig			CONFIG_RMII
1049c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1050c041e9d2SJens Scharsig
1051c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1052c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1053c041e9d2SJens Scharsig			The driver doen't show link status messages.
1054c041e9d2SJens Scharsig
1055efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1056efdd7319SRob Herring		Support for the Calxeda XGMAC device
1057efdd7319SRob Herring
105845219c46Swdenk		CONFIG_DRIVER_LAN91C96
105945219c46Swdenk		Support for SMSC's LAN91C96 chips.
106045219c46Swdenk
106145219c46Swdenk			CONFIG_LAN91C96_BASE
106245219c46Swdenk			Define this to hold the physical address
106345219c46Swdenk			of the LAN91C96's I/O space
106445219c46Swdenk
106545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
106645219c46Swdenk			Define this to enable 32 bit addressing
106745219c46Swdenk
1068f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1069f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1070f39748aeSwdenk
1071f39748aeSwdenk			CONFIG_SMC91111_BASE
1072f39748aeSwdenk			Define this to hold the physical address
1073f39748aeSwdenk			of the device (I/O space)
1074f39748aeSwdenk
1075f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1076f39748aeSwdenk			Define this if data bus is 32 bits
1077f39748aeSwdenk
1078f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1079f39748aeSwdenk			Define this to use i/o functions instead of macros
1080f39748aeSwdenk			(some hardware wont work with macros)
1081f39748aeSwdenk
1082dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1083dc02badaSHeiko Schocher		Support for davinci emac
1084dc02badaSHeiko Schocher
1085dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1086dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1087dc02badaSHeiko Schocher
1088b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1089b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1090b3dbf4a5SMacpaul Lin
1091b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1092b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1093b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1094b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1095b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1096b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1097b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1098b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1099b3dbf4a5SMacpaul Lin
1100c2fff331SMike Rapoport		CONFIG_SMC911X
1101557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1102557b377dSJens Gehrlein
1103c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1104557b377dSJens Gehrlein			Define this to hold the physical address
1105557b377dSJens Gehrlein			of the device (I/O space)
1106557b377dSJens Gehrlein
1107c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1108557b377dSJens Gehrlein			Define this if data bus is 32 bits
1109557b377dSJens Gehrlein
1110c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1111557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1112557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1113c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1114557b377dSJens Gehrlein
11153d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11163d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11173d0075faSYoshihiro Shimoda
11183d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11193d0075faSYoshihiro Shimoda			Define the number of ports to be used
11203d0075faSYoshihiro Shimoda
11213d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11223d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11233d0075faSYoshihiro Shimoda
112468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
112568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
112668260aabSYoshihiro Shimoda
11275e124724SVadim Bendebury- TPM Support:
11285e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11295e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11305e124724SVadim Bendebury		per system is supported at this time.
11315e124724SVadim Bendebury
11325e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11335e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11345e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11355e124724SVadim Bendebury			0xfed40000.
11365e124724SVadim Bendebury
1137c609719bSwdenk- USB Support:
1138c609719bSwdenk		At the moment only the UHCI host controller is
11394d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1140c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1141c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
114230d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1143c609719bSwdenk		storage devices.
1144c609719bSwdenk		Note:
1145c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1146c609719bSwdenk		(TEAC FD-05PUB).
11474d13cbadSwdenk		MPC5200 USB requires additional defines:
11484d13cbadSwdenk			CONFIG_USB_CLOCK
11494d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1150307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1151307ecb6dSEric Millbrandt				for USB on PSC3
11524d13cbadSwdenk			CONFIG_USB_CONFIG
11534d13cbadSwdenk				for differential drivers: 0x00001000
11544d13cbadSwdenk				for single ended drivers: 0x00005000
1155307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1156307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1158fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1159fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11604d13cbadSwdenk
11619ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11629ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
11639ab4ce22SSimon Glass
116416c8d5e7SWolfgang Denk- USB Device:
116516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
116616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
116716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
116811ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
116916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
117016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
117116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
117216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
117316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
117416c8d5e7SWolfgang Denk		a Linux host by
117516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
117616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
117716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
117816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
117916c8d5e7SWolfgang Denk
118016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
118116c8d5e7SWolfgang Denk			Define this to build a UDC device
118216c8d5e7SWolfgang Denk
118316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
118416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
118516c8d5e7SWolfgang Denk			talk to the UDC device
118616c8d5e7SWolfgang Denk
1187f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1188f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1189f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1190f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1191f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1192f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1193f9da0f89SVipin KUMAR			speed.
1194f9da0f89SVipin KUMAR
11956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
119616c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
119716c8d5e7SWolfgang Denk			be set to usbtty.
119816c8d5e7SWolfgang Denk
119916c8d5e7SWolfgang Denk			mpc8xx:
12006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
120116c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
12026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
120316c8d5e7SWolfgang Denk
12046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
120516c8d5e7SWolfgang Denk				Derive USB clock from brgclk
12066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
120716c8d5e7SWolfgang Denk
120816c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
120916c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
121016c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
121116c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
121216c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
121316c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
121416c8d5e7SWolfgang Denk
121516c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
121616c8d5e7SWolfgang Denk			Define this string as the name of your company for
121716c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
121816c8d5e7SWolfgang Denk
121916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
122016c8d5e7SWolfgang Denk			Define this string as the name of your product
122116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
122216c8d5e7SWolfgang Denk
122316c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
122416c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
122516c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
122616c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
122716c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
122816c8d5e7SWolfgang Denk
122916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
123016c8d5e7SWolfgang Denk			Define this as the unique Product ID
123116c8d5e7SWolfgang Denk			for your device
123216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1233c609719bSwdenk
1234d70a560fSIgor Grinberg- ULPI Layer Support:
1235d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1236d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1237d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1238d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1239d70a560fSIgor Grinberg		viewport is supported.
1240d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1241d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1242c609719bSwdenk
1243c609719bSwdenk- MMC Support:
1244c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1245c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1246c609719bSwdenk		accessed from the boot prompt by mapping the device
1247c609719bSwdenk		to physical memory similar to flash. Command line is
1248602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1249602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1250c609719bSwdenk
1251afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1252afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1253afb35666SYoshihiro Shimoda
1254afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1255afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1256afb35666SYoshihiro Shimoda
1257afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1258afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1259afb35666SYoshihiro Shimoda
12606705d81eSwdenk- Journaling Flash filesystem support:
12616705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
12626705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
12636705d81eSwdenk		Define these for a default partition on a NAND device
12646705d81eSwdenk
12656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
12666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
12676705d81eSwdenk		Define these for a default partition on a NOR device
12686705d81eSwdenk
12696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
12706705d81eSwdenk		Define this to create an own partition. You have to provide a
12716705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
12726705d81eSwdenk
12736705d81eSwdenk		If you define only one JFFS2 partition you may also want to
12746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
12756705d81eSwdenk		to disable the command chpart. This is the default when you
12766705d81eSwdenk		have not defined a custom partition
12776705d81eSwdenk
1278c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1279c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1280656f4c65SDonggeun Kim
1281656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1282656f4c65SDonggeun Kim		file in FAT formatted partition.
1283656f4c65SDonggeun Kim
1284656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1285656f4c65SDonggeun Kim		user to write files to FAT.
1286c30a15e5SDonggeun Kim
1287c609719bSwdenk- Keyboard Support:
1288c609719bSwdenk		CONFIG_ISA_KEYBOARD
1289c609719bSwdenk
1290c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1291c609719bSwdenk		support
1292c609719bSwdenk
1293c609719bSwdenk		CONFIG_I8042_KBD
1294c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1295c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1296c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1297c609719bSwdenk		for cfb_console. Supports cursor blinking.
1298c609719bSwdenk
1299c609719bSwdenk- Video support:
1300c609719bSwdenk		CONFIG_VIDEO
1301c609719bSwdenk
1302c609719bSwdenk		Define this to enable video support (for output to
1303c609719bSwdenk		video).
1304c609719bSwdenk
1305c609719bSwdenk		CONFIG_VIDEO_CT69000
1306c609719bSwdenk
1307c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1308c609719bSwdenk
1309c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1310eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1311eeb1b77bSwdenk		video output is selected via environment 'videoout'
1312eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1313eeb1b77bSwdenk		assumed.
1314c609719bSwdenk
1315eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
131611ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1317eeb1b77bSwdenk		are possible:
1318eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1319eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1320eeb1b77bSwdenk
1321eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1322eeb1b77bSwdenk		-------------+---------------------------------------------
1323eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1324eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1325eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1326eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1327eeb1b77bSwdenk		-------------+---------------------------------------------
1328c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1329c609719bSwdenk
1330eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13317817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1332eeb1b77bSwdenk
1333eeb1b77bSwdenk
1334a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1335a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1336a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1337a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1338a6c7ad2fSwdenk
13397d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13407d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13417d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13427d3053fbSTimur Tabi		support, and should also define these other macros:
13437d3053fbSTimur Tabi
13447d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13457d3053fbSTimur Tabi			CONFIG_VIDEO
13467d3053fbSTimur Tabi			CONFIG_CMD_BMP
13477d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13487d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13497d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13507d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13517d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13527d3053fbSTimur Tabi
1353ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1354ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1355ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1356ba8e76bdSTimur Tabi		description of this variable.
13577d3053fbSTimur Tabi
1358682011ffSwdenk- Keyboard Support:
1359682011ffSwdenk		CONFIG_KEYBOARD
1360682011ffSwdenk
1361682011ffSwdenk		Define this to enable a custom keyboard support.
1362682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1363682011ffSwdenk		defined in your board-specific files.
1364682011ffSwdenk		The only board using this so far is RBC823.
1365a6c7ad2fSwdenk
1366c609719bSwdenk- LCD Support:	CONFIG_LCD
1367c609719bSwdenk
1368c609719bSwdenk		Define this to enable LCD support (for output to LCD
1369c609719bSwdenk		display); also select one of the supported displays
1370c609719bSwdenk		by defining one of these:
1371c609719bSwdenk
137239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
137339cf4804SStelian Pop
137439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
137539cf4804SStelian Pop
1376fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1377c609719bSwdenk
1378fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1379c609719bSwdenk
1380fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1381c609719bSwdenk
1382fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1383fd3103bbSwdenk			Active, color, single scan.
1384fd3103bbSwdenk
1385fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1386fd3103bbSwdenk
1387fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1388c609719bSwdenk			Active, color, single scan.
1389c609719bSwdenk
1390c609719bSwdenk		CONFIG_SHARP_16x9
1391c609719bSwdenk
1392c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1393c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1394c609719bSwdenk
1395c609719bSwdenk		CONFIG_SHARP_LQ64D341
1396c609719bSwdenk
1397c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1398c609719bSwdenk			Active, color, single scan.
1399c609719bSwdenk
1400c609719bSwdenk		CONFIG_HLD1045
1401c609719bSwdenk
1402c609719bSwdenk			HLD1045 display, 640x480.
1403c609719bSwdenk			Active, color, single scan.
1404c609719bSwdenk
1405c609719bSwdenk		CONFIG_OPTREX_BW
1406c609719bSwdenk
1407c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1408c609719bSwdenk			or
1409c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1410c609719bSwdenk			or
1411c609719bSwdenk			Hitachi	 SP14Q002
1412c609719bSwdenk
1413c609719bSwdenk			320x240. Black & white.
1414c609719bSwdenk
1415c609719bSwdenk		Normally display is black on white background; define
14166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1417c609719bSwdenk
14187152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1419d791b1dcSwdenk
1420d791b1dcSwdenk		If this option is set, the environment is checked for
1421d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1422d791b1dcSwdenk		of logo, copyright and system information on the LCD
1423e94d2cd9Swdenk		is suppressed and the BMP image at the address
1424d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1425d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1426d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1427d791b1dcSwdenk		loaded very quickly after power-on.
1428d791b1dcSwdenk
14291ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14301ca298ceSMatthias Weisser
14311ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14321ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14331ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14341ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14351ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14361ca298ceSMatthias Weisser		specify 'm' for centering the image.
14371ca298ceSMatthias Weisser
14381ca298ceSMatthias Weisser		Example:
14391ca298ceSMatthias Weisser		setenv splashpos m,m
14401ca298ceSMatthias Weisser			=> image at center of screen
14411ca298ceSMatthias Weisser
14421ca298ceSMatthias Weisser		setenv splashpos 30,20
14431ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14441ca298ceSMatthias Weisser
14451ca298ceSMatthias Weisser		setenv splashpos -10,m
14461ca298ceSMatthias Weisser			=> vertically centered image
14471ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14481ca298ceSMatthias Weisser
144998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
145098f4a3dfSStefan Roese
145198f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
145298f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
145398f4a3dfSStefan Roese		splashscreen support or the bmp command.
145498f4a3dfSStefan Roese
1455d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1456d5011762SAnatolij Gustschin
1457d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1458d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1459d5011762SAnatolij Gustschin		bmp command.
1460d5011762SAnatolij Gustschin
1461c29fdfc1Swdenk- Compression support:
1462c29fdfc1Swdenk		CONFIG_BZIP2
1463c29fdfc1Swdenk
1464c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1465c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1466c29fdfc1Swdenk		compressed images are supported.
1467c29fdfc1Swdenk
1468c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
14696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1470c29fdfc1Swdenk		be at least 4MB.
1471d791b1dcSwdenk
1472fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1473fc9c1727SLuigi 'Comio' Mantellini
1474fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1475fc9c1727SLuigi 'Comio' Mantellini		images is included.
1476fc9c1727SLuigi 'Comio' Mantellini
1477fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1478fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1479fc9c1727SLuigi 'Comio' Mantellini		formula:
1480fc9c1727SLuigi 'Comio' Mantellini
1481fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1482fc9c1727SLuigi 'Comio' Mantellini
1483fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1484fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1485fc9c1727SLuigi 'Comio' Mantellini
1486fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1487fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1488fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1489fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1490fc9c1727SLuigi 'Comio' Mantellini
1491fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1492fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
14936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1494fc9c1727SLuigi 'Comio' Mantellini
149517ea1177Swdenk- MII/PHY support:
149617ea1177Swdenk		CONFIG_PHY_ADDR
149717ea1177Swdenk
149817ea1177Swdenk		The address of PHY on MII bus.
149917ea1177Swdenk
150017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
150117ea1177Swdenk
150217ea1177Swdenk		The clock frequency of the MII bus
150317ea1177Swdenk
150417ea1177Swdenk		CONFIG_PHY_GIGE
150517ea1177Swdenk
150617ea1177Swdenk		If this option is set, support for speed/duplex
150711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
150817ea1177Swdenk
150917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
151017ea1177Swdenk
151117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
151217ea1177Swdenk		reset before any MII register access is possible.
151317ea1177Swdenk		For such PHY, set this option to the usec delay
151417ea1177Swdenk		required. (minimum 300usec for LXT971A)
151517ea1177Swdenk
151617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
151717ea1177Swdenk
151817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
151917ea1177Swdenk		command issued before MII status register can be read
152017ea1177Swdenk
1521c609719bSwdenk- Ethernet address:
1522c609719bSwdenk		CONFIG_ETHADDR
1523c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1524c609719bSwdenk		CONFIG_ETH2ADDR
1525c609719bSwdenk		CONFIG_ETH3ADDR
1526c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1527c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1528c609719bSwdenk
152911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
153011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1531c609719bSwdenk		is not determined automatically.
1532c609719bSwdenk
1533c609719bSwdenk- IP address:
1534c609719bSwdenk		CONFIG_IPADDR
1535c609719bSwdenk
1536c609719bSwdenk		Define a default value for the IP address to use for
153711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1538c609719bSwdenk		determined through e.g. bootp.
15391ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1540c609719bSwdenk
1541c609719bSwdenk- Server IP address:
1542c609719bSwdenk		CONFIG_SERVERIP
1543c609719bSwdenk
1544c609719bSwdenk		Defines a default value for the IP address of a TFTP
1545c609719bSwdenk		server to contact when using the "tftboot" command.
15461ebcd654SWolfgang Denk		(Environment variable "serverip")
1547c609719bSwdenk
154897cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
154997cfe861SRobin Getz
155097cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
155197cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
155297cfe861SRobin Getz
15531ebcd654SWolfgang Denk- Gateway IP address:
15541ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15551ebcd654SWolfgang Denk
15561ebcd654SWolfgang Denk		Defines a default value for the IP address of the
15571ebcd654SWolfgang Denk		default router where packets to other networks are
15581ebcd654SWolfgang Denk		sent to.
15591ebcd654SWolfgang Denk		(Environment variable "gatewayip")
15601ebcd654SWolfgang Denk
15611ebcd654SWolfgang Denk- Subnet mask:
15621ebcd654SWolfgang Denk		CONFIG_NETMASK
15631ebcd654SWolfgang Denk
15641ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
15651ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
15661ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
15671ebcd654SWolfgang Denk		forwarded through a router.
15681ebcd654SWolfgang Denk		(Environment variable "netmask")
15691ebcd654SWolfgang Denk
157053a5c424SDavid Updegraff- Multicast TFTP Mode:
157153a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
157253a5c424SDavid Updegraff
157353a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
157453a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
157511ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
157653a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
157753a5c424SDavid Updegraff		multicast group.
157853a5c424SDavid Updegraff
1579c609719bSwdenk- BOOTP Recovery Mode:
1580c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1581c609719bSwdenk
1582c609719bSwdenk		If you have many targets in a network that try to
1583c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1584c609719bSwdenk		systems send out BOOTP requests at precisely the same
1585c609719bSwdenk		moment (which would happen for instance at recovery
1586c609719bSwdenk		from a power failure, when all systems will try to
1587c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1588c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1589c609719bSwdenk		inserted before sending out BOOTP requests. The
15906c33c785SWolfgang Denk		following delays are inserted then:
1591c609719bSwdenk
1592c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1593c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1594c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1595c609719bSwdenk		4th and following
1596c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1597c609719bSwdenk
1598fe389a82Sstroese- DHCP Advanced Options:
15991fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
16001fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1601fe389a82Sstroese
16021fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
16031fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
16041fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
16051fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
16061fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
16071fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16081fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16091fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16101fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16111fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16121fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16131fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16142c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1615fe389a82Sstroese
16165d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16175d110f0aSWilson Callan		environment variable, not the BOOTP server.
1618fe389a82Sstroese
16192c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16202c00e099SJoe Hershberger		after the configured retry count, the call will fail
16212c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16222c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16232c00e099SJoe Hershberger		is not available.
16242c00e099SJoe Hershberger
1625fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1626fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1627fe389a82Sstroese		than one DNS serverip is offered to the client.
1628fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1629fe389a82Sstroese		serverip will be stored in the additional environment
1630fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1631fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16321fe80d79SJon Loeliger		is defined.
1633fe389a82Sstroese
1634fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1635fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1636fe389a82Sstroese		need the hostname of the DHCP requester.
16375d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16381fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16391fe80d79SJon Loeliger		option 12 to the DHCP server.
1640fe389a82Sstroese
1641d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1642d9a2f416SAras Vaichas
1643d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1644d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1645d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1646d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1647d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1648d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1649d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1650d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1651d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1652d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1653d9a2f416SAras Vaichas		this delay.
1654d9a2f416SAras Vaichas
1655d22c338eSJoe Hershberger - Link-local IP address negotiation:
1656d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1657d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1658d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1659d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1660d22c338eSJoe Hershberger
1661d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1662d22c338eSJoe Hershberger
1663a3d991bdSwdenk - CDP Options:
1664a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1665a3d991bdSwdenk
1666a3d991bdSwdenk		The device id used in CDP trigger frames.
1667a3d991bdSwdenk
1668a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1669a3d991bdSwdenk
1670a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1671a3d991bdSwdenk		of the device.
1672a3d991bdSwdenk
1673a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1674a3d991bdSwdenk
1675a3d991bdSwdenk		A printf format string which contains the ascii name of
1676a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
167711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1678a3d991bdSwdenk
1679a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1680a3d991bdSwdenk
1681a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1682a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1683a3d991bdSwdenk
1684a3d991bdSwdenk		CONFIG_CDP_VERSION
1685a3d991bdSwdenk
1686a3d991bdSwdenk		An ascii string containing the version of the software.
1687a3d991bdSwdenk
1688a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1689a3d991bdSwdenk
1690a3d991bdSwdenk		An ascii string containing the name of the platform.
1691a3d991bdSwdenk
1692a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1693a3d991bdSwdenk
1694a3d991bdSwdenk		A 32bit integer sent on the trigger.
1695a3d991bdSwdenk
1696a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1697a3d991bdSwdenk
1698a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1699a3d991bdSwdenk		device in .1 of milliwatts.
1700a3d991bdSwdenk
1701a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1702a3d991bdSwdenk
1703a3d991bdSwdenk		A byte containing the id of the VLAN.
1704a3d991bdSwdenk
1705c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1706c609719bSwdenk
1707c609719bSwdenk		Several configurations allow to display the current
1708c609719bSwdenk		status using a LED. For instance, the LED will blink
1709c609719bSwdenk		fast while running U-Boot code, stop blinking as
1710c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1711c609719bSwdenk		start blinking slow once the Linux kernel is running
1712c609719bSwdenk		(supported by a status LED driver in the Linux
1713c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1714c609719bSwdenk		feature in U-Boot.
1715c609719bSwdenk
1716c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1717c609719bSwdenk
1718c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1719c609719bSwdenk		on those systems that support this (optional)
1720c609719bSwdenk		feature, like the TQM8xxL modules.
1721c609719bSwdenk
1722c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1723c609719bSwdenk
1724b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1725b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
172611ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1727c609719bSwdenk
1728b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1729602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1730b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1731b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1732c609719bSwdenk		command line interface.
1733c609719bSwdenk
1734bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1735c609719bSwdenk
1736b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1737b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1738b37c7e5eSwdenk		support for I2C.
1739c609719bSwdenk
1740b37c7e5eSwdenk		There are several other quantities that must also be
1741b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1742c609719bSwdenk
17436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1744b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
17456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
174611ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1747c609719bSwdenk
17488d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1749a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
17508d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
17518d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
17528d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1753b37c7e5eSwdenk
17545da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
17555da71efaSEric Millbrandt
17565da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
17575da71efaSEric Millbrandt		chips might think that the current transfer is still
17585da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
17595da71efaSEric Millbrandt		commands until the slave device responds.
17605da71efaSEric Millbrandt
1761b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1762b37c7e5eSwdenk
1763b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1764b37c7e5eSwdenk		then the following macros need to be defined (examples are
1765b37c7e5eSwdenk		from include/configs/lwmon.h):
1766c609719bSwdenk
1767c609719bSwdenk		I2C_INIT
1768c609719bSwdenk
1769b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1770c609719bSwdenk		controller or configure ports.
1771c609719bSwdenk
1772b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1773b37c7e5eSwdenk
1774c609719bSwdenk		I2C_PORT
1775c609719bSwdenk
1776c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1777c609719bSwdenk		assumes both bits are on the same port). Valid values
1778c609719bSwdenk		are 0..3 for ports A..D.
1779c609719bSwdenk
1780c609719bSwdenk		I2C_ACTIVE
1781c609719bSwdenk
1782c609719bSwdenk		The code necessary to make the I2C data line active
1783c609719bSwdenk		(driven).  If the data line is open collector, this
1784c609719bSwdenk		define can be null.
1785c609719bSwdenk
1786b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1787b37c7e5eSwdenk
1788c609719bSwdenk		I2C_TRISTATE
1789c609719bSwdenk
1790c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1791c609719bSwdenk		(inactive).  If the data line is open collector, this
1792c609719bSwdenk		define can be null.
1793c609719bSwdenk
1794b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1795b37c7e5eSwdenk
1796c609719bSwdenk		I2C_READ
1797c609719bSwdenk
1798c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1799c609719bSwdenk		FALSE if it is low.
1800c609719bSwdenk
1801b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1802b37c7e5eSwdenk
1803c609719bSwdenk		I2C_SDA(bit)
1804c609719bSwdenk
1805c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1806c609719bSwdenk		is FALSE, it clears it (low).
1807c609719bSwdenk
1808b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1809b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1810b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1811b37c7e5eSwdenk
1812c609719bSwdenk		I2C_SCL(bit)
1813c609719bSwdenk
1814c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1815c609719bSwdenk		is FALSE, it clears it (low).
1816c609719bSwdenk
1817b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1818b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1819b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1820b37c7e5eSwdenk
1821c609719bSwdenk		I2C_DELAY
1822c609719bSwdenk
1823c609719bSwdenk		This delay is invoked four times per clock cycle so this
1824c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1825b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1826b37c7e5eSwdenk		like:
1827b37c7e5eSwdenk
1828b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1829c609719bSwdenk
1830793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1831793b5726SMike Frysinger
1832793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1833793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1834793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1835793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1836793b5726SMike Frysinger
1837793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1838793b5726SMike Frysinger		the generic GPIO functions.
1839793b5726SMike Frysinger
18406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
184147cd00faSwdenk
184247cd00faSwdenk		When a board is reset during an i2c bus transfer
184347cd00faSwdenk		chips might think that the current transfer is still
184447cd00faSwdenk		in progress. On some boards it is possible to access
184547cd00faSwdenk		the i2c SCLK line directly, either by using the
184647cd00faSwdenk		processor pin as a GPIO or by having a second pin
184747cd00faSwdenk		connected to the bus. If this option is defined a
184847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
184947cd00faSwdenk		is run early in the boot sequence.
185047cd00faSwdenk
185126a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
185226a33504SRichard Retanubun
185326a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
185426a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
185526a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
185626a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
185726a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
185826a33504SRichard Retanubun		controller provide such a method. It is called at the end of
185926a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
186026a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
186126a33504SRichard Retanubun
186217ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
186317ea1177Swdenk
186417ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
186517ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
186617ea1177Swdenk		variable "i2cfast". (see also i2cfast)
186717ea1177Swdenk
1868bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1869bb99ad6dSBen Warren
1870bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1871bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1872bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1873bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1874bb99ad6dSBen Warren
18756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1876bb99ad6dSBen Warren
1877bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
18780f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
18790f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
18800f89c54bSPeter Tyser		a 1D array of device addresses
1881bb99ad6dSBen Warren
1882bb99ad6dSBen Warren		e.g.
1883bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
18846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1885bb99ad6dSBen Warren
1886bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1887bb99ad6dSBen Warren
1888bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
18896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1890bb99ad6dSBen Warren
1891bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1892bb99ad6dSBen Warren
18936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1894be5e6181STimur Tabi
1895be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1896be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1897be5e6181STimur Tabi
18986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
18990dc018ecSStefan Roese
19000dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
19010dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
19020dc018ecSStefan Roese
19036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
19040dc018ecSStefan Roese
19050dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
19060dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
19070dc018ecSStefan Roese
19086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19099ebbb54fSVictor Gallardo
19109ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19119ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19129ebbb54fSVictor Gallardo		specified DTT device.
19139ebbb54fSVictor Gallardo
1914be5e6181STimur Tabi		CONFIG_FSL_I2C
1915be5e6181STimur Tabi
1916be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
19177817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1918be5e6181STimur Tabi
191967b23a32SHeiko Schocher		CONFIG_I2C_MUX
192067b23a32SHeiko Schocher
192167b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
192267b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
192367b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
192467b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
192567b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
192667b23a32SHeiko Schocher		the muxes to activate this new "bus".
192767b23a32SHeiko Schocher
192867b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
192967b23a32SHeiko Schocher		feature!
193067b23a32SHeiko Schocher
193167b23a32SHeiko Schocher		Example:
193267b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
193367b23a32SHeiko Schocher			The First mux with address 70 and channel 6
193467b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
193567b23a32SHeiko Schocher
193667b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
193767b23a32SHeiko Schocher
193867b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
193967b23a32SHeiko Schocher		of I2C Busses with muxes:
194067b23a32SHeiko Schocher
194167b23a32SHeiko Schocher		=> i2c bus
194267b23a32SHeiko Schocher		Busses reached over muxes:
194367b23a32SHeiko Schocher		Bus ID: 2
194467b23a32SHeiko Schocher		  reached over Mux(es):
194567b23a32SHeiko Schocher		    pca9544a@70 ch: 4
194667b23a32SHeiko Schocher		Bus ID: 3
194767b23a32SHeiko Schocher		  reached over Mux(es):
194867b23a32SHeiko Schocher		    pca9544a@70 ch: 6
194967b23a32SHeiko Schocher		    pca9544a@71 ch: 4
195067b23a32SHeiko Schocher		=>
195167b23a32SHeiko Schocher
195267b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1953f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1954f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
195567b23a32SHeiko Schocher		the channel 4.
195667b23a32SHeiko Schocher
195767b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1958f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
195967b23a32SHeiko Schocher		the 2 muxes.
196067b23a32SHeiko Schocher
196167b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
196267b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
196367b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
196467b23a32SHeiko Schocher		to add this option to other architectures.
196567b23a32SHeiko Schocher
19662ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
19672ac6985aSAndrew Dyer
19682ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
19692ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
19702ac6985aSAndrew Dyer		between writing the address pointer and reading the
19712ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
19722ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
19732ac6985aSAndrew Dyer		devices can use either method, but some require one or
19742ac6985aSAndrew Dyer		the other.
1975be5e6181STimur Tabi
1976c609719bSwdenk- SPI Support:	CONFIG_SPI
1977c609719bSwdenk
1978c609719bSwdenk		Enables SPI driver (so far only tested with
1979c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1980c609719bSwdenk		D/As on the SACSng board)
1981c609719bSwdenk
19826639562eSYoshihiro Shimoda		CONFIG_SH_SPI
19836639562eSYoshihiro Shimoda
19846639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
19856639562eSYoshihiro Shimoda		only SH7757 is supported.
19866639562eSYoshihiro Shimoda
1987c609719bSwdenk		CONFIG_SPI_X
1988c609719bSwdenk
1989c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1990c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1991c609719bSwdenk
1992c609719bSwdenk		CONFIG_SOFT_SPI
1993c609719bSwdenk
1994c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1995c609719bSwdenk		using hardware support. This is a general purpose
1996c609719bSwdenk		driver that only requires three general I/O port pins
1997c609719bSwdenk		(two outputs, one input) to function. If this is
1998c609719bSwdenk		defined, the board configuration must define several
1999c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2000c609719bSwdenk		an example, see include/configs/sacsng.h.
2001c609719bSwdenk
200204a9e118SBen Warren		CONFIG_HARD_SPI
200304a9e118SBen Warren
200404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
200504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
200604a9e118SBen Warren		must define a list of chip-select function pointers.
200704a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
200804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
200904a9e118SBen Warren
201038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
201138254f45SGuennadi Liakhovetski
201238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20132e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
201438254f45SGuennadi Liakhovetski
20150133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20160133502eSMatthias Fuchs
20170133502eSMatthias Fuchs		Enables FPGA subsystem.
20180133502eSMatthias Fuchs
20190133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20200133502eSMatthias Fuchs
20210133502eSMatthias Fuchs		Enables support for specific chip vendors.
20220133502eSMatthias Fuchs		(ALTERA, XILINX)
20230133502eSMatthias Fuchs
20240133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20250133502eSMatthias Fuchs
20260133502eSMatthias Fuchs		Enables support for FPGA family.
20270133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20280133502eSMatthias Fuchs
20290133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2030c609719bSwdenk
2031c609719bSwdenk		Specify the number of FPGA devices to support.
2032c609719bSwdenk
20336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2034c609719bSwdenk
2035c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2036c609719bSwdenk
20376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2038c609719bSwdenk
2039c609719bSwdenk		Enable checks on FPGA configuration interface busy
2040c609719bSwdenk		status by the configuration function. This option
2041c609719bSwdenk		will require a board or device specific function to
2042c609719bSwdenk		be written.
2043c609719bSwdenk
2044c609719bSwdenk		CONFIG_FPGA_DELAY
2045c609719bSwdenk
2046c609719bSwdenk		If defined, a function that provides delays in the FPGA
2047c609719bSwdenk		configuration driver.
2048c609719bSwdenk
20496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2050c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2051c609719bSwdenk
20526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2053c609719bSwdenk
2054c609719bSwdenk		Check for configuration errors during FPGA bitfile
2055c609719bSwdenk		loading. For example, abort during Virtex II
2056c609719bSwdenk		configuration if the INIT_B line goes low (which
2057c609719bSwdenk		indicated a CRC error).
2058c609719bSwdenk
20596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2060c609719bSwdenk
2061c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2062c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2063c609719bSwdenk		FPGA configuration sequence. The default time is 500
206411ccc33fSMarcel Ziswiler		ms.
2065c609719bSwdenk
20666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2067c609719bSwdenk
2068c609719bSwdenk		Maximum time to wait for BUSY to deassert during
206911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2070c609719bSwdenk
20716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2072c609719bSwdenk
2073c609719bSwdenk		Time to wait after FPGA configuration. The default is
207411ccc33fSMarcel Ziswiler		200 ms.
2075c609719bSwdenk
2076c609719bSwdenk- Configuration Management:
2077c609719bSwdenk		CONFIG_IDENT_STRING
2078c609719bSwdenk
2079c609719bSwdenk		If defined, this string will be added to the U-Boot
2080c609719bSwdenk		version information (U_BOOT_VERSION)
2081c609719bSwdenk
2082c609719bSwdenk- Vendor Parameter Protection:
2083c609719bSwdenk
2084c609719bSwdenk		U-Boot considers the values of the environment
2085c609719bSwdenk		variables "serial#" (Board Serial Number) and
20867152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2087c609719bSwdenk		are set once by the board vendor / manufacturer, and
2088c609719bSwdenk		protects these variables from casual modification by
2089c609719bSwdenk		the user. Once set, these variables are read-only,
2090c609719bSwdenk		and write or delete attempts are rejected. You can
209111ccc33fSMarcel Ziswiler		change this behaviour:
2092c609719bSwdenk
2093c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2094c609719bSwdenk		file, the write protection for vendor parameters is
209547cd00faSwdenk		completely disabled. Anybody can change or delete
2096c609719bSwdenk		these parameters.
2097c609719bSwdenk
2098c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2099c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
210011ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2101c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2102c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2103c609719bSwdenk		read-only.]
2104c609719bSwdenk
2105c609719bSwdenk- Protected RAM:
2106c609719bSwdenk		CONFIG_PRAM
2107c609719bSwdenk
2108c609719bSwdenk		Define this variable to enable the reservation of
2109c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2110c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2111c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2112c609719bSwdenk		this default value by defining an environment
2113c609719bSwdenk		variable "pram" to the number of kB you want to
2114c609719bSwdenk		reserve. Note that the board info structure will
2115c609719bSwdenk		still show the full amount of RAM. If pRAM is
2116c609719bSwdenk		reserved, a new environment variable "mem" will
2117c609719bSwdenk		automatically be defined to hold the amount of
2118c609719bSwdenk		remaining RAM in a form that can be passed as boot
2119c609719bSwdenk		argument to Linux, for instance like that:
2120c609719bSwdenk
2121fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2122c609719bSwdenk			saveenv
2123c609719bSwdenk
2124c609719bSwdenk		This way you can tell Linux not to use this memory,
2125c609719bSwdenk		either, which results in a memory region that will
2126c609719bSwdenk		not be affected by reboots.
2127c609719bSwdenk
2128c609719bSwdenk		*WARNING* If your board configuration uses automatic
2129c609719bSwdenk		detection of the RAM size, you must make sure that
2130c609719bSwdenk		this memory test is non-destructive. So far, the
2131c609719bSwdenk		following board configurations are known to be
2132c609719bSwdenk		"pRAM-clean":
2133c609719bSwdenk
2134c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2135c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
2136544d97e9SWolfgang Denk			FLAGADM, TQM8260
2137c609719bSwdenk
2138c609719bSwdenk- Error Recovery:
2139c609719bSwdenk		CONFIG_PANIC_HANG
2140c609719bSwdenk
2141c609719bSwdenk		Define this variable to stop the system in case of a
2142c609719bSwdenk		fatal error, so that you have to reset it manually.
2143c609719bSwdenk		This is probably NOT a good idea for an embedded
214411ccc33fSMarcel Ziswiler		system where you want the system to reboot
2145c609719bSwdenk		automatically as fast as possible, but it may be
2146c609719bSwdenk		useful during development since you can try to debug
2147c609719bSwdenk		the conditions that lead to the situation.
2148c609719bSwdenk
2149c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2150c609719bSwdenk
2151c609719bSwdenk		This variable defines the number of retries for
2152c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2153c609719bSwdenk		before giving up the operation. If not defined, a
2154c609719bSwdenk		default value of 5 is used.
2155c609719bSwdenk
215640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
215740cb90eeSGuennadi Liakhovetski
215840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
215940cb90eeSGuennadi Liakhovetski
216048a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
216148a3e999STetsuyuki Kobayashi
216248a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
216348a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
216448a3e999STetsuyuki Kobayashi		try longer timeout such as
216548a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
216648a3e999STetsuyuki Kobayashi
2167c609719bSwdenk- Command Interpreter:
21688078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
216904a85b3bSwdenk
217004a85b3bSwdenk		Enable auto completion of commands using TAB.
217104a85b3bSwdenk
21728078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
21738078f1a5SWolfgang Denk		for the "hush" shell.
21748078f1a5SWolfgang Denk
21758078f1a5SWolfgang Denk
21766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2177c609719bSwdenk
2178c609719bSwdenk		Define this variable to enable the "hush" shell (from
2179c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2180c609719bSwdenk		powerful command line syntax like
2181c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2182c609719bSwdenk		constructs ("shell scripts").
2183c609719bSwdenk
2184c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2185c609719bSwdenk		with a somewhat smaller memory footprint.
2186c609719bSwdenk
2187c609719bSwdenk
21886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2189c609719bSwdenk
2190c609719bSwdenk		This defines the secondary prompt string, which is
2191c609719bSwdenk		printed when the command interpreter needs more input
2192c609719bSwdenk		to complete a command. Usually "> ".
2193c609719bSwdenk
2194c609719bSwdenk	Note:
2195c609719bSwdenk
2196c609719bSwdenk		In the current implementation, the local variables
2197c609719bSwdenk		space and global environment variables space are
2198c609719bSwdenk		separated. Local variables are those you define by
21993b57fe0aSwdenk		simply typing `name=value'. To access a local
2200c609719bSwdenk		variable later on, you have write `$name' or
22013b57fe0aSwdenk		`${name}'; to execute the contents of a variable
22023b57fe0aSwdenk		directly type `$name' at the command prompt.
2203c609719bSwdenk
2204c609719bSwdenk		Global environment variables are those you use
2205c609719bSwdenk		setenv/printenv to work with. To run a command stored
2206c609719bSwdenk		in such a variable, you need to use the run command,
2207c609719bSwdenk		and you must not use the '$' sign to access them.
2208c609719bSwdenk
2209c609719bSwdenk		To store commands and special characters in a
2210c609719bSwdenk		variable, please use double quotation marks
2211c609719bSwdenk		surrounding the whole text of the variable, instead
2212c609719bSwdenk		of the backslashes before semicolons and special
2213c609719bSwdenk		symbols.
2214c609719bSwdenk
2215aa0c71acSWolfgang Denk- Commandline Editing and History:
2216aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2217aa0c71acSWolfgang Denk
221811ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2219aa0c71acSWolfgang Denk		commandline input operations
2220aa0c71acSWolfgang Denk
2221a8c7c708Swdenk- Default Environment:
2222c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2223c609719bSwdenk
2224c609719bSwdenk		Define this to contain any number of null terminated
2225c609719bSwdenk		strings (variable = value pairs) that will be part of
22267152b1d0Swdenk		the default environment compiled into the boot image.
22272262cfeeSwdenk
2228c609719bSwdenk		For example, place something like this in your
2229c609719bSwdenk		board's config file:
2230c609719bSwdenk
2231c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2232c609719bSwdenk			"myvar1=value1\0" \
2233c609719bSwdenk			"myvar2=value2\0"
2234c609719bSwdenk
2235c609719bSwdenk		Warning: This method is based on knowledge about the
2236c609719bSwdenk		internal format how the environment is stored by the
22372262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2238c609719bSwdenk		interface! Although it is unlikely that this format
22397152b1d0Swdenk		will change soon, there is no guarantee either.
2240c609719bSwdenk		You better know what you are doing here.
2241c609719bSwdenk
2242c609719bSwdenk		Note: overly (ab)use of the default environment is
2243c609719bSwdenk		discouraged. Make sure to check other ways to preset
224474de7aefSWolfgang Denk		the environment like the "source" command or the
2245c609719bSwdenk		boot command first.
2246c609719bSwdenk
22475e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
22485e724ca2SStephen Warren
22495e724ca2SStephen Warren		Define this in order to add variables describing the
22505e724ca2SStephen Warren		U-Boot build configuration to the default environment.
22515e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
22525e724ca2SStephen Warren
22535e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
22545e724ca2SStephen Warren
22555e724ca2SStephen Warren		- CONFIG_SYS_ARCH
22565e724ca2SStephen Warren		- CONFIG_SYS_CPU
22575e724ca2SStephen Warren		- CONFIG_SYS_BOARD
22585e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
22595e724ca2SStephen Warren		- CONFIG_SYS_SOC
22605e724ca2SStephen Warren
2261a8c7c708Swdenk- DataFlash Support:
22622abbe075Swdenk		CONFIG_HAS_DATAFLASH
22632abbe075Swdenk
22642abbe075Swdenk		Defining this option enables DataFlash features and
22652abbe075Swdenk		allows to read/write in Dataflash via the standard
22662abbe075Swdenk		commands cp, md...
22672abbe075Swdenk
2268f61ec45eSEric Nelson- Serial Flash support
2269f61ec45eSEric Nelson		CONFIG_CMD_SF
2270f61ec45eSEric Nelson
2271f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2272f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2273f61ec45eSEric Nelson
2274f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2275f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2276f61ec45eSEric Nelson		commands.
2277f61ec45eSEric Nelson
2278f61ec45eSEric Nelson		The following defaults may be provided by the platform
2279f61ec45eSEric Nelson		to handle the common case when only a single serial
2280f61ec45eSEric Nelson		flash is present on the system.
2281f61ec45eSEric Nelson
2282f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2283f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2284f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2285f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2286f61ec45eSEric Nelson
22873f85ce27Swdenk- SystemACE Support:
22883f85ce27Swdenk		CONFIG_SYSTEMACE
22893f85ce27Swdenk
22903f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
22913f85ce27Swdenk		chips attached via some sort of local bus. The address
229211ccc33fSMarcel Ziswiler		of the chip must also be defined in the
22936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
22943f85ce27Swdenk
22953f85ce27Swdenk		#define CONFIG_SYSTEMACE
22966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
22973f85ce27Swdenk
22983f85ce27Swdenk		When SystemACE support is added, the "ace" device type
22993f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
23003f85ce27Swdenk
2301ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2302ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2303ecb0ccd9SWolfgang Denk
230428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2305ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
230628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2307ecb0ccd9SWolfgang Denk		number generator is used.
2308ecb0ccd9SWolfgang Denk
230928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
231028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
231128cb9375SWolfgang Denk		defined, the normal port 69 is used.
231228cb9375SWolfgang Denk
231328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2314ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2315ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2316ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2317ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2318ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2319ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2320ecb0ccd9SWolfgang Denk
2321a8c7c708Swdenk- Show boot progress:
2322c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2323c609719bSwdenk
2324c609719bSwdenk		Defining this option allows to add some board-
2325c609719bSwdenk		specific code (calling a user-provided function
2326c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2327c609719bSwdenk		the system's boot progress on some display (for
2328c609719bSwdenk		example, some LED's) on your board. At the moment,
2329c609719bSwdenk		the following checkpoints are implemented:
2330c609719bSwdenk
23313a608ca0SSimon Glass- Detailed boot stage timing
23323a608ca0SSimon Glass		CONFIG_BOOTSTAGE
23333a608ca0SSimon Glass		Define this option to get detailed timing of each stage
23343a608ca0SSimon Glass		of the boot process.
23353a608ca0SSimon Glass
23363a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
23373a608ca0SSimon Glass		This is the number of available user bootstage records.
23383a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
23393a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
23403a608ca0SSimon Glass		the limit, recording will stop.
23413a608ca0SSimon Glass
23423a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
23433a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
23443a608ca0SSimon Glass
23453a608ca0SSimon Glass		Timer summary in microseconds:
23463a608ca0SSimon Glass		       Mark    Elapsed  Stage
23473a608ca0SSimon Glass			  0          0  reset
23483a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
23493a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
23503a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
23513a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
23523a608ca0SSimon Glass		  3,910,375    250,777  main_loop
23533a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
23543a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
23553a608ca0SSimon Glass
23561372cce2SMarian BalakowiczLegacy uImage format:
23571372cce2SMarian Balakowicz
2358c609719bSwdenk  Arg	Where			When
2359c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2360c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2361c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2362c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2363c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2364c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2365c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2366c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2367c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
23681372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2369c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2370c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2371c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2372c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
23731372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2374c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
23751372cce2SMarian Balakowicz
23761372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
23771372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
23781372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
23791372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
23801372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
23811372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
23821372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
238311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
23841372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
23851372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
23861372cce2SMarian Balakowicz
2387ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2388c609719bSwdenk
2389a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
239063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
239163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
239263e73c9aSwdenk
2393566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2394566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2395566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2396566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2397566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2398566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2399566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2400566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2401566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2402566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2403566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2404566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2405566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2406566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2407566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2408566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2409566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2410566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2411566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2412566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2413566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2414566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2415566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2416566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2417566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2418566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2419566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2420566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2421566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2422566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2423566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2424566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2425566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2426566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2427566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2428566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2429566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2430566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2431566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2432566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2433566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2434566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2435566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2436566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2437566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2438566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2439566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2440c609719bSwdenk
2441566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2442c609719bSwdenk
2443566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2444566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2445566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2446206c60cbSwdenk
2447566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2448566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
244911ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2450566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2451566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2452566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
245374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
245474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2455566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2456c609719bSwdenk
24571372cce2SMarian BalakowiczFIT uImage format:
24581372cce2SMarian Balakowicz
24591372cce2SMarian Balakowicz  Arg	Where			When
24601372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
24611372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
24621372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
24631372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
24641372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
24651372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2466f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
24671372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
24681372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
24691372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
24701372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
24711372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
247211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
247311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
24741372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
24751372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
24761372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
24771372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
24781372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
24791372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
24801372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
24811372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
24821372cce2SMarian Balakowicz
24831372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
24841372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
24851372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
248611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
24871372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
24881372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
24891372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
24901372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
24911372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
24921372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
24931372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
24941372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
24951372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
24961372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
24971372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
24981372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
24991372cce2SMarian Balakowicz
250011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
25011372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
25021372cce2SMarian Balakowicz
250311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
25041372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
25051372cce2SMarian Balakowicz
250611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
25071372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
25081372cce2SMarian Balakowicz
25094cf2609bSWolfgang Denk- Standalone program support:
25104cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
25114cf2609bSWolfgang Denk
25126feff899SWolfgang Denk		This option defines a board specific value for the
25136feff899SWolfgang Denk		address where standalone program gets loaded, thus
25146feff899SWolfgang Denk		overwriting the architecture dependent default
25154cf2609bSWolfgang Denk		settings.
25164cf2609bSWolfgang Denk
25174cf2609bSWolfgang Denk- Frame Buffer Address:
25184cf2609bSWolfgang Denk		CONFIG_FB_ADDR
25194cf2609bSWolfgang Denk
25204cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
25214cf2609bSWolfgang Denk		address for frame buffer.
25224cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
25234cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
25246feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
25254cf2609bSWolfgang Denk
25264cf2609bSWolfgang Denk		Please see board_init_f function.
25274cf2609bSWolfgang Denk
2528cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2529cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2530cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2531cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2532cccfc2abSDetlev Zundel
2533cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2534cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2535cccfc2abSDetlev Zundel
2536cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2537cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2538cccfc2abSDetlev Zundel
2539cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2540cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2541cccfc2abSDetlev Zundel
2542cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2543cccfc2abSDetlev Zundel
2544cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2545cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2546cccfc2abSDetlev Zundel
25476a11cf48SDaniel Schwierzeck- SPL framework
25486a11cf48SDaniel Schwierzeck		CONFIG_SPL
25496a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
25506a11cf48SDaniel Schwierzeck
255195579793STom Rini		CONFIG_SPL_LDSCRIPT
255295579793STom Rini		LDSCRIPT for linking the SPL binary.
255395579793STom Rini
255495579793STom Rini		CONFIG_SPL_MAX_SIZE
255595579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
255695579793STom Rini
25576a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
25586a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
25596a11cf48SDaniel Schwierzeck
256095579793STom Rini		CONFIG_SPL_BSS_START_ADDR
256195579793STom Rini		Link address for the BSS within the SPL binary.
256295579793STom Rini
256395579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
256495579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
256595579793STom Rini
256695579793STom Rini		CONFIG_SPL_STACK
256795579793STom Rini		Adress of the start of the stack SPL will use
256895579793STom Rini
256995579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
257095579793STom Rini		Starting address of the malloc pool used in SPL.
257195579793STom Rini
257295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
257395579793STom Rini		The size of the malloc pool used in SPL.
25746a11cf48SDaniel Schwierzeck
25756a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
25766a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
25776a11cf48SDaniel Schwierzeck
25786a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
25796a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
25806a11cf48SDaniel Schwierzeck
25816a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
25826a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
25836a11cf48SDaniel Schwierzeck
25846a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
25856a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
25866a11cf48SDaniel Schwierzeck
25876a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
25886a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
25896a11cf48SDaniel Schwierzeck
259095579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
259195579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
259295579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
259395579793STom Rini		Address, size and partition on the MMC to load U-Boot from
259495579793STom Rini		when the MMC is being used in raw mode.
259595579793STom Rini
259695579793STom Rini		CONFIG_SPL_FAT_SUPPORT
259795579793STom Rini		Support for fs/fat/libfat.o in SPL binary
259895579793STom Rini
259995579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
260095579793STom Rini		Filename to read to load U-Boot when reading from FAT
260195579793STom Rini
260295579793STom Rini		CONFIG_SPL_NAND_SIMPLE
260395579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
260495579793STom Rini
260595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
260695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
260795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
260895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
260995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
261095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
261195579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
261295579793STom Rini
261395579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
261495579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
261595579793STom Rini		from.
261695579793STom Rini
261795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
261895579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
261995579793STom Rini		to.
262095579793STom Rini
262195579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
262295579793STom Rini		Define this if you need to first read the OOB and then the
262395579793STom Rini		data. This is used for example on davinci plattforms.
262495579793STom Rini
262595579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
262695579793STom Rini		Support for an OMAP3-specific set of functions to return the
262795579793STom Rini		ID and MFR of the first attached NAND chip, if present.
262895579793STom Rini
26296a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
26306a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
26316a11cf48SDaniel Schwierzeck
26326a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
26336a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
26346a11cf48SDaniel Schwierzeck
26356a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
26366a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
26376a11cf48SDaniel Schwierzeck
26386a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
26396a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
26401372cce2SMarian Balakowicz
2641c609719bSwdenkModem Support:
2642c609719bSwdenk--------------
2643c609719bSwdenk
2644566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2645c609719bSwdenk
264611ccc33fSMarcel Ziswiler- Modem support enable:
2647c609719bSwdenk		CONFIG_MODEM_SUPPORT
2648c609719bSwdenk
2649c609719bSwdenk- RTS/CTS Flow control enable:
2650c609719bSwdenk		CONFIG_HWFLOW
2651c609719bSwdenk
2652c609719bSwdenk- Modem debug support:
2653c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2654c609719bSwdenk
2655c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2656c609719bSwdenk		for modem support. Useful only with BDI2000.
2657c609719bSwdenk
2658a8c7c708Swdenk- Interrupt support (PPC):
2659a8c7c708Swdenk
2660a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2661a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
266211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2663a8c7c708Swdenk		should set decrementer_count to appropriate value. If
266411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2665a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
266611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2667a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2668a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2669a8c7c708Swdenk		general timer_interrupt().
2670a8c7c708Swdenk
2671c609719bSwdenk- General:
2672c609719bSwdenk
2673c609719bSwdenk		In the target system modem support is enabled when a
2674c609719bSwdenk		specific key (key combination) is pressed during
2675c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
267611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2677c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2678c609719bSwdenk		function, returning 1 and thus enabling modem
2679c609719bSwdenk		initialization.
2680c609719bSwdenk
2681c609719bSwdenk		If there are no modem init strings in the
2682c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2683c609719bSwdenk		previous output (banner, info printfs) will be
268411ccc33fSMarcel Ziswiler		suppressed, though.
2685c609719bSwdenk
2686c609719bSwdenk		See also: doc/README.Modem
2687c609719bSwdenk
26889660e442SHelmut RaigerBoard initialization settings:
26899660e442SHelmut Raiger------------------------------
26909660e442SHelmut Raiger
26919660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
26929660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
26939660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
26949660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
26959660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
26969660e442SHelmut Raigertypically in board_init_f() and board_init_r().
26979660e442SHelmut Raiger
26989660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
26999660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
27009660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
27019660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2702c609719bSwdenk
2703c609719bSwdenkConfiguration Settings:
2704c609719bSwdenk-----------------------
2705c609719bSwdenk
27066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2707c609719bSwdenk		undefine this when you're short of memory.
2708c609719bSwdenk
27092fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
27102fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
27112fb2604dSPeter Tyser
27126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2713c609719bSwdenk		prompt for user input.
2714c609719bSwdenk
27156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2716c609719bSwdenk
27176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2718c609719bSwdenk
27196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2720c609719bSwdenk
27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2722c609719bSwdenk		the application (usually a Linux kernel) when it is
2723c609719bSwdenk		booted
2724c609719bSwdenk
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2726c609719bSwdenk		List of legal baudrate settings for this board.
2727c609719bSwdenk
27286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2729c609719bSwdenk		Suppress display of console information at boot.
2730c609719bSwdenk
27316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2732c609719bSwdenk		If the board specific function
2733c609719bSwdenk			extern int overwrite_console (void);
2734c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2735c609719bSwdenk		serial port, else the settings in the environment are used.
2736c609719bSwdenk
27376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2738c609719bSwdenk		Enable the call to overwrite_console().
2739c609719bSwdenk
27406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2741c609719bSwdenk		Enable overwrite of previous console environment settings.
2742c609719bSwdenk
27436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2744c609719bSwdenk		Begin and End addresses of the area used by the
2745c609719bSwdenk		simple memory test.
2746c609719bSwdenk
27476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2748c609719bSwdenk		Enable an alternate, more extensive memory test.
2749c609719bSwdenk
27506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
27515f535fe1Swdenk		Scratch address used by the alternate memory test
27525f535fe1Swdenk		You only need to set this if address zero isn't writeable
27535f535fe1Swdenk
27546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
275614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
275711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
275814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
275914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
276014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
27615e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
276214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
27635e12e75dSStefan Roese		will have to get fixed in Linux additionally.
276414f73ca6SStefan Roese
276514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
276614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
276714f73ca6SStefan Roese		be touched.
276814f73ca6SStefan Roese
276914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
277014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
277114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
277214f73ca6SStefan Roese		non page size aligned address and this could cause major
277314f73ca6SStefan Roese		problems.
277414f73ca6SStefan Roese
27756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2776c609719bSwdenk		Default load address for network file downloads
2777c609719bSwdenk
27786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2779c609719bSwdenk		Enable temporary baudrate change while serial download
2780c609719bSwdenk
27816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2782c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2783c609719bSwdenk
27846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2785c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2786c609719bSwdenk		Cogent motherboard)
2787c609719bSwdenk
27886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2789c609719bSwdenk		Physical start address of Flash memory.
2790c609719bSwdenk
27916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2792c609719bSwdenk		Physical start address of boot monitor code (set by
2793c609719bSwdenk		make config files to be same as the text base address
279414d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
27956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2796c609719bSwdenk
27976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
27983b57fe0aSwdenk		Size of memory reserved for monitor code, used to
27993b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
28003b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
28013b57fe0aSwdenk		flash sector.
2802c609719bSwdenk
28036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2804c609719bSwdenk		Size of DRAM reserved for malloc() use.
2805c609719bSwdenk
28066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
280715940c9aSStefan Roese		Normally compressed uImages are limited to an
280815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
28096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
281015940c9aSStefan Roese		to adjust this setting to your needs.
2811c609719bSwdenk
28126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2813c609719bSwdenk		Maximum size of memory mapped by the startup code of
2814c609719bSwdenk		the Linux kernel; all data that must be processed by
28157d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
28167d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
28177d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
28187d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2819c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2820c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2821c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2822c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2823c609719bSwdenk
2824fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2825fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2826fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2827fca43cc8SJohn Rigby		is enabled.
2828fca43cc8SJohn Rigby
2829fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2830fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2831fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2832fca43cc8SJohn Rigby
2833fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2834fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2835fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2836fca43cc8SJohn Rigby
28376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2838c609719bSwdenk		Max number of Flash memory banks
2839c609719bSwdenk
28406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2841c609719bSwdenk		Max number of sectors on a Flash chip
2842c609719bSwdenk
28436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2844c609719bSwdenk		Timeout for Flash erase operations (in ms)
2845c609719bSwdenk
28466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2847c609719bSwdenk		Timeout for Flash write operations (in ms)
2848c609719bSwdenk
28496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
28508564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
28518564acf9Swdenk
28526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
28538564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
28548564acf9Swdenk
28556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
28568564acf9Swdenk		If defined, hardware flash sectors protection is used
28578564acf9Swdenk		instead of U-Boot software protection.
28588564acf9Swdenk
28596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2860c609719bSwdenk
2861c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2862c609719bSwdenk		without this option such a download has to be
2863c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2864c609719bSwdenk		copy from RAM to flash.
2865c609719bSwdenk
2866c609719bSwdenk		The two-step approach is usually more reliable, since
2867c609719bSwdenk		you can check if the download worked before you erase
286811ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
286911ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2870c609719bSwdenk		downloaded image) this option may be very useful.
2871c609719bSwdenk
28726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2873c609719bSwdenk		Define if the flash driver uses extra elements in the
28745653fc33Swdenk		common flash structure for storing flash geometry.
28755653fc33Swdenk
287600b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
28775653fc33Swdenk		This option also enables the building of the cfi_flash driver
28785653fc33Swdenk		in the drivers directory
287953cf9435Sstroese
288091809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
288191809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
288291809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
288391809ed5SPiotr Ziecik		to the MTD layer.
288491809ed5SPiotr Ziecik
28856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
288696ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
288796ef831fSGuennadi Liakhovetski
288896ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
288996ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
289096ef831fSGuennadi Liakhovetski		write commands.
289196ef831fSGuennadi Liakhovetski
28926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
28935568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
28945568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
28955568e613SStefan Roese		is useful, if some of the configured banks are only
28965568e613SStefan Roese		optionally available.
28975568e613SStefan Roese
28989a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
28999a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
29009a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
29019a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
29029a042e9cSJerry Van Baren
29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
290411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
290511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
290653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
290753cf9435Sstroese		buffers can be full shortly after enabling the interface
290811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
290953cf9435Sstroese		Defaults to 4 if not defined.
2910c609719bSwdenk
2911ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2912ea882bafSWolfgang Denk
2913ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2914ea882bafSWolfgang Denk	internally to store the environment settings. The default
2915ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2916ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2917ea882bafSWolfgang Denk	lib/hashtable.c for details.
2918ea882bafSWolfgang Denk
2919c609719bSwdenkThe following definitions that deal with the placement and management
2920c609719bSwdenkof environment data (variable area); in general, we support the
2921c609719bSwdenkfollowing configurations:
2922c609719bSwdenk
2923c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2924c3eb3fe4SMike Frysinger
2925c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2926c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2927c3eb3fe4SMike Frysinger
29285a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2929c609719bSwdenk
2930c609719bSwdenk	Define this if the environment is in flash memory.
2931c609719bSwdenk
2932c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2933c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2934c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2935c609719bSwdenk	   sector" type flash chips, which have several smaller
2936c609719bSwdenk	   sectors at the start or the end. For instance, such a
2937c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2938c609719bSwdenk	   such a case you would place the environment in one of the
2939c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2940c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2941c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2942c609719bSwdenk	   between U-Boot and the environment.
2943c609719bSwdenk
29440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2945c609719bSwdenk
2946c609719bSwdenk	   Offset of environment data (variable area) to the
2947c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2948c609719bSwdenk	   type flash chips the second sector can be used: the offset
2949c609719bSwdenk	   for this sector is given here.
2950c609719bSwdenk
29516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2952c609719bSwdenk
29530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2954c609719bSwdenk
2955c609719bSwdenk	   This is just another way to specify the start address of
2956c609719bSwdenk	   the flash sector containing the environment (instead of
29570e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2958c609719bSwdenk
29590e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2960c609719bSwdenk
2961c609719bSwdenk	   Size of the sector containing the environment.
2962c609719bSwdenk
2963c609719bSwdenk
2964c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2965c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2966c609719bSwdenk	   the environment.
2967c609719bSwdenk
29680e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2969c609719bSwdenk
29705a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
29710e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2972c609719bSwdenk	   of this flash sector for the environment. This saves
2973c609719bSwdenk	   memory for the RAM copy of the environment.
2974c609719bSwdenk
2975c609719bSwdenk	   It may also save flash memory if you decide to use this
2976c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2977c609719bSwdenk	   since then the remainder of the flash sector could be used
2978c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2979c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2980c609719bSwdenk	   updating the environment in flash makes it always
2981c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2982c609719bSwdenk	   wrong before the contents has been restored from a copy in
2983c609719bSwdenk	   RAM, your target system will be dead.
2984c609719bSwdenk
29850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
29860e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2987c609719bSwdenk
2988c609719bSwdenk	   These settings describe a second storage area used to hold
298911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
29903e38691eSwdenk	   a valid backup copy in case there is a power failure during
2991c609719bSwdenk	   a "saveenv" operation.
2992c609719bSwdenk
2993c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2994c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2995c609719bSwdenkaccordingly!
2996c609719bSwdenk
2997c609719bSwdenk
29989314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2999c609719bSwdenk
3000c609719bSwdenk	Define this if you have some non-volatile memory device
3001c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3002c609719bSwdenk	environment.
3003c609719bSwdenk
30040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3006c609719bSwdenk
300711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3008c609719bSwdenk	  want to use for environment. It is assumed that this memory
3009c609719bSwdenk	  can just be read and written to, without any special
3010c609719bSwdenk	  provision.
3011c609719bSwdenk
3012c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3013c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
301411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3015c609719bSwdenkU-Boot will hang.
3016c609719bSwdenk
3017c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3018c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3019c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3020c609719bSwdenkto save the current settings.
3021c609719bSwdenk
3022c609719bSwdenk
3023bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3024c609719bSwdenk
3025c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3026c609719bSwdenk	device and a driver for it.
3027c609719bSwdenk
30280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3030c609719bSwdenk
3031c609719bSwdenk	  These two #defines specify the offset and size of the
3032c609719bSwdenk	  environment area within the total memory of your EEPROM.
3033c609719bSwdenk
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3035c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3036c609719bSwdenk	  The default address is zero.
3037c609719bSwdenk
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3039c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3040c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3041c609719bSwdenk	  would require six bits.
3042c609719bSwdenk
30436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3044c609719bSwdenk	  If defined, the number of milliseconds to delay between
3045c609719bSwdenk	  page writes.	The default is zero milliseconds.
3046c609719bSwdenk
30476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3048c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3049c609719bSwdenk	  that this is NOT the chip address length!
3050c609719bSwdenk
30516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
30525cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
30535cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
30545cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
30555cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
30565cf91d6bSwdenk	  byte chips.
30575cf91d6bSwdenk
30585cf91d6bSwdenk	  Note that we consider the length of the address field to
30595cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
30605cf91d6bSwdenk	  in the chip address.
30615cf91d6bSwdenk
30626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3063c609719bSwdenk	  The size in bytes of the EEPROM device.
3064c609719bSwdenk
3065548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3066548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3067548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3068548738b4SHeiko Schocher
3069548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3070548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3071548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3072548738b4SHeiko Schocher	  EEPROM. For example:
3073548738b4SHeiko Schocher
3074548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3075548738b4SHeiko Schocher
3076548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3077548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3078c609719bSwdenk
3079057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
30805779d8d9Swdenk
30815779d8d9Swdenk	Define this if you have a DataFlash memory device which you
30825779d8d9Swdenk	want to use for the environment.
30835779d8d9Swdenk
30840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
30875779d8d9Swdenk
30885779d8d9Swdenk	  These three #defines specify the offset and size of the
30895779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
30905779d8d9Swdenk	  at the specified address.
30915779d8d9Swdenk
30920a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
30930a85a9e7SLiu Gang
30940a85a9e7SLiu Gang	Define this if you have a remote memory space which you
30950a85a9e7SLiu Gang	want to use for the local device's environment.
30960a85a9e7SLiu Gang
30970a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
30980a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
30990a85a9e7SLiu Gang
31000a85a9e7SLiu Gang	  These two #defines specify the address and size of the
31010a85a9e7SLiu Gang	  environment area within the remote memory space. The
31020a85a9e7SLiu Gang	  local device can get the environment from remote memory
31030a85a9e7SLiu Gang	  space by SRIO or other links.
31040a85a9e7SLiu Gang
31050a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
31060a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
31070a85a9e7SLiu Gangenvironment stored in a remote NOR flash by SRIO link, but it can
31080a85a9e7SLiu Gangnot erase, write this NOR flash by SRIO interface.
31090a85a9e7SLiu Gang
311051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
311113a5695bSwdenk
311213a5695bSwdenk	Define this if you have a NAND device which you want to use
311313a5695bSwdenk	for the environment.
311413a5695bSwdenk
31150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
31160e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
311713a5695bSwdenk
311813a5695bSwdenk	  These two #defines specify the offset and size of the environment
3119fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3120fdd813deSScott Wood	  aligned to an erase block boundary.
31215779d8d9Swdenk
3122fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3123e443c944SMarkus Klotzbuecher
31240e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3125fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3126fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3127fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3128fdd813deSScott Wood	  aligned to an erase block boundary.
3129e443c944SMarkus Klotzbuecher
3130fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3131fdd813deSScott Wood
3132fdd813deSScott Wood	  Specifies the length of the region in which the environment
3133fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3134fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3135fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3136fdd813deSScott Wood	  the range to be avoided.
3137fdd813deSScott Wood
3138fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3139fdd813deSScott Wood
3140fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3141fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3142fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3143fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3144fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3145e443c944SMarkus Klotzbuecher
3146b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3147b74ab737SGuennadi Liakhovetski
3148b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3149b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3150b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3151b74ab737SGuennadi Liakhovetski
31526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3153c609719bSwdenk
3154c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3155c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3156c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3157c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3158c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3159c609719bSwdenk	to be a good choice since it makes it far enough from the
3160c609719bSwdenk	start of the data area as well as from the stack pointer.
3161c609719bSwdenk
3162e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3163c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3164cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3165c609719bSwdenkuntil then to read environment variables.
3166c609719bSwdenk
316785ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
316885ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
316985ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
317085ec0bccSwdenknecessary, because the first environment variable we need is the
317185ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
317285ec0bccSwdenkhave any device yet where we could complain.]
3173c609719bSwdenk
3174c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3175c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
317685ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3177c609719bSwdenk
31786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3179fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3180fc3e2165Swdenk
31816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3182fc3e2165Swdenk		      also needs to be defined.
3183fc3e2165Swdenk
31846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3185fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3186c609719bSwdenk
3187f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3188f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3189f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3190f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3191f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3192f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3193f5675aa5SRon Madrid
3194c609719bSwdenkLow Level (hardware related) configuration options:
3195dc7c9a1aSwdenk---------------------------------------------------
3196c609719bSwdenk
31976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3198c609719bSwdenk		Cache Line Size of the CPU.
3199c609719bSwdenk
32006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3201c609719bSwdenk		Default address of the IMMR after system reset.
32022535d602Swdenk
32032535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
32042535d602Swdenk		and RPXsuper) to be able to adjust the position of
32052535d602Swdenk		the IMMR register after a reset.
3206c609719bSwdenk
3207e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3208e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3209e46fedfeSTimur Tabi		PowerPC SOCs.
3210e46fedfeSTimur Tabi
3211e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3212e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3213e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3214e46fedfeSTimur Tabi
3215e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3216e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3217e46fedfeSTimur Tabi
3218e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3219e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3220e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3221e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3222e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3223e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3224e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3225e46fedfeSTimur Tabi
3226e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3227e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3228e46fedfeSTimur Tabi
3229e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3230e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3231e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3232e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3233e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3234e46fedfeSTimur Tabi
3235e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3236e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3237e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3238e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3239e46fedfeSTimur Tabi
3240e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3241e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3242e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3243e46fedfeSTimur Tabi
32447f6c2cbcSwdenk- Floppy Disk Support:
32456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
32467f6c2cbcSwdenk
32477f6c2cbcSwdenk		the default drive number (default value 0)
32487f6c2cbcSwdenk
32496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
32507f6c2cbcSwdenk
325111ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
32527f6c2cbcSwdenk		(default value 1)
32537f6c2cbcSwdenk
32546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
32557f6c2cbcSwdenk
32567f6c2cbcSwdenk		defines the offset of register from address. It
32577f6c2cbcSwdenk		depends on which part of the data bus is connected to
325811ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
32597f6c2cbcSwdenk
32606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
32616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
32627f6c2cbcSwdenk		default value.
32637f6c2cbcSwdenk
32646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
32657f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
32667f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
32677f6c2cbcSwdenk		source code. It is used to make hardware dependant
32687f6c2cbcSwdenk		initializations.
32697f6c2cbcSwdenk
32700abddf82SMacpaul Lin- CONFIG_IDE_AHB:
32710abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
32720abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
32730abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
32740abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
32750abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
32760abddf82SMacpaul Lin		is requierd.
32770abddf82SMacpaul Lin
32786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
327925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
328025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3281c609719bSwdenk
32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3283c609719bSwdenk
32847152b1d0Swdenk		Start address of memory area that can be used for
3285c609719bSwdenk		initial data and stack; please note that this must be
3286c609719bSwdenk		writable memory that is working WITHOUT special
3287c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3288c609719bSwdenk		will become available only after programming the
3289c609719bSwdenk		memory controller and running certain initialization
3290c609719bSwdenk		sequences.
3291c609719bSwdenk
3292c609719bSwdenk		U-Boot uses the following memory types:
3293c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3294c609719bSwdenk		- MPC824X: data cache
3295c609719bSwdenk		- PPC4xx:  data cache
3296c609719bSwdenk
32976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3298c609719bSwdenk
3299c609719bSwdenk		Offset of the initial data structure in the memory
33006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
33016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3302c609719bSwdenk		data is located at the end of the available space
3303553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
33056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
33066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3307c609719bSwdenk
3308c609719bSwdenk	Note:
3309c609719bSwdenk		On the MPC824X (or other systems that use the data
3310c609719bSwdenk		cache for initial memory) the address chosen for
33116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3312c609719bSwdenk		point to an otherwise UNUSED address space between
3313c609719bSwdenk		the top of RAM and the start of the PCI space.
3314c609719bSwdenk
33156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3316c609719bSwdenk
33176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3318c609719bSwdenk
33196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3320c609719bSwdenk
33216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3322c609719bSwdenk
33236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3324c609719bSwdenk
33256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3326c609719bSwdenk
33276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3328c609719bSwdenk		SDRAM timing
3329c609719bSwdenk
33306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3331c609719bSwdenk		periodic timer for refresh
3332c609719bSwdenk
33336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3334c609719bSwdenk
33356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
33366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
33376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
33386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3339c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3340c609719bSwdenk
3341c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
33426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
33436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3344c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3345c609719bSwdenk
33466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3348c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3349c609719bSwdenk		Prescaler definitions (SDRAM timing)
3350c609719bSwdenk
33516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3352c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3353c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3354c609719bSwdenk
33556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3356b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3357b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3358b423d055SHeiko Schocher
33596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3360c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3361c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3362c609719bSwdenk
33636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3364c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3365c609719bSwdenk		wrong setting might damage your board. Read
3366c609719bSwdenk		doc/README.MBX before setting this variable!
3367c609719bSwdenk
33686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3369ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3370ea909b76Swdenk		(Power On Self Tests). This definition overrides
3371ea909b76Swdenk		#define'd default value in commproc.h resp.
3372ea909b76Swdenk		cpm_8260.h.
3373ea909b76Swdenk
33746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
33756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
33766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
33776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
33786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
33796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
33806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
33816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3382a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
33835d232d0eSwdenk
33849cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
33859cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
33869cacf4fcSDirk Eibach		required.
33879cacf4fcSDirk Eibach
338869fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
338969fd2d3bSAndrew Sharp		Only scan through and get the devices on the busses.
339069fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
339169fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
339269fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
339369fd2d3bSAndrew Sharp		by coreboot or similar.
339469fd2d3bSAndrew Sharp
3395a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3396a09b9b68SKumar Gala		Chip has SRIO or not
3397a09b9b68SKumar Gala
3398a09b9b68SKumar Gala- CONFIG_SRIO1:
3399a09b9b68SKumar Gala		Board has SRIO 1 port available
3400a09b9b68SKumar Gala
3401a09b9b68SKumar Gala- CONFIG_SRIO2:
3402a09b9b68SKumar Gala		Board has SRIO 2 port available
3403a09b9b68SKumar Gala
3404a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3405a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3406a09b9b68SKumar Gala
3407a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3408a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3409a09b9b68SKumar Gala
3410a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3411a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3412a09b9b68SKumar Gala
3413eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3414eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3415eced4626SAlex Waterman		16 bit bus.
3416eced4626SAlex Waterman
3417eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3418eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3419eced4626SAlex Waterman		a default value will be used.
3420eced4626SAlex Waterman
3421bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3422218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3423218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3424218ca724SWolfgang Denk
3425bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3426bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3427bb99ad6dSBen Warren
34286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3429218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3430218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3431218ca724SWolfgang Denk		to something your driver can deal with.
3432bb99ad6dSBen Warren
34331b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
34341b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
34351b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
34361b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
34371b3e3c4fSYork Sun		header files or board specific files.
34381b3e3c4fSYork Sun
34396f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
34406f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
34416f5e1dc5SYork Sun
34426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3443218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3444218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
34452ad6b513STimur Tabi
3446c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3447c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3448c26e454dSwdenk
3449c26e454dSwdenk- CONFIG_FEC[12]_PHY
3450c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
34516e592385Swdenk		to the given FEC; i. e.
3452c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3453c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3454c26e454dSwdenk
3455c26e454dSwdenk		When set to -1, means to probe for first available.
3456c26e454dSwdenk
3457c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3458c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3459c26e454dSwdenk		(so program the FEC to ignore it).
3460c26e454dSwdenk
3461c26e454dSwdenk- CONFIG_RMII
3462c26e454dSwdenk		Enable RMII mode for all FECs.
3463c26e454dSwdenk		Note that this is a global option, we can't
3464c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3465c26e454dSwdenk
34665cf91d6bSwdenk- CONFIG_CRC32_VERIFY
34675cf91d6bSwdenk		Add a verify option to the crc32 command.
34685cf91d6bSwdenk		The syntax is:
34695cf91d6bSwdenk
34705cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
34715cf91d6bSwdenk
34725cf91d6bSwdenk		Where address/count indicate a memory area
34735cf91d6bSwdenk		and crc32 is the correct crc32 which the
34745cf91d6bSwdenk		area should have.
34755cf91d6bSwdenk
347656523f12Swdenk- CONFIG_LOOPW
347756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3478602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
347956523f12Swdenk
34807b466641Sstroese- CONFIG_MX_CYCLIC
34817b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
34827b466641Sstroese		"md/mw" commands.
34837b466641Sstroese		Examples:
34847b466641Sstroese
34857b466641Sstroese		=> mdc.b 10 4 500
34867b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
34877b466641Sstroese
34887b466641Sstroese		=> mwc.l 100 12345678 10
34897b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
34907b466641Sstroese
34917b466641Sstroese		This only takes effect if the memory commands are activated
3492602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
34937b466641Sstroese
34948aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3495afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3496e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3497e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3498e03f3169SWolfgang Denk		relocate itself into RAM.
34998aa1a2d1Swdenk
3500e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3501e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3502e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3503e03f3169SWolfgang Denk		these initializations itself.
35048aa1a2d1Swdenk
3505401bb30bSAneesh V- CONFIG_SPL_BUILD
3506df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3507df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3508df81238bSMagnus Lilja		compiling a NAND SPL.
3509400558b5Swdenk
3510d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3511d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3512d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3513d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3514d8834a13SMatthias Weisser		conditions but may increase the binary size.
3515d8834a13SMatthias Weisser
3516f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3517f2717b47STimur Tabi-----------------------------------
3518f2717b47STimur Tabi
3519f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3520f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3521f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3522f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3523f2717b47STimur Tabiwithin that device.
3524f2717b47STimur Tabi
3525f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3526f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3527f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3528f2717b47STimur Tabi	is also specified.
3529f2717b47STimur Tabi
3530f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3531f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3532f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3533f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3534f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3535f2717b47STimur Tabi
3536f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3537f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3538f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3539f2717b47STimur Tabi	virtual address in NOR flash.
3540f2717b47STimur Tabi
3541f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3542f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3543f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3544f2717b47STimur Tabi
3545f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3546f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3547f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3548f2717b47STimur Tabi
3549f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3550f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3551f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3552f2717b47STimur Tabi
3553292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3554292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3555292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3556292dc6c5SLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3557292dc6c5SLiu Gang	->master inbound window->master LAW->the ucode address in master's
3558292dc6c5SLiu Gang	NOR flash.
3559f2717b47STimur Tabi
3560c609719bSwdenkBuilding the Software:
3561c609719bSwdenk======================
3562c609719bSwdenk
3563218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3564218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3565218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3566218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3567218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3568218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3569c609719bSwdenk
3570218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3571218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3572218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3573218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3574218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3575c609719bSwdenk
3576218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3577218ca724SWolfgang Denk	$ export CROSS_COMPILE
3578c609719bSwdenk
35792f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
35802f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
35812f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
35822f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
35832f8d396bSPeter Tyser
35842f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
35852f8d396bSPeter Tyser
35862f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
35872f8d396bSPeter Tyser      be executed on computers running Windows.
35882f8d396bSPeter Tyser
3589c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3590c609719bSwdenksources you must configure U-Boot for one specific board type. This
3591c609719bSwdenkis done by typing:
3592c609719bSwdenk
3593c609719bSwdenk	make NAME_config
3594c609719bSwdenk
3595218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
35964d675ae6SMichael Jonesrations; see boards.cfg for supported names.
359754387ac9Swdenk
3598c609719bSwdenkNote: for some board special configuration names may exist; check if
3599c609719bSwdenk      additional information is available from the board vendor; for
36002729af9dSwdenk      instance, the TQM823L systems are available without (standard)
36012729af9dSwdenk      or with LCD support. You can select such additional "features"
360211ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3603c609719bSwdenk
36042729af9dSwdenk      make TQM823L_config
36052729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3606c609719bSwdenk
3607c609719bSwdenk      make TQM823L_LCD_config
3608c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3609c609719bSwdenk
3610c609719bSwdenk      etc.
3611c609719bSwdenk
3612c609719bSwdenk
3613c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
36147152b1d0Swdenkimages ready for download to / installation on your system:
3615c609719bSwdenk
3616c609719bSwdenk- "u-boot.bin" is a raw binary image
3617c609719bSwdenk- "u-boot" is an image in ELF binary format
3618c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3619c609719bSwdenk
3620baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3621baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3622baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3623baf31249SMarian Balakowicz
3624baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3625baf31249SMarian Balakowicz
3626baf31249SMarian Balakowicz	make O=/tmp/build distclean
3627baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3628baf31249SMarian Balakowicz	make O=/tmp/build all
3629baf31249SMarian Balakowicz
3630baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3631baf31249SMarian Balakowicz
3632baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3633baf31249SMarian Balakowicz	make distclean
3634baf31249SMarian Balakowicz	make NAME_config
3635baf31249SMarian Balakowicz	make all
3636baf31249SMarian Balakowicz
3637baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3638baf31249SMarian Balakowiczvariable.
3639baf31249SMarian Balakowicz
3640c609719bSwdenk
3641c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3642c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3643c609719bSwdenknative "make".
3644c609719bSwdenk
3645c609719bSwdenk
3646c609719bSwdenkIf the system board that you have is not listed, then you will need
3647c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3648c609719bSwdenksteps:
3649c609719bSwdenk
3650c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
36514d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
36524d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3653c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
365485ec0bccSwdenk    files you need. In your board directory, you will need at least
365585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
365685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
365785ec0bccSwdenk    your board
3658c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3659c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
366085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3661c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3662c609719bSwdenk    to be installed on your target system.
366385ec0bccSwdenk6.  Debug and solve any problems that might arise.
3664c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3665c609719bSwdenk
3666c609719bSwdenk
3667c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3668c609719bSwdenk==============================================================
3669c609719bSwdenk
3670c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3671c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3672c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3673c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3674218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3675c609719bSwdenk
3676c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3677c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3678c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3679c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3680c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
36817152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3682218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3683218ca724SWolfgang Denkyou can type
3684c609719bSwdenk
3685c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3686c609719bSwdenk
3687c609719bSwdenkor to build on a native PowerPC system you can type
3688c609719bSwdenk
3689c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3690c609719bSwdenk
3691218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3692218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3693218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3694218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3695218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3696218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3697218ca724SWolfgang Denkvariable. For example:
3698baf31249SMarian Balakowicz
3699baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3700baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3701baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3702baf31249SMarian Balakowicz
3703218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3704218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3705218ca724SWolfgang Denkduring the whole build process.
3706baf31249SMarian Balakowicz
3707baf31249SMarian Balakowicz
3708c609719bSwdenkSee also "U-Boot Porting Guide" below.
3709c609719bSwdenk
3710c609719bSwdenk
3711c609719bSwdenkMonitor Commands - Overview:
3712c609719bSwdenk============================
3713c609719bSwdenk
3714c609719bSwdenkgo	- start application at address 'addr'
3715c609719bSwdenkrun	- run commands in an environment variable
3716c609719bSwdenkbootm	- boot application image from memory
3717c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
371844f074c7SMarek Vasutbootz   - boot zImage from memory
3719c609719bSwdenktftpboot- boot image via network using TFTP protocol
3720c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3721c609719bSwdenk	       (and eventually "gatewayip")
37221fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3723c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3724c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3725c609719bSwdenkloads	- load S-Record file over serial line
3726c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3727c609719bSwdenkmd	- memory display
3728c609719bSwdenkmm	- memory modify (auto-incrementing)
3729c609719bSwdenknm	- memory modify (constant address)
3730c609719bSwdenkmw	- memory write (fill)
3731c609719bSwdenkcp	- memory copy
3732c609719bSwdenkcmp	- memory compare
3733c609719bSwdenkcrc32	- checksum calculation
37340f89c54bSPeter Tyseri2c	- I2C sub-system
3735c609719bSwdenksspi	- SPI utility commands
3736c609719bSwdenkbase	- print or set address offset
3737c609719bSwdenkprintenv- print environment variables
3738c609719bSwdenksetenv	- set environment variables
3739c609719bSwdenksaveenv - save environment variables to persistent storage
3740c609719bSwdenkprotect - enable or disable FLASH write protection
3741c609719bSwdenkerase	- erase FLASH memory
3742c609719bSwdenkflinfo	- print FLASH memory information
3743c609719bSwdenkbdinfo	- print Board Info structure
3744c609719bSwdenkiminfo	- print header information for application image
3745c609719bSwdenkconinfo - print console devices and informations
3746c609719bSwdenkide	- IDE sub-system
3747c609719bSwdenkloop	- infinite loop on address range
374856523f12Swdenkloopw	- infinite write loop on address range
3749c609719bSwdenkmtest	- simple RAM test
3750c609719bSwdenkicache	- enable or disable instruction cache
3751c609719bSwdenkdcache	- enable or disable data cache
3752c609719bSwdenkreset	- Perform RESET of the CPU
3753c609719bSwdenkecho	- echo args to console
3754c609719bSwdenkversion - print monitor version
3755c609719bSwdenkhelp	- print online help
3756c609719bSwdenk?	- alias for 'help'
3757c609719bSwdenk
3758c609719bSwdenk
3759c609719bSwdenkMonitor Commands - Detailed Description:
3760c609719bSwdenk========================================
3761c609719bSwdenk
3762c609719bSwdenkTODO.
3763c609719bSwdenk
3764c609719bSwdenkFor now: just type "help <command>".
3765c609719bSwdenk
3766c609719bSwdenk
3767c609719bSwdenkEnvironment Variables:
3768c609719bSwdenk======================
3769c609719bSwdenk
3770c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3771c609719bSwdenkcan be made persistent by saving to Flash memory.
3772c609719bSwdenk
3773c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3774c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3775c609719bSwdenkwithout a value can be used to delete a variable from the
3776c609719bSwdenkenvironment. As long as you don't save the environment you are
3777c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3778c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3779c609719bSwdenk
3780c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3781c96f86eeSWolfgang Denk
3782c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3783c609719bSwdenk
3784c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3785c609719bSwdenk
3786c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3787c609719bSwdenk
3788c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3789c609719bSwdenk
3790c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3791c609719bSwdenk
3792c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3793c609719bSwdenk
37947d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
37957d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
37967d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
37977d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
37987d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
37997d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3800c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3801c3624e6eSGrant Likely		  bootm_mapsize.
3802c3624e6eSGrant Likely
3803c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3804c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3805c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3806c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3807c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3808c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3809c3624e6eSGrant Likely		  used otherwise.
38107d721e34SBartlomiej Sieka
38117d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
38127d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
38137d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
38147d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
38157d721e34SBartlomiej Sieka		  environment variable.
38167d721e34SBartlomiej Sieka
38174bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
38184bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
38194bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
38204bae9090SBartlomiej Sieka
3821c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3822c609719bSwdenk		  "bootp" will just load perform a lookup of the
3823c609719bSwdenk		  configuration from the BOOTP server, but not try to
3824c609719bSwdenk		  load any image using TFTP
3825c609719bSwdenk
3826c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3827c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3828c609719bSwdenk		  be automatically started (by internally calling
3829c609719bSwdenk		  "bootm")
3830c609719bSwdenk
38314a6fd34bSwdenk		  If set to "no", a standalone image passed to the
38324a6fd34bSwdenk		  "bootm" command will be copied to the load address
38334a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
38344a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
38354a6fd34bSwdenk		  data.
38364a6fd34bSwdenk
3837a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3838a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3839fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3840fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3841fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3842fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3843fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3844fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3845fa34f6b2SShawn Guo		  access it during the boot procedure.
3846fa34f6b2SShawn Guo
3847a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3848a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3849a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3850a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3851a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3852a28afca5SDavid A. Long		  must be accessible by the kernel.
3853a28afca5SDavid A. Long
3854eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3855eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3856eea63e05SSimon Glass		  defined.
3857eea63e05SSimon Glass
385817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
385917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
386017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
386117ea1177Swdenk		  initialization code. So, for changes to be effective
386217ea1177Swdenk		  it must be saved and board must be reset.
386317ea1177Swdenk
3864c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3865c609719bSwdenk		  If this variable is not set, initrd images will be
3866c609719bSwdenk		  copied to the highest possible address in RAM; this
3867c609719bSwdenk		  is usually what you want since it allows for
3868c609719bSwdenk		  maximum initrd size. If for some reason you want to
3869c609719bSwdenk		  make sure that the initrd image is loaded below the
38706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3871c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3872c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3873c609719bSwdenk		  address to use (U-Boot will still check that it
3874c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3875c609719bSwdenk
3876c609719bSwdenk		  For instance, when you have a system with 16 MB
38777152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3878c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3879c609719bSwdenk		  the "bootargs" variable. However, now you must make
38807152b1d0Swdenk		  sure that the initrd image is placed in the first
3881c609719bSwdenk		  12 MB as well - this can be done with
3882c609719bSwdenk
3883c609719bSwdenk		  setenv initrd_high 00c00000
3884c609719bSwdenk
388538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
388638b99261Swdenk		  indication to U-Boot that all addresses are legal
388738b99261Swdenk		  for the Linux kernel, including addresses in flash
388838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
388938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
389038b99261Swdenk		  boot time on your system, but requires that this
389138b99261Swdenk		  feature is supported by your Linux kernel.
389238b99261Swdenk
3893c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3894c609719bSwdenk
3895c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3896dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3897c609719bSwdenk
3898c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3899c609719bSwdenk
3900c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3901c609719bSwdenk
3902c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3903c609719bSwdenk
3904c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3905c609719bSwdenk
3906c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3907c609719bSwdenk
3908e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3909a3d991bdSwdenk
3910e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3911e2a53458SMike Frysinger		  For example you can do the following
3912a3d991bdSwdenk
391348690d80SHeiko Schocher		  => setenv ethact FEC
391448690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
391548690d80SHeiko Schocher		  => setenv ethact SCC
391648690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3917a3d991bdSwdenk
3918e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3919e1692577SMatthias Fuchs		  available network interfaces.
3920e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3921e1692577SMatthias Fuchs
3922a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3923a3d991bdSwdenk		  either succeed or fail without retrying.
39246e592385Swdenk		  When set to "once" the network operation will
39256e592385Swdenk		  fail when all the available network interfaces
39266e592385Swdenk		  are tried once without success.
3927a3d991bdSwdenk		  Useful on scripts which control the retry operation
3928a3d991bdSwdenk		  themselves.
3929a3d991bdSwdenk
3930b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3931a1cf027aSJean-Christophe PLAGNIOL-VILLARD
393228cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3933ecb0ccd9SWolfgang Denk		  UDP source port.
3934ecb0ccd9SWolfgang Denk
393528cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
393628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
393728cb9375SWolfgang Denk
3938c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3939c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3940c96f86eeSWolfgang Denk
3941c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3942c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3943c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3944c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3945c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3946c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3947c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3948c96f86eeSWolfgang Denk
3949a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
395011ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3951a3d991bdSwdenk		  VLAN tagged frames.
3952c609719bSwdenk
3953dc0b7b0eSJason HobbsThe following image location variables contain the location of images
3954dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
3955dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
3956dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
3957dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
3958dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
3959dc0b7b0eSJason Hobbsflash or offset in NAND flash.
3960dc0b7b0eSJason Hobbs
3961dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
3962dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
3963dc0b7b0eSJason Hobbsboards use these variables for other purposes.
3964dc0b7b0eSJason Hobbs
3965dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
3966dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
3967dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
3968dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
3969dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
3970dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3971dc0b7b0eSJason Hobbs
3972c609719bSwdenkThe following environment variables may be used and automatically
3973c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3974c609719bSwdenkdepending the information provided by your boot server:
3975c609719bSwdenk
3976c609719bSwdenk  bootfile	- see above
3977c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3978fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3979c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3980c609719bSwdenk  hostname	- Target hostname
3981c609719bSwdenk  ipaddr	- see above
3982c609719bSwdenk  netmask	- Subnet Mask
3983c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3984c609719bSwdenk  serverip	- see above
3985c609719bSwdenk
3986c609719bSwdenk
3987c609719bSwdenkThere are two special Environment Variables:
3988c609719bSwdenk
3989c609719bSwdenk  serial#	- contains hardware identification information such
3990c609719bSwdenk		  as type string and/or serial number
3991c609719bSwdenk  ethaddr	- Ethernet address
3992c609719bSwdenk
3993c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3994c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3995c609719bSwdenkonce they have been set once.
3996c609719bSwdenk
3997c609719bSwdenk
3998c1551ea8SstroeseFurther special Environment Variables:
3999c1551ea8Sstroese
4000c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4001c1551ea8Sstroese		  with the "version" command. This variable is
4002c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4003c1551ea8Sstroese
4004c1551ea8Sstroese
4005c609719bSwdenkPlease note that changes to some configuration parameters may take
4006c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4007c609719bSwdenk
4008c609719bSwdenk
4009f07771ccSwdenkCommand Line Parsing:
4010f07771ccSwdenk=====================
4011f07771ccSwdenk
4012f07771ccSwdenkThere are two different command line parsers available with U-Boot:
40137152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4014f07771ccSwdenk
4015f07771ccSwdenkOld, simple command line parser:
4016f07771ccSwdenk--------------------------------
4017f07771ccSwdenk
4018f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4019f07771ccSwdenk- several commands on one line, separated by ';'
4020fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4021f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4022f07771ccSwdenk  for example:
4023fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4024f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4025f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4026f07771ccSwdenk
4027f07771ccSwdenkHush shell:
4028f07771ccSwdenk-----------
4029f07771ccSwdenk
4030f07771ccSwdenk- similar to Bourne shell, with control structures like
4031f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4032f07771ccSwdenk  until...do...done, ...
4033f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4034f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4035f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4036f07771ccSwdenk  command
4037f07771ccSwdenk
4038f07771ccSwdenkGeneral rules:
4039f07771ccSwdenk--------------
4040f07771ccSwdenk
4041f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4042f07771ccSwdenk    command) contains several commands separated by semicolon, and
4043f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4044f07771ccSwdenk    executed anyway.
4045f07771ccSwdenk
4046f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
404711ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4048f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4049f07771ccSwdenk    variables are not executed.
4050f07771ccSwdenk
4051c609719bSwdenkNote for Redundant Ethernet Interfaces:
4052c609719bSwdenk=======================================
4053c609719bSwdenk
405411ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4055c609719bSwdenksuch configurations and is capable of automatic selection of a
40567152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4057c609719bSwdenk
4058c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4059c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4060c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4061c609719bSwdenk
4062c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4063c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4064c609719bSwdenkding setting in the environment; if the corresponding environment
4065c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4066c609719bSwdenk
4067c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4068c609719bSwdenk  environment, the SROM's address is used.
4069c609719bSwdenk
4070c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4071c609719bSwdenk  environment exists, then the value from the environment variable is
4072c609719bSwdenk  used.
4073c609719bSwdenk
4074c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4075c609719bSwdenk  both addresses are the same, this MAC address is used.
4076c609719bSwdenk
4077c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4078c609719bSwdenk  addresses differ, the value from the environment is used and a
4079c609719bSwdenk  warning is printed.
4080c609719bSwdenk
4081c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4082c609719bSwdenk  is raised.
4083c609719bSwdenk
4084ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4085ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4086ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4087ecee9324SBen WarrenThe naming convention is as follows:
4088ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4089c609719bSwdenk
4090c609719bSwdenkImage Formats:
4091c609719bSwdenk==============
4092c609719bSwdenk
40933310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
40943310c549SMarian Balakowiczimages in two formats:
40953310c549SMarian Balakowicz
40963310c549SMarian BalakowiczNew uImage format (FIT)
40973310c549SMarian Balakowicz-----------------------
40983310c549SMarian Balakowicz
40993310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
41003310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
41013310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
41023310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
41033310c549SMarian Balakowicz
41043310c549SMarian Balakowicz
41053310c549SMarian BalakowiczOld uImage format
41063310c549SMarian Balakowicz-----------------
41073310c549SMarian Balakowicz
41083310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
41093310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
41103310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4111c609719bSwdenk
4112c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4113c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4114f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4115f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4116f5ed9e39SPeter Tyser  INTEGRITY).
41177b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4118afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4119afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4120c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4121c609719bSwdenk* Load Address
4122c609719bSwdenk* Entry Point
4123c609719bSwdenk* Image Name
4124c609719bSwdenk* Image Timestamp
4125c609719bSwdenk
4126c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4127c609719bSwdenkand the data portions of the image are secured against corruption by
4128c609719bSwdenkCRC32 checksums.
4129c609719bSwdenk
4130c609719bSwdenk
4131c609719bSwdenkLinux Support:
4132c609719bSwdenk==============
4133c609719bSwdenk
4134c609719bSwdenkAlthough U-Boot should support any OS or standalone application
41357152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4136c609719bSwdenkU-Boot.
4137c609719bSwdenk
4138c609719bSwdenkU-Boot includes many features that so far have been part of some
4139c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4140c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4141c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
41427152b1d0Swdenkserves several purposes:
4143c609719bSwdenk
4144c609719bSwdenk- the same features can be used for other OS or standalone
4145c609719bSwdenk  applications (for instance: using compressed images to reduce the
4146c609719bSwdenk  Flash memory footprint)
4147c609719bSwdenk
4148c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
41497152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4150c609719bSwdenk
4151c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4152c609719bSwdenk  images; of course this also means that different kernel images can
4153c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4154c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4155c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4156c609719bSwdenk  software is easier now.
4157c609719bSwdenk
4158c609719bSwdenk
4159c609719bSwdenkLinux HOWTO:
4160c609719bSwdenk============
4161c609719bSwdenk
4162c609719bSwdenkPorting Linux to U-Boot based systems:
4163c609719bSwdenk---------------------------------------
4164c609719bSwdenk
4165c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4166c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4167c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4168c609719bSwdenkLinux :-).
4169c609719bSwdenk
4170a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4171c609719bSwdenk
4172c609719bSwdenkJust make sure your machine specific header file (for instance
4173c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
41741dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
41751dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
41766d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4177c609719bSwdenk
4178c609719bSwdenk
4179c609719bSwdenkConfiguring the Linux kernel:
4180c609719bSwdenk-----------------------------
4181c609719bSwdenk
4182c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4183c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4184c609719bSwdenk
4185c609719bSwdenk
4186c609719bSwdenkBuilding a Linux Image:
4187c609719bSwdenk-----------------------
4188c609719bSwdenk
418924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
419024ee89b9Swdenknot used. If you use recent kernel source, a new build target
419124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
419224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
419324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
419424ee89b9Swdenk100% compatible format.
4195c609719bSwdenk
4196c609719bSwdenkExample:
4197c609719bSwdenk
4198c609719bSwdenk	make TQM850L_config
4199c609719bSwdenk	make oldconfig
4200c609719bSwdenk	make dep
420124ee89b9Swdenk	make uImage
4202c609719bSwdenk
420324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
420424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
420524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4206c609719bSwdenk
420724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
420824ee89b9Swdenk
420924ee89b9Swdenk* convert the kernel into a raw binary image:
421024ee89b9Swdenk
421124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
421224ee89b9Swdenk				 -R .note -R .comment \
421324ee89b9Swdenk				 -S vmlinux linux.bin
421424ee89b9Swdenk
421524ee89b9Swdenk* compress the binary image:
421624ee89b9Swdenk
421724ee89b9Swdenk	gzip -9 linux.bin
421824ee89b9Swdenk
421924ee89b9Swdenk* package compressed binary image for U-Boot:
422024ee89b9Swdenk
422124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
422224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
422324ee89b9Swdenk		-d linux.bin.gz uImage
422424ee89b9Swdenk
422524ee89b9Swdenk
422624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
422724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
422824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
422924ee89b9Swdenkbyte header containing information about target architecture,
423024ee89b9Swdenkoperating system, image type, compression method, entry points, time
423124ee89b9Swdenkstamp, CRC32 checksums, etc.
423224ee89b9Swdenk
423324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
423424ee89b9Swdenkprint the header information, or to build new images.
4235c609719bSwdenk
4236c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4237c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4238c609719bSwdenkchecksum verification:
4239c609719bSwdenk
4240c609719bSwdenk	tools/mkimage -l image
4241c609719bSwdenk	  -l ==> list image header information
4242c609719bSwdenk
4243c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4244c609719bSwdenkfrom a "data file" which is used as image payload:
4245c609719bSwdenk
4246c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4247c609719bSwdenk		      -n name -d data_file image
4248c609719bSwdenk	  -A ==> set architecture to 'arch'
4249c609719bSwdenk	  -O ==> set operating system to 'os'
4250c609719bSwdenk	  -T ==> set image type to 'type'
4251c609719bSwdenk	  -C ==> set compression type 'comp'
4252c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4253c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4254c609719bSwdenk	  -n ==> set image name to 'name'
4255c609719bSwdenk	  -d ==> use image data from 'datafile'
4256c609719bSwdenk
425769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
425869459791Swdenkaddress (0x00000000), but the entry point address depends on the
425969459791Swdenkkernel version:
4260c609719bSwdenk
4261c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
426224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4263c609719bSwdenk
4264c609719bSwdenkSo a typical call to build a U-Boot image would read:
4265c609719bSwdenk
426624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
426724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4268a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
426924ee89b9Swdenk	> examples/uImage.TQM850L
427024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4271c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4272c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4273c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4274c609719bSwdenk	Load Address: 0x00000000
427524ee89b9Swdenk	Entry Point:  0x00000000
4276c609719bSwdenk
4277c609719bSwdenkTo verify the contents of the image (or check for corruption):
4278c609719bSwdenk
427924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
428024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4281c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4282c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4283c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4284c609719bSwdenk	Load Address: 0x00000000
428524ee89b9Swdenk	Entry Point:  0x00000000
4286c609719bSwdenk
4287c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4288c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4289c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4290c609719bSwdenkneed to be uncompressed:
4291c609719bSwdenk
4292a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
429324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
429424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4295a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
429624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
429724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4298c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4299c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4300c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4301c609719bSwdenk	Load Address: 0x00000000
430224ee89b9Swdenk	Entry Point:  0x00000000
4303c609719bSwdenk
4304c609719bSwdenk
4305c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4306c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4307c609719bSwdenk
4308c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4309c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4310c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4311c609719bSwdenk	Image Name:   Simple Ramdisk Image
4312c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4313c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4314c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4315c609719bSwdenk	Load Address: 0x00000000
4316c609719bSwdenk	Entry Point:  0x00000000
4317c609719bSwdenk
4318c609719bSwdenk
4319c609719bSwdenkInstalling a Linux Image:
4320c609719bSwdenk-------------------------
4321c609719bSwdenk
4322c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4323c609719bSwdenkyou must convert the image to S-Record format:
4324c609719bSwdenk
4325c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4326c609719bSwdenk
4327c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4328c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4329c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4330c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4331c609719bSwdenkcommand.
4332c609719bSwdenk
4333c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4334c609719bSwdenkTQM8xxL is in the first Flash bank):
4335c609719bSwdenk
4336c609719bSwdenk	=> erase 40100000 401FFFFF
4337c609719bSwdenk
4338c609719bSwdenk	.......... done
4339c609719bSwdenk	Erased 8 sectors
4340c609719bSwdenk
4341c609719bSwdenk	=> loads 40100000
4342c609719bSwdenk	## Ready for S-Record download ...
4343c609719bSwdenk	~>examples/image.srec
4344c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4345c609719bSwdenk	...
4346c609719bSwdenk	15989 15990 15991 15992
4347c609719bSwdenk	[file transfer complete]
4348c609719bSwdenk	[connected]
4349c609719bSwdenk	## Start Addr = 0x00000000
4350c609719bSwdenk
4351c609719bSwdenk
4352c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4353c609719bSwdenkthis includes a checksum verification so you can be sure no data
4354c609719bSwdenkcorruption happened:
4355c609719bSwdenk
4356c609719bSwdenk	=> imi 40100000
4357c609719bSwdenk
4358c609719bSwdenk	## Checking Image at 40100000 ...
4359c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4360c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4361c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4362c609719bSwdenk	   Load Address: 00000000
4363c609719bSwdenk	   Entry Point:	 0000000c
4364c609719bSwdenk	   Verifying Checksum ... OK
4365c609719bSwdenk
4366c609719bSwdenk
4367c609719bSwdenkBoot Linux:
4368c609719bSwdenk-----------
4369c609719bSwdenk
4370c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4371c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4372c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4373c609719bSwdenkparameters. You can check and modify this variable using the
4374c609719bSwdenk"printenv" and "setenv" commands:
4375c609719bSwdenk
4376c609719bSwdenk
4377c609719bSwdenk	=> printenv bootargs
4378c609719bSwdenk	bootargs=root=/dev/ram
4379c609719bSwdenk
4380c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4381c609719bSwdenk
4382c609719bSwdenk	=> printenv bootargs
4383c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4384c609719bSwdenk
4385c609719bSwdenk	=> bootm 40020000
4386c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4387c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4388c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4389c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4390c609719bSwdenk	   Load Address: 00000000
4391c609719bSwdenk	   Entry Point:	 0000000c
4392c609719bSwdenk	   Verifying Checksum ... OK
4393c609719bSwdenk	   Uncompressing Kernel Image ... OK
4394c609719bSwdenk	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
4395c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4396c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4397c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4398c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4399c609719bSwdenk	...
4400c609719bSwdenk
440111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
44027152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4403c609719bSwdenkformat!) to the "bootm" command:
4404c609719bSwdenk
4405c609719bSwdenk	=> imi 40100000 40200000
4406c609719bSwdenk
4407c609719bSwdenk	## Checking Image at 40100000 ...
4408c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4409c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4410c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4411c609719bSwdenk	   Load Address: 00000000
4412c609719bSwdenk	   Entry Point:	 0000000c
4413c609719bSwdenk	   Verifying Checksum ... OK
4414c609719bSwdenk
4415c609719bSwdenk	## Checking Image at 40200000 ...
4416c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4417c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4418c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4419c609719bSwdenk	   Load Address: 00000000
4420c609719bSwdenk	   Entry Point:	 00000000
4421c609719bSwdenk	   Verifying Checksum ... OK
4422c609719bSwdenk
4423c609719bSwdenk	=> bootm 40100000 40200000
4424c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4425c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4426c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4427c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4428c609719bSwdenk	   Load Address: 00000000
4429c609719bSwdenk	   Entry Point:	 0000000c
4430c609719bSwdenk	   Verifying Checksum ... OK
4431c609719bSwdenk	   Uncompressing Kernel Image ... OK
4432c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4433c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4434c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4435c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4436c609719bSwdenk	   Load Address: 00000000
4437c609719bSwdenk	   Entry Point:	 00000000
4438c609719bSwdenk	   Verifying Checksum ... OK
4439c609719bSwdenk	   Loading Ramdisk ... OK
4440c609719bSwdenk	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
4441c609719bSwdenk	Boot arguments: root=/dev/ram
4442c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4443c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4444c609719bSwdenk	...
4445c609719bSwdenk	RAMDISK: Compressed image found at block 0
4446c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4447c609719bSwdenk
4448c609719bSwdenk	bash#
4449c609719bSwdenk
44500267768eSMatthew McClintockBoot Linux and pass a flat device tree:
44510267768eSMatthew McClintock-----------
44520267768eSMatthew McClintock
44530267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
44540267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
44550267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
44560267768eSMatthew McClintockflat device tree:
44570267768eSMatthew McClintock
44580267768eSMatthew McClintock=> print oftaddr
44590267768eSMatthew McClintockoftaddr=0x300000
44600267768eSMatthew McClintock=> print oft
44610267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
44620267768eSMatthew McClintock=> tftp $oftaddr $oft
44630267768eSMatthew McClintockSpeed: 1000, full duplex
44640267768eSMatthew McClintockUsing TSEC0 device
44650267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
44660267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
44670267768eSMatthew McClintockLoad address: 0x300000
44680267768eSMatthew McClintockLoading: #
44690267768eSMatthew McClintockdone
44700267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
44710267768eSMatthew McClintock=> tftp $loadaddr $bootfile
44720267768eSMatthew McClintockSpeed: 1000, full duplex
44730267768eSMatthew McClintockUsing TSEC0 device
44740267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
44750267768eSMatthew McClintockFilename 'uImage'.
44760267768eSMatthew McClintockLoad address: 0x200000
44770267768eSMatthew McClintockLoading:############
44780267768eSMatthew McClintockdone
44790267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
44800267768eSMatthew McClintock=> print loadaddr
44810267768eSMatthew McClintockloadaddr=200000
44820267768eSMatthew McClintock=> print oftaddr
44830267768eSMatthew McClintockoftaddr=0x300000
44840267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
44850267768eSMatthew McClintock## Booting image at 00200000 ...
44860267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
44870267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
44880267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
44890267768eSMatthew McClintock   Load Address: 00000000
44900267768eSMatthew McClintock   Entry Point:	 00000000
44910267768eSMatthew McClintock   Verifying Checksum ... OK
44920267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
44930267768eSMatthew McClintockBooting using flat device tree at 0x300000
44940267768eSMatthew McClintockUsing MPC85xx ADS machine description
44950267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
44960267768eSMatthew McClintock[snip]
44970267768eSMatthew McClintock
44980267768eSMatthew McClintock
44996069ff26SwdenkMore About U-Boot Image Types:
45006069ff26Swdenk------------------------------
45016069ff26Swdenk
45026069ff26SwdenkU-Boot supports the following image types:
45036069ff26Swdenk
45046069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
45056069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
45066069ff26Swdenk	well) you can continue to work in U-Boot after return from
45076069ff26Swdenk	the Standalone Program.
45086069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
45096069ff26Swdenk	will take over control completely. Usually these programs
45106069ff26Swdenk	will install their own set of exception handlers, device
45116069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
45126069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
45136069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
45146069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
45156069ff26Swdenk	being started.
45166069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
45176069ff26Swdenk	(Linux) kernel image and one or more data images like
45186069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
45196069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
45206069ff26Swdenk	server provides just a single image file, but you want to get
45216069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
45226069ff26Swdenk
45236069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
45246069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
45256069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
45266069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
45276069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
45286069ff26Swdenk	a multiple of 4 bytes).
45296069ff26Swdenk
45306069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
45316069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
45326069ff26Swdenk	flash memory.
45336069ff26Swdenk
45346069ff26Swdenk   "Script files" are command sequences that will be executed by
45356069ff26Swdenk	U-Boot's command interpreter; this feature is especially
45366069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
45376069ff26Swdenk	as command interpreter.
45386069ff26Swdenk
453944f074c7SMarek VasutBooting the Linux zImage:
454044f074c7SMarek Vasut-------------------------
454144f074c7SMarek Vasut
454244f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
454344f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
454444f074c7SMarek Vasutas the syntax of "bootm" command.
454544f074c7SMarek Vasut
4546017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4547017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4548017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4549017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4550017e1f3fSMarek Vasut
4551c609719bSwdenk
4552c609719bSwdenkStandalone HOWTO:
4553c609719bSwdenk=================
4554c609719bSwdenk
4555c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4556c609719bSwdenkrun "standalone" applications, which can use some resources of
4557c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4558c609719bSwdenk
4559c609719bSwdenkTwo simple examples are included with the sources:
4560c609719bSwdenk
4561c609719bSwdenk"Hello World" Demo:
4562c609719bSwdenk-------------------
4563c609719bSwdenk
4564c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4565c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4566c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4567c609719bSwdenklike that:
4568c609719bSwdenk
4569c609719bSwdenk	=> loads
4570c609719bSwdenk	## Ready for S-Record download ...
4571c609719bSwdenk	~>examples/hello_world.srec
4572c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4573c609719bSwdenk	[file transfer complete]
4574c609719bSwdenk	[connected]
4575c609719bSwdenk	## Start Addr = 0x00040004
4576c609719bSwdenk
4577c609719bSwdenk	=> go 40004 Hello World! This is a test.
4578c609719bSwdenk	## Starting application at 0x00040004 ...
4579c609719bSwdenk	Hello World
4580c609719bSwdenk	argc = 7
4581c609719bSwdenk	argv[0] = "40004"
4582c609719bSwdenk	argv[1] = "Hello"
4583c609719bSwdenk	argv[2] = "World!"
4584c609719bSwdenk	argv[3] = "This"
4585c609719bSwdenk	argv[4] = "is"
4586c609719bSwdenk	argv[5] = "a"
4587c609719bSwdenk	argv[6] = "test."
4588c609719bSwdenk	argv[7] = "<NULL>"
4589c609719bSwdenk	Hit any key to exit ...
4590c609719bSwdenk
4591c609719bSwdenk	## Application terminated, rc = 0x0
4592c609719bSwdenk
4593c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4594c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4595c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4596c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4597c609719bSwdenkcharacter, but this is just a demo program. The application can be
4598c609719bSwdenkcontrolled by the following keys:
4599c609719bSwdenk
4600c609719bSwdenk	? - print current values og the CPM Timer registers
4601c609719bSwdenk	b - enable interrupts and start timer
4602c609719bSwdenk	e - stop timer and disable interrupts
4603c609719bSwdenk	q - quit application
4604c609719bSwdenk
4605c609719bSwdenk	=> loads
4606c609719bSwdenk	## Ready for S-Record download ...
4607c609719bSwdenk	~>examples/timer.srec
4608c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4609c609719bSwdenk	[file transfer complete]
4610c609719bSwdenk	[connected]
4611c609719bSwdenk	## Start Addr = 0x00040004
4612c609719bSwdenk
4613c609719bSwdenk	=> go 40004
4614c609719bSwdenk	## Starting application at 0x00040004 ...
4615c609719bSwdenk	TIMERS=0xfff00980
4616c609719bSwdenk	Using timer 1
4617c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4618c609719bSwdenk
4619c609719bSwdenkHit 'b':
4620c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4621c609719bSwdenk	Enabling timer
4622c609719bSwdenkHit '?':
4623c609719bSwdenk	[q, b, e, ?] ........
4624c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4625c609719bSwdenkHit '?':
4626c609719bSwdenk	[q, b, e, ?] .
4627c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4628c609719bSwdenkHit '?':
4629c609719bSwdenk	[q, b, e, ?] .
4630c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4631c609719bSwdenkHit '?':
4632c609719bSwdenk	[q, b, e, ?] .
4633c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4634c609719bSwdenkHit 'e':
4635c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4636c609719bSwdenkHit 'q':
4637c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4638c609719bSwdenk
4639c609719bSwdenk
464085ec0bccSwdenkMinicom warning:
464185ec0bccSwdenk================
464285ec0bccSwdenk
46437152b1d0SwdenkOver time, many people have reported problems when trying to use the
464485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
464585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4646f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
464785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
464885ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
464985ec0bccSwdenk
465052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
465152f52c14Swdenkconfiguration to your "File transfer protocols" section:
465252f52c14Swdenk
465352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
465452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
465552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
465652f52c14Swdenk
465752f52c14Swdenk
4658c609719bSwdenkNetBSD Notes:
4659c609719bSwdenk=============
4660c609719bSwdenk
4661c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4662c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4663c609719bSwdenk
4664c609719bSwdenkBuilding requires a cross environment; it is known to work on
4665c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4666c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4667c609719bSwdenkNote that the cross-powerpc package does not install include files;
4668c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4669c609719bSwdenkmissing.  This file has to be installed and patched manually:
4670c609719bSwdenk
4671c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4672c609719bSwdenk	# mkdir powerpc
4673c609719bSwdenk	# ln -s powerpc machine
4674c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4675c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4676c609719bSwdenk
4677c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4678c609719bSwdenkand U-Boot include files.
4679c609719bSwdenk
4680c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4681c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4682c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4683c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
46842a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4685c609719bSwdenk
4686c609719bSwdenk
4687c609719bSwdenkImplementation Internals:
4688c609719bSwdenk=========================
4689c609719bSwdenk
4690c609719bSwdenkThe following is not intended to be a complete description of every
4691c609719bSwdenkimplementation detail. However, it should help to understand the
4692c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4693c609719bSwdenkhardware.
4694c609719bSwdenk
4695c609719bSwdenk
4696c609719bSwdenkInitial Stack, Global Data:
4697c609719bSwdenk---------------------------
4698c609719bSwdenk
4699c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4700c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4701c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4702c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4703c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4704c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4705c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4706c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4707c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4708c609719bSwdenklocked as (mis-) used as memory, etc.
4709c609719bSwdenk
47107152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
47110668236bSWolfgang Denk	U-Boot mailing list:
471243d9616cSwdenk
471343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
471443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
471543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
471643d9616cSwdenk	...
471743d9616cSwdenk
471843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
471943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
472043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
472143d9616cSwdenk	is that the cache is being used as a temporary supply of
472243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
472311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
472443d9616cSwdenk	can see how this works by studying the cache architecture and
472543d9616cSwdenk	operation in the architecture and processor-specific manuals.
472643d9616cSwdenk
472743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
472843d9616cSwdenk	is another option for the system designer to use as an
472911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
473043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
473143d9616cSwdenk	board designers haven't used it for something that would
473243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
473343d9616cSwdenk	used.
473443d9616cSwdenk
47356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
473643d9616cSwdenk	with your processor/board/system design. The default value
473743d9616cSwdenk	you will find in any recent u-boot distribution in
47388a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
473943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
474043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
474143d9616cSwdenk	that are supposed to respond to that address! That code in
474243d9616cSwdenk	start.S has been around a while and should work as is when
474343d9616cSwdenk	you get the config right.
474443d9616cSwdenk
474543d9616cSwdenk	-Chris Hallinan
474643d9616cSwdenk	DS4.COM, Inc.
474743d9616cSwdenk
4748c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4749c609719bSwdenkcode for the initialization procedures:
4750c609719bSwdenk
4751c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4752c609719bSwdenk  to write it.
4753c609719bSwdenk
475411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4755c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
47567152b1d0Swdenk  zation is performed later (when relocating to RAM).
4757c609719bSwdenk
4758c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4759c609719bSwdenk  that.
4760c609719bSwdenk
4761c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4762c609719bSwdenknormal global data to share information beween the code. But it
4763c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4764c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4765c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4766c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4767c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4768c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4769c609719bSwdenkreserve for this purpose.
4770c609719bSwdenk
47717152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4772c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4773c609719bSwdenkGCC's implementation.
4774c609719bSwdenk
4775c609719bSwdenkFor PowerPC, the following registers have specific use:
4776c609719bSwdenk	R1:	stack pointer
4777e7670f6cSWolfgang Denk	R2:	reserved for system use
4778c609719bSwdenk	R3-R4:	parameter passing and return values
4779c609719bSwdenk	R5-R10: parameter passing
4780c609719bSwdenk	R13:	small data area pointer
4781c609719bSwdenk	R30:	GOT pointer
4782c609719bSwdenk	R31:	frame pointer
4783c609719bSwdenk
4784e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4785e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4786e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4787c609719bSwdenk
4788e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4789c609719bSwdenk
4790c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4791c609719bSwdenk    address of the global data structure is known at compile time),
4792c609719bSwdenk    but it turned out that reserving a register results in somewhat
4793c609719bSwdenk    smaller code - although the code savings are not that big (on
4794c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4795c609719bSwdenk    624 text + 127 data).
4796c609719bSwdenk
4797c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
47984c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
47994c58eb55SMike Frysinger
4800c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
48014c58eb55SMike Frysinger
4802c609719bSwdenkOn ARM, the following registers are used:
4803c609719bSwdenk
4804c609719bSwdenk	R0:	function argument word/integer result
4805c609719bSwdenk	R1-R3:	function argument word
4806c609719bSwdenk	R9:	GOT pointer
4807c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4808c609719bSwdenk	R11:	argument (frame) pointer
4809c609719bSwdenk	R12:	temporary workspace
4810c609719bSwdenk	R13:	stack pointer
4811c609719bSwdenk	R14:	link register
4812c609719bSwdenk	R15:	program counter
4813c609719bSwdenk
4814c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4815c609719bSwdenk
48160df01fd3SThomas ChouOn Nios II, the ABI is documented here:
48170df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
48180df01fd3SThomas Chou
48190df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
48200df01fd3SThomas Chou
48210df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
48220df01fd3SThomas Chou    to access small data sections, so gp is free.
48230df01fd3SThomas Chou
4824afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4825afc1ce82SMacpaul Lin
4826afc1ce82SMacpaul Lin	R0-R1:	argument/return
4827afc1ce82SMacpaul Lin	R2-R5:	argument
4828afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4829afc1ce82SMacpaul Lin	R16:	trampoline register
4830afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4831afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4832afc1ce82SMacpaul Lin	R30:	link register (LP)
4833afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4834afc1ce82SMacpaul Lin	PC:	program counter (PC)
4835afc1ce82SMacpaul Lin
4836afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4837afc1ce82SMacpaul Lin
4838d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4839d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4840c609719bSwdenk
4841c609719bSwdenkMemory Management:
4842c609719bSwdenk------------------
4843c609719bSwdenk
4844c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4845c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4846c609719bSwdenk
4847c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4848c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4849c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4850c609719bSwdenkphysical memory banks.
4851c609719bSwdenk
4852c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4853c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4854c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4855c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
48566d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4857c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4858c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4859c609719bSwdenk
4860c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4861c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4862c609719bSwdenk
4863c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4864c609719bSwdenkthis:
4865c609719bSwdenk
4866c609719bSwdenk	0x0000 0000	Exception Vector code
4867c609719bSwdenk	      :
4868c609719bSwdenk	0x0000 1FFF
4869c609719bSwdenk	0x0000 2000	Free for Application Use
4870c609719bSwdenk	      :
4871c609719bSwdenk	      :
4872c609719bSwdenk
4873c609719bSwdenk	      :
4874c609719bSwdenk	      :
4875c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4876c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4877c609719bSwdenk	0x00FC 0000	Malloc Arena
4878c609719bSwdenk	      :
4879c609719bSwdenk	0x00FD FFFF
4880c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4881c609719bSwdenk	...		eventually: LCD or video framebuffer
4882c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4883c609719bSwdenk	0x00FF FFFF	[End of RAM]
4884c609719bSwdenk
4885c609719bSwdenk
4886c609719bSwdenkSystem Initialization:
4887c609719bSwdenk----------------------
4888c609719bSwdenk
4889c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
489011ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4891c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
48927152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4893c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4894c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4895c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4896c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4897c609719bSwdenkthe caches and the SIU.
4898c609719bSwdenk
4899c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4900c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4901c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4902c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4903c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4904c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4905c609719bSwdenkbanks.
4906c609719bSwdenk
4907c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
49087152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4909c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4910c609719bSwdenk0x00000000, with any additional banks following immediately to create
4911c609719bSwdenkcontiguous memory starting from 0.
4912c609719bSwdenk
4913c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4914c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4915c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4916c609719bSwdenkpages, and the final stack is set up.
4917c609719bSwdenk
4918c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4919c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4920c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4921c609719bSwdenknew address in RAM.
4922c609719bSwdenk
4923c609719bSwdenk
4924c609719bSwdenkU-Boot Porting Guide:
4925c609719bSwdenk----------------------
4926c609719bSwdenk
4927c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
49286aff3115Swdenklist, October 2002]
4929c609719bSwdenk
4930c609719bSwdenk
4931c609719bSwdenkint main(int argc, char *argv[])
4932c609719bSwdenk{
4933c609719bSwdenk	sighandler_t no_more_time;
4934c609719bSwdenk
4935c609719bSwdenk	signal(SIGALRM, no_more_time);
4936c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4937c609719bSwdenk
4938c609719bSwdenk	if (available_money > available_manpower) {
49396c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4940c609719bSwdenk		return 0;
4941c609719bSwdenk	}
4942c609719bSwdenk
4943c609719bSwdenk	Download latest U-Boot source;
4944c609719bSwdenk
49450668236bSWolfgang Denk	Subscribe to u-boot mailing list;
49466aff3115Swdenk
49476c3fef28SJerry Van Baren	if (clueless)
4948c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4949c609719bSwdenk
4950c609719bSwdenk	while (learning) {
4951c609719bSwdenk		Read the README file in the top level directory;
49527cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
49536c3fef28SJerry Van Baren		Read applicable doc/*.README;
4954c609719bSwdenk		Read the source, Luke;
49556c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4956c609719bSwdenk	}
4957c609719bSwdenk
49586c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
49596c3fef28SJerry Van Baren		Buy a BDI3000;
49606c3fef28SJerry Van Baren	else
4961c609719bSwdenk		Add a lot of aggravation and time;
4962c609719bSwdenk
49636c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
49646c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
49656c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
49666c3fef28SJerry Van Baren	} else {
4967c609719bSwdenk		Create your own board support subdirectory;
49686c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
49696c3fef28SJerry Van Baren	}
49706c3fef28SJerry Van Baren	Edit new board/<myboard> files
49716c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4972c609719bSwdenk
49736c3fef28SJerry Van Baren	while (!accepted) {
4974c609719bSwdenk		while (!running) {
4975c609719bSwdenk			do {
4976c609719bSwdenk				Add / modify source code;
4977c609719bSwdenk			} until (compiles);
4978c609719bSwdenk			Debug;
4979c609719bSwdenk			if (clueless)
4980c609719bSwdenk				email("Hi, I am having problems...");
4981c609719bSwdenk		}
49826c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
49836c3fef28SJerry Van Baren		if (reasonable critiques)
49846c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
49856c3fef28SJerry Van Baren		else
49866c3fef28SJerry Van Baren			Defend code as written;
49876c3fef28SJerry Van Baren	}
4988c609719bSwdenk
4989c609719bSwdenk	return 0;
4990c609719bSwdenk}
4991c609719bSwdenk
4992c609719bSwdenkvoid no_more_time (int sig)
4993c609719bSwdenk{
4994c609719bSwdenk      hire_a_guru();
4995c609719bSwdenk}
4996c609719bSwdenk
4997c609719bSwdenk
4998c609719bSwdenkCoding Standards:
4999c609719bSwdenk-----------------
5000c609719bSwdenk
5001c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
50022c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
50037ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5004c609719bSwdenk
50052c051651SDetlev ZundelSource files originating from a different project (for example the
50062c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
50072c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
50082c051651SDetlev Zundelsources.
50092c051651SDetlev Zundel
50102c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
50112c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
50122c051651SDetlev Zundelin your code.
5013c609719bSwdenk
5014c178d3daSwdenkPlease also stick to the following formatting rules:
5015180d3f74Swdenk- remove any trailing white space
50167ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5017180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
50187ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5019180d3f74Swdenk- do not add trailing empty lines to source files
5020180d3f74Swdenk
5021c609719bSwdenkSubmissions which do not conform to the standards may be returned
5022c609719bSwdenkwith a request to reformat the changes.
5023c609719bSwdenk
5024c609719bSwdenk
5025c609719bSwdenkSubmitting Patches:
5026c609719bSwdenk-------------------
5027c609719bSwdenk
5028c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5029c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5030c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5031c609719bSwdenk
50320d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5033218ca724SWolfgang Denk
50340668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
50350668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
50360668236bSWolfgang Denk
5037c609719bSwdenkWhen you send a patch, please include the following information with
5038c609719bSwdenkit:
5039c609719bSwdenk
5040c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5041c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5042c609719bSwdenk  patch actually fixes something.
5043c609719bSwdenk
5044c609719bSwdenk* For new features: a description of the feature and your
5045c609719bSwdenk  implementation.
5046c609719bSwdenk
5047c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5048c609719bSwdenk
5049c609719bSwdenk* For major contributions, your entry to the CREDITS file
5050c609719bSwdenk
5051c609719bSwdenk* When you add support for a new board, don't forget to add this
50527ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5053c609719bSwdenk
5054c609719bSwdenk* If your patch adds new configuration options, don't forget to
5055c609719bSwdenk  document these in the README file.
5056c609719bSwdenk
5057218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5058218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
50597ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5060218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5061218ca724SWolfgang Denk  with some other mail clients.
5062c609719bSwdenk
5063218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5064218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5065218ca724SWolfgang Denk  GNU diff.
50666dff5529Swdenk
5067218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5068218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5069218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5070218ca724SWolfgang Denk  affected files).
5071218ca724SWolfgang Denk
5072218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5073218ca724SWolfgang Denk  and compressed attachments must not be used.
5074c609719bSwdenk
507552f52c14Swdenk* If one logical set of modifications affects or creates several
507652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
507752f52c14Swdenk
507852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
507952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
508052f52c14Swdenk
508152f52c14Swdenk
5082c609719bSwdenkNotes:
5083c609719bSwdenk
5084c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5085c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5086c609719bSwdenk  for any of the boards.
5087c609719bSwdenk
5088c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5089c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5090c609719bSwdenk  returned with a request to re-formatting / split it.
5091c609719bSwdenk
5092c609719bSwdenk* If you modify existing code, make sure that your new code does not
5093c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5094c609719bSwdenk  When adding new features, these should compile conditionally only
5095c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5096c609719bSwdenk  disabled must not need more memory than the old code without your
5097c609719bSwdenk  modification.
509890dc6704Swdenk
50990668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
51000668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
51010668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
51020668236bSWolfgang Denk  bigger than the size limit should be avoided.
5103