xref: /openbmc/u-boot/README (revision afa6b551fddc35a83e40c63101947d237bde5183)
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
377*afa6b551SPrabhakar Kushwaha		CONFIG_SYS_PPC_E500_DEBUG_TLB
378*afa6b551SPrabhakar Kushwaha
379*afa6b551SPrabhakar Kushwaha		Enables a temporary TLB entry to be used during boot to work
380*afa6b551SPrabhakar Kushwaha		around limitations in e500v1 and e500v2 external debugger
381*afa6b551SPrabhakar Kushwaha		support. This reduces the portions of the boot code where
382*afa6b551SPrabhakar Kushwaha		breakpoints and single stepping do not work.  The value of this
383*afa6b551SPrabhakar Kushwaha		symbol should be set to the TLB1 entry to be used for this
384*afa6b551SPrabhakar Kushwaha		purpose.
385*afa6b551SPrabhakar 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
747602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
748602ad3b3SJon Loeliger		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.
910c1551ea8Sstroese		This variable is readonly.
911c1551ea8Sstroese
912c609719bSwdenk- Real-Time Clock:
913c609719bSwdenk
914602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
915c609719bSwdenk		has to be selected, too. Define exactly one of the
916c609719bSwdenk		following options:
917c609719bSwdenk
918c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
919c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9204e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
921c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9221cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
923c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9247f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9253bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9269536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9274c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
92971d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
93071d19f30SHeiko Schocher					  RV3029 RTC.
931c609719bSwdenk
932b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
933b37c7e5eSwdenk		must also be configured. See I2C Support, below.
934b37c7e5eSwdenk
935e92739d3SPeter Tyser- GPIO Support:
936e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
937e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
938e92739d3SPeter Tyser
9395dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9405dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9415dec49caSChris Packham		pins supported by a particular chip.
9425dec49caSChris Packham
943e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
944e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
945e92739d3SPeter Tyser
946c609719bSwdenk- Timestamp Support:
947c609719bSwdenk
948c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
949c609719bSwdenk		(date and time) of an image is printed by image
950c609719bSwdenk		commands like bootm or iminfo. This option is
951602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
952c609719bSwdenk
953c609719bSwdenk- Partition Support:
954c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
95507f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
956c609719bSwdenk
957602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
958218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
959218ca724SWolfgang Denk		least one partition type as well.
960c609719bSwdenk
961c609719bSwdenk- IDE Reset method:
9624d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9634d13cbadSwdenk		board configurations files but used nowhere!
964c609719bSwdenk
9654d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9664d13cbadSwdenk		be performed by calling the function
9674d13cbadSwdenk			ide_set_reset(int reset)
9684d13cbadSwdenk		which has to be defined in a board specific file
969c609719bSwdenk
970c609719bSwdenk- ATAPI Support:
971c609719bSwdenk		CONFIG_ATAPI
972c609719bSwdenk
973c609719bSwdenk		Set this to enable ATAPI support.
974c609719bSwdenk
975c40b2956Swdenk- LBA48 Support
976c40b2956Swdenk		CONFIG_LBA48
977c40b2956Swdenk
978c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9794b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
980c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
981c40b2956Swdenk		support disks up to 2.1TB.
982c40b2956Swdenk
9836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
984c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
985c40b2956Swdenk			Default is 32bit.
986c40b2956Swdenk
987c609719bSwdenk- SCSI Support:
988c609719bSwdenk		At the moment only there is only support for the
989c609719bSwdenk		SYM53C8XX SCSI controller; define
990c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
991c609719bSwdenk
9926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
995c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
996c609719bSwdenk		devices.
9976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
998c609719bSwdenk
999c609719bSwdenk- NETWORK Support (PCI):
1000682011ffSwdenk		CONFIG_E1000
1001ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1002ce5207e1SKyle Moffett
1003ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1004ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1005ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1006ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1007ce5207e1SKyle Moffett
1008ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1009ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1010ce5207e1SKyle Moffett		example with the "sspi" command.
1011ce5207e1SKyle Moffett
1012ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1013ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1014ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1015682011ffSwdenk
1016ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
101711ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1018ac3315c2SAndre Schwarz
1019c609719bSwdenk		CONFIG_EEPRO100
1020c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
102111ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1022c609719bSwdenk		write routine for first time initialisation.
1023c609719bSwdenk
1024c609719bSwdenk		CONFIG_TULIP
1025c609719bSwdenk		Support for Digital 2114x chips.
1026c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1027c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1028c609719bSwdenk
1029c609719bSwdenk		CONFIG_NATSEMI
1030c609719bSwdenk		Support for National dp83815 chips.
1031c609719bSwdenk
1032c609719bSwdenk		CONFIG_NS8382X
1033c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1034c609719bSwdenk
103545219c46Swdenk- NETWORK Support (other):
103645219c46Swdenk
1037c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1038c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1039c041e9d2SJens Scharsig
1040c041e9d2SJens Scharsig			CONFIG_RMII
1041c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1042c041e9d2SJens Scharsig
1043c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1044c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1045c041e9d2SJens Scharsig			The driver doen't show link status messages.
1046c041e9d2SJens Scharsig
1047efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1048efdd7319SRob Herring		Support for the Calxeda XGMAC device
1049efdd7319SRob Herring
105045219c46Swdenk		CONFIG_DRIVER_LAN91C96
105145219c46Swdenk		Support for SMSC's LAN91C96 chips.
105245219c46Swdenk
105345219c46Swdenk			CONFIG_LAN91C96_BASE
105445219c46Swdenk			Define this to hold the physical address
105545219c46Swdenk			of the LAN91C96's I/O space
105645219c46Swdenk
105745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
105845219c46Swdenk			Define this to enable 32 bit addressing
105945219c46Swdenk
1060f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1061f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1062f39748aeSwdenk
1063f39748aeSwdenk			CONFIG_SMC91111_BASE
1064f39748aeSwdenk			Define this to hold the physical address
1065f39748aeSwdenk			of the device (I/O space)
1066f39748aeSwdenk
1067f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1068f39748aeSwdenk			Define this if data bus is 32 bits
1069f39748aeSwdenk
1070f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1071f39748aeSwdenk			Define this to use i/o functions instead of macros
1072f39748aeSwdenk			(some hardware wont work with macros)
1073f39748aeSwdenk
1074dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1075dc02badaSHeiko Schocher		Support for davinci emac
1076dc02badaSHeiko Schocher
1077dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1078dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1079dc02badaSHeiko Schocher
1080b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1081b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1082b3dbf4a5SMacpaul Lin
1083b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1084b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1085b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1086b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1087b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1088b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1089b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1090b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1091b3dbf4a5SMacpaul Lin
1092c2fff331SMike Rapoport		CONFIG_SMC911X
1093557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1094557b377dSJens Gehrlein
1095c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1096557b377dSJens Gehrlein			Define this to hold the physical address
1097557b377dSJens Gehrlein			of the device (I/O space)
1098557b377dSJens Gehrlein
1099c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1100557b377dSJens Gehrlein			Define this if data bus is 32 bits
1101557b377dSJens Gehrlein
1102c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1103557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1104557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1105c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1106557b377dSJens Gehrlein
11073d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11083d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11093d0075faSYoshihiro Shimoda
11103d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11113d0075faSYoshihiro Shimoda			Define the number of ports to be used
11123d0075faSYoshihiro Shimoda
11133d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11143d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11153d0075faSYoshihiro Shimoda
111668260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
111768260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
111868260aabSYoshihiro Shimoda
11195e124724SVadim Bendebury- TPM Support:
11205e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11215e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11225e124724SVadim Bendebury		per system is supported at this time.
11235e124724SVadim Bendebury
11245e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11255e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11265e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11275e124724SVadim Bendebury			0xfed40000.
11285e124724SVadim Bendebury
1129c609719bSwdenk- USB Support:
1130c609719bSwdenk		At the moment only the UHCI host controller is
11314d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1132c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1133c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
113430d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1135c609719bSwdenk		storage devices.
1136c609719bSwdenk		Note:
1137c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1138c609719bSwdenk		(TEAC FD-05PUB).
11394d13cbadSwdenk		MPC5200 USB requires additional defines:
11404d13cbadSwdenk			CONFIG_USB_CLOCK
11414d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1142307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1143307ecb6dSEric Millbrandt				for USB on PSC3
11444d13cbadSwdenk			CONFIG_USB_CONFIG
11454d13cbadSwdenk				for differential drivers: 0x00001000
11464d13cbadSwdenk				for single ended drivers: 0x00005000
1147307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1148307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1150fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1151fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11524d13cbadSwdenk
11539ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
11549ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
11559ab4ce22SSimon Glass
115616c8d5e7SWolfgang Denk- USB Device:
115716c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
115816c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
115916c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
116011ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
116116c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
116216c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
116316c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
116416c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
116516c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
116616c8d5e7SWolfgang Denk		a Linux host by
116716c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
116816c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
116916c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
117016c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
117116c8d5e7SWolfgang Denk
117216c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
117316c8d5e7SWolfgang Denk			Define this to build a UDC device
117416c8d5e7SWolfgang Denk
117516c8d5e7SWolfgang Denk			CONFIG_USB_TTY
117616c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
117716c8d5e7SWolfgang Denk			talk to the UDC device
117816c8d5e7SWolfgang Denk
1179f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1180f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1181f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1182f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1183f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1184f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1185f9da0f89SVipin KUMAR			speed.
1186f9da0f89SVipin KUMAR
11876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
118816c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
118916c8d5e7SWolfgang Denk			be set to usbtty.
119016c8d5e7SWolfgang Denk
119116c8d5e7SWolfgang Denk			mpc8xx:
11926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
119316c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
11946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
119516c8d5e7SWolfgang Denk
11966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
119716c8d5e7SWolfgang Denk				Derive USB clock from brgclk
11986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
119916c8d5e7SWolfgang Denk
120016c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
120116c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
120216c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
120316c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
120416c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
120516c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
120616c8d5e7SWolfgang Denk
120716c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
120816c8d5e7SWolfgang Denk			Define this string as the name of your company for
120916c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
121016c8d5e7SWolfgang Denk
121116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
121216c8d5e7SWolfgang Denk			Define this string as the name of your product
121316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
121416c8d5e7SWolfgang Denk
121516c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
121616c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
121716c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
121816c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
121916c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
122016c8d5e7SWolfgang Denk
122116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
122216c8d5e7SWolfgang Denk			Define this as the unique Product ID
122316c8d5e7SWolfgang Denk			for your device
122416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1225c609719bSwdenk
1226d70a560fSIgor Grinberg- ULPI Layer Support:
1227d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1228d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1229d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1230d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1231d70a560fSIgor Grinberg		viewport is supported.
1232d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1233d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1234c609719bSwdenk
1235c609719bSwdenk- MMC Support:
1236c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1237c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1238c609719bSwdenk		accessed from the boot prompt by mapping the device
1239c609719bSwdenk		to physical memory similar to flash. Command line is
1240602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1241602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1242c609719bSwdenk
1243afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1244afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1245afb35666SYoshihiro Shimoda
1246afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1247afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1248afb35666SYoshihiro Shimoda
1249afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1250afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1251afb35666SYoshihiro Shimoda
12526705d81eSwdenk- Journaling Flash filesystem support:
12536705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
12546705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
12556705d81eSwdenk		Define these for a default partition on a NAND device
12566705d81eSwdenk
12576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
12586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
12596705d81eSwdenk		Define these for a default partition on a NOR device
12606705d81eSwdenk
12616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
12626705d81eSwdenk		Define this to create an own partition. You have to provide a
12636705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
12646705d81eSwdenk
12656705d81eSwdenk		If you define only one JFFS2 partition you may also want to
12666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
12676705d81eSwdenk		to disable the command chpart. This is the default when you
12686705d81eSwdenk		have not defined a custom partition
12696705d81eSwdenk
1270c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1271c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1272656f4c65SDonggeun Kim
1273656f4c65SDonggeun Kim		Define this to enable support for saving memory data as a
1274656f4c65SDonggeun Kim		file in FAT formatted partition.
1275656f4c65SDonggeun Kim
1276656f4c65SDonggeun Kim		This will also enable the command "fatwrite" enabling the
1277656f4c65SDonggeun Kim		user to write files to FAT.
1278c30a15e5SDonggeun Kim
1279c609719bSwdenk- Keyboard Support:
1280c609719bSwdenk		CONFIG_ISA_KEYBOARD
1281c609719bSwdenk
1282c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1283c609719bSwdenk		support
1284c609719bSwdenk
1285c609719bSwdenk		CONFIG_I8042_KBD
1286c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1287c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1288c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1289c609719bSwdenk		for cfb_console. Supports cursor blinking.
1290c609719bSwdenk
1291c609719bSwdenk- Video support:
1292c609719bSwdenk		CONFIG_VIDEO
1293c609719bSwdenk
1294c609719bSwdenk		Define this to enable video support (for output to
1295c609719bSwdenk		video).
1296c609719bSwdenk
1297c609719bSwdenk		CONFIG_VIDEO_CT69000
1298c609719bSwdenk
1299c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1300c609719bSwdenk
1301c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1302eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1303eeb1b77bSwdenk		video output is selected via environment 'videoout'
1304eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1305eeb1b77bSwdenk		assumed.
1306c609719bSwdenk
1307eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
130811ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1309eeb1b77bSwdenk		are possible:
1310eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1311eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1312eeb1b77bSwdenk
1313eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1314eeb1b77bSwdenk		-------------+---------------------------------------------
1315eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1316eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1317eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1318eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1319eeb1b77bSwdenk		-------------+---------------------------------------------
1320c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1321c609719bSwdenk
1322eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13237817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1324eeb1b77bSwdenk
1325eeb1b77bSwdenk
1326a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1327a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1328a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1329a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1330a6c7ad2fSwdenk
13317d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13327d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13337d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13347d3053fbSTimur Tabi		support, and should also define these other macros:
13357d3053fbSTimur Tabi
13367d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13377d3053fbSTimur Tabi			CONFIG_VIDEO
13387d3053fbSTimur Tabi			CONFIG_CMD_BMP
13397d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13407d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13417d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13427d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13437d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13447d3053fbSTimur Tabi
1345ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1346ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1347ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1348ba8e76bdSTimur Tabi		description of this variable.
13497d3053fbSTimur Tabi
1350682011ffSwdenk- Keyboard Support:
1351682011ffSwdenk		CONFIG_KEYBOARD
1352682011ffSwdenk
1353682011ffSwdenk		Define this to enable a custom keyboard support.
1354682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1355682011ffSwdenk		defined in your board-specific files.
1356682011ffSwdenk		The only board using this so far is RBC823.
1357a6c7ad2fSwdenk
1358c609719bSwdenk- LCD Support:	CONFIG_LCD
1359c609719bSwdenk
1360c609719bSwdenk		Define this to enable LCD support (for output to LCD
1361c609719bSwdenk		display); also select one of the supported displays
1362c609719bSwdenk		by defining one of these:
1363c609719bSwdenk
136439cf4804SStelian Pop		CONFIG_ATMEL_LCD:
136539cf4804SStelian Pop
136639cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
136739cf4804SStelian Pop
1368fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1369c609719bSwdenk
1370fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1371c609719bSwdenk
1372fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1373c609719bSwdenk
1374fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1375fd3103bbSwdenk			Active, color, single scan.
1376fd3103bbSwdenk
1377fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1378fd3103bbSwdenk
1379fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1380c609719bSwdenk			Active, color, single scan.
1381c609719bSwdenk
1382c609719bSwdenk		CONFIG_SHARP_16x9
1383c609719bSwdenk
1384c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1385c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1386c609719bSwdenk
1387c609719bSwdenk		CONFIG_SHARP_LQ64D341
1388c609719bSwdenk
1389c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1390c609719bSwdenk			Active, color, single scan.
1391c609719bSwdenk
1392c609719bSwdenk		CONFIG_HLD1045
1393c609719bSwdenk
1394c609719bSwdenk			HLD1045 display, 640x480.
1395c609719bSwdenk			Active, color, single scan.
1396c609719bSwdenk
1397c609719bSwdenk		CONFIG_OPTREX_BW
1398c609719bSwdenk
1399c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1400c609719bSwdenk			or
1401c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1402c609719bSwdenk			or
1403c609719bSwdenk			Hitachi	 SP14Q002
1404c609719bSwdenk
1405c609719bSwdenk			320x240. Black & white.
1406c609719bSwdenk
1407c609719bSwdenk		Normally display is black on white background; define
14086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1409c609719bSwdenk
14107152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1411d791b1dcSwdenk
1412d791b1dcSwdenk		If this option is set, the environment is checked for
1413d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1414d791b1dcSwdenk		of logo, copyright and system information on the LCD
1415e94d2cd9Swdenk		is suppressed and the BMP image at the address
1416d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1417d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1418d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1419d791b1dcSwdenk		loaded very quickly after power-on.
1420d791b1dcSwdenk
14211ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
14221ca298ceSMatthias Weisser
14231ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14241ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14251ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14261ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14271ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14281ca298ceSMatthias Weisser		specify 'm' for centering the image.
14291ca298ceSMatthias Weisser
14301ca298ceSMatthias Weisser		Example:
14311ca298ceSMatthias Weisser		setenv splashpos m,m
14321ca298ceSMatthias Weisser			=> image at center of screen
14331ca298ceSMatthias Weisser
14341ca298ceSMatthias Weisser		setenv splashpos 30,20
14351ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14361ca298ceSMatthias Weisser
14371ca298ceSMatthias Weisser		setenv splashpos -10,m
14381ca298ceSMatthias Weisser			=> vertically centered image
14391ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14401ca298ceSMatthias Weisser
144198f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
144298f4a3dfSStefan Roese
144398f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
144498f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
144598f4a3dfSStefan Roese		splashscreen support or the bmp command.
144698f4a3dfSStefan Roese
1447d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1448d5011762SAnatolij Gustschin
1449d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1450d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1451d5011762SAnatolij Gustschin		bmp command.
1452d5011762SAnatolij Gustschin
1453c29fdfc1Swdenk- Compression support:
1454c29fdfc1Swdenk		CONFIG_BZIP2
1455c29fdfc1Swdenk
1456c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1457c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1458c29fdfc1Swdenk		compressed images are supported.
1459c29fdfc1Swdenk
1460c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
14616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1462c29fdfc1Swdenk		be at least 4MB.
1463d791b1dcSwdenk
1464fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1465fc9c1727SLuigi 'Comio' Mantellini
1466fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1467fc9c1727SLuigi 'Comio' Mantellini		images is included.
1468fc9c1727SLuigi 'Comio' Mantellini
1469fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1470fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1471fc9c1727SLuigi 'Comio' Mantellini		formula:
1472fc9c1727SLuigi 'Comio' Mantellini
1473fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1474fc9c1727SLuigi 'Comio' Mantellini
1475fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1476fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1477fc9c1727SLuigi 'Comio' Mantellini
1478fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1479fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1480fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1481fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1482fc9c1727SLuigi 'Comio' Mantellini
1483fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1484fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
14856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1486fc9c1727SLuigi 'Comio' Mantellini
148717ea1177Swdenk- MII/PHY support:
148817ea1177Swdenk		CONFIG_PHY_ADDR
148917ea1177Swdenk
149017ea1177Swdenk		The address of PHY on MII bus.
149117ea1177Swdenk
149217ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
149317ea1177Swdenk
149417ea1177Swdenk		The clock frequency of the MII bus
149517ea1177Swdenk
149617ea1177Swdenk		CONFIG_PHY_GIGE
149717ea1177Swdenk
149817ea1177Swdenk		If this option is set, support for speed/duplex
149911ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
150017ea1177Swdenk
150117ea1177Swdenk		CONFIG_PHY_RESET_DELAY
150217ea1177Swdenk
150317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
150417ea1177Swdenk		reset before any MII register access is possible.
150517ea1177Swdenk		For such PHY, set this option to the usec delay
150617ea1177Swdenk		required. (minimum 300usec for LXT971A)
150717ea1177Swdenk
150817ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
150917ea1177Swdenk
151017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
151117ea1177Swdenk		command issued before MII status register can be read
151217ea1177Swdenk
1513c609719bSwdenk- Ethernet address:
1514c609719bSwdenk		CONFIG_ETHADDR
1515c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1516c609719bSwdenk		CONFIG_ETH2ADDR
1517c609719bSwdenk		CONFIG_ETH3ADDR
1518c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1519c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1520c609719bSwdenk
152111ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
152211ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1523c609719bSwdenk		is not determined automatically.
1524c609719bSwdenk
1525c609719bSwdenk- IP address:
1526c609719bSwdenk		CONFIG_IPADDR
1527c609719bSwdenk
1528c609719bSwdenk		Define a default value for the IP address to use for
152911ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1530c609719bSwdenk		determined through e.g. bootp.
15311ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1532c609719bSwdenk
1533c609719bSwdenk- Server IP address:
1534c609719bSwdenk		CONFIG_SERVERIP
1535c609719bSwdenk
1536c609719bSwdenk		Defines a default value for the IP address of a TFTP
1537c609719bSwdenk		server to contact when using the "tftboot" command.
15381ebcd654SWolfgang Denk		(Environment variable "serverip")
1539c609719bSwdenk
154097cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
154197cfe861SRobin Getz
154297cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
154397cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
154497cfe861SRobin Getz
15451ebcd654SWolfgang Denk- Gateway IP address:
15461ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15471ebcd654SWolfgang Denk
15481ebcd654SWolfgang Denk		Defines a default value for the IP address of the
15491ebcd654SWolfgang Denk		default router where packets to other networks are
15501ebcd654SWolfgang Denk		sent to.
15511ebcd654SWolfgang Denk		(Environment variable "gatewayip")
15521ebcd654SWolfgang Denk
15531ebcd654SWolfgang Denk- Subnet mask:
15541ebcd654SWolfgang Denk		CONFIG_NETMASK
15551ebcd654SWolfgang Denk
15561ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
15571ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
15581ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
15591ebcd654SWolfgang Denk		forwarded through a router.
15601ebcd654SWolfgang Denk		(Environment variable "netmask")
15611ebcd654SWolfgang Denk
156253a5c424SDavid Updegraff- Multicast TFTP Mode:
156353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
156453a5c424SDavid Updegraff
156553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
156653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
156711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
156853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
156953a5c424SDavid Updegraff		multicast group.
157053a5c424SDavid Updegraff
1571c609719bSwdenk- BOOTP Recovery Mode:
1572c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1573c609719bSwdenk
1574c609719bSwdenk		If you have many targets in a network that try to
1575c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1576c609719bSwdenk		systems send out BOOTP requests at precisely the same
1577c609719bSwdenk		moment (which would happen for instance at recovery
1578c609719bSwdenk		from a power failure, when all systems will try to
1579c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1580c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1581c609719bSwdenk		inserted before sending out BOOTP requests. The
15826c33c785SWolfgang Denk		following delays are inserted then:
1583c609719bSwdenk
1584c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1585c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1586c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1587c609719bSwdenk		4th and following
1588c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1589c609719bSwdenk
1590fe389a82Sstroese- DHCP Advanced Options:
15911fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
15921fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1593fe389a82Sstroese
15941fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
15951fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
15961fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
15971fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
15981fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
15991fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
16001fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
16011fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
16021fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
16031fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
16041fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
16051fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
16062c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1607fe389a82Sstroese
16085d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
16095d110f0aSWilson Callan		environment variable, not the BOOTP server.
1610fe389a82Sstroese
16112c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
16122c00e099SJoe Hershberger		after the configured retry count, the call will fail
16132c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
16142c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
16152c00e099SJoe Hershberger		is not available.
16162c00e099SJoe Hershberger
1617fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1618fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1619fe389a82Sstroese		than one DNS serverip is offered to the client.
1620fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1621fe389a82Sstroese		serverip will be stored in the additional environment
1622fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1623fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
16241fe80d79SJon Loeliger		is defined.
1625fe389a82Sstroese
1626fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1627fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1628fe389a82Sstroese		need the hostname of the DHCP requester.
16295d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16301fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16311fe80d79SJon Loeliger		option 12 to the DHCP server.
1632fe389a82Sstroese
1633d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1634d9a2f416SAras Vaichas
1635d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1636d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1637d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1638d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1639d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1640d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1641d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1642d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1643d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1644d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1645d9a2f416SAras Vaichas		this delay.
1646d9a2f416SAras Vaichas
1647d22c338eSJoe Hershberger - Link-local IP address negotiation:
1648d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1649d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1650d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1651d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1652d22c338eSJoe Hershberger
1653d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1654d22c338eSJoe Hershberger
1655a3d991bdSwdenk - CDP Options:
1656a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1657a3d991bdSwdenk
1658a3d991bdSwdenk		The device id used in CDP trigger frames.
1659a3d991bdSwdenk
1660a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1661a3d991bdSwdenk
1662a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1663a3d991bdSwdenk		of the device.
1664a3d991bdSwdenk
1665a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1666a3d991bdSwdenk
1667a3d991bdSwdenk		A printf format string which contains the ascii name of
1668a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
166911ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1670a3d991bdSwdenk
1671a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1672a3d991bdSwdenk
1673a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1674a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1675a3d991bdSwdenk
1676a3d991bdSwdenk		CONFIG_CDP_VERSION
1677a3d991bdSwdenk
1678a3d991bdSwdenk		An ascii string containing the version of the software.
1679a3d991bdSwdenk
1680a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1681a3d991bdSwdenk
1682a3d991bdSwdenk		An ascii string containing the name of the platform.
1683a3d991bdSwdenk
1684a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1685a3d991bdSwdenk
1686a3d991bdSwdenk		A 32bit integer sent on the trigger.
1687a3d991bdSwdenk
1688a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1689a3d991bdSwdenk
1690a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1691a3d991bdSwdenk		device in .1 of milliwatts.
1692a3d991bdSwdenk
1693a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1694a3d991bdSwdenk
1695a3d991bdSwdenk		A byte containing the id of the VLAN.
1696a3d991bdSwdenk
1697c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1698c609719bSwdenk
1699c609719bSwdenk		Several configurations allow to display the current
1700c609719bSwdenk		status using a LED. For instance, the LED will blink
1701c609719bSwdenk		fast while running U-Boot code, stop blinking as
1702c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1703c609719bSwdenk		start blinking slow once the Linux kernel is running
1704c609719bSwdenk		(supported by a status LED driver in the Linux
1705c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1706c609719bSwdenk		feature in U-Boot.
1707c609719bSwdenk
1708c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1709c609719bSwdenk
1710c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1711c609719bSwdenk		on those systems that support this (optional)
1712c609719bSwdenk		feature, like the TQM8xxL modules.
1713c609719bSwdenk
1714c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1715c609719bSwdenk
1716b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1717b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
171811ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1719c609719bSwdenk
1720b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1721602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1722b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1723b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1724c609719bSwdenk		command line interface.
1725c609719bSwdenk
1726bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1727c609719bSwdenk
1728b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1729b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1730b37c7e5eSwdenk		support for I2C.
1731c609719bSwdenk
1732b37c7e5eSwdenk		There are several other quantities that must also be
1733b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1734c609719bSwdenk
17356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1736b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
17376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
173811ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1739c609719bSwdenk
17408d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1741a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
17428d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
17438d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
17448d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1745b37c7e5eSwdenk
17465da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
17475da71efaSEric Millbrandt
17485da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
17495da71efaSEric Millbrandt		chips might think that the current transfer is still
17505da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
17515da71efaSEric Millbrandt		commands until the slave device responds.
17525da71efaSEric Millbrandt
1753b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1754b37c7e5eSwdenk
1755b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1756b37c7e5eSwdenk		then the following macros need to be defined (examples are
1757b37c7e5eSwdenk		from include/configs/lwmon.h):
1758c609719bSwdenk
1759c609719bSwdenk		I2C_INIT
1760c609719bSwdenk
1761b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1762c609719bSwdenk		controller or configure ports.
1763c609719bSwdenk
1764b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1765b37c7e5eSwdenk
1766c609719bSwdenk		I2C_PORT
1767c609719bSwdenk
1768c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1769c609719bSwdenk		assumes both bits are on the same port). Valid values
1770c609719bSwdenk		are 0..3 for ports A..D.
1771c609719bSwdenk
1772c609719bSwdenk		I2C_ACTIVE
1773c609719bSwdenk
1774c609719bSwdenk		The code necessary to make the I2C data line active
1775c609719bSwdenk		(driven).  If the data line is open collector, this
1776c609719bSwdenk		define can be null.
1777c609719bSwdenk
1778b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1779b37c7e5eSwdenk
1780c609719bSwdenk		I2C_TRISTATE
1781c609719bSwdenk
1782c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1783c609719bSwdenk		(inactive).  If the data line is open collector, this
1784c609719bSwdenk		define can be null.
1785c609719bSwdenk
1786b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1787b37c7e5eSwdenk
1788c609719bSwdenk		I2C_READ
1789c609719bSwdenk
1790c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1791c609719bSwdenk		FALSE if it is low.
1792c609719bSwdenk
1793b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1794b37c7e5eSwdenk
1795c609719bSwdenk		I2C_SDA(bit)
1796c609719bSwdenk
1797c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1798c609719bSwdenk		is FALSE, it clears it (low).
1799c609719bSwdenk
1800b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1801b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1802b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1803b37c7e5eSwdenk
1804c609719bSwdenk		I2C_SCL(bit)
1805c609719bSwdenk
1806c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1807c609719bSwdenk		is FALSE, it clears it (low).
1808c609719bSwdenk
1809b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1810b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1811b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1812b37c7e5eSwdenk
1813c609719bSwdenk		I2C_DELAY
1814c609719bSwdenk
1815c609719bSwdenk		This delay is invoked four times per clock cycle so this
1816c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1817b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1818b37c7e5eSwdenk		like:
1819b37c7e5eSwdenk
1820b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1821c609719bSwdenk
1822793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1823793b5726SMike Frysinger
1824793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1825793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1826793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1827793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1828793b5726SMike Frysinger
1829793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1830793b5726SMike Frysinger		the generic GPIO functions.
1831793b5726SMike Frysinger
18326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
183347cd00faSwdenk
183447cd00faSwdenk		When a board is reset during an i2c bus transfer
183547cd00faSwdenk		chips might think that the current transfer is still
183647cd00faSwdenk		in progress. On some boards it is possible to access
183747cd00faSwdenk		the i2c SCLK line directly, either by using the
183847cd00faSwdenk		processor pin as a GPIO or by having a second pin
183947cd00faSwdenk		connected to the bus. If this option is defined a
184047cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
184147cd00faSwdenk		is run early in the boot sequence.
184247cd00faSwdenk
184326a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
184426a33504SRichard Retanubun
184526a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
184626a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
184726a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
184826a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
184926a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
185026a33504SRichard Retanubun		controller provide such a method. It is called at the end of
185126a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
185226a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
185326a33504SRichard Retanubun
185417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
185517ea1177Swdenk
185617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
185717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
185817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
185917ea1177Swdenk
1860bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1861bb99ad6dSBen Warren
1862bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1863bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1864bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1865bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1866bb99ad6dSBen Warren
18676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1868bb99ad6dSBen Warren
1869bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
18700f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
18710f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
18720f89c54bSPeter Tyser		a 1D array of device addresses
1873bb99ad6dSBen Warren
1874bb99ad6dSBen Warren		e.g.
1875bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
18766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1877bb99ad6dSBen Warren
1878bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1879bb99ad6dSBen Warren
1880bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
18816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1882bb99ad6dSBen Warren
1883bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1884bb99ad6dSBen Warren
18856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1886be5e6181STimur Tabi
1887be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1888be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1889be5e6181STimur Tabi
18906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
18910dc018ecSStefan Roese
18920dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
18930dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
18940dc018ecSStefan Roese
18956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
18960dc018ecSStefan Roese
18970dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
18980dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
18990dc018ecSStefan Roese
19006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
19019ebbb54fSVictor Gallardo
19029ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
19039ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
19049ebbb54fSVictor Gallardo		specified DTT device.
19059ebbb54fSVictor Gallardo
1906be5e6181STimur Tabi		CONFIG_FSL_I2C
1907be5e6181STimur Tabi
1908be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
19097817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1910be5e6181STimur Tabi
191167b23a32SHeiko Schocher		CONFIG_I2C_MUX
191267b23a32SHeiko Schocher
191367b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
191467b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
191567b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
191667b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
191767b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
191867b23a32SHeiko Schocher		the muxes to activate this new "bus".
191967b23a32SHeiko Schocher
192067b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
192167b23a32SHeiko Schocher		feature!
192267b23a32SHeiko Schocher
192367b23a32SHeiko Schocher		Example:
192467b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
192567b23a32SHeiko Schocher			The First mux with address 70 and channel 6
192667b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
192767b23a32SHeiko Schocher
192867b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
192967b23a32SHeiko Schocher
193067b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
193167b23a32SHeiko Schocher		of I2C Busses with muxes:
193267b23a32SHeiko Schocher
193367b23a32SHeiko Schocher		=> i2c bus
193467b23a32SHeiko Schocher		Busses reached over muxes:
193567b23a32SHeiko Schocher		Bus ID: 2
193667b23a32SHeiko Schocher		  reached over Mux(es):
193767b23a32SHeiko Schocher		    pca9544a@70 ch: 4
193867b23a32SHeiko Schocher		Bus ID: 3
193967b23a32SHeiko Schocher		  reached over Mux(es):
194067b23a32SHeiko Schocher		    pca9544a@70 ch: 6
194167b23a32SHeiko Schocher		    pca9544a@71 ch: 4
194267b23a32SHeiko Schocher		=>
194367b23a32SHeiko Schocher
194467b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1945f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1946f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
194767b23a32SHeiko Schocher		the channel 4.
194867b23a32SHeiko Schocher
194967b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1950f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
195167b23a32SHeiko Schocher		the 2 muxes.
195267b23a32SHeiko Schocher
195367b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
195467b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
195567b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
195667b23a32SHeiko Schocher		to add this option to other architectures.
195767b23a32SHeiko Schocher
19582ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
19592ac6985aSAndrew Dyer
19602ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
19612ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
19622ac6985aSAndrew Dyer		between writing the address pointer and reading the
19632ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
19642ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
19652ac6985aSAndrew Dyer		devices can use either method, but some require one or
19662ac6985aSAndrew Dyer		the other.
1967be5e6181STimur Tabi
1968c609719bSwdenk- SPI Support:	CONFIG_SPI
1969c609719bSwdenk
1970c609719bSwdenk		Enables SPI driver (so far only tested with
1971c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1972c609719bSwdenk		D/As on the SACSng board)
1973c609719bSwdenk
19746639562eSYoshihiro Shimoda		CONFIG_SH_SPI
19756639562eSYoshihiro Shimoda
19766639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
19776639562eSYoshihiro Shimoda		only SH7757 is supported.
19786639562eSYoshihiro Shimoda
1979c609719bSwdenk		CONFIG_SPI_X
1980c609719bSwdenk
1981c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1982c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1983c609719bSwdenk
1984c609719bSwdenk		CONFIG_SOFT_SPI
1985c609719bSwdenk
1986c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1987c609719bSwdenk		using hardware support. This is a general purpose
1988c609719bSwdenk		driver that only requires three general I/O port pins
1989c609719bSwdenk		(two outputs, one input) to function. If this is
1990c609719bSwdenk		defined, the board configuration must define several
1991c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1992c609719bSwdenk		an example, see include/configs/sacsng.h.
1993c609719bSwdenk
199404a9e118SBen Warren		CONFIG_HARD_SPI
199504a9e118SBen Warren
199604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
199704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
199804a9e118SBen Warren		must define a list of chip-select function pointers.
199904a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
200004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
200104a9e118SBen Warren
200238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
200338254f45SGuennadi Liakhovetski
200438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
20052e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
200638254f45SGuennadi Liakhovetski
20070133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
20080133502eSMatthias Fuchs
20090133502eSMatthias Fuchs		Enables FPGA subsystem.
20100133502eSMatthias Fuchs
20110133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
20120133502eSMatthias Fuchs
20130133502eSMatthias Fuchs		Enables support for specific chip vendors.
20140133502eSMatthias Fuchs		(ALTERA, XILINX)
20150133502eSMatthias Fuchs
20160133502eSMatthias Fuchs		CONFIG_FPGA_<family>
20170133502eSMatthias Fuchs
20180133502eSMatthias Fuchs		Enables support for FPGA family.
20190133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
20200133502eSMatthias Fuchs
20210133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2022c609719bSwdenk
2023c609719bSwdenk		Specify the number of FPGA devices to support.
2024c609719bSwdenk
20256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2026c609719bSwdenk
2027c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2028c609719bSwdenk
20296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2030c609719bSwdenk
2031c609719bSwdenk		Enable checks on FPGA configuration interface busy
2032c609719bSwdenk		status by the configuration function. This option
2033c609719bSwdenk		will require a board or device specific function to
2034c609719bSwdenk		be written.
2035c609719bSwdenk
2036c609719bSwdenk		CONFIG_FPGA_DELAY
2037c609719bSwdenk
2038c609719bSwdenk		If defined, a function that provides delays in the FPGA
2039c609719bSwdenk		configuration driver.
2040c609719bSwdenk
20416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2042c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2043c609719bSwdenk
20446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2045c609719bSwdenk
2046c609719bSwdenk		Check for configuration errors during FPGA bitfile
2047c609719bSwdenk		loading. For example, abort during Virtex II
2048c609719bSwdenk		configuration if the INIT_B line goes low (which
2049c609719bSwdenk		indicated a CRC error).
2050c609719bSwdenk
20516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2052c609719bSwdenk
2053c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2054c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2055c609719bSwdenk		FPGA configuration sequence. The default time is 500
205611ccc33fSMarcel Ziswiler		ms.
2057c609719bSwdenk
20586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2059c609719bSwdenk
2060c609719bSwdenk		Maximum time to wait for BUSY to deassert during
206111ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2062c609719bSwdenk
20636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2064c609719bSwdenk
2065c609719bSwdenk		Time to wait after FPGA configuration. The default is
206611ccc33fSMarcel Ziswiler		200 ms.
2067c609719bSwdenk
2068c609719bSwdenk- Configuration Management:
2069c609719bSwdenk		CONFIG_IDENT_STRING
2070c609719bSwdenk
2071c609719bSwdenk		If defined, this string will be added to the U-Boot
2072c609719bSwdenk		version information (U_BOOT_VERSION)
2073c609719bSwdenk
2074c609719bSwdenk- Vendor Parameter Protection:
2075c609719bSwdenk
2076c609719bSwdenk		U-Boot considers the values of the environment
2077c609719bSwdenk		variables "serial#" (Board Serial Number) and
20787152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2079c609719bSwdenk		are set once by the board vendor / manufacturer, and
2080c609719bSwdenk		protects these variables from casual modification by
2081c609719bSwdenk		the user. Once set, these variables are read-only,
2082c609719bSwdenk		and write or delete attempts are rejected. You can
208311ccc33fSMarcel Ziswiler		change this behaviour:
2084c609719bSwdenk
2085c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2086c609719bSwdenk		file, the write protection for vendor parameters is
208747cd00faSwdenk		completely disabled. Anybody can change or delete
2088c609719bSwdenk		these parameters.
2089c609719bSwdenk
2090c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2091c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
209211ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2093c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2094c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2095c609719bSwdenk		read-only.]
2096c609719bSwdenk
2097c609719bSwdenk- Protected RAM:
2098c609719bSwdenk		CONFIG_PRAM
2099c609719bSwdenk
2100c609719bSwdenk		Define this variable to enable the reservation of
2101c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2102c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2103c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2104c609719bSwdenk		this default value by defining an environment
2105c609719bSwdenk		variable "pram" to the number of kB you want to
2106c609719bSwdenk		reserve. Note that the board info structure will
2107c609719bSwdenk		still show the full amount of RAM. If pRAM is
2108c609719bSwdenk		reserved, a new environment variable "mem" will
2109c609719bSwdenk		automatically be defined to hold the amount of
2110c609719bSwdenk		remaining RAM in a form that can be passed as boot
2111c609719bSwdenk		argument to Linux, for instance like that:
2112c609719bSwdenk
2113fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2114c609719bSwdenk			saveenv
2115c609719bSwdenk
2116c609719bSwdenk		This way you can tell Linux not to use this memory,
2117c609719bSwdenk		either, which results in a memory region that will
2118c609719bSwdenk		not be affected by reboots.
2119c609719bSwdenk
2120c609719bSwdenk		*WARNING* If your board configuration uses automatic
2121c609719bSwdenk		detection of the RAM size, you must make sure that
2122c609719bSwdenk		this memory test is non-destructive. So far, the
2123c609719bSwdenk		following board configurations are known to be
2124c609719bSwdenk		"pRAM-clean":
2125c609719bSwdenk
2126c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2127c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
2128544d97e9SWolfgang Denk			FLAGADM, TQM8260
2129c609719bSwdenk
2130c609719bSwdenk- Error Recovery:
2131c609719bSwdenk		CONFIG_PANIC_HANG
2132c609719bSwdenk
2133c609719bSwdenk		Define this variable to stop the system in case of a
2134c609719bSwdenk		fatal error, so that you have to reset it manually.
2135c609719bSwdenk		This is probably NOT a good idea for an embedded
213611ccc33fSMarcel Ziswiler		system where you want the system to reboot
2137c609719bSwdenk		automatically as fast as possible, but it may be
2138c609719bSwdenk		useful during development since you can try to debug
2139c609719bSwdenk		the conditions that lead to the situation.
2140c609719bSwdenk
2141c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2142c609719bSwdenk
2143c609719bSwdenk		This variable defines the number of retries for
2144c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2145c609719bSwdenk		before giving up the operation. If not defined, a
2146c609719bSwdenk		default value of 5 is used.
2147c609719bSwdenk
214840cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
214940cb90eeSGuennadi Liakhovetski
215040cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
215140cb90eeSGuennadi Liakhovetski
2152c609719bSwdenk- Command Interpreter:
21538078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
215404a85b3bSwdenk
215504a85b3bSwdenk		Enable auto completion of commands using TAB.
215604a85b3bSwdenk
21578078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
21588078f1a5SWolfgang Denk		for the "hush" shell.
21598078f1a5SWolfgang Denk
21608078f1a5SWolfgang Denk
21616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2162c609719bSwdenk
2163c609719bSwdenk		Define this variable to enable the "hush" shell (from
2164c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2165c609719bSwdenk		powerful command line syntax like
2166c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2167c609719bSwdenk		constructs ("shell scripts").
2168c609719bSwdenk
2169c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2170c609719bSwdenk		with a somewhat smaller memory footprint.
2171c609719bSwdenk
2172c609719bSwdenk
21736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2174c609719bSwdenk
2175c609719bSwdenk		This defines the secondary prompt string, which is
2176c609719bSwdenk		printed when the command interpreter needs more input
2177c609719bSwdenk		to complete a command. Usually "> ".
2178c609719bSwdenk
2179c609719bSwdenk	Note:
2180c609719bSwdenk
2181c609719bSwdenk		In the current implementation, the local variables
2182c609719bSwdenk		space and global environment variables space are
2183c609719bSwdenk		separated. Local variables are those you define by
21843b57fe0aSwdenk		simply typing `name=value'. To access a local
2185c609719bSwdenk		variable later on, you have write `$name' or
21863b57fe0aSwdenk		`${name}'; to execute the contents of a variable
21873b57fe0aSwdenk		directly type `$name' at the command prompt.
2188c609719bSwdenk
2189c609719bSwdenk		Global environment variables are those you use
2190c609719bSwdenk		setenv/printenv to work with. To run a command stored
2191c609719bSwdenk		in such a variable, you need to use the run command,
2192c609719bSwdenk		and you must not use the '$' sign to access them.
2193c609719bSwdenk
2194c609719bSwdenk		To store commands and special characters in a
2195c609719bSwdenk		variable, please use double quotation marks
2196c609719bSwdenk		surrounding the whole text of the variable, instead
2197c609719bSwdenk		of the backslashes before semicolons and special
2198c609719bSwdenk		symbols.
2199c609719bSwdenk
2200aa0c71acSWolfgang Denk- Commandline Editing and History:
2201aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2202aa0c71acSWolfgang Denk
220311ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2204aa0c71acSWolfgang Denk		commandline input operations
2205aa0c71acSWolfgang Denk
2206a8c7c708Swdenk- Default Environment:
2207c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2208c609719bSwdenk
2209c609719bSwdenk		Define this to contain any number of null terminated
2210c609719bSwdenk		strings (variable = value pairs) that will be part of
22117152b1d0Swdenk		the default environment compiled into the boot image.
22122262cfeeSwdenk
2213c609719bSwdenk		For example, place something like this in your
2214c609719bSwdenk		board's config file:
2215c609719bSwdenk
2216c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2217c609719bSwdenk			"myvar1=value1\0" \
2218c609719bSwdenk			"myvar2=value2\0"
2219c609719bSwdenk
2220c609719bSwdenk		Warning: This method is based on knowledge about the
2221c609719bSwdenk		internal format how the environment is stored by the
22222262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2223c609719bSwdenk		interface! Although it is unlikely that this format
22247152b1d0Swdenk		will change soon, there is no guarantee either.
2225c609719bSwdenk		You better know what you are doing here.
2226c609719bSwdenk
2227c609719bSwdenk		Note: overly (ab)use of the default environment is
2228c609719bSwdenk		discouraged. Make sure to check other ways to preset
222974de7aefSWolfgang Denk		the environment like the "source" command or the
2230c609719bSwdenk		boot command first.
2231c609719bSwdenk
2232a8c7c708Swdenk- DataFlash Support:
22332abbe075Swdenk		CONFIG_HAS_DATAFLASH
22342abbe075Swdenk
22352abbe075Swdenk		Defining this option enables DataFlash features and
22362abbe075Swdenk		allows to read/write in Dataflash via the standard
22372abbe075Swdenk		commands cp, md...
22382abbe075Swdenk
2239f61ec45eSEric Nelson- Serial Flash support
2240f61ec45eSEric Nelson		CONFIG_CMD_SF
2241f61ec45eSEric Nelson
2242f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2243f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2244f61ec45eSEric Nelson
2245f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2246f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2247f61ec45eSEric Nelson		commands.
2248f61ec45eSEric Nelson
2249f61ec45eSEric Nelson		The following defaults may be provided by the platform
2250f61ec45eSEric Nelson		to handle the common case when only a single serial
2251f61ec45eSEric Nelson		flash is present on the system.
2252f61ec45eSEric Nelson
2253f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2254f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2255f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2256f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2257f61ec45eSEric Nelson
22583f85ce27Swdenk- SystemACE Support:
22593f85ce27Swdenk		CONFIG_SYSTEMACE
22603f85ce27Swdenk
22613f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
22623f85ce27Swdenk		chips attached via some sort of local bus. The address
226311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
22646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
22653f85ce27Swdenk
22663f85ce27Swdenk		#define CONFIG_SYSTEMACE
22676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
22683f85ce27Swdenk
22693f85ce27Swdenk		When SystemACE support is added, the "ace" device type
22703f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
22713f85ce27Swdenk
2272ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2273ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2274ecb0ccd9SWolfgang Denk
227528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2276ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
227728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2278ecb0ccd9SWolfgang Denk		number generator is used.
2279ecb0ccd9SWolfgang Denk
228028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
228128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
228228cb9375SWolfgang Denk		defined, the normal port 69 is used.
228328cb9375SWolfgang Denk
228428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2285ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2286ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2287ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2288ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2289ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2290ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2291ecb0ccd9SWolfgang Denk
2292a8c7c708Swdenk- Show boot progress:
2293c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2294c609719bSwdenk
2295c609719bSwdenk		Defining this option allows to add some board-
2296c609719bSwdenk		specific code (calling a user-provided function
2297c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2298c609719bSwdenk		the system's boot progress on some display (for
2299c609719bSwdenk		example, some LED's) on your board. At the moment,
2300c609719bSwdenk		the following checkpoints are implemented:
2301c609719bSwdenk
23023a608ca0SSimon Glass- Detailed boot stage timing
23033a608ca0SSimon Glass		CONFIG_BOOTSTAGE
23043a608ca0SSimon Glass		Define this option to get detailed timing of each stage
23053a608ca0SSimon Glass		of the boot process.
23063a608ca0SSimon Glass
23073a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
23083a608ca0SSimon Glass		This is the number of available user bootstage records.
23093a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
23103a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
23113a608ca0SSimon Glass		the limit, recording will stop.
23123a608ca0SSimon Glass
23133a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
23143a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
23153a608ca0SSimon Glass
23163a608ca0SSimon Glass		Timer summary in microseconds:
23173a608ca0SSimon Glass		       Mark    Elapsed  Stage
23183a608ca0SSimon Glass			  0          0  reset
23193a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
23203a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
23213a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
23223a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
23233a608ca0SSimon Glass		  3,910,375    250,777  main_loop
23243a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
23253a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
23263a608ca0SSimon Glass
23271372cce2SMarian BalakowiczLegacy uImage format:
23281372cce2SMarian Balakowicz
2329c609719bSwdenk  Arg	Where			When
2330c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2331c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2332c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2333c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2334c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2335c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2336c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2337c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2338c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
23391372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2340c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2341c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2342c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2343c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
23441372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2345c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
23461372cce2SMarian Balakowicz
23471372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
23481372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
23491372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
23501372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
23511372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
23521372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
23531372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
235411ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
23551372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
23561372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
23571372cce2SMarian Balakowicz
2358ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2359c609719bSwdenk
2360a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
236163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
236263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
236363e73c9aSwdenk
2364566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2365566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2366566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2367566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2368566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2369566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2370566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2371566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2372566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2373566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2374566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2375566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2376566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2377566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2378566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2379566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2380566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2381566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2382566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2383566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2384566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2385566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2386566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2387566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2388566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2389566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2390566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2391566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2392566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2393566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2394566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2395566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2396566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2397566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2398566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2399566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2400566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2401566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2402566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2403566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2404566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2405566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2406566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2407566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2408566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2409566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2410566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2411c609719bSwdenk
2412566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2413c609719bSwdenk
2414566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2415566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2416566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2417206c60cbSwdenk
2418566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2419566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
242011ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2421566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2422566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2423566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
242474de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
242574de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2426566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2427c609719bSwdenk
24281372cce2SMarian BalakowiczFIT uImage format:
24291372cce2SMarian Balakowicz
24301372cce2SMarian Balakowicz  Arg	Where			When
24311372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
24321372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
24331372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
24341372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
24351372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
24361372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2437f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
24381372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
24391372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
24401372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
24411372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
24421372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
244311ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
244411ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
24451372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
24461372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
24471372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
24481372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
24491372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
24501372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
24511372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
24521372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
24531372cce2SMarian Balakowicz
24541372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
24551372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
24561372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
245711ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
24581372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
24591372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
24601372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
24611372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
24621372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
24631372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
24641372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
24651372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
24661372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
24671372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
24681372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
24691372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
24701372cce2SMarian Balakowicz
247111ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
24721372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
24731372cce2SMarian Balakowicz
247411ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
24751372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
24761372cce2SMarian Balakowicz
247711ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
24781372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
24791372cce2SMarian Balakowicz
24804cf2609bSWolfgang Denk- Standalone program support:
24814cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
24824cf2609bSWolfgang Denk
24836feff899SWolfgang Denk		This option defines a board specific value for the
24846feff899SWolfgang Denk		address where standalone program gets loaded, thus
24856feff899SWolfgang Denk		overwriting the architecture dependent default
24864cf2609bSWolfgang Denk		settings.
24874cf2609bSWolfgang Denk
24884cf2609bSWolfgang Denk- Frame Buffer Address:
24894cf2609bSWolfgang Denk		CONFIG_FB_ADDR
24904cf2609bSWolfgang Denk
24914cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
24924cf2609bSWolfgang Denk		address for frame buffer.
24934cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
24944cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
24956feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
24964cf2609bSWolfgang Denk
24974cf2609bSWolfgang Denk		Please see board_init_f function.
24984cf2609bSWolfgang Denk
2499cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2500cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2501cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2502cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2503cccfc2abSDetlev Zundel
2504cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2505cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2506cccfc2abSDetlev Zundel
2507cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2508cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2509cccfc2abSDetlev Zundel
2510cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2511cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2512cccfc2abSDetlev Zundel
2513cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2514cccfc2abSDetlev Zundel
2515cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2516cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2517cccfc2abSDetlev Zundel
25186a11cf48SDaniel Schwierzeck- SPL framework
25196a11cf48SDaniel Schwierzeck		CONFIG_SPL
25206a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
25216a11cf48SDaniel Schwierzeck
252295579793STom Rini		CONFIG_SPL_LDSCRIPT
252395579793STom Rini		LDSCRIPT for linking the SPL binary.
252495579793STom Rini
252595579793STom Rini		CONFIG_SPL_MAX_SIZE
252695579793STom Rini		Maximum binary size (text, data and rodata) of the SPL binary.
252795579793STom Rini
25286a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
25296a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
25306a11cf48SDaniel Schwierzeck
253195579793STom Rini		CONFIG_SPL_BSS_START_ADDR
253295579793STom Rini		Link address for the BSS within the SPL binary.
253395579793STom Rini
253495579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
253595579793STom Rini		Maximum binary size of the BSS section of the SPL binary.
253695579793STom Rini
253795579793STom Rini		CONFIG_SPL_STACK
253895579793STom Rini		Adress of the start of the stack SPL will use
253995579793STom Rini
254095579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
254195579793STom Rini		Starting address of the malloc pool used in SPL.
254295579793STom Rini
254395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
254495579793STom Rini		The size of the malloc pool used in SPL.
25456a11cf48SDaniel Schwierzeck
25466a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
25476a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
25486a11cf48SDaniel Schwierzeck
25496a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
25506a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
25516a11cf48SDaniel Schwierzeck
25526a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
25536a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
25546a11cf48SDaniel Schwierzeck
25556a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
25566a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
25576a11cf48SDaniel Schwierzeck
25586a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
25596a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
25606a11cf48SDaniel Schwierzeck
256195579793STom Rini		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
256295579793STom Rini		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
256395579793STom Rini		CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION
256495579793STom Rini		Address, size and partition on the MMC to load U-Boot from
256595579793STom Rini		when the MMC is being used in raw mode.
256695579793STom Rini
256795579793STom Rini		CONFIG_SPL_FAT_SUPPORT
256895579793STom Rini		Support for fs/fat/libfat.o in SPL binary
256995579793STom Rini
257095579793STom Rini		CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME
257195579793STom Rini		Filename to read to load U-Boot when reading from FAT
257295579793STom Rini
257395579793STom Rini		CONFIG_SPL_NAND_SIMPLE
257495579793STom Rini		Support for drivers/mtd/nand/libnand.o in SPL binary
257595579793STom Rini
257695579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
257795579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
257895579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
257995579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
258095579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
258195579793STom Rini		Defines the size and behavior of the NAND that SPL uses
258295579793STom Rini		to read U-Boot with CONFIG_SPL_NAND_SIMPLE
258395579793STom Rini
258495579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
258595579793STom Rini		Location in NAND for CONFIG_SPL_NAND_SIMPLE to read U-Boot
258695579793STom Rini		from.
258795579793STom Rini
258895579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
258995579793STom Rini		Location in memory for CONFIG_SPL_NAND_SIMPLE to load U-Boot
259095579793STom Rini		to.
259195579793STom Rini
259295579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
259395579793STom Rini		Define this if you need to first read the OOB and then the
259495579793STom Rini		data. This is used for example on davinci plattforms.
259595579793STom Rini
259695579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
259795579793STom Rini		Support for an OMAP3-specific set of functions to return the
259895579793STom Rini		ID and MFR of the first attached NAND chip, if present.
259995579793STom Rini
26006a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
26016a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
26026a11cf48SDaniel Schwierzeck
26036a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
26046a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
26056a11cf48SDaniel Schwierzeck
26066a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
26076a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
26086a11cf48SDaniel Schwierzeck
26096a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
26106a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
26111372cce2SMarian Balakowicz
2612c609719bSwdenkModem Support:
2613c609719bSwdenk--------------
2614c609719bSwdenk
2615566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2616c609719bSwdenk
261711ccc33fSMarcel Ziswiler- Modem support enable:
2618c609719bSwdenk		CONFIG_MODEM_SUPPORT
2619c609719bSwdenk
2620c609719bSwdenk- RTS/CTS Flow control enable:
2621c609719bSwdenk		CONFIG_HWFLOW
2622c609719bSwdenk
2623c609719bSwdenk- Modem debug support:
2624c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2625c609719bSwdenk
2626c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2627c609719bSwdenk		for modem support. Useful only with BDI2000.
2628c609719bSwdenk
2629a8c7c708Swdenk- Interrupt support (PPC):
2630a8c7c708Swdenk
2631a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2632a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
263311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2634a8c7c708Swdenk		should set decrementer_count to appropriate value. If
263511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2636a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
263711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2638a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2639a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2640a8c7c708Swdenk		general timer_interrupt().
2641a8c7c708Swdenk
2642c609719bSwdenk- General:
2643c609719bSwdenk
2644c609719bSwdenk		In the target system modem support is enabled when a
2645c609719bSwdenk		specific key (key combination) is pressed during
2646c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
264711ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2648c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2649c609719bSwdenk		function, returning 1 and thus enabling modem
2650c609719bSwdenk		initialization.
2651c609719bSwdenk
2652c609719bSwdenk		If there are no modem init strings in the
2653c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2654c609719bSwdenk		previous output (banner, info printfs) will be
265511ccc33fSMarcel Ziswiler		suppressed, though.
2656c609719bSwdenk
2657c609719bSwdenk		See also: doc/README.Modem
2658c609719bSwdenk
26599660e442SHelmut RaigerBoard initialization settings:
26609660e442SHelmut Raiger------------------------------
26619660e442SHelmut Raiger
26629660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
26639660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
26649660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
26659660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
26669660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
26679660e442SHelmut Raigertypically in board_init_f() and board_init_r().
26689660e442SHelmut Raiger
26699660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
26709660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
26719660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
26729660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2673c609719bSwdenk
2674c609719bSwdenkConfiguration Settings:
2675c609719bSwdenk-----------------------
2676c609719bSwdenk
26776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2678c609719bSwdenk		undefine this when you're short of memory.
2679c609719bSwdenk
26802fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
26812fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
26822fb2604dSPeter Tyser
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2684c609719bSwdenk		prompt for user input.
2685c609719bSwdenk
26866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2687c609719bSwdenk
26886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2689c609719bSwdenk
26906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2691c609719bSwdenk
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2693c609719bSwdenk		the application (usually a Linux kernel) when it is
2694c609719bSwdenk		booted
2695c609719bSwdenk
26966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2697c609719bSwdenk		List of legal baudrate settings for this board.
2698c609719bSwdenk
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2700c609719bSwdenk		Suppress display of console information at boot.
2701c609719bSwdenk
27026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2703c609719bSwdenk		If the board specific function
2704c609719bSwdenk			extern int overwrite_console (void);
2705c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2706c609719bSwdenk		serial port, else the settings in the environment are used.
2707c609719bSwdenk
27086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2709c609719bSwdenk		Enable the call to overwrite_console().
2710c609719bSwdenk
27116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2712c609719bSwdenk		Enable overwrite of previous console environment settings.
2713c609719bSwdenk
27146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2715c609719bSwdenk		Begin and End addresses of the area used by the
2716c609719bSwdenk		simple memory test.
2717c609719bSwdenk
27186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2719c609719bSwdenk		Enable an alternate, more extensive memory test.
2720c609719bSwdenk
27216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
27225f535fe1Swdenk		Scratch address used by the alternate memory test
27235f535fe1Swdenk		You only need to set this if address zero isn't writeable
27245f535fe1Swdenk
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
27266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
272714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
272811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
272914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
273014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
273114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
27325e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
273314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
27345e12e75dSStefan Roese		will have to get fixed in Linux additionally.
273514f73ca6SStefan Roese
273614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
273714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
273814f73ca6SStefan Roese		be touched.
273914f73ca6SStefan Roese
274014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
274114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
274214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
274314f73ca6SStefan Roese		non page size aligned address and this could cause major
274414f73ca6SStefan Roese		problems.
274514f73ca6SStefan Roese
27466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2747c609719bSwdenk		Default load address for network file downloads
2748c609719bSwdenk
27496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2750c609719bSwdenk		Enable temporary baudrate change while serial download
2751c609719bSwdenk
27526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2753c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2754c609719bSwdenk
27556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2756c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2757c609719bSwdenk		Cogent motherboard)
2758c609719bSwdenk
27596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2760c609719bSwdenk		Physical start address of Flash memory.
2761c609719bSwdenk
27626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2763c609719bSwdenk		Physical start address of boot monitor code (set by
2764c609719bSwdenk		make config files to be same as the text base address
276514d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
27666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2767c609719bSwdenk
27686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
27693b57fe0aSwdenk		Size of memory reserved for monitor code, used to
27703b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
27713b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
27723b57fe0aSwdenk		flash sector.
2773c609719bSwdenk
27746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2775c609719bSwdenk		Size of DRAM reserved for malloc() use.
2776c609719bSwdenk
27776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
277815940c9aSStefan Roese		Normally compressed uImages are limited to an
277915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
27806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
278115940c9aSStefan Roese		to adjust this setting to your needs.
2782c609719bSwdenk
27836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2784c609719bSwdenk		Maximum size of memory mapped by the startup code of
2785c609719bSwdenk		the Linux kernel; all data that must be processed by
27867d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
27877d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
27887d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
27897d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2790c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2791c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2792c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2793c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2794c609719bSwdenk
2795fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2796fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2797fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2798fca43cc8SJohn Rigby		is enabled.
2799fca43cc8SJohn Rigby
2800fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2801fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2802fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2803fca43cc8SJohn Rigby
2804fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2805fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2806fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2807fca43cc8SJohn Rigby
28086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2809c609719bSwdenk		Max number of Flash memory banks
2810c609719bSwdenk
28116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2812c609719bSwdenk		Max number of sectors on a Flash chip
2813c609719bSwdenk
28146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2815c609719bSwdenk		Timeout for Flash erase operations (in ms)
2816c609719bSwdenk
28176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2818c609719bSwdenk		Timeout for Flash write operations (in ms)
2819c609719bSwdenk
28206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
28218564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
28228564acf9Swdenk
28236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
28248564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
28258564acf9Swdenk
28266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
28278564acf9Swdenk		If defined, hardware flash sectors protection is used
28288564acf9Swdenk		instead of U-Boot software protection.
28298564acf9Swdenk
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2831c609719bSwdenk
2832c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2833c609719bSwdenk		without this option such a download has to be
2834c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2835c609719bSwdenk		copy from RAM to flash.
2836c609719bSwdenk
2837c609719bSwdenk		The two-step approach is usually more reliable, since
2838c609719bSwdenk		you can check if the download worked before you erase
283911ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
284011ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2841c609719bSwdenk		downloaded image) this option may be very useful.
2842c609719bSwdenk
28436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2844c609719bSwdenk		Define if the flash driver uses extra elements in the
28455653fc33Swdenk		common flash structure for storing flash geometry.
28465653fc33Swdenk
284700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
28485653fc33Swdenk		This option also enables the building of the cfi_flash driver
28495653fc33Swdenk		in the drivers directory
285053cf9435Sstroese
285191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
285291809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
285391809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
285491809ed5SPiotr Ziecik		to the MTD layer.
285591809ed5SPiotr Ziecik
28566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
285796ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
285896ef831fSGuennadi Liakhovetski
285996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
286096ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
286196ef831fSGuennadi Liakhovetski		write commands.
286296ef831fSGuennadi Liakhovetski
28636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
28645568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
28655568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
28665568e613SStefan Roese		is useful, if some of the configured banks are only
28675568e613SStefan Roese		optionally available.
28685568e613SStefan Roese
28699a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
28709a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
28719a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
28729a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
28739a042e9cSJerry Van Baren
28746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
287511ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
287611ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
287753cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
287853cf9435Sstroese		buffers can be full shortly after enabling the interface
287911ccc33fSMarcel Ziswiler		on high Ethernet traffic.
288053cf9435Sstroese		Defaults to 4 if not defined.
2881c609719bSwdenk
2882ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2883ea882bafSWolfgang Denk
2884ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2885ea882bafSWolfgang Denk	internally to store the environment settings. The default
2886ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2887ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2888ea882bafSWolfgang Denk	lib/hashtable.c for details.
2889ea882bafSWolfgang Denk
2890c609719bSwdenkThe following definitions that deal with the placement and management
2891c609719bSwdenkof environment data (variable area); in general, we support the
2892c609719bSwdenkfollowing configurations:
2893c609719bSwdenk
2894c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2895c3eb3fe4SMike Frysinger
2896c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2897c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2898c3eb3fe4SMike Frysinger
28995a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2900c609719bSwdenk
2901c609719bSwdenk	Define this if the environment is in flash memory.
2902c609719bSwdenk
2903c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2904c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2905c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2906c609719bSwdenk	   sector" type flash chips, which have several smaller
2907c609719bSwdenk	   sectors at the start or the end. For instance, such a
2908c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2909c609719bSwdenk	   such a case you would place the environment in one of the
2910c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2911c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2912c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2913c609719bSwdenk	   between U-Boot and the environment.
2914c609719bSwdenk
29150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2916c609719bSwdenk
2917c609719bSwdenk	   Offset of environment data (variable area) to the
2918c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2919c609719bSwdenk	   type flash chips the second sector can be used: the offset
2920c609719bSwdenk	   for this sector is given here.
2921c609719bSwdenk
29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2923c609719bSwdenk
29240e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2925c609719bSwdenk
2926c609719bSwdenk	   This is just another way to specify the start address of
2927c609719bSwdenk	   the flash sector containing the environment (instead of
29280e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2929c609719bSwdenk
29300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2931c609719bSwdenk
2932c609719bSwdenk	   Size of the sector containing the environment.
2933c609719bSwdenk
2934c609719bSwdenk
2935c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2936c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2937c609719bSwdenk	   the environment.
2938c609719bSwdenk
29390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2940c609719bSwdenk
29415a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
29420e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2943c609719bSwdenk	   of this flash sector for the environment. This saves
2944c609719bSwdenk	   memory for the RAM copy of the environment.
2945c609719bSwdenk
2946c609719bSwdenk	   It may also save flash memory if you decide to use this
2947c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2948c609719bSwdenk	   since then the remainder of the flash sector could be used
2949c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2950c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2951c609719bSwdenk	   updating the environment in flash makes it always
2952c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2953c609719bSwdenk	   wrong before the contents has been restored from a copy in
2954c609719bSwdenk	   RAM, your target system will be dead.
2955c609719bSwdenk
29560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
29570e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2958c609719bSwdenk
2959c609719bSwdenk	   These settings describe a second storage area used to hold
296011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
29613e38691eSwdenk	   a valid backup copy in case there is a power failure during
2962c609719bSwdenk	   a "saveenv" operation.
2963c609719bSwdenk
2964c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2965c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2966c609719bSwdenkaccordingly!
2967c609719bSwdenk
2968c609719bSwdenk
29699314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2970c609719bSwdenk
2971c609719bSwdenk	Define this if you have some non-volatile memory device
2972c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2973c609719bSwdenk	environment.
2974c609719bSwdenk
29750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
29760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2977c609719bSwdenk
297811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2979c609719bSwdenk	  want to use for environment. It is assumed that this memory
2980c609719bSwdenk	  can just be read and written to, without any special
2981c609719bSwdenk	  provision.
2982c609719bSwdenk
2983c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2984c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
298511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2986c609719bSwdenkU-Boot will hang.
2987c609719bSwdenk
2988c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2989c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2990c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2991c609719bSwdenkto save the current settings.
2992c609719bSwdenk
2993c609719bSwdenk
2994bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2995c609719bSwdenk
2996c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2997c609719bSwdenk	device and a driver for it.
2998c609719bSwdenk
29990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30000e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3001c609719bSwdenk
3002c609719bSwdenk	  These two #defines specify the offset and size of the
3003c609719bSwdenk	  environment area within the total memory of your EEPROM.
3004c609719bSwdenk
30056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3006c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3007c609719bSwdenk	  The default address is zero.
3008c609719bSwdenk
30096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3010c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3011c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3012c609719bSwdenk	  would require six bits.
3013c609719bSwdenk
30146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3015c609719bSwdenk	  If defined, the number of milliseconds to delay between
3016c609719bSwdenk	  page writes.	The default is zero milliseconds.
3017c609719bSwdenk
30186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3019c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3020c609719bSwdenk	  that this is NOT the chip address length!
3021c609719bSwdenk
30226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
30235cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
30245cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
30255cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
30265cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
30275cf91d6bSwdenk	  byte chips.
30285cf91d6bSwdenk
30295cf91d6bSwdenk	  Note that we consider the length of the address field to
30305cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
30315cf91d6bSwdenk	  in the chip address.
30325cf91d6bSwdenk
30336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3034c609719bSwdenk	  The size in bytes of the EEPROM device.
3035c609719bSwdenk
3036548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3037548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3038548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3039548738b4SHeiko Schocher
3040548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3041548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3042548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3043548738b4SHeiko Schocher	  EEPROM. For example:
3044548738b4SHeiko Schocher
3045548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
3046548738b4SHeiko Schocher
3047548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3048548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3049c609719bSwdenk
3050057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
30515779d8d9Swdenk
30525779d8d9Swdenk	Define this if you have a DataFlash memory device which you
30535779d8d9Swdenk	want to use for the environment.
30545779d8d9Swdenk
30550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
30570e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
30585779d8d9Swdenk
30595779d8d9Swdenk	  These three #defines specify the offset and size of the
30605779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
30615779d8d9Swdenk	  at the specified address.
30625779d8d9Swdenk
30630a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
30640a85a9e7SLiu Gang
30650a85a9e7SLiu Gang	Define this if you have a remote memory space which you
30660a85a9e7SLiu Gang	want to use for the local device's environment.
30670a85a9e7SLiu Gang
30680a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
30690a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
30700a85a9e7SLiu Gang
30710a85a9e7SLiu Gang	  These two #defines specify the address and size of the
30720a85a9e7SLiu Gang	  environment area within the remote memory space. The
30730a85a9e7SLiu Gang	  local device can get the environment from remote memory
30740a85a9e7SLiu Gang	  space by SRIO or other links.
30750a85a9e7SLiu Gang
30760a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
30770a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
30780a85a9e7SLiu Gangenvironment stored in a remote NOR flash by SRIO link, but it can
30790a85a9e7SLiu Gangnot erase, write this NOR flash by SRIO interface.
30800a85a9e7SLiu Gang
308151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
308213a5695bSwdenk
308313a5695bSwdenk	Define this if you have a NAND device which you want to use
308413a5695bSwdenk	for the environment.
308513a5695bSwdenk
30860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
30870e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
308813a5695bSwdenk
308913a5695bSwdenk	  These two #defines specify the offset and size of the environment
3090fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3091fdd813deSScott Wood	  aligned to an erase block boundary.
30925779d8d9Swdenk
3093fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3094e443c944SMarkus Klotzbuecher
30950e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3096fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3097fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
3098fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
3099fdd813deSScott Wood	  aligned to an erase block boundary.
3100e443c944SMarkus Klotzbuecher
3101fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3102fdd813deSScott Wood
3103fdd813deSScott Wood	  Specifies the length of the region in which the environment
3104fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3105fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3106fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3107fdd813deSScott Wood	  the range to be avoided.
3108fdd813deSScott Wood
3109fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3110fdd813deSScott Wood
3111fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3112fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3113fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3114fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3115fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3116e443c944SMarkus Klotzbuecher
3117b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3118b74ab737SGuennadi Liakhovetski
3119b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3120b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3121b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3122b74ab737SGuennadi Liakhovetski
31236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3124c609719bSwdenk
3125c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3126c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3127c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3128c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3129c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3130c609719bSwdenk	to be a good choice since it makes it far enough from the
3131c609719bSwdenk	start of the data area as well as from the stack pointer.
3132c609719bSwdenk
3133e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3134c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3135cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3136c609719bSwdenkuntil then to read environment variables.
3137c609719bSwdenk
313885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
313985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
314085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
314185ec0bccSwdenknecessary, because the first environment variable we need is the
314285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
314385ec0bccSwdenkhave any device yet where we could complain.]
3144c609719bSwdenk
3145c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3146c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
314785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3148c609719bSwdenk
31496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3150fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3151fc3e2165Swdenk
31526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3153fc3e2165Swdenk		      also needs to be defined.
3154fc3e2165Swdenk
31556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3156fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3157c609719bSwdenk
3158f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3159f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3160f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3161f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3162f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3163f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3164f5675aa5SRon Madrid
3165c609719bSwdenkLow Level (hardware related) configuration options:
3166dc7c9a1aSwdenk---------------------------------------------------
3167c609719bSwdenk
31686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3169c609719bSwdenk		Cache Line Size of the CPU.
3170c609719bSwdenk
31716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3172c609719bSwdenk		Default address of the IMMR after system reset.
31732535d602Swdenk
31742535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
31752535d602Swdenk		and RPXsuper) to be able to adjust the position of
31762535d602Swdenk		the IMMR register after a reset.
3177c609719bSwdenk
3178e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3179e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3180e46fedfeSTimur Tabi		PowerPC SOCs.
3181e46fedfeSTimur Tabi
3182e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3183e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3184e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3185e46fedfeSTimur Tabi
3186e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3187e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3188e46fedfeSTimur Tabi
3189e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3190e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3191e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3192e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3193e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3194e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3195e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3196e46fedfeSTimur Tabi
3197e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3198e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3199e46fedfeSTimur Tabi
3200e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3201e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3202e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3203e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3204e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3205e46fedfeSTimur Tabi
3206e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3207e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3208e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3209e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3210e46fedfeSTimur Tabi
3211e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3212e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3213e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3214e46fedfeSTimur Tabi
32157f6c2cbcSwdenk- Floppy Disk Support:
32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
32177f6c2cbcSwdenk
32187f6c2cbcSwdenk		the default drive number (default value 0)
32197f6c2cbcSwdenk
32206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
32217f6c2cbcSwdenk
322211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
32237f6c2cbcSwdenk		(default value 1)
32247f6c2cbcSwdenk
32256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
32267f6c2cbcSwdenk
32277f6c2cbcSwdenk		defines the offset of register from address. It
32287f6c2cbcSwdenk		depends on which part of the data bus is connected to
322911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
32307f6c2cbcSwdenk
32316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
32326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
32337f6c2cbcSwdenk		default value.
32347f6c2cbcSwdenk
32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
32367f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
32377f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
32387f6c2cbcSwdenk		source code. It is used to make hardware dependant
32397f6c2cbcSwdenk		initializations.
32407f6c2cbcSwdenk
32410abddf82SMacpaul Lin- CONFIG_IDE_AHB:
32420abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
32430abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
32440abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
32450abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
32460abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
32470abddf82SMacpaul Lin		is requierd.
32480abddf82SMacpaul Lin
32496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
325025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
325125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3252c609719bSwdenk
32536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3254c609719bSwdenk
32557152b1d0Swdenk		Start address of memory area that can be used for
3256c609719bSwdenk		initial data and stack; please note that this must be
3257c609719bSwdenk		writable memory that is working WITHOUT special
3258c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3259c609719bSwdenk		will become available only after programming the
3260c609719bSwdenk		memory controller and running certain initialization
3261c609719bSwdenk		sequences.
3262c609719bSwdenk
3263c609719bSwdenk		U-Boot uses the following memory types:
3264c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3265c609719bSwdenk		- MPC824X: data cache
3266c609719bSwdenk		- PPC4xx:  data cache
3267c609719bSwdenk
32686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3269c609719bSwdenk
3270c609719bSwdenk		Offset of the initial data structure in the memory
32716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
32726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3273c609719bSwdenk		data is located at the end of the available space
3274553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
32756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
32766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
32776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3278c609719bSwdenk
3279c609719bSwdenk	Note:
3280c609719bSwdenk		On the MPC824X (or other systems that use the data
3281c609719bSwdenk		cache for initial memory) the address chosen for
32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3283c609719bSwdenk		point to an otherwise UNUSED address space between
3284c609719bSwdenk		the top of RAM and the start of the PCI space.
3285c609719bSwdenk
32866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3287c609719bSwdenk
32886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3289c609719bSwdenk
32906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3291c609719bSwdenk
32926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3293c609719bSwdenk
32946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3295c609719bSwdenk
32966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3297c609719bSwdenk
32986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3299c609719bSwdenk		SDRAM timing
3300c609719bSwdenk
33016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3302c609719bSwdenk		periodic timer for refresh
3303c609719bSwdenk
33046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3305c609719bSwdenk
33066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
33076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
33096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3310c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3311c609719bSwdenk
3312c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
33136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
33146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3315c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3316c609719bSwdenk
33176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
33186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3319c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3320c609719bSwdenk		Prescaler definitions (SDRAM timing)
3321c609719bSwdenk
33226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3323c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3324c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3325c609719bSwdenk
33266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3327b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3328b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3329b423d055SHeiko Schocher
33306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3331c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3332c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3333c609719bSwdenk
33346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3335c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3336c609719bSwdenk		wrong setting might damage your board. Read
3337c609719bSwdenk		doc/README.MBX before setting this variable!
3338c609719bSwdenk
33396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3340ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3341ea909b76Swdenk		(Power On Self Tests). This definition overrides
3342ea909b76Swdenk		#define'd default value in commproc.h resp.
3343ea909b76Swdenk		cpm_8260.h.
3344ea909b76Swdenk
33456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
33466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
33486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
33496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
33516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
33526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3353a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
33545d232d0eSwdenk
33559cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
33569cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
33579cacf4fcSDirk Eibach		required.
33589cacf4fcSDirk Eibach
3359a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3360a09b9b68SKumar Gala		Chip has SRIO or not
3361a09b9b68SKumar Gala
3362a09b9b68SKumar Gala- CONFIG_SRIO1:
3363a09b9b68SKumar Gala		Board has SRIO 1 port available
3364a09b9b68SKumar Gala
3365a09b9b68SKumar Gala- CONFIG_SRIO2:
3366a09b9b68SKumar Gala		Board has SRIO 2 port available
3367a09b9b68SKumar Gala
3368a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3369a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3370a09b9b68SKumar Gala
3371a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3372a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3373a09b9b68SKumar Gala
3374a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3375a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3376a09b9b68SKumar Gala
3377eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3378eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3379eced4626SAlex Waterman		16 bit bus.
3380eced4626SAlex Waterman
3381eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3382eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3383eced4626SAlex Waterman		a default value will be used.
3384eced4626SAlex Waterman
3385bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3386218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3387218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3388218ca724SWolfgang Denk
3389bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3390bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3391bb99ad6dSBen Warren
33926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3393218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3394218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3395218ca724SWolfgang Denk		to something your driver can deal with.
3396bb99ad6dSBen Warren
33971b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
33981b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
33991b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
34001b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
34011b3e3c4fSYork Sun		header files or board specific files.
34021b3e3c4fSYork Sun
34036f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
34046f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
34056f5e1dc5SYork Sun
34066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3407218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3408218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
34092ad6b513STimur Tabi
3410c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3411c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3412c26e454dSwdenk
3413c26e454dSwdenk- CONFIG_FEC[12]_PHY
3414c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
34156e592385Swdenk		to the given FEC; i. e.
3416c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3417c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3418c26e454dSwdenk
3419c26e454dSwdenk		When set to -1, means to probe for first available.
3420c26e454dSwdenk
3421c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3422c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3423c26e454dSwdenk		(so program the FEC to ignore it).
3424c26e454dSwdenk
3425c26e454dSwdenk- CONFIG_RMII
3426c26e454dSwdenk		Enable RMII mode for all FECs.
3427c26e454dSwdenk		Note that this is a global option, we can't
3428c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3429c26e454dSwdenk
34305cf91d6bSwdenk- CONFIG_CRC32_VERIFY
34315cf91d6bSwdenk		Add a verify option to the crc32 command.
34325cf91d6bSwdenk		The syntax is:
34335cf91d6bSwdenk
34345cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
34355cf91d6bSwdenk
34365cf91d6bSwdenk		Where address/count indicate a memory area
34375cf91d6bSwdenk		and crc32 is the correct crc32 which the
34385cf91d6bSwdenk		area should have.
34395cf91d6bSwdenk
344056523f12Swdenk- CONFIG_LOOPW
344156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3442602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
344356523f12Swdenk
34447b466641Sstroese- CONFIG_MX_CYCLIC
34457b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
34467b466641Sstroese		"md/mw" commands.
34477b466641Sstroese		Examples:
34487b466641Sstroese
34497b466641Sstroese		=> mdc.b 10 4 500
34507b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
34517b466641Sstroese
34527b466641Sstroese		=> mwc.l 100 12345678 10
34537b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
34547b466641Sstroese
34557b466641Sstroese		This only takes effect if the memory commands are activated
3456602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
34577b466641Sstroese
34588aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3459afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3460e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3461e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3462e03f3169SWolfgang Denk		relocate itself into RAM.
34638aa1a2d1Swdenk
3464e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3465e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3466e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3467e03f3169SWolfgang Denk		these initializations itself.
34688aa1a2d1Swdenk
3469401bb30bSAneesh V- CONFIG_SPL_BUILD
3470df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3471df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3472df81238bSMagnus Lilja		compiling a NAND SPL.
3473400558b5Swdenk
3474d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3475d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3476d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3477d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3478d8834a13SMatthias Weisser		conditions but may increase the binary size.
3479d8834a13SMatthias Weisser
3480f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3481f2717b47STimur Tabi-----------------------------------
3482f2717b47STimur Tabi
3483f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3484f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3485f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3486f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3487f2717b47STimur Tabiwithin that device.
3488f2717b47STimur Tabi
3489f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3490f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3491f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3492f2717b47STimur Tabi	is also specified.
3493f2717b47STimur Tabi
3494f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3495f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3496f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3497f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3498f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3499f2717b47STimur Tabi
3500f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3501f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3502f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3503f2717b47STimur Tabi	virtual address in NOR flash.
3504f2717b47STimur Tabi
3505f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3506f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3507f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3508f2717b47STimur Tabi
3509f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3510f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3511f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3512f2717b47STimur Tabi
3513f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3514f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3515f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3516f2717b47STimur Tabi
3517292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
3518292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
3519292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
3520292dc6c5SLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO outbound window
3521292dc6c5SLiu Gang	->master inbound window->master LAW->the ucode address in master's
3522292dc6c5SLiu Gang	NOR flash.
3523f2717b47STimur Tabi
3524c609719bSwdenkBuilding the Software:
3525c609719bSwdenk======================
3526c609719bSwdenk
3527218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3528218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3529218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3530218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3531218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3532218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3533c609719bSwdenk
3534218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3535218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3536218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3537218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3538218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3539c609719bSwdenk
3540218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3541218ca724SWolfgang Denk	$ export CROSS_COMPILE
3542c609719bSwdenk
35432f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
35442f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
35452f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
35462f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
35472f8d396bSPeter Tyser
35482f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
35492f8d396bSPeter Tyser
35502f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
35512f8d396bSPeter Tyser      be executed on computers running Windows.
35522f8d396bSPeter Tyser
3553c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3554c609719bSwdenksources you must configure U-Boot for one specific board type. This
3555c609719bSwdenkis done by typing:
3556c609719bSwdenk
3557c609719bSwdenk	make NAME_config
3558c609719bSwdenk
3559218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
35604d675ae6SMichael Jonesrations; see boards.cfg for supported names.
356154387ac9Swdenk
3562c609719bSwdenkNote: for some board special configuration names may exist; check if
3563c609719bSwdenk      additional information is available from the board vendor; for
35642729af9dSwdenk      instance, the TQM823L systems are available without (standard)
35652729af9dSwdenk      or with LCD support. You can select such additional "features"
356611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3567c609719bSwdenk
35682729af9dSwdenk      make TQM823L_config
35692729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3570c609719bSwdenk
3571c609719bSwdenk      make TQM823L_LCD_config
3572c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3573c609719bSwdenk
3574c609719bSwdenk      etc.
3575c609719bSwdenk
3576c609719bSwdenk
3577c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
35787152b1d0Swdenkimages ready for download to / installation on your system:
3579c609719bSwdenk
3580c609719bSwdenk- "u-boot.bin" is a raw binary image
3581c609719bSwdenk- "u-boot" is an image in ELF binary format
3582c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3583c609719bSwdenk
3584baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3585baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3586baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3587baf31249SMarian Balakowicz
3588baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3589baf31249SMarian Balakowicz
3590baf31249SMarian Balakowicz	make O=/tmp/build distclean
3591baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3592baf31249SMarian Balakowicz	make O=/tmp/build all
3593baf31249SMarian Balakowicz
3594baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3595baf31249SMarian Balakowicz
3596baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3597baf31249SMarian Balakowicz	make distclean
3598baf31249SMarian Balakowicz	make NAME_config
3599baf31249SMarian Balakowicz	make all
3600baf31249SMarian Balakowicz
3601baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3602baf31249SMarian Balakowiczvariable.
3603baf31249SMarian Balakowicz
3604c609719bSwdenk
3605c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3606c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3607c609719bSwdenknative "make".
3608c609719bSwdenk
3609c609719bSwdenk
3610c609719bSwdenkIf the system board that you have is not listed, then you will need
3611c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3612c609719bSwdenksteps:
3613c609719bSwdenk
3614c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
36154d675ae6SMichael Jones    "boards.cfg" file, using the existing entries as examples.
36164d675ae6SMichael Jones    Follow the instructions there to keep the boards in order.
3617c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
361885ec0bccSwdenk    files you need. In your board directory, you will need at least
361985ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
362085ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
362185ec0bccSwdenk    your board
3622c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3623c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
362485ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3625c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3626c609719bSwdenk    to be installed on your target system.
362785ec0bccSwdenk6.  Debug and solve any problems that might arise.
3628c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3629c609719bSwdenk
3630c609719bSwdenk
3631c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3632c609719bSwdenk==============================================================
3633c609719bSwdenk
3634c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3635c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3636c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3637c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3638218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3639c609719bSwdenk
3640c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3641c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3642c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3643c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3644c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
36457152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3646218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3647218ca724SWolfgang Denkyou can type
3648c609719bSwdenk
3649c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3650c609719bSwdenk
3651c609719bSwdenkor to build on a native PowerPC system you can type
3652c609719bSwdenk
3653c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3654c609719bSwdenk
3655218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3656218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3657218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3658218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3659218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3660218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3661218ca724SWolfgang Denkvariable. For example:
3662baf31249SMarian Balakowicz
3663baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3664baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3665baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3666baf31249SMarian Balakowicz
3667218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3668218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3669218ca724SWolfgang Denkduring the whole build process.
3670baf31249SMarian Balakowicz
3671baf31249SMarian Balakowicz
3672c609719bSwdenkSee also "U-Boot Porting Guide" below.
3673c609719bSwdenk
3674c609719bSwdenk
3675c609719bSwdenkMonitor Commands - Overview:
3676c609719bSwdenk============================
3677c609719bSwdenk
3678c609719bSwdenkgo	- start application at address 'addr'
3679c609719bSwdenkrun	- run commands in an environment variable
3680c609719bSwdenkbootm	- boot application image from memory
3681c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
368244f074c7SMarek Vasutbootz   - boot zImage from memory
3683c609719bSwdenktftpboot- boot image via network using TFTP protocol
3684c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3685c609719bSwdenk	       (and eventually "gatewayip")
36861fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3687c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3688c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3689c609719bSwdenkloads	- load S-Record file over serial line
3690c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3691c609719bSwdenkmd	- memory display
3692c609719bSwdenkmm	- memory modify (auto-incrementing)
3693c609719bSwdenknm	- memory modify (constant address)
3694c609719bSwdenkmw	- memory write (fill)
3695c609719bSwdenkcp	- memory copy
3696c609719bSwdenkcmp	- memory compare
3697c609719bSwdenkcrc32	- checksum calculation
36980f89c54bSPeter Tyseri2c	- I2C sub-system
3699c609719bSwdenksspi	- SPI utility commands
3700c609719bSwdenkbase	- print or set address offset
3701c609719bSwdenkprintenv- print environment variables
3702c609719bSwdenksetenv	- set environment variables
3703c609719bSwdenksaveenv - save environment variables to persistent storage
3704c609719bSwdenkprotect - enable or disable FLASH write protection
3705c609719bSwdenkerase	- erase FLASH memory
3706c609719bSwdenkflinfo	- print FLASH memory information
3707c609719bSwdenkbdinfo	- print Board Info structure
3708c609719bSwdenkiminfo	- print header information for application image
3709c609719bSwdenkconinfo - print console devices and informations
3710c609719bSwdenkide	- IDE sub-system
3711c609719bSwdenkloop	- infinite loop on address range
371256523f12Swdenkloopw	- infinite write loop on address range
3713c609719bSwdenkmtest	- simple RAM test
3714c609719bSwdenkicache	- enable or disable instruction cache
3715c609719bSwdenkdcache	- enable or disable data cache
3716c609719bSwdenkreset	- Perform RESET of the CPU
3717c609719bSwdenkecho	- echo args to console
3718c609719bSwdenkversion - print monitor version
3719c609719bSwdenkhelp	- print online help
3720c609719bSwdenk?	- alias for 'help'
3721c609719bSwdenk
3722c609719bSwdenk
3723c609719bSwdenkMonitor Commands - Detailed Description:
3724c609719bSwdenk========================================
3725c609719bSwdenk
3726c609719bSwdenkTODO.
3727c609719bSwdenk
3728c609719bSwdenkFor now: just type "help <command>".
3729c609719bSwdenk
3730c609719bSwdenk
3731c609719bSwdenkEnvironment Variables:
3732c609719bSwdenk======================
3733c609719bSwdenk
3734c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3735c609719bSwdenkcan be made persistent by saving to Flash memory.
3736c609719bSwdenk
3737c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3738c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3739c609719bSwdenkwithout a value can be used to delete a variable from the
3740c609719bSwdenkenvironment. As long as you don't save the environment you are
3741c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3742c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3743c609719bSwdenk
3744c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3745c96f86eeSWolfgang Denk
3746c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3747c609719bSwdenk
3748c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3749c609719bSwdenk
3750c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3751c609719bSwdenk
3752c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3753c609719bSwdenk
3754c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3755c609719bSwdenk
3756c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3757c609719bSwdenk
37587d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
37597d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
37607d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
37617d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
37627d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
37637d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3764c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3765c3624e6eSGrant Likely		  bootm_mapsize.
3766c3624e6eSGrant Likely
3767c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3768c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3769c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3770c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3771c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3772c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3773c3624e6eSGrant Likely		  used otherwise.
37747d721e34SBartlomiej Sieka
37757d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
37767d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
37777d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
37787d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
37797d721e34SBartlomiej Sieka		  environment variable.
37807d721e34SBartlomiej Sieka
37814bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
37824bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
37834bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
37844bae9090SBartlomiej Sieka
3785c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3786c609719bSwdenk		  "bootp" will just load perform a lookup of the
3787c609719bSwdenk		  configuration from the BOOTP server, but not try to
3788c609719bSwdenk		  load any image using TFTP
3789c609719bSwdenk
3790c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3791c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3792c609719bSwdenk		  be automatically started (by internally calling
3793c609719bSwdenk		  "bootm")
3794c609719bSwdenk
37954a6fd34bSwdenk		  If set to "no", a standalone image passed to the
37964a6fd34bSwdenk		  "bootm" command will be copied to the load address
37974a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
37984a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
37994a6fd34bSwdenk		  data.
38004a6fd34bSwdenk
3801a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3802a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3803fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3804fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3805fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3806fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3807fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3808fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3809fa34f6b2SShawn Guo		  access it during the boot procedure.
3810fa34f6b2SShawn Guo
3811a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3812a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3813a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3814a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3815a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3816a28afca5SDavid A. Long		  must be accessible by the kernel.
3817a28afca5SDavid A. Long
3818eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3819eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3820eea63e05SSimon Glass		  defined.
3821eea63e05SSimon Glass
382217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
382317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
382417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
382517ea1177Swdenk		  initialization code. So, for changes to be effective
382617ea1177Swdenk		  it must be saved and board must be reset.
382717ea1177Swdenk
3828c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3829c609719bSwdenk		  If this variable is not set, initrd images will be
3830c609719bSwdenk		  copied to the highest possible address in RAM; this
3831c609719bSwdenk		  is usually what you want since it allows for
3832c609719bSwdenk		  maximum initrd size. If for some reason you want to
3833c609719bSwdenk		  make sure that the initrd image is loaded below the
38346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3835c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3836c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3837c609719bSwdenk		  address to use (U-Boot will still check that it
3838c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3839c609719bSwdenk
3840c609719bSwdenk		  For instance, when you have a system with 16 MB
38417152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3842c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3843c609719bSwdenk		  the "bootargs" variable. However, now you must make
38447152b1d0Swdenk		  sure that the initrd image is placed in the first
3845c609719bSwdenk		  12 MB as well - this can be done with
3846c609719bSwdenk
3847c609719bSwdenk		  setenv initrd_high 00c00000
3848c609719bSwdenk
384938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
385038b99261Swdenk		  indication to U-Boot that all addresses are legal
385138b99261Swdenk		  for the Linux kernel, including addresses in flash
385238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
385338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
385438b99261Swdenk		  boot time on your system, but requires that this
385538b99261Swdenk		  feature is supported by your Linux kernel.
385638b99261Swdenk
3857c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3858c609719bSwdenk
3859c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3860dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3861c609719bSwdenk
3862c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3863c609719bSwdenk
3864c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3865c609719bSwdenk
3866c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3867c609719bSwdenk
3868c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3869c609719bSwdenk
3870c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3871c609719bSwdenk
3872e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3873a3d991bdSwdenk
3874e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3875e2a53458SMike Frysinger		  For example you can do the following
3876a3d991bdSwdenk
387748690d80SHeiko Schocher		  => setenv ethact FEC
387848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
387948690d80SHeiko Schocher		  => setenv ethact SCC
388048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3881a3d991bdSwdenk
3882e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3883e1692577SMatthias Fuchs		  available network interfaces.
3884e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3885e1692577SMatthias Fuchs
3886a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3887a3d991bdSwdenk		  either succeed or fail without retrying.
38886e592385Swdenk		  When set to "once" the network operation will
38896e592385Swdenk		  fail when all the available network interfaces
38906e592385Swdenk		  are tried once without success.
3891a3d991bdSwdenk		  Useful on scripts which control the retry operation
3892a3d991bdSwdenk		  themselves.
3893a3d991bdSwdenk
3894b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3895a1cf027aSJean-Christophe PLAGNIOL-VILLARD
389628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3897ecb0ccd9SWolfgang Denk		  UDP source port.
3898ecb0ccd9SWolfgang Denk
389928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
390028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
390128cb9375SWolfgang Denk
3902c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3903c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3904c96f86eeSWolfgang Denk
3905c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3906c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3907c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3908c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3909c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3910c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3911c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3912c96f86eeSWolfgang Denk
3913a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
391411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3915a3d991bdSwdenk		  VLAN tagged frames.
3916c609719bSwdenk
3917dc0b7b0eSJason HobbsThe following image location variables contain the location of images
3918dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
3919dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
3920dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
3921dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
3922dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
3923dc0b7b0eSJason Hobbsflash or offset in NAND flash.
3924dc0b7b0eSJason Hobbs
3925dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
3926dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
3927dc0b7b0eSJason Hobbsboards use these variables for other purposes.
3928dc0b7b0eSJason Hobbs
3929dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
3930dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
3931dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
3932dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
3933dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
3934dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3935dc0b7b0eSJason Hobbs
3936c609719bSwdenkThe following environment variables may be used and automatically
3937c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3938c609719bSwdenkdepending the information provided by your boot server:
3939c609719bSwdenk
3940c609719bSwdenk  bootfile	- see above
3941c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3942fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3943c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3944c609719bSwdenk  hostname	- Target hostname
3945c609719bSwdenk  ipaddr	- see above
3946c609719bSwdenk  netmask	- Subnet Mask
3947c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3948c609719bSwdenk  serverip	- see above
3949c609719bSwdenk
3950c609719bSwdenk
3951c609719bSwdenkThere are two special Environment Variables:
3952c609719bSwdenk
3953c609719bSwdenk  serial#	- contains hardware identification information such
3954c609719bSwdenk		  as type string and/or serial number
3955c609719bSwdenk  ethaddr	- Ethernet address
3956c609719bSwdenk
3957c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3958c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3959c609719bSwdenkonce they have been set once.
3960c609719bSwdenk
3961c609719bSwdenk
3962c1551ea8SstroeseFurther special Environment Variables:
3963c1551ea8Sstroese
3964c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3965c1551ea8Sstroese		  with the "version" command. This variable is
3966c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3967c1551ea8Sstroese
3968c1551ea8Sstroese
3969c609719bSwdenkPlease note that changes to some configuration parameters may take
3970c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3971c609719bSwdenk
3972c609719bSwdenk
3973f07771ccSwdenkCommand Line Parsing:
3974f07771ccSwdenk=====================
3975f07771ccSwdenk
3976f07771ccSwdenkThere are two different command line parsers available with U-Boot:
39777152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3978f07771ccSwdenk
3979f07771ccSwdenkOld, simple command line parser:
3980f07771ccSwdenk--------------------------------
3981f07771ccSwdenk
3982f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3983f07771ccSwdenk- several commands on one line, separated by ';'
3984fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3985f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3986f07771ccSwdenk  for example:
3987fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3988f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3989f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3990f07771ccSwdenk
3991f07771ccSwdenkHush shell:
3992f07771ccSwdenk-----------
3993f07771ccSwdenk
3994f07771ccSwdenk- similar to Bourne shell, with control structures like
3995f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3996f07771ccSwdenk  until...do...done, ...
3997f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3998f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3999f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4000f07771ccSwdenk  command
4001f07771ccSwdenk
4002f07771ccSwdenkGeneral rules:
4003f07771ccSwdenk--------------
4004f07771ccSwdenk
4005f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4006f07771ccSwdenk    command) contains several commands separated by semicolon, and
4007f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4008f07771ccSwdenk    executed anyway.
4009f07771ccSwdenk
4010f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
401111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4012f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4013f07771ccSwdenk    variables are not executed.
4014f07771ccSwdenk
4015c609719bSwdenkNote for Redundant Ethernet Interfaces:
4016c609719bSwdenk=======================================
4017c609719bSwdenk
401811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4019c609719bSwdenksuch configurations and is capable of automatic selection of a
40207152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4021c609719bSwdenk
4022c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4023c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4024c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4025c609719bSwdenk
4026c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4027c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4028c609719bSwdenkding setting in the environment; if the corresponding environment
4029c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4030c609719bSwdenk
4031c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4032c609719bSwdenk  environment, the SROM's address is used.
4033c609719bSwdenk
4034c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4035c609719bSwdenk  environment exists, then the value from the environment variable is
4036c609719bSwdenk  used.
4037c609719bSwdenk
4038c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4039c609719bSwdenk  both addresses are the same, this MAC address is used.
4040c609719bSwdenk
4041c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4042c609719bSwdenk  addresses differ, the value from the environment is used and a
4043c609719bSwdenk  warning is printed.
4044c609719bSwdenk
4045c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4046c609719bSwdenk  is raised.
4047c609719bSwdenk
4048ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4049ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4050ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4051ecee9324SBen WarrenThe naming convention is as follows:
4052ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4053c609719bSwdenk
4054c609719bSwdenkImage Formats:
4055c609719bSwdenk==============
4056c609719bSwdenk
40573310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
40583310c549SMarian Balakowiczimages in two formats:
40593310c549SMarian Balakowicz
40603310c549SMarian BalakowiczNew uImage format (FIT)
40613310c549SMarian Balakowicz-----------------------
40623310c549SMarian Balakowicz
40633310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
40643310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
40653310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
40663310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
40673310c549SMarian Balakowicz
40683310c549SMarian Balakowicz
40693310c549SMarian BalakowiczOld uImage format
40703310c549SMarian Balakowicz-----------------
40713310c549SMarian Balakowicz
40723310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
40733310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
40743310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4075c609719bSwdenk
4076c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4077c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4078f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4079f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4080f5ed9e39SPeter Tyser  INTEGRITY).
40817b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4082afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4083afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4084c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4085c609719bSwdenk* Load Address
4086c609719bSwdenk* Entry Point
4087c609719bSwdenk* Image Name
4088c609719bSwdenk* Image Timestamp
4089c609719bSwdenk
4090c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4091c609719bSwdenkand the data portions of the image are secured against corruption by
4092c609719bSwdenkCRC32 checksums.
4093c609719bSwdenk
4094c609719bSwdenk
4095c609719bSwdenkLinux Support:
4096c609719bSwdenk==============
4097c609719bSwdenk
4098c609719bSwdenkAlthough U-Boot should support any OS or standalone application
40997152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4100c609719bSwdenkU-Boot.
4101c609719bSwdenk
4102c609719bSwdenkU-Boot includes many features that so far have been part of some
4103c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4104c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4105c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
41067152b1d0Swdenkserves several purposes:
4107c609719bSwdenk
4108c609719bSwdenk- the same features can be used for other OS or standalone
4109c609719bSwdenk  applications (for instance: using compressed images to reduce the
4110c609719bSwdenk  Flash memory footprint)
4111c609719bSwdenk
4112c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
41137152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4114c609719bSwdenk
4115c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4116c609719bSwdenk  images; of course this also means that different kernel images can
4117c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4118c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4119c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4120c609719bSwdenk  software is easier now.
4121c609719bSwdenk
4122c609719bSwdenk
4123c609719bSwdenkLinux HOWTO:
4124c609719bSwdenk============
4125c609719bSwdenk
4126c609719bSwdenkPorting Linux to U-Boot based systems:
4127c609719bSwdenk---------------------------------------
4128c609719bSwdenk
4129c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4130c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4131c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4132c609719bSwdenkLinux :-).
4133c609719bSwdenk
4134a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4135c609719bSwdenk
4136c609719bSwdenkJust make sure your machine specific header file (for instance
4137c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
41381dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
41391dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
41406d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4141c609719bSwdenk
4142c609719bSwdenk
4143c609719bSwdenkConfiguring the Linux kernel:
4144c609719bSwdenk-----------------------------
4145c609719bSwdenk
4146c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4147c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4148c609719bSwdenk
4149c609719bSwdenk
4150c609719bSwdenkBuilding a Linux Image:
4151c609719bSwdenk-----------------------
4152c609719bSwdenk
415324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
415424ee89b9Swdenknot used. If you use recent kernel source, a new build target
415524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
415624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
415724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
415824ee89b9Swdenk100% compatible format.
4159c609719bSwdenk
4160c609719bSwdenkExample:
4161c609719bSwdenk
4162c609719bSwdenk	make TQM850L_config
4163c609719bSwdenk	make oldconfig
4164c609719bSwdenk	make dep
416524ee89b9Swdenk	make uImage
4166c609719bSwdenk
416724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
416824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
416924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4170c609719bSwdenk
417124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
417224ee89b9Swdenk
417324ee89b9Swdenk* convert the kernel into a raw binary image:
417424ee89b9Swdenk
417524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
417624ee89b9Swdenk				 -R .note -R .comment \
417724ee89b9Swdenk				 -S vmlinux linux.bin
417824ee89b9Swdenk
417924ee89b9Swdenk* compress the binary image:
418024ee89b9Swdenk
418124ee89b9Swdenk	gzip -9 linux.bin
418224ee89b9Swdenk
418324ee89b9Swdenk* package compressed binary image for U-Boot:
418424ee89b9Swdenk
418524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
418624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
418724ee89b9Swdenk		-d linux.bin.gz uImage
418824ee89b9Swdenk
418924ee89b9Swdenk
419024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
419124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
419224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
419324ee89b9Swdenkbyte header containing information about target architecture,
419424ee89b9Swdenkoperating system, image type, compression method, entry points, time
419524ee89b9Swdenkstamp, CRC32 checksums, etc.
419624ee89b9Swdenk
419724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
419824ee89b9Swdenkprint the header information, or to build new images.
4199c609719bSwdenk
4200c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4201c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4202c609719bSwdenkchecksum verification:
4203c609719bSwdenk
4204c609719bSwdenk	tools/mkimage -l image
4205c609719bSwdenk	  -l ==> list image header information
4206c609719bSwdenk
4207c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4208c609719bSwdenkfrom a "data file" which is used as image payload:
4209c609719bSwdenk
4210c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4211c609719bSwdenk		      -n name -d data_file image
4212c609719bSwdenk	  -A ==> set architecture to 'arch'
4213c609719bSwdenk	  -O ==> set operating system to 'os'
4214c609719bSwdenk	  -T ==> set image type to 'type'
4215c609719bSwdenk	  -C ==> set compression type 'comp'
4216c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4217c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4218c609719bSwdenk	  -n ==> set image name to 'name'
4219c609719bSwdenk	  -d ==> use image data from 'datafile'
4220c609719bSwdenk
422169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
422269459791Swdenkaddress (0x00000000), but the entry point address depends on the
422369459791Swdenkkernel version:
4224c609719bSwdenk
4225c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
422624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4227c609719bSwdenk
4228c609719bSwdenkSo a typical call to build a U-Boot image would read:
4229c609719bSwdenk
423024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
423124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4232a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
423324ee89b9Swdenk	> examples/uImage.TQM850L
423424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4235c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4236c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4237c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4238c609719bSwdenk	Load Address: 0x00000000
423924ee89b9Swdenk	Entry Point:  0x00000000
4240c609719bSwdenk
4241c609719bSwdenkTo verify the contents of the image (or check for corruption):
4242c609719bSwdenk
424324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
424424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4245c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4246c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4247c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4248c609719bSwdenk	Load Address: 0x00000000
424924ee89b9Swdenk	Entry Point:  0x00000000
4250c609719bSwdenk
4251c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4252c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4253c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4254c609719bSwdenkneed to be uncompressed:
4255c609719bSwdenk
4256a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
425724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
425824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4259a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
426024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
426124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4262c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4263c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4264c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4265c609719bSwdenk	Load Address: 0x00000000
426624ee89b9Swdenk	Entry Point:  0x00000000
4267c609719bSwdenk
4268c609719bSwdenk
4269c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4270c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4271c609719bSwdenk
4272c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4273c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4274c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4275c609719bSwdenk	Image Name:   Simple Ramdisk Image
4276c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4277c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4278c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4279c609719bSwdenk	Load Address: 0x00000000
4280c609719bSwdenk	Entry Point:  0x00000000
4281c609719bSwdenk
4282c609719bSwdenk
4283c609719bSwdenkInstalling a Linux Image:
4284c609719bSwdenk-------------------------
4285c609719bSwdenk
4286c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4287c609719bSwdenkyou must convert the image to S-Record format:
4288c609719bSwdenk
4289c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4290c609719bSwdenk
4291c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4292c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4293c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4294c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4295c609719bSwdenkcommand.
4296c609719bSwdenk
4297c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4298c609719bSwdenkTQM8xxL is in the first Flash bank):
4299c609719bSwdenk
4300c609719bSwdenk	=> erase 40100000 401FFFFF
4301c609719bSwdenk
4302c609719bSwdenk	.......... done
4303c609719bSwdenk	Erased 8 sectors
4304c609719bSwdenk
4305c609719bSwdenk	=> loads 40100000
4306c609719bSwdenk	## Ready for S-Record download ...
4307c609719bSwdenk	~>examples/image.srec
4308c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4309c609719bSwdenk	...
4310c609719bSwdenk	15989 15990 15991 15992
4311c609719bSwdenk	[file transfer complete]
4312c609719bSwdenk	[connected]
4313c609719bSwdenk	## Start Addr = 0x00000000
4314c609719bSwdenk
4315c609719bSwdenk
4316c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4317c609719bSwdenkthis includes a checksum verification so you can be sure no data
4318c609719bSwdenkcorruption happened:
4319c609719bSwdenk
4320c609719bSwdenk	=> imi 40100000
4321c609719bSwdenk
4322c609719bSwdenk	## Checking Image at 40100000 ...
4323c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4324c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4325c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4326c609719bSwdenk	   Load Address: 00000000
4327c609719bSwdenk	   Entry Point:	 0000000c
4328c609719bSwdenk	   Verifying Checksum ... OK
4329c609719bSwdenk
4330c609719bSwdenk
4331c609719bSwdenkBoot Linux:
4332c609719bSwdenk-----------
4333c609719bSwdenk
4334c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4335c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4336c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4337c609719bSwdenkparameters. You can check and modify this variable using the
4338c609719bSwdenk"printenv" and "setenv" commands:
4339c609719bSwdenk
4340c609719bSwdenk
4341c609719bSwdenk	=> printenv bootargs
4342c609719bSwdenk	bootargs=root=/dev/ram
4343c609719bSwdenk
4344c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4345c609719bSwdenk
4346c609719bSwdenk	=> printenv bootargs
4347c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4348c609719bSwdenk
4349c609719bSwdenk	=> bootm 40020000
4350c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4351c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4352c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4353c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4354c609719bSwdenk	   Load Address: 00000000
4355c609719bSwdenk	   Entry Point:	 0000000c
4356c609719bSwdenk	   Verifying Checksum ... OK
4357c609719bSwdenk	   Uncompressing Kernel Image ... OK
4358c609719bSwdenk	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
4359c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4360c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4361c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4362c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4363c609719bSwdenk	...
4364c609719bSwdenk
436511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
43667152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4367c609719bSwdenkformat!) to the "bootm" command:
4368c609719bSwdenk
4369c609719bSwdenk	=> imi 40100000 40200000
4370c609719bSwdenk
4371c609719bSwdenk	## Checking Image at 40100000 ...
4372c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4373c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4374c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4375c609719bSwdenk	   Load Address: 00000000
4376c609719bSwdenk	   Entry Point:	 0000000c
4377c609719bSwdenk	   Verifying Checksum ... OK
4378c609719bSwdenk
4379c609719bSwdenk	## Checking Image at 40200000 ...
4380c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4381c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4382c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4383c609719bSwdenk	   Load Address: 00000000
4384c609719bSwdenk	   Entry Point:	 00000000
4385c609719bSwdenk	   Verifying Checksum ... OK
4386c609719bSwdenk
4387c609719bSwdenk	=> bootm 40100000 40200000
4388c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4389c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4390c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4391c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4392c609719bSwdenk	   Load Address: 00000000
4393c609719bSwdenk	   Entry Point:	 0000000c
4394c609719bSwdenk	   Verifying Checksum ... OK
4395c609719bSwdenk	   Uncompressing Kernel Image ... OK
4396c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4397c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4398c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4399c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4400c609719bSwdenk	   Load Address: 00000000
4401c609719bSwdenk	   Entry Point:	 00000000
4402c609719bSwdenk	   Verifying Checksum ... OK
4403c609719bSwdenk	   Loading Ramdisk ... OK
4404c609719bSwdenk	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
4405c609719bSwdenk	Boot arguments: root=/dev/ram
4406c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4407c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4408c609719bSwdenk	...
4409c609719bSwdenk	RAMDISK: Compressed image found at block 0
4410c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4411c609719bSwdenk
4412c609719bSwdenk	bash#
4413c609719bSwdenk
44140267768eSMatthew McClintockBoot Linux and pass a flat device tree:
44150267768eSMatthew McClintock-----------
44160267768eSMatthew McClintock
44170267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
44180267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
44190267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
44200267768eSMatthew McClintockflat device tree:
44210267768eSMatthew McClintock
44220267768eSMatthew McClintock=> print oftaddr
44230267768eSMatthew McClintockoftaddr=0x300000
44240267768eSMatthew McClintock=> print oft
44250267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
44260267768eSMatthew McClintock=> tftp $oftaddr $oft
44270267768eSMatthew McClintockSpeed: 1000, full duplex
44280267768eSMatthew McClintockUsing TSEC0 device
44290267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
44300267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
44310267768eSMatthew McClintockLoad address: 0x300000
44320267768eSMatthew McClintockLoading: #
44330267768eSMatthew McClintockdone
44340267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
44350267768eSMatthew McClintock=> tftp $loadaddr $bootfile
44360267768eSMatthew McClintockSpeed: 1000, full duplex
44370267768eSMatthew McClintockUsing TSEC0 device
44380267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
44390267768eSMatthew McClintockFilename 'uImage'.
44400267768eSMatthew McClintockLoad address: 0x200000
44410267768eSMatthew McClintockLoading:############
44420267768eSMatthew McClintockdone
44430267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
44440267768eSMatthew McClintock=> print loadaddr
44450267768eSMatthew McClintockloadaddr=200000
44460267768eSMatthew McClintock=> print oftaddr
44470267768eSMatthew McClintockoftaddr=0x300000
44480267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
44490267768eSMatthew McClintock## Booting image at 00200000 ...
44500267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
44510267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
44520267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
44530267768eSMatthew McClintock   Load Address: 00000000
44540267768eSMatthew McClintock   Entry Point:	 00000000
44550267768eSMatthew McClintock   Verifying Checksum ... OK
44560267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
44570267768eSMatthew McClintockBooting using flat device tree at 0x300000
44580267768eSMatthew McClintockUsing MPC85xx ADS machine description
44590267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
44600267768eSMatthew McClintock[snip]
44610267768eSMatthew McClintock
44620267768eSMatthew McClintock
44636069ff26SwdenkMore About U-Boot Image Types:
44646069ff26Swdenk------------------------------
44656069ff26Swdenk
44666069ff26SwdenkU-Boot supports the following image types:
44676069ff26Swdenk
44686069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
44696069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
44706069ff26Swdenk	well) you can continue to work in U-Boot after return from
44716069ff26Swdenk	the Standalone Program.
44726069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
44736069ff26Swdenk	will take over control completely. Usually these programs
44746069ff26Swdenk	will install their own set of exception handlers, device
44756069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
44766069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
44776069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
44786069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
44796069ff26Swdenk	being started.
44806069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
44816069ff26Swdenk	(Linux) kernel image and one or more data images like
44826069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
44836069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
44846069ff26Swdenk	server provides just a single image file, but you want to get
44856069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
44866069ff26Swdenk
44876069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
44886069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
44896069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
44906069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
44916069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
44926069ff26Swdenk	a multiple of 4 bytes).
44936069ff26Swdenk
44946069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
44956069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
44966069ff26Swdenk	flash memory.
44976069ff26Swdenk
44986069ff26Swdenk   "Script files" are command sequences that will be executed by
44996069ff26Swdenk	U-Boot's command interpreter; this feature is especially
45006069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
45016069ff26Swdenk	as command interpreter.
45026069ff26Swdenk
450344f074c7SMarek VasutBooting the Linux zImage:
450444f074c7SMarek Vasut-------------------------
450544f074c7SMarek Vasut
450644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
450744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
450844f074c7SMarek Vasutas the syntax of "bootm" command.
450944f074c7SMarek Vasut
4510017e1f3fSMarek VasutNote, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply
4511017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
4512017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
4513017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
4514017e1f3fSMarek Vasut
4515c609719bSwdenk
4516c609719bSwdenkStandalone HOWTO:
4517c609719bSwdenk=================
4518c609719bSwdenk
4519c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4520c609719bSwdenkrun "standalone" applications, which can use some resources of
4521c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4522c609719bSwdenk
4523c609719bSwdenkTwo simple examples are included with the sources:
4524c609719bSwdenk
4525c609719bSwdenk"Hello World" Demo:
4526c609719bSwdenk-------------------
4527c609719bSwdenk
4528c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4529c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4530c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4531c609719bSwdenklike that:
4532c609719bSwdenk
4533c609719bSwdenk	=> loads
4534c609719bSwdenk	## Ready for S-Record download ...
4535c609719bSwdenk	~>examples/hello_world.srec
4536c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4537c609719bSwdenk	[file transfer complete]
4538c609719bSwdenk	[connected]
4539c609719bSwdenk	## Start Addr = 0x00040004
4540c609719bSwdenk
4541c609719bSwdenk	=> go 40004 Hello World! This is a test.
4542c609719bSwdenk	## Starting application at 0x00040004 ...
4543c609719bSwdenk	Hello World
4544c609719bSwdenk	argc = 7
4545c609719bSwdenk	argv[0] = "40004"
4546c609719bSwdenk	argv[1] = "Hello"
4547c609719bSwdenk	argv[2] = "World!"
4548c609719bSwdenk	argv[3] = "This"
4549c609719bSwdenk	argv[4] = "is"
4550c609719bSwdenk	argv[5] = "a"
4551c609719bSwdenk	argv[6] = "test."
4552c609719bSwdenk	argv[7] = "<NULL>"
4553c609719bSwdenk	Hit any key to exit ...
4554c609719bSwdenk
4555c609719bSwdenk	## Application terminated, rc = 0x0
4556c609719bSwdenk
4557c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4558c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4559c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4560c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4561c609719bSwdenkcharacter, but this is just a demo program. The application can be
4562c609719bSwdenkcontrolled by the following keys:
4563c609719bSwdenk
4564c609719bSwdenk	? - print current values og the CPM Timer registers
4565c609719bSwdenk	b - enable interrupts and start timer
4566c609719bSwdenk	e - stop timer and disable interrupts
4567c609719bSwdenk	q - quit application
4568c609719bSwdenk
4569c609719bSwdenk	=> loads
4570c609719bSwdenk	## Ready for S-Record download ...
4571c609719bSwdenk	~>examples/timer.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
4578c609719bSwdenk	## Starting application at 0x00040004 ...
4579c609719bSwdenk	TIMERS=0xfff00980
4580c609719bSwdenk	Using timer 1
4581c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4582c609719bSwdenk
4583c609719bSwdenkHit 'b':
4584c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4585c609719bSwdenk	Enabling timer
4586c609719bSwdenkHit '?':
4587c609719bSwdenk	[q, b, e, ?] ........
4588c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4589c609719bSwdenkHit '?':
4590c609719bSwdenk	[q, b, e, ?] .
4591c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4592c609719bSwdenkHit '?':
4593c609719bSwdenk	[q, b, e, ?] .
4594c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4595c609719bSwdenkHit '?':
4596c609719bSwdenk	[q, b, e, ?] .
4597c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4598c609719bSwdenkHit 'e':
4599c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4600c609719bSwdenkHit 'q':
4601c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4602c609719bSwdenk
4603c609719bSwdenk
460485ec0bccSwdenkMinicom warning:
460585ec0bccSwdenk================
460685ec0bccSwdenk
46077152b1d0SwdenkOver time, many people have reported problems when trying to use the
460885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
460985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4610f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
461185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
461285ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
461385ec0bccSwdenk
461452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
461552f52c14Swdenkconfiguration to your "File transfer protocols" section:
461652f52c14Swdenk
461752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
461852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
461952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
462052f52c14Swdenk
462152f52c14Swdenk
4622c609719bSwdenkNetBSD Notes:
4623c609719bSwdenk=============
4624c609719bSwdenk
4625c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4626c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4627c609719bSwdenk
4628c609719bSwdenkBuilding requires a cross environment; it is known to work on
4629c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4630c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4631c609719bSwdenkNote that the cross-powerpc package does not install include files;
4632c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4633c609719bSwdenkmissing.  This file has to be installed and patched manually:
4634c609719bSwdenk
4635c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4636c609719bSwdenk	# mkdir powerpc
4637c609719bSwdenk	# ln -s powerpc machine
4638c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4639c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4640c609719bSwdenk
4641c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4642c609719bSwdenkand U-Boot include files.
4643c609719bSwdenk
4644c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4645c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4646c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4647c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
46482a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4649c609719bSwdenk
4650c609719bSwdenk
4651c609719bSwdenkImplementation Internals:
4652c609719bSwdenk=========================
4653c609719bSwdenk
4654c609719bSwdenkThe following is not intended to be a complete description of every
4655c609719bSwdenkimplementation detail. However, it should help to understand the
4656c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4657c609719bSwdenkhardware.
4658c609719bSwdenk
4659c609719bSwdenk
4660c609719bSwdenkInitial Stack, Global Data:
4661c609719bSwdenk---------------------------
4662c609719bSwdenk
4663c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4664c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4665c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4666c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4667c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4668c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4669c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4670c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4671c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4672c609719bSwdenklocked as (mis-) used as memory, etc.
4673c609719bSwdenk
46747152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
46750668236bSWolfgang Denk	U-Boot mailing list:
467643d9616cSwdenk
467743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
467843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
467943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
468043d9616cSwdenk	...
468143d9616cSwdenk
468243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
468343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
468443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
468543d9616cSwdenk	is that the cache is being used as a temporary supply of
468643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
468711ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
468843d9616cSwdenk	can see how this works by studying the cache architecture and
468943d9616cSwdenk	operation in the architecture and processor-specific manuals.
469043d9616cSwdenk
469143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
469243d9616cSwdenk	is another option for the system designer to use as an
469311ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
469443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
469543d9616cSwdenk	board designers haven't used it for something that would
469643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
469743d9616cSwdenk	used.
469843d9616cSwdenk
46996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
470043d9616cSwdenk	with your processor/board/system design. The default value
470143d9616cSwdenk	you will find in any recent u-boot distribution in
47028a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
470343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
470443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
470543d9616cSwdenk	that are supposed to respond to that address! That code in
470643d9616cSwdenk	start.S has been around a while and should work as is when
470743d9616cSwdenk	you get the config right.
470843d9616cSwdenk
470943d9616cSwdenk	-Chris Hallinan
471043d9616cSwdenk	DS4.COM, Inc.
471143d9616cSwdenk
4712c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4713c609719bSwdenkcode for the initialization procedures:
4714c609719bSwdenk
4715c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4716c609719bSwdenk  to write it.
4717c609719bSwdenk
471811ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4719c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
47207152b1d0Swdenk  zation is performed later (when relocating to RAM).
4721c609719bSwdenk
4722c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4723c609719bSwdenk  that.
4724c609719bSwdenk
4725c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4726c609719bSwdenknormal global data to share information beween the code. But it
4727c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4728c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4729c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4730c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4731c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4732c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4733c609719bSwdenkreserve for this purpose.
4734c609719bSwdenk
47357152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4736c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4737c609719bSwdenkGCC's implementation.
4738c609719bSwdenk
4739c609719bSwdenkFor PowerPC, the following registers have specific use:
4740c609719bSwdenk	R1:	stack pointer
4741e7670f6cSWolfgang Denk	R2:	reserved for system use
4742c609719bSwdenk	R3-R4:	parameter passing and return values
4743c609719bSwdenk	R5-R10: parameter passing
4744c609719bSwdenk	R13:	small data area pointer
4745c609719bSwdenk	R30:	GOT pointer
4746c609719bSwdenk	R31:	frame pointer
4747c609719bSwdenk
4748e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4749e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4750e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4751c609719bSwdenk
4752e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4753c609719bSwdenk
4754c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4755c609719bSwdenk    address of the global data structure is known at compile time),
4756c609719bSwdenk    but it turned out that reserving a register results in somewhat
4757c609719bSwdenk    smaller code - although the code savings are not that big (on
4758c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4759c609719bSwdenk    624 text + 127 data).
4760c609719bSwdenk
4761c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
47624c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
47634c58eb55SMike Frysinger
4764c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
47654c58eb55SMike Frysinger
4766c609719bSwdenkOn ARM, the following registers are used:
4767c609719bSwdenk
4768c609719bSwdenk	R0:	function argument word/integer result
4769c609719bSwdenk	R1-R3:	function argument word
4770c609719bSwdenk	R9:	GOT pointer
4771c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4772c609719bSwdenk	R11:	argument (frame) pointer
4773c609719bSwdenk	R12:	temporary workspace
4774c609719bSwdenk	R13:	stack pointer
4775c609719bSwdenk	R14:	link register
4776c609719bSwdenk	R15:	program counter
4777c609719bSwdenk
4778c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4779c609719bSwdenk
47800df01fd3SThomas ChouOn Nios II, the ABI is documented here:
47810df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
47820df01fd3SThomas Chou
47830df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
47840df01fd3SThomas Chou
47850df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
47860df01fd3SThomas Chou    to access small data sections, so gp is free.
47870df01fd3SThomas Chou
4788afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4789afc1ce82SMacpaul Lin
4790afc1ce82SMacpaul Lin	R0-R1:	argument/return
4791afc1ce82SMacpaul Lin	R2-R5:	argument
4792afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4793afc1ce82SMacpaul Lin	R16:	trampoline register
4794afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4795afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4796afc1ce82SMacpaul Lin	R30:	link register (LP)
4797afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4798afc1ce82SMacpaul Lin	PC:	program counter (PC)
4799afc1ce82SMacpaul Lin
4800afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4801afc1ce82SMacpaul Lin
4802d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4803d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4804c609719bSwdenk
4805c609719bSwdenkMemory Management:
4806c609719bSwdenk------------------
4807c609719bSwdenk
4808c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4809c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4810c609719bSwdenk
4811c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4812c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4813c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4814c609719bSwdenkphysical memory banks.
4815c609719bSwdenk
4816c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4817c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4818c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4819c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
48206d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4821c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4822c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4823c609719bSwdenk
4824c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4825c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4826c609719bSwdenk
4827c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4828c609719bSwdenkthis:
4829c609719bSwdenk
4830c609719bSwdenk	0x0000 0000	Exception Vector code
4831c609719bSwdenk	      :
4832c609719bSwdenk	0x0000 1FFF
4833c609719bSwdenk	0x0000 2000	Free for Application Use
4834c609719bSwdenk	      :
4835c609719bSwdenk	      :
4836c609719bSwdenk
4837c609719bSwdenk	      :
4838c609719bSwdenk	      :
4839c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4840c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4841c609719bSwdenk	0x00FC 0000	Malloc Arena
4842c609719bSwdenk	      :
4843c609719bSwdenk	0x00FD FFFF
4844c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4845c609719bSwdenk	...		eventually: LCD or video framebuffer
4846c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4847c609719bSwdenk	0x00FF FFFF	[End of RAM]
4848c609719bSwdenk
4849c609719bSwdenk
4850c609719bSwdenkSystem Initialization:
4851c609719bSwdenk----------------------
4852c609719bSwdenk
4853c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
485411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4855c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
48567152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4857c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4858c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4859c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4860c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4861c609719bSwdenkthe caches and the SIU.
4862c609719bSwdenk
4863c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4864c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4865c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4866c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4867c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4868c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4869c609719bSwdenkbanks.
4870c609719bSwdenk
4871c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
48727152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4873c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4874c609719bSwdenk0x00000000, with any additional banks following immediately to create
4875c609719bSwdenkcontiguous memory starting from 0.
4876c609719bSwdenk
4877c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4878c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4879c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4880c609719bSwdenkpages, and the final stack is set up.
4881c609719bSwdenk
4882c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4883c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4884c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4885c609719bSwdenknew address in RAM.
4886c609719bSwdenk
4887c609719bSwdenk
4888c609719bSwdenkU-Boot Porting Guide:
4889c609719bSwdenk----------------------
4890c609719bSwdenk
4891c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
48926aff3115Swdenklist, October 2002]
4893c609719bSwdenk
4894c609719bSwdenk
4895c609719bSwdenkint main(int argc, char *argv[])
4896c609719bSwdenk{
4897c609719bSwdenk	sighandler_t no_more_time;
4898c609719bSwdenk
4899c609719bSwdenk	signal(SIGALRM, no_more_time);
4900c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4901c609719bSwdenk
4902c609719bSwdenk	if (available_money > available_manpower) {
49036c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4904c609719bSwdenk		return 0;
4905c609719bSwdenk	}
4906c609719bSwdenk
4907c609719bSwdenk	Download latest U-Boot source;
4908c609719bSwdenk
49090668236bSWolfgang Denk	Subscribe to u-boot mailing list;
49106aff3115Swdenk
49116c3fef28SJerry Van Baren	if (clueless)
4912c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4913c609719bSwdenk
4914c609719bSwdenk	while (learning) {
4915c609719bSwdenk		Read the README file in the top level directory;
49167cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
49176c3fef28SJerry Van Baren		Read applicable doc/*.README;
4918c609719bSwdenk		Read the source, Luke;
49196c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4920c609719bSwdenk	}
4921c609719bSwdenk
49226c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
49236c3fef28SJerry Van Baren		Buy a BDI3000;
49246c3fef28SJerry Van Baren	else
4925c609719bSwdenk		Add a lot of aggravation and time;
4926c609719bSwdenk
49276c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
49286c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
49296c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
49306c3fef28SJerry Van Baren	} else {
4931c609719bSwdenk		Create your own board support subdirectory;
49326c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
49336c3fef28SJerry Van Baren	}
49346c3fef28SJerry Van Baren	Edit new board/<myboard> files
49356c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4936c609719bSwdenk
49376c3fef28SJerry Van Baren	while (!accepted) {
4938c609719bSwdenk		while (!running) {
4939c609719bSwdenk			do {
4940c609719bSwdenk				Add / modify source code;
4941c609719bSwdenk			} until (compiles);
4942c609719bSwdenk			Debug;
4943c609719bSwdenk			if (clueless)
4944c609719bSwdenk				email("Hi, I am having problems...");
4945c609719bSwdenk		}
49466c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
49476c3fef28SJerry Van Baren		if (reasonable critiques)
49486c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
49496c3fef28SJerry Van Baren		else
49506c3fef28SJerry Van Baren			Defend code as written;
49516c3fef28SJerry Van Baren	}
4952c609719bSwdenk
4953c609719bSwdenk	return 0;
4954c609719bSwdenk}
4955c609719bSwdenk
4956c609719bSwdenkvoid no_more_time (int sig)
4957c609719bSwdenk{
4958c609719bSwdenk      hire_a_guru();
4959c609719bSwdenk}
4960c609719bSwdenk
4961c609719bSwdenk
4962c609719bSwdenkCoding Standards:
4963c609719bSwdenk-----------------
4964c609719bSwdenk
4965c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
49662c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
49677ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4968c609719bSwdenk
49692c051651SDetlev ZundelSource files originating from a different project (for example the
49702c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
49712c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
49722c051651SDetlev Zundelsources.
49732c051651SDetlev Zundel
49742c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
49752c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
49762c051651SDetlev Zundelin your code.
4977c609719bSwdenk
4978c178d3daSwdenkPlease also stick to the following formatting rules:
4979180d3f74Swdenk- remove any trailing white space
49807ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4981180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
49827ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4983180d3f74Swdenk- do not add trailing empty lines to source files
4984180d3f74Swdenk
4985c609719bSwdenkSubmissions which do not conform to the standards may be returned
4986c609719bSwdenkwith a request to reformat the changes.
4987c609719bSwdenk
4988c609719bSwdenk
4989c609719bSwdenkSubmitting Patches:
4990c609719bSwdenk-------------------
4991c609719bSwdenk
4992c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4993c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4994c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4995c609719bSwdenk
49960d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4997218ca724SWolfgang Denk
49980668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
49990668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
50000668236bSWolfgang Denk
5001c609719bSwdenkWhen you send a patch, please include the following information with
5002c609719bSwdenkit:
5003c609719bSwdenk
5004c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5005c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5006c609719bSwdenk  patch actually fixes something.
5007c609719bSwdenk
5008c609719bSwdenk* For new features: a description of the feature and your
5009c609719bSwdenk  implementation.
5010c609719bSwdenk
5011c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5012c609719bSwdenk
5013c609719bSwdenk* For major contributions, your entry to the CREDITS file
5014c609719bSwdenk
5015c609719bSwdenk* When you add support for a new board, don't forget to add this
50167ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
5017c609719bSwdenk
5018c609719bSwdenk* If your patch adds new configuration options, don't forget to
5019c609719bSwdenk  document these in the README file.
5020c609719bSwdenk
5021218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5022218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
50237ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5024218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5025218ca724SWolfgang Denk  with some other mail clients.
5026c609719bSwdenk
5027218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5028218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5029218ca724SWolfgang Denk  GNU diff.
50306dff5529Swdenk
5031218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5032218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5033218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5034218ca724SWolfgang Denk  affected files).
5035218ca724SWolfgang Denk
5036218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5037218ca724SWolfgang Denk  and compressed attachments must not be used.
5038c609719bSwdenk
503952f52c14Swdenk* If one logical set of modifications affects or creates several
504052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
504152f52c14Swdenk
504252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
504352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
504452f52c14Swdenk
504552f52c14Swdenk
5046c609719bSwdenkNotes:
5047c609719bSwdenk
5048c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
5049c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5050c609719bSwdenk  for any of the boards.
5051c609719bSwdenk
5052c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5053c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5054c609719bSwdenk  returned with a request to re-formatting / split it.
5055c609719bSwdenk
5056c609719bSwdenk* If you modify existing code, make sure that your new code does not
5057c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5058c609719bSwdenk  When adding new features, these should compile conditionally only
5059c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5060c609719bSwdenk  disabled must not need more memory than the old code without your
5061c609719bSwdenk  modification.
506290dc6704Swdenk
50630668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
50640668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
50650668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
50660668236bSWolfgang Denk  bigger than the size limit should be avoided.
5067