xref: /openbmc/u-boot/README (revision 3a608ca01d76e8cb90dcc8dc1a22cde98cdca3ab)
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
3770b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3790b953ffcSMarkus Klotzbuecher
3800b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3810b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3820b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3830b953ffcSMarkus Klotzbuecher
3846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3850b953ffcSMarkus Klotzbuecher
3860b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3870b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3880b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3890b953ffcSMarkus Klotzbuecher		by this value.
3900b953ffcSMarkus Klotzbuecher
39192bbd64eSDaniel Schwierzeck- MIPS CPU options:
39292bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
39392bbd64eSDaniel Schwierzeck
39492bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
39592bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
39692bbd64eSDaniel Schwierzeck		relocation.
39792bbd64eSDaniel Schwierzeck
39892bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
39992bbd64eSDaniel Schwierzeck
40092bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
40192bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
40292bbd64eSDaniel Schwierzeck		Possible values are:
40392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
40492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
40592bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
40692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
40792bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
40892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
40992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
41092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
41192bbd64eSDaniel Schwierzeck
41292bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
41392bbd64eSDaniel Schwierzeck
41492bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
41592bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
41692bbd64eSDaniel Schwierzeck
41792bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
41892bbd64eSDaniel Schwierzeck
41992bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
42092bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
42192bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
42292bbd64eSDaniel Schwierzeck
423b67d8816SChristian Riesch- ARM options:
424b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
425b67d8816SChristian Riesch
426b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
427b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
428b67d8816SChristian Riesch
4295da627a4Swdenk- Linux Kernel Interface:
430c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
431c609719bSwdenk
432c609719bSwdenk		U-Boot stores all clock information in Hz
433c609719bSwdenk		internally. For binary compatibility with older Linux
434c609719bSwdenk		kernels (which expect the clocks passed in the
435c609719bSwdenk		bd_info data to be in MHz) the environment variable
436c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
437c609719bSwdenk		converts clock data to MHZ before passing it to the
438c609719bSwdenk		Linux kernel.
439c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
440c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
441c609719bSwdenk		default environment.
442c609719bSwdenk
4435da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4445da627a4Swdenk
44511ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4465da627a4Swdenk		expect it to be in bytes, others in MB.
4475da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4485da627a4Swdenk
449fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
450f57f70aaSWolfgang Denk
451f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
452213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
453213bf8c8SGerald Van Baren		concepts).
454213bf8c8SGerald Van Baren
455213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
456213bf8c8SGerald Van Baren		 * New libfdt-based support
457213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4583bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
459213bf8c8SGerald Van Baren
460b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
461b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
462b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
463b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
464f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
465c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
466f57f70aaSWolfgang Denk
46711ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
46811ccc33fSMarcel Ziswiler		addresses
4693bb342fcSKim Phillips
4704e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4714e253137SKumar Gala
4724e253137SKumar Gala		Board code has addition modification that it wants to make
4734e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4746705d81eSwdenk
4750267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4760267768eSMatthew McClintock
47711ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4780267768eSMatthew McClintock		param header, the default value is zero if undefined.
4790267768eSMatthew McClintock
4803887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4813887c3fbSHeiko Schocher
4823887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4833887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4843887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4853887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4863887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4873887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4883887c3fbSHeiko Schocher
4897eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
4907eb29398SIgor Grinberg
4917eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
4927eb29398SIgor Grinberg		machine type and must be used to specify the machine type
4937eb29398SIgor Grinberg		number as it appears in the ARM machine registry
4947eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
4957eb29398SIgor Grinberg		Only boards that have multiple machine types supported
4967eb29398SIgor Grinberg		in a single configuration file and the machine type is
4977eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
4987eb29398SIgor Grinberg
4990b2f4ecaSNiklaus Giger- vxWorks boot parameters:
5000b2f4ecaSNiklaus Giger
5010b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
5020b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
5030b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
5040b2f4ecaSNiklaus Giger
5050b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
5060b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
5070b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
5080b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
5090b2f4ecaSNiklaus Giger
5100b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5110b2f4ecaSNiklaus Giger
5120b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5130b2f4ecaSNiklaus Giger
5140b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5150b2f4ecaSNiklaus Giger		the defaults discussed just above.
5160b2f4ecaSNiklaus Giger
5172c451f78SAneesh V- Cache Configuration:
5182c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5192c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5202c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5212c451f78SAneesh V
52293bc2193SAneesh V- Cache Configuration for ARM:
52393bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
52493bc2193SAneesh V				      controller
52593bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
52693bc2193SAneesh V					controller register space
52793bc2193SAneesh V
5286705d81eSwdenk- Serial Ports:
52948d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5306705d81eSwdenk
5316705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5326705d81eSwdenk
53348d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5346705d81eSwdenk
5356705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5366705d81eSwdenk
5376705d81eSwdenk		CONFIG_PL011_CLOCK
5386705d81eSwdenk
5396705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5406705d81eSwdenk		the clock speed of the UARTs.
5416705d81eSwdenk
5426705d81eSwdenk		CONFIG_PL01x_PORTS
5436705d81eSwdenk
5446705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5456705d81eSwdenk		define this to a list of base addresses for each (supported)
5466705d81eSwdenk		port. See e.g. include/configs/versatile.h
5476705d81eSwdenk
548910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
549910f1ae3SJohn Rigby
550910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
551910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
552910f1ae3SJohn Rigby		this variable to initialize the extra register.
553910f1ae3SJohn Rigby
554910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
555910f1ae3SJohn Rigby
556910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
557910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
558910f1ae3SJohn Rigby		variable to flush the UART at init time.
559910f1ae3SJohn Rigby
5606705d81eSwdenk
561c609719bSwdenk- Console Interface:
562c609719bSwdenk		Depending on board, define exactly one serial port
563c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
564c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
565c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
566c609719bSwdenk
567c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
568c609719bSwdenk		port routines must be defined elsewhere
569c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
570c609719bSwdenk
571c609719bSwdenk		CONFIG_CFB_CONSOLE
572c609719bSwdenk		Enables console device for a color framebuffer. Needs following
573c53043b7SWolfgang Denk		defines (cf. smiLynxEM, i8042)
574c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
575c609719bSwdenk						(default big endian)
576c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
577c609719bSwdenk						rectangle fill
578c609719bSwdenk						(cf. smiLynxEM)
579c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
580c609719bSwdenk						bit-blit (cf. smiLynxEM)
581c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
582c609719bSwdenk						(cols=pitch)
583c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
584c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
585c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
586c609719bSwdenk						(0-5, cf. cfb_console.c)
587c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
588c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
589c609719bSwdenk						(i.e. i8042_kbd_init())
590c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
591c609719bSwdenk						(i.e. i8042_tstc)
592c609719bSwdenk			VIDEO_GETC_FCT		get char fct
593c609719bSwdenk						(i.e. i8042_getc)
594c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
595c609719bSwdenk						(requires blink timer
596c609719bSwdenk						cf. i8042.c)
5976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
598c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
599c609719bSwdenk						upper right corner
600602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
601c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
602c609719bSwdenk						upper left corner
603a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
604a6c7ad2fSwdenk						linux_logo.h for logo.
605a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
606c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
60711ccc33fSMarcel Ziswiler						additional board info beside
608c609719bSwdenk						the logo
609c609719bSwdenk
610c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
611c609719bSwdenk		default i/o. Serial console can be forced with
612c609719bSwdenk		environment 'console=serial'.
613c609719bSwdenk
614a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
615a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
616a3ad8e26Swdenk		the "silent" environment variable. See
617a3ad8e26Swdenk		doc/README.silent for more information.
618a3ad8e26Swdenk
619c609719bSwdenk- Console Baudrate:
620c609719bSwdenk		CONFIG_BAUDRATE - in bps
621c609719bSwdenk		Select one of the baudrates listed in
6226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
624c609719bSwdenk
625c92fac91SHeiko Schocher- Console Rx buffer length
626c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
627c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6282b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
629c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
630c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
631c92fac91SHeiko Schocher		the SMC.
632c92fac91SHeiko Schocher
6339558b48aSGraeme Russ- Pre-Console Buffer:
6349558b48aSGraeme Russ		Prior to the console being initialised (i.e. serial UART
6359558b48aSGraeme Russ		initialised etc) all console output is silently discarded.
6369558b48aSGraeme Russ		Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
6379558b48aSGraeme Russ		buffer any console messages prior to the console being
6389558b48aSGraeme Russ		initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
6399558b48aSGraeme Russ		bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
6409558b48aSGraeme Russ		a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
6419558b48aSGraeme Russ		bytes are output before the console is initialised, the
6429558b48aSGraeme Russ		earlier bytes are discarded.
6439558b48aSGraeme Russ
6449558b48aSGraeme Russ		'Sane' compilers will generate smaller code if
6459558b48aSGraeme Russ		CONFIG_PRE_CON_BUF_SZ is a power of 2
6469558b48aSGraeme Russ
647295d3942SSimon Glass- Pre-console putc():
648295d3942SSimon Glass		Prior to the console being initialised, console output is
649295d3942SSimon Glass		normally silently discarded. This can be annoying if a
650295d3942SSimon Glass		panic() happens in this time.
651295d3942SSimon Glass
652295d3942SSimon Glass		If the CONFIG_PRE_CONSOLE_PUTC option is defined, then
653295d3942SSimon Glass		U-Boot will call board_pre_console_putc() for each output
654295d3942SSimon Glass		character in this case, This function should try to output
655295d3942SSimon Glass		the character if possible, perhaps on all available UARTs
656295d3942SSimon Glass		(it will need to do this directly, since the console code
657295d3942SSimon Glass		is not functional yet). Note that if the panic happens
658295d3942SSimon Glass		early enough, then it is possible that board_init_f()
659295d3942SSimon Glass		(or even arch_cpu_init() on ARM) has not been called yet.
660295d3942SSimon Glass		You should init all clocks, GPIOs, etc. that are needed
661295d3942SSimon Glass		to get the character out. Baud rates will need to default
662295d3942SSimon Glass		to something sensible.
663295d3942SSimon Glass
664046a37bdSSonny Rao- Safe printf() functions
665046a37bdSSonny Rao		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
666046a37bdSSonny Rao		the printf() functions. These are defined in
667046a37bdSSonny Rao		include/vsprintf.h and include snprintf(), vsnprintf() and
668046a37bdSSonny Rao		so on. Code size increase is approximately 300-500 bytes.
669046a37bdSSonny Rao		If this option is not given then these functions will
670046a37bdSSonny Rao		silently discard their buffer size argument - this means
671046a37bdSSonny Rao		you are not getting any overflow checking in this case.
672046a37bdSSonny Rao
673c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
674c609719bSwdenk		Delay before automatically booting the default image;
675c609719bSwdenk		set to -1 to disable autoboot.
676c609719bSwdenk
677c609719bSwdenk		See doc/README.autoboot for these options that
678c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
679c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
680c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
681c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
682c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
683c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
684c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
685c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
686c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
687c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
688c609719bSwdenk		CONFIG_RESET_TO_RETRY
689c609719bSwdenk
690c609719bSwdenk- Autoboot Command:
691c609719bSwdenk		CONFIG_BOOTCOMMAND
692c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
693c609719bSwdenk		define a command string that is automatically executed
694c609719bSwdenk		when no character is read on the console interface
695c609719bSwdenk		within "Boot Delay" after reset.
696c609719bSwdenk
697c609719bSwdenk		CONFIG_BOOTARGS
698c609719bSwdenk		This can be used to pass arguments to the bootm
699c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
700c609719bSwdenk		environment value "bootargs".
701c609719bSwdenk
702c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
703c609719bSwdenk		The value of these goes into the environment as
704c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
705c609719bSwdenk		as a convenience, when switching between booting from
70611ccc33fSMarcel Ziswiler		RAM and NFS.
707c609719bSwdenk
708c609719bSwdenk- Pre-Boot Commands:
709c609719bSwdenk		CONFIG_PREBOOT
710c609719bSwdenk
711c609719bSwdenk		When this option is #defined, the existence of the
712c609719bSwdenk		environment variable "preboot" will be checked
713c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
714c609719bSwdenk		countdown and/or running the auto-boot command resp.
715c609719bSwdenk		entering interactive mode.
716c609719bSwdenk
717c609719bSwdenk		This feature is especially useful when "preboot" is
718c609719bSwdenk		automatically generated or modified. For an example
719c609719bSwdenk		see the LWMON board specific code: here "preboot" is
720c609719bSwdenk		modified when the user holds down a certain
721c609719bSwdenk		combination of keys on the (special) keyboard when
722c609719bSwdenk		booting the systems
723c609719bSwdenk
724c609719bSwdenk- Serial Download Echo Mode:
725c609719bSwdenk		CONFIG_LOADS_ECHO
726c609719bSwdenk		If defined to 1, all characters received during a
727c609719bSwdenk		serial download (using the "loads" command) are
728c609719bSwdenk		echoed back. This might be needed by some terminal
729c609719bSwdenk		emulations (like "cu"), but may as well just take
730c609719bSwdenk		time on others. This setting #define's the initial
731c609719bSwdenk		value of the "loads_echo" environment variable.
732c609719bSwdenk
733602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
734c609719bSwdenk		CONFIG_KGDB_BAUDRATE
735c609719bSwdenk		Select one of the baudrates listed in
7366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
737c609719bSwdenk
738c609719bSwdenk- Monitor Functions:
739602ad3b3SJon Loeliger		Monitor commands can be included or excluded
740602ad3b3SJon Loeliger		from the build by using the #include files
741602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
742602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
743602ad3b3SJon Loeliger		and augmenting with additional #define's
744602ad3b3SJon Loeliger		for wanted commands.
745c609719bSwdenk
746602ad3b3SJon Loeliger		The default command configuration includes all commands
747602ad3b3SJon Loeliger		except those marked below with a "*".
748602ad3b3SJon Loeliger
749602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
750602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
751602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
752602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
753602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
754602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
755602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
756602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
757710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
758602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
759602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
760602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
761a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
762a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
763a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
764a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
765602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
766602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
767246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
768602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
769602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7700c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
771bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
772602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
773602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
774602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
775602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
776602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
777a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
778a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
779602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
780602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
781602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
782602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
783602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
784602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7850c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
786602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
787602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
788602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
789602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7901ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
791602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
792602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
79302c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
79402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
795602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
79656523f12Swdenk					  loop, loopw, mtest
797602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
798602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
799602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
80068d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
801602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
802602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
803e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
804e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
805602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
806602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
807602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
808602ad3b3SJon Loeliger					  host
809602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
810602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
811602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
812602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
813602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
814602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
815602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
816602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
817602ad3b3SJon Loeliger					  (4xx only)
818f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
819c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
82002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
82174de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
822602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8237a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8241fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
825ca366d0eSChe-liang Chiou		CONFIG_CMD_TIME		* run command and report execution time
826602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
827602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
828602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
829c609719bSwdenk
830c609719bSwdenk
831c609719bSwdenk		EXAMPLE: If you want all functions except of network
832c609719bSwdenk		support you can write:
833c609719bSwdenk
834602ad3b3SJon Loeliger		#include "config_cmd_all.h"
835602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
836c609719bSwdenk
837213bf8c8SGerald Van Baren	Other Commands:
838213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
839c609719bSwdenk
840c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
841602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
842c609719bSwdenk		what you (and your U-Boot users) are doing. Data
843c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
844c609719bSwdenk		8260 (where accesses to the IMMR region must be
845c609719bSwdenk		uncached), and it cannot be disabled on all other
846c609719bSwdenk		systems where we (mis-) use the data cache to hold an
847c609719bSwdenk		initial stack and some data.
848c609719bSwdenk
849c609719bSwdenk
850c609719bSwdenk		XXX - this list needs to get updated!
851c609719bSwdenk
85245ba8077SSimon Glass- Device tree:
85345ba8077SSimon Glass		CONFIG_OF_CONTROL
85445ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
85545ba8077SSimon Glass		to configure its devices, instead of relying on statically
85645ba8077SSimon Glass		compiled #defines in the board file. This option is
85745ba8077SSimon Glass		experimental and only available on a few boards. The device
85845ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
85945ba8077SSimon Glass
8602c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
8612c0f79e4SSimon Glass		be done using one of the two options below:
862bbb0b128SSimon Glass
863bbb0b128SSimon Glass		CONFIG_OF_EMBED
864bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
865bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
866bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
867bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
868bbb0b128SSimon Glass		the global data structure as gd->blob.
86945ba8077SSimon Glass
8702c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
8712c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
8722c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
8732c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
8742c0f79e4SSimon Glass
8752c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
8762c0f79e4SSimon Glass
8772c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
8782c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
8792c0f79e4SSimon Glass		still use the individual files if you need something more
8802c0f79e4SSimon Glass		exotic.
8812c0f79e4SSimon Glass
882c609719bSwdenk- Watchdog:
883c609719bSwdenk		CONFIG_WATCHDOG
884c609719bSwdenk		If this variable is defined, it enables watchdog
8856abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8866abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8876abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8886abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8896abe6fb6SDetlev Zundel		available, then no further board specific code should
8906abe6fb6SDetlev Zundel		be needed to use it.
8916abe6fb6SDetlev Zundel
8926abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8936abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8946abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8956abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
896c609719bSwdenk
897c1551ea8Sstroese- U-Boot Version:
898c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
899c1551ea8Sstroese		If this variable is defined, an environment variable
900c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
901c1551ea8Sstroese		version as printed by the "version" command.
902c1551ea8Sstroese		This variable is readonly.
903c1551ea8Sstroese
904c609719bSwdenk- Real-Time Clock:
905c609719bSwdenk
906602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
907c609719bSwdenk		has to be selected, too. Define exactly one of the
908c609719bSwdenk		following options:
909c609719bSwdenk
910c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
911c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9124e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
913c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9141cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
915c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9167f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
9173bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9189536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9194c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
92171d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
92271d19f30SHeiko Schocher					  RV3029 RTC.
923c609719bSwdenk
924b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
925b37c7e5eSwdenk		must also be configured. See I2C Support, below.
926b37c7e5eSwdenk
927e92739d3SPeter Tyser- GPIO Support:
928e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
929e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
930e92739d3SPeter Tyser
9315dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9325dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9335dec49caSChris Packham		pins supported by a particular chip.
9345dec49caSChris Packham
935e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
936e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
937e92739d3SPeter Tyser
938c609719bSwdenk- Timestamp Support:
939c609719bSwdenk
940c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
941c609719bSwdenk		(date and time) of an image is printed by image
942c609719bSwdenk		commands like bootm or iminfo. This option is
943602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
944c609719bSwdenk
945c609719bSwdenk- Partition Support:
946c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
94707f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
948c609719bSwdenk
949602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
950218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
951218ca724SWolfgang Denk		least one partition type as well.
952c609719bSwdenk
953c609719bSwdenk- IDE Reset method:
9544d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
9554d13cbadSwdenk		board configurations files but used nowhere!
956c609719bSwdenk
9574d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
9584d13cbadSwdenk		be performed by calling the function
9594d13cbadSwdenk			ide_set_reset(int reset)
9604d13cbadSwdenk		which has to be defined in a board specific file
961c609719bSwdenk
962c609719bSwdenk- ATAPI Support:
963c609719bSwdenk		CONFIG_ATAPI
964c609719bSwdenk
965c609719bSwdenk		Set this to enable ATAPI support.
966c609719bSwdenk
967c40b2956Swdenk- LBA48 Support
968c40b2956Swdenk		CONFIG_LBA48
969c40b2956Swdenk
970c40b2956Swdenk		Set this to enable support for disks larger than 137GB
9714b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
972c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
973c40b2956Swdenk		support disks up to 2.1TB.
974c40b2956Swdenk
9756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
976c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
977c40b2956Swdenk			Default is 32bit.
978c40b2956Swdenk
979c609719bSwdenk- SCSI Support:
980c609719bSwdenk		At the moment only there is only support for the
981c609719bSwdenk		SYM53C8XX SCSI controller; define
982c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
983c609719bSwdenk
9846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
987c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
988c609719bSwdenk		devices.
9896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
990c609719bSwdenk
991c609719bSwdenk- NETWORK Support (PCI):
992682011ffSwdenk		CONFIG_E1000
993ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
994ce5207e1SKyle Moffett
995ce5207e1SKyle Moffett		CONFIG_E1000_SPI
996ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
997ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
998ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
999ce5207e1SKyle Moffett
1000ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1001ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1002ce5207e1SKyle Moffett		example with the "sspi" command.
1003ce5207e1SKyle Moffett
1004ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1005ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1006ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1007682011ffSwdenk
1008ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
100911ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
1010ac3315c2SAndre Schwarz
1011c609719bSwdenk		CONFIG_EEPRO100
1012c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
101311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1014c609719bSwdenk		write routine for first time initialisation.
1015c609719bSwdenk
1016c609719bSwdenk		CONFIG_TULIP
1017c609719bSwdenk		Support for Digital 2114x chips.
1018c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1019c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1020c609719bSwdenk
1021c609719bSwdenk		CONFIG_NATSEMI
1022c609719bSwdenk		Support for National dp83815 chips.
1023c609719bSwdenk
1024c609719bSwdenk		CONFIG_NS8382X
1025c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1026c609719bSwdenk
102745219c46Swdenk- NETWORK Support (other):
102845219c46Swdenk
1029c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1030c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1031c041e9d2SJens Scharsig
1032c041e9d2SJens Scharsig			CONFIG_RMII
1033c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1034c041e9d2SJens Scharsig
1035c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1036c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1037c041e9d2SJens Scharsig			The driver doen't show link status messages.
1038c041e9d2SJens Scharsig
1039efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1040efdd7319SRob Herring		Support for the Calxeda XGMAC device
1041efdd7319SRob Herring
104245219c46Swdenk		CONFIG_DRIVER_LAN91C96
104345219c46Swdenk		Support for SMSC's LAN91C96 chips.
104445219c46Swdenk
104545219c46Swdenk			CONFIG_LAN91C96_BASE
104645219c46Swdenk			Define this to hold the physical address
104745219c46Swdenk			of the LAN91C96's I/O space
104845219c46Swdenk
104945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
105045219c46Swdenk			Define this to enable 32 bit addressing
105145219c46Swdenk
1052f39748aeSwdenk		CONFIG_DRIVER_SMC91111
1053f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1054f39748aeSwdenk
1055f39748aeSwdenk			CONFIG_SMC91111_BASE
1056f39748aeSwdenk			Define this to hold the physical address
1057f39748aeSwdenk			of the device (I/O space)
1058f39748aeSwdenk
1059f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1060f39748aeSwdenk			Define this if data bus is 32 bits
1061f39748aeSwdenk
1062f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1063f39748aeSwdenk			Define this to use i/o functions instead of macros
1064f39748aeSwdenk			(some hardware wont work with macros)
1065f39748aeSwdenk
1066dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1067dc02badaSHeiko Schocher		Support for davinci emac
1068dc02badaSHeiko Schocher
1069dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1070dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1071dc02badaSHeiko Schocher
1072b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1073b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1074b3dbf4a5SMacpaul Lin
1075b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1076b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1077b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1078b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1079b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1080b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1081b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1082b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1083b3dbf4a5SMacpaul Lin
1084c2fff331SMike Rapoport		CONFIG_SMC911X
1085557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1086557b377dSJens Gehrlein
1087c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1088557b377dSJens Gehrlein			Define this to hold the physical address
1089557b377dSJens Gehrlein			of the device (I/O space)
1090557b377dSJens Gehrlein
1091c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1092557b377dSJens Gehrlein			Define this if data bus is 32 bits
1093557b377dSJens Gehrlein
1094c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1095557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1096557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1097c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1098557b377dSJens Gehrlein
10993d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11003d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11013d0075faSYoshihiro Shimoda
11023d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11033d0075faSYoshihiro Shimoda			Define the number of ports to be used
11043d0075faSYoshihiro Shimoda
11053d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11063d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11073d0075faSYoshihiro Shimoda
110868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
110968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
111068260aabSYoshihiro Shimoda
11115e124724SVadim Bendebury- TPM Support:
11125e124724SVadim Bendebury		CONFIG_GENERIC_LPC_TPM
11135e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
11145e124724SVadim Bendebury		per system is supported at this time.
11155e124724SVadim Bendebury
11165e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
11175e124724SVadim Bendebury			Base address where the generic TPM device is mapped
11185e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
11195e124724SVadim Bendebury			0xfed40000.
11205e124724SVadim Bendebury
1121c609719bSwdenk- USB Support:
1122c609719bSwdenk		At the moment only the UHCI host controller is
11234d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1124c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1125c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
112630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1127c609719bSwdenk		storage devices.
1128c609719bSwdenk		Note:
1129c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1130c609719bSwdenk		(TEAC FD-05PUB).
11314d13cbadSwdenk		MPC5200 USB requires additional defines:
11324d13cbadSwdenk			CONFIG_USB_CLOCK
11334d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1134307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1135307ecb6dSEric Millbrandt				for USB on PSC3
11364d13cbadSwdenk			CONFIG_USB_CONFIG
11374d13cbadSwdenk				for differential drivers: 0x00001000
11384d13cbadSwdenk				for single ended drivers: 0x00005000
1139307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1140307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
11416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1142fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1143fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
11444d13cbadSwdenk
114516c8d5e7SWolfgang Denk- USB Device:
114616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
114716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
114816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
114911ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
115016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
115116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
115216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
115316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
115416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
115516c8d5e7SWolfgang Denk		a Linux host by
115616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
115716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
115816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
115916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
116016c8d5e7SWolfgang Denk
116116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
116216c8d5e7SWolfgang Denk			Define this to build a UDC device
116316c8d5e7SWolfgang Denk
116416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
116516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
116616c8d5e7SWolfgang Denk			talk to the UDC device
116716c8d5e7SWolfgang Denk
11686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
116916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
117016c8d5e7SWolfgang Denk			be set to usbtty.
117116c8d5e7SWolfgang Denk
117216c8d5e7SWolfgang Denk			mpc8xx:
11736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
117416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
11756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
117616c8d5e7SWolfgang Denk
11776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
117816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
11796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
118016c8d5e7SWolfgang Denk
118116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
118216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
118316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
118416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
118516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
118616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
118716c8d5e7SWolfgang Denk
118816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
118916c8d5e7SWolfgang Denk			Define this string as the name of your company for
119016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
119116c8d5e7SWolfgang Denk
119216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
119316c8d5e7SWolfgang Denk			Define this string as the name of your product
119416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
119516c8d5e7SWolfgang Denk
119616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
119716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
119816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
119916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
120016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
120116c8d5e7SWolfgang Denk
120216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
120316c8d5e7SWolfgang Denk			Define this as the unique Product ID
120416c8d5e7SWolfgang Denk			for your device
120516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1206c609719bSwdenk
1207d70a560fSIgor Grinberg- ULPI Layer Support:
1208d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1209d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1210d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1211d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1212d70a560fSIgor Grinberg		viewport is supported.
1213d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1214d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1215c609719bSwdenk
1216c609719bSwdenk- MMC Support:
1217c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1218c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1219c609719bSwdenk		accessed from the boot prompt by mapping the device
1220c609719bSwdenk		to physical memory similar to flash. Command line is
1221602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1222602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1223c609719bSwdenk
1224afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1225afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1226afb35666SYoshihiro Shimoda
1227afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1228afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1229afb35666SYoshihiro Shimoda
1230afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1231afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1232afb35666SYoshihiro Shimoda
12336705d81eSwdenk- Journaling Flash filesystem support:
12346705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
12356705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
12366705d81eSwdenk		Define these for a default partition on a NAND device
12376705d81eSwdenk
12386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
12396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
12406705d81eSwdenk		Define these for a default partition on a NOR device
12416705d81eSwdenk
12426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
12436705d81eSwdenk		Define this to create an own partition. You have to provide a
12446705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
12456705d81eSwdenk
12466705d81eSwdenk		If you define only one JFFS2 partition you may also want to
12476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
12486705d81eSwdenk		to disable the command chpart. This is the default when you
12496705d81eSwdenk		have not defined a custom partition
12506705d81eSwdenk
1251c30a15e5SDonggeun Kim- FAT(File Allocation Table) filesystem write function support:
1252c30a15e5SDonggeun Kim		CONFIG_FAT_WRITE
1253c30a15e5SDonggeun Kim		Support for saving memory data as a file
1254c30a15e5SDonggeun Kim		in FAT formatted partition
1255c30a15e5SDonggeun Kim
1256c609719bSwdenk- Keyboard Support:
1257c609719bSwdenk		CONFIG_ISA_KEYBOARD
1258c609719bSwdenk
1259c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1260c609719bSwdenk		support
1261c609719bSwdenk
1262c609719bSwdenk		CONFIG_I8042_KBD
1263c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1264c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1265c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1266c609719bSwdenk		for cfb_console. Supports cursor blinking.
1267c609719bSwdenk
1268c609719bSwdenk- Video support:
1269c609719bSwdenk		CONFIG_VIDEO
1270c609719bSwdenk
1271c609719bSwdenk		Define this to enable video support (for output to
1272c609719bSwdenk		video).
1273c609719bSwdenk
1274c609719bSwdenk		CONFIG_VIDEO_CT69000
1275c609719bSwdenk
1276c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1277c609719bSwdenk
1278c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1279eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1280eeb1b77bSwdenk		video output is selected via environment 'videoout'
1281eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1282eeb1b77bSwdenk		assumed.
1283c609719bSwdenk
1284eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
128511ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1286eeb1b77bSwdenk		are possible:
1287eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1288eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1289eeb1b77bSwdenk
1290eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1291eeb1b77bSwdenk		-------------+---------------------------------------------
1292eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1293eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1294eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1295eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1296eeb1b77bSwdenk		-------------+---------------------------------------------
1297c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1298c609719bSwdenk
1299eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
13007817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1301eeb1b77bSwdenk
1302eeb1b77bSwdenk
1303a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1304a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1305a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1306a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1307a6c7ad2fSwdenk
13087d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
13097d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
13107d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
13117d3053fbSTimur Tabi		support, and should also define these other macros:
13127d3053fbSTimur Tabi
13137d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
13147d3053fbSTimur Tabi			CONFIG_VIDEO
13157d3053fbSTimur Tabi			CONFIG_CMD_BMP
13167d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
13177d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
13187d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
13197d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
13207d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
13217d3053fbSTimur Tabi
1322ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1323ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1324ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1325ba8e76bdSTimur Tabi		description of this variable.
13267d3053fbSTimur Tabi
1327682011ffSwdenk- Keyboard Support:
1328682011ffSwdenk		CONFIG_KEYBOARD
1329682011ffSwdenk
1330682011ffSwdenk		Define this to enable a custom keyboard support.
1331682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1332682011ffSwdenk		defined in your board-specific files.
1333682011ffSwdenk		The only board using this so far is RBC823.
1334a6c7ad2fSwdenk
1335c609719bSwdenk- LCD Support:	CONFIG_LCD
1336c609719bSwdenk
1337c609719bSwdenk		Define this to enable LCD support (for output to LCD
1338c609719bSwdenk		display); also select one of the supported displays
1339c609719bSwdenk		by defining one of these:
1340c609719bSwdenk
134139cf4804SStelian Pop		CONFIG_ATMEL_LCD:
134239cf4804SStelian Pop
134339cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
134439cf4804SStelian Pop
1345fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1346c609719bSwdenk
1347fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1348c609719bSwdenk
1349fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1350c609719bSwdenk
1351fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1352fd3103bbSwdenk			Active, color, single scan.
1353fd3103bbSwdenk
1354fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1355fd3103bbSwdenk
1356fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1357c609719bSwdenk			Active, color, single scan.
1358c609719bSwdenk
1359c609719bSwdenk		CONFIG_SHARP_16x9
1360c609719bSwdenk
1361c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1362c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1363c609719bSwdenk
1364c609719bSwdenk		CONFIG_SHARP_LQ64D341
1365c609719bSwdenk
1366c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1367c609719bSwdenk			Active, color, single scan.
1368c609719bSwdenk
1369c609719bSwdenk		CONFIG_HLD1045
1370c609719bSwdenk
1371c609719bSwdenk			HLD1045 display, 640x480.
1372c609719bSwdenk			Active, color, single scan.
1373c609719bSwdenk
1374c609719bSwdenk		CONFIG_OPTREX_BW
1375c609719bSwdenk
1376c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1377c609719bSwdenk			or
1378c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1379c609719bSwdenk			or
1380c609719bSwdenk			Hitachi	 SP14Q002
1381c609719bSwdenk
1382c609719bSwdenk			320x240. Black & white.
1383c609719bSwdenk
1384c609719bSwdenk		Normally display is black on white background; define
13856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1386c609719bSwdenk
13877152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1388d791b1dcSwdenk
1389d791b1dcSwdenk		If this option is set, the environment is checked for
1390d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1391d791b1dcSwdenk		of logo, copyright and system information on the LCD
1392e94d2cd9Swdenk		is suppressed and the BMP image at the address
1393d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1394d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1395d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1396d791b1dcSwdenk		loaded very quickly after power-on.
1397d791b1dcSwdenk
13981ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
13991ca298ceSMatthias Weisser
14001ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
14011ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
14021ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
14031ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
14041ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
14051ca298ceSMatthias Weisser		specify 'm' for centering the image.
14061ca298ceSMatthias Weisser
14071ca298ceSMatthias Weisser		Example:
14081ca298ceSMatthias Weisser		setenv splashpos m,m
14091ca298ceSMatthias Weisser			=> image at center of screen
14101ca298ceSMatthias Weisser
14111ca298ceSMatthias Weisser		setenv splashpos 30,20
14121ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
14131ca298ceSMatthias Weisser
14141ca298ceSMatthias Weisser		setenv splashpos -10,m
14151ca298ceSMatthias Weisser			=> vertically centered image
14161ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
14171ca298ceSMatthias Weisser
141898f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
141998f4a3dfSStefan Roese
142098f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
142198f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
142298f4a3dfSStefan Roese		splashscreen support or the bmp command.
142398f4a3dfSStefan Roese
1424d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1425d5011762SAnatolij Gustschin
1426d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1427d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1428d5011762SAnatolij Gustschin		bmp command.
1429d5011762SAnatolij Gustschin
1430c29fdfc1Swdenk- Compression support:
1431c29fdfc1Swdenk		CONFIG_BZIP2
1432c29fdfc1Swdenk
1433c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1434c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1435c29fdfc1Swdenk		compressed images are supported.
1436c29fdfc1Swdenk
1437c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
14386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1439c29fdfc1Swdenk		be at least 4MB.
1440d791b1dcSwdenk
1441fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1442fc9c1727SLuigi 'Comio' Mantellini
1443fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1444fc9c1727SLuigi 'Comio' Mantellini		images is included.
1445fc9c1727SLuigi 'Comio' Mantellini
1446fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1447fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1448fc9c1727SLuigi 'Comio' Mantellini		formula:
1449fc9c1727SLuigi 'Comio' Mantellini
1450fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1451fc9c1727SLuigi 'Comio' Mantellini
1452fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1453fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1454fc9c1727SLuigi 'Comio' Mantellini
1455fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1456fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1457fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1458fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1459fc9c1727SLuigi 'Comio' Mantellini
1460fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1461fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
14626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1463fc9c1727SLuigi 'Comio' Mantellini
146417ea1177Swdenk- MII/PHY support:
146517ea1177Swdenk		CONFIG_PHY_ADDR
146617ea1177Swdenk
146717ea1177Swdenk		The address of PHY on MII bus.
146817ea1177Swdenk
146917ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
147017ea1177Swdenk
147117ea1177Swdenk		The clock frequency of the MII bus
147217ea1177Swdenk
147317ea1177Swdenk		CONFIG_PHY_GIGE
147417ea1177Swdenk
147517ea1177Swdenk		If this option is set, support for speed/duplex
147611ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
147717ea1177Swdenk
147817ea1177Swdenk		CONFIG_PHY_RESET_DELAY
147917ea1177Swdenk
148017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
148117ea1177Swdenk		reset before any MII register access is possible.
148217ea1177Swdenk		For such PHY, set this option to the usec delay
148317ea1177Swdenk		required. (minimum 300usec for LXT971A)
148417ea1177Swdenk
148517ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
148617ea1177Swdenk
148717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
148817ea1177Swdenk		command issued before MII status register can be read
148917ea1177Swdenk
1490c609719bSwdenk- Ethernet address:
1491c609719bSwdenk		CONFIG_ETHADDR
1492c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1493c609719bSwdenk		CONFIG_ETH2ADDR
1494c609719bSwdenk		CONFIG_ETH3ADDR
1495c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1496c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1497c609719bSwdenk
149811ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
149911ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1500c609719bSwdenk		is not determined automatically.
1501c609719bSwdenk
1502c609719bSwdenk- IP address:
1503c609719bSwdenk		CONFIG_IPADDR
1504c609719bSwdenk
1505c609719bSwdenk		Define a default value for the IP address to use for
150611ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1507c609719bSwdenk		determined through e.g. bootp.
15081ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1509c609719bSwdenk
1510c609719bSwdenk- Server IP address:
1511c609719bSwdenk		CONFIG_SERVERIP
1512c609719bSwdenk
1513c609719bSwdenk		Defines a default value for the IP address of a TFTP
1514c609719bSwdenk		server to contact when using the "tftboot" command.
15151ebcd654SWolfgang Denk		(Environment variable "serverip")
1516c609719bSwdenk
151797cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
151897cfe861SRobin Getz
151997cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
152097cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
152197cfe861SRobin Getz
15221ebcd654SWolfgang Denk- Gateway IP address:
15231ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
15241ebcd654SWolfgang Denk
15251ebcd654SWolfgang Denk		Defines a default value for the IP address of the
15261ebcd654SWolfgang Denk		default router where packets to other networks are
15271ebcd654SWolfgang Denk		sent to.
15281ebcd654SWolfgang Denk		(Environment variable "gatewayip")
15291ebcd654SWolfgang Denk
15301ebcd654SWolfgang Denk- Subnet mask:
15311ebcd654SWolfgang Denk		CONFIG_NETMASK
15321ebcd654SWolfgang Denk
15331ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
15341ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
15351ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
15361ebcd654SWolfgang Denk		forwarded through a router.
15371ebcd654SWolfgang Denk		(Environment variable "netmask")
15381ebcd654SWolfgang Denk
153953a5c424SDavid Updegraff- Multicast TFTP Mode:
154053a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
154153a5c424SDavid Updegraff
154253a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
154353a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
154411ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
154553a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
154653a5c424SDavid Updegraff		multicast group.
154753a5c424SDavid Updegraff
1548c609719bSwdenk- BOOTP Recovery Mode:
1549c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1550c609719bSwdenk
1551c609719bSwdenk		If you have many targets in a network that try to
1552c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1553c609719bSwdenk		systems send out BOOTP requests at precisely the same
1554c609719bSwdenk		moment (which would happen for instance at recovery
1555c609719bSwdenk		from a power failure, when all systems will try to
1556c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1557c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1558c609719bSwdenk		inserted before sending out BOOTP requests. The
15596c33c785SWolfgang Denk		following delays are inserted then:
1560c609719bSwdenk
1561c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1562c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1563c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1564c609719bSwdenk		4th and following
1565c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1566c609719bSwdenk
1567fe389a82Sstroese- DHCP Advanced Options:
15681fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
15691fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1570fe389a82Sstroese
15711fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
15721fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
15731fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
15741fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
15751fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
15761fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
15771fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
15781fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
15791fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
15801fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
15811fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
15821fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1583fe389a82Sstroese
15845d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
15855d110f0aSWilson Callan		environment variable, not the BOOTP server.
1586fe389a82Sstroese
1587fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1588fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1589fe389a82Sstroese		than one DNS serverip is offered to the client.
1590fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1591fe389a82Sstroese		serverip will be stored in the additional environment
1592fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1593fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
15941fe80d79SJon Loeliger		is defined.
1595fe389a82Sstroese
1596fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1597fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1598fe389a82Sstroese		need the hostname of the DHCP requester.
15995d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
16001fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
16011fe80d79SJon Loeliger		option 12 to the DHCP server.
1602fe389a82Sstroese
1603d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1604d9a2f416SAras Vaichas
1605d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1606d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1607d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1608d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1609d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1610d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1611d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1612d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1613d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1614d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1615d9a2f416SAras Vaichas		this delay.
1616d9a2f416SAras Vaichas
1617a3d991bdSwdenk - CDP Options:
1618a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1619a3d991bdSwdenk
1620a3d991bdSwdenk		The device id used in CDP trigger frames.
1621a3d991bdSwdenk
1622a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1623a3d991bdSwdenk
1624a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1625a3d991bdSwdenk		of the device.
1626a3d991bdSwdenk
1627a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1628a3d991bdSwdenk
1629a3d991bdSwdenk		A printf format string which contains the ascii name of
1630a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
163111ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1632a3d991bdSwdenk
1633a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1634a3d991bdSwdenk
1635a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1636a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1637a3d991bdSwdenk
1638a3d991bdSwdenk		CONFIG_CDP_VERSION
1639a3d991bdSwdenk
1640a3d991bdSwdenk		An ascii string containing the version of the software.
1641a3d991bdSwdenk
1642a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1643a3d991bdSwdenk
1644a3d991bdSwdenk		An ascii string containing the name of the platform.
1645a3d991bdSwdenk
1646a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1647a3d991bdSwdenk
1648a3d991bdSwdenk		A 32bit integer sent on the trigger.
1649a3d991bdSwdenk
1650a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1651a3d991bdSwdenk
1652a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1653a3d991bdSwdenk		device in .1 of milliwatts.
1654a3d991bdSwdenk
1655a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1656a3d991bdSwdenk
1657a3d991bdSwdenk		A byte containing the id of the VLAN.
1658a3d991bdSwdenk
1659c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1660c609719bSwdenk
1661c609719bSwdenk		Several configurations allow to display the current
1662c609719bSwdenk		status using a LED. For instance, the LED will blink
1663c609719bSwdenk		fast while running U-Boot code, stop blinking as
1664c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1665c609719bSwdenk		start blinking slow once the Linux kernel is running
1666c609719bSwdenk		(supported by a status LED driver in the Linux
1667c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1668c609719bSwdenk		feature in U-Boot.
1669c609719bSwdenk
1670c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1671c609719bSwdenk
1672c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1673c609719bSwdenk		on those systems that support this (optional)
1674c609719bSwdenk		feature, like the TQM8xxL modules.
1675c609719bSwdenk
1676c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1677c609719bSwdenk
1678b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1679b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
168011ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1681c609719bSwdenk
1682b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1683602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1684b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1685b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1686c609719bSwdenk		command line interface.
1687c609719bSwdenk
1688bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1689c609719bSwdenk
1690b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1691b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1692b37c7e5eSwdenk		support for I2C.
1693c609719bSwdenk
1694b37c7e5eSwdenk		There are several other quantities that must also be
1695b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1696c609719bSwdenk
16976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1698b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
16996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
170011ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1701c609719bSwdenk
17028d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1703a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
17048d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
17058d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
17068d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1707b37c7e5eSwdenk
17085da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
17095da71efaSEric Millbrandt
17105da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
17115da71efaSEric Millbrandt		chips might think that the current transfer is still
17125da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
17135da71efaSEric Millbrandt		commands until the slave device responds.
17145da71efaSEric Millbrandt
1715b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1716b37c7e5eSwdenk
1717b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1718b37c7e5eSwdenk		then the following macros need to be defined (examples are
1719b37c7e5eSwdenk		from include/configs/lwmon.h):
1720c609719bSwdenk
1721c609719bSwdenk		I2C_INIT
1722c609719bSwdenk
1723b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1724c609719bSwdenk		controller or configure ports.
1725c609719bSwdenk
1726b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1727b37c7e5eSwdenk
1728c609719bSwdenk		I2C_PORT
1729c609719bSwdenk
1730c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1731c609719bSwdenk		assumes both bits are on the same port). Valid values
1732c609719bSwdenk		are 0..3 for ports A..D.
1733c609719bSwdenk
1734c609719bSwdenk		I2C_ACTIVE
1735c609719bSwdenk
1736c609719bSwdenk		The code necessary to make the I2C data line active
1737c609719bSwdenk		(driven).  If the data line is open collector, this
1738c609719bSwdenk		define can be null.
1739c609719bSwdenk
1740b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1741b37c7e5eSwdenk
1742c609719bSwdenk		I2C_TRISTATE
1743c609719bSwdenk
1744c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1745c609719bSwdenk		(inactive).  If the data line is open collector, this
1746c609719bSwdenk		define can be null.
1747c609719bSwdenk
1748b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1749b37c7e5eSwdenk
1750c609719bSwdenk		I2C_READ
1751c609719bSwdenk
1752c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1753c609719bSwdenk		FALSE if it is low.
1754c609719bSwdenk
1755b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1756b37c7e5eSwdenk
1757c609719bSwdenk		I2C_SDA(bit)
1758c609719bSwdenk
1759c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1760c609719bSwdenk		is FALSE, it clears it (low).
1761c609719bSwdenk
1762b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1763b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1764b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1765b37c7e5eSwdenk
1766c609719bSwdenk		I2C_SCL(bit)
1767c609719bSwdenk
1768c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1769c609719bSwdenk		is FALSE, it clears it (low).
1770c609719bSwdenk
1771b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1772b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1773b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1774b37c7e5eSwdenk
1775c609719bSwdenk		I2C_DELAY
1776c609719bSwdenk
1777c609719bSwdenk		This delay is invoked four times per clock cycle so this
1778c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1779b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1780b37c7e5eSwdenk		like:
1781b37c7e5eSwdenk
1782b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1783c609719bSwdenk
1784793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1785793b5726SMike Frysinger
1786793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1787793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1788793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1789793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1790793b5726SMike Frysinger
1791793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1792793b5726SMike Frysinger		the generic GPIO functions.
1793793b5726SMike Frysinger
17946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
179547cd00faSwdenk
179647cd00faSwdenk		When a board is reset during an i2c bus transfer
179747cd00faSwdenk		chips might think that the current transfer is still
179847cd00faSwdenk		in progress. On some boards it is possible to access
179947cd00faSwdenk		the i2c SCLK line directly, either by using the
180047cd00faSwdenk		processor pin as a GPIO or by having a second pin
180147cd00faSwdenk		connected to the bus. If this option is defined a
180247cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
180347cd00faSwdenk		is run early in the boot sequence.
180447cd00faSwdenk
180526a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
180626a33504SRichard Retanubun
180726a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
180826a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
180926a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
181026a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
181126a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
181226a33504SRichard Retanubun		controller provide such a method. It is called at the end of
181326a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
181426a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
181526a33504SRichard Retanubun
181617ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
181717ea1177Swdenk
181817ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
181917ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
182017ea1177Swdenk		variable "i2cfast". (see also i2cfast)
182117ea1177Swdenk
1822bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1823bb99ad6dSBen Warren
1824bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1825bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
1826bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
1827bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1828bb99ad6dSBen Warren
18296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1830bb99ad6dSBen Warren
1831bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
18320f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
18330f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
18340f89c54bSPeter Tyser		a 1D array of device addresses
1835bb99ad6dSBen Warren
1836bb99ad6dSBen Warren		e.g.
1837bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
18386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
1839bb99ad6dSBen Warren
1840bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1841bb99ad6dSBen Warren
1842bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
18436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1844bb99ad6dSBen Warren
1845bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1846bb99ad6dSBen Warren
18476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1848be5e6181STimur Tabi
1849be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1850be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1851be5e6181STimur Tabi
18526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
18530dc018ecSStefan Roese
18540dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
18550dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
18560dc018ecSStefan Roese
18576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
18580dc018ecSStefan Roese
18590dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
18600dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
18610dc018ecSStefan Roese
18626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
18639ebbb54fSVictor Gallardo
18649ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
18659ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
18669ebbb54fSVictor Gallardo		specified DTT device.
18679ebbb54fSVictor Gallardo
1868be5e6181STimur Tabi		CONFIG_FSL_I2C
1869be5e6181STimur Tabi
1870be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
18717817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1872be5e6181STimur Tabi
187367b23a32SHeiko Schocher		CONFIG_I2C_MUX
187467b23a32SHeiko Schocher
187567b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
187667b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
187767b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
187867b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
187967b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
188067b23a32SHeiko Schocher		the muxes to activate this new "bus".
188167b23a32SHeiko Schocher
188267b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
188367b23a32SHeiko Schocher		feature!
188467b23a32SHeiko Schocher
188567b23a32SHeiko Schocher		Example:
188667b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
188767b23a32SHeiko Schocher			The First mux with address 70 and channel 6
188867b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
188967b23a32SHeiko Schocher
189067b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
189167b23a32SHeiko Schocher
189267b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
189367b23a32SHeiko Schocher		of I2C Busses with muxes:
189467b23a32SHeiko Schocher
189567b23a32SHeiko Schocher		=> i2c bus
189667b23a32SHeiko Schocher		Busses reached over muxes:
189767b23a32SHeiko Schocher		Bus ID: 2
189867b23a32SHeiko Schocher		  reached over Mux(es):
189967b23a32SHeiko Schocher		    pca9544a@70 ch: 4
190067b23a32SHeiko Schocher		Bus ID: 3
190167b23a32SHeiko Schocher		  reached over Mux(es):
190267b23a32SHeiko Schocher		    pca9544a@70 ch: 6
190367b23a32SHeiko Schocher		    pca9544a@71 ch: 4
190467b23a32SHeiko Schocher		=>
190567b23a32SHeiko Schocher
190667b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1907f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1908f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
190967b23a32SHeiko Schocher		the channel 4.
191067b23a32SHeiko Schocher
191167b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1912f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
191367b23a32SHeiko Schocher		the 2 muxes.
191467b23a32SHeiko Schocher
191567b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
191667b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
191767b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
191867b23a32SHeiko Schocher		to add this option to other architectures.
191967b23a32SHeiko Schocher
19202ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
19212ac6985aSAndrew Dyer
19222ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
19232ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
19242ac6985aSAndrew Dyer		between writing the address pointer and reading the
19252ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
19262ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
19272ac6985aSAndrew Dyer		devices can use either method, but some require one or
19282ac6985aSAndrew Dyer		the other.
1929be5e6181STimur Tabi
1930c609719bSwdenk- SPI Support:	CONFIG_SPI
1931c609719bSwdenk
1932c609719bSwdenk		Enables SPI driver (so far only tested with
1933c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1934c609719bSwdenk		D/As on the SACSng board)
1935c609719bSwdenk
19366639562eSYoshihiro Shimoda		CONFIG_SH_SPI
19376639562eSYoshihiro Shimoda
19386639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
19396639562eSYoshihiro Shimoda		only SH7757 is supported.
19406639562eSYoshihiro Shimoda
1941c609719bSwdenk		CONFIG_SPI_X
1942c609719bSwdenk
1943c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1944c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1945c609719bSwdenk
1946c609719bSwdenk		CONFIG_SOFT_SPI
1947c609719bSwdenk
1948c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1949c609719bSwdenk		using hardware support. This is a general purpose
1950c609719bSwdenk		driver that only requires three general I/O port pins
1951c609719bSwdenk		(two outputs, one input) to function. If this is
1952c609719bSwdenk		defined, the board configuration must define several
1953c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1954c609719bSwdenk		an example, see include/configs/sacsng.h.
1955c609719bSwdenk
195604a9e118SBen Warren		CONFIG_HARD_SPI
195704a9e118SBen Warren
195804a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
195904a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
196004a9e118SBen Warren		must define a list of chip-select function pointers.
196104a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
196204a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
196304a9e118SBen Warren
196438254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
196538254f45SGuennadi Liakhovetski
196638254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
19672e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
196838254f45SGuennadi Liakhovetski
19690133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
19700133502eSMatthias Fuchs
19710133502eSMatthias Fuchs		Enables FPGA subsystem.
19720133502eSMatthias Fuchs
19730133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
19740133502eSMatthias Fuchs
19750133502eSMatthias Fuchs		Enables support for specific chip vendors.
19760133502eSMatthias Fuchs		(ALTERA, XILINX)
19770133502eSMatthias Fuchs
19780133502eSMatthias Fuchs		CONFIG_FPGA_<family>
19790133502eSMatthias Fuchs
19800133502eSMatthias Fuchs		Enables support for FPGA family.
19810133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
19820133502eSMatthias Fuchs
19830133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1984c609719bSwdenk
1985c609719bSwdenk		Specify the number of FPGA devices to support.
1986c609719bSwdenk
19876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1988c609719bSwdenk
1989c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1990c609719bSwdenk
19916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1992c609719bSwdenk
1993c609719bSwdenk		Enable checks on FPGA configuration interface busy
1994c609719bSwdenk		status by the configuration function. This option
1995c609719bSwdenk		will require a board or device specific function to
1996c609719bSwdenk		be written.
1997c609719bSwdenk
1998c609719bSwdenk		CONFIG_FPGA_DELAY
1999c609719bSwdenk
2000c609719bSwdenk		If defined, a function that provides delays in the FPGA
2001c609719bSwdenk		configuration driver.
2002c609719bSwdenk
20036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2004c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2005c609719bSwdenk
20066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2007c609719bSwdenk
2008c609719bSwdenk		Check for configuration errors during FPGA bitfile
2009c609719bSwdenk		loading. For example, abort during Virtex II
2010c609719bSwdenk		configuration if the INIT_B line goes low (which
2011c609719bSwdenk		indicated a CRC error).
2012c609719bSwdenk
20136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2014c609719bSwdenk
2015c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
2016c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
2017c609719bSwdenk		FPGA configuration sequence. The default time is 500
201811ccc33fSMarcel Ziswiler		ms.
2019c609719bSwdenk
20206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2021c609719bSwdenk
2022c609719bSwdenk		Maximum time to wait for BUSY to deassert during
202311ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2024c609719bSwdenk
20256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2026c609719bSwdenk
2027c609719bSwdenk		Time to wait after FPGA configuration. The default is
202811ccc33fSMarcel Ziswiler		200 ms.
2029c609719bSwdenk
2030c609719bSwdenk- Configuration Management:
2031c609719bSwdenk		CONFIG_IDENT_STRING
2032c609719bSwdenk
2033c609719bSwdenk		If defined, this string will be added to the U-Boot
2034c609719bSwdenk		version information (U_BOOT_VERSION)
2035c609719bSwdenk
2036c609719bSwdenk- Vendor Parameter Protection:
2037c609719bSwdenk
2038c609719bSwdenk		U-Boot considers the values of the environment
2039c609719bSwdenk		variables "serial#" (Board Serial Number) and
20407152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2041c609719bSwdenk		are set once by the board vendor / manufacturer, and
2042c609719bSwdenk		protects these variables from casual modification by
2043c609719bSwdenk		the user. Once set, these variables are read-only,
2044c609719bSwdenk		and write or delete attempts are rejected. You can
204511ccc33fSMarcel Ziswiler		change this behaviour:
2046c609719bSwdenk
2047c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2048c609719bSwdenk		file, the write protection for vendor parameters is
204947cd00faSwdenk		completely disabled. Anybody can change or delete
2050c609719bSwdenk		these parameters.
2051c609719bSwdenk
2052c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
2053c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
205411ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2055c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2056c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2057c609719bSwdenk		read-only.]
2058c609719bSwdenk
2059c609719bSwdenk- Protected RAM:
2060c609719bSwdenk		CONFIG_PRAM
2061c609719bSwdenk
2062c609719bSwdenk		Define this variable to enable the reservation of
2063c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2064c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2065c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2066c609719bSwdenk		this default value by defining an environment
2067c609719bSwdenk		variable "pram" to the number of kB you want to
2068c609719bSwdenk		reserve. Note that the board info structure will
2069c609719bSwdenk		still show the full amount of RAM. If pRAM is
2070c609719bSwdenk		reserved, a new environment variable "mem" will
2071c609719bSwdenk		automatically be defined to hold the amount of
2072c609719bSwdenk		remaining RAM in a form that can be passed as boot
2073c609719bSwdenk		argument to Linux, for instance like that:
2074c609719bSwdenk
2075fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2076c609719bSwdenk			saveenv
2077c609719bSwdenk
2078c609719bSwdenk		This way you can tell Linux not to use this memory,
2079c609719bSwdenk		either, which results in a memory region that will
2080c609719bSwdenk		not be affected by reboots.
2081c609719bSwdenk
2082c609719bSwdenk		*WARNING* If your board configuration uses automatic
2083c609719bSwdenk		detection of the RAM size, you must make sure that
2084c609719bSwdenk		this memory test is non-destructive. So far, the
2085c609719bSwdenk		following board configurations are known to be
2086c609719bSwdenk		"pRAM-clean":
2087c609719bSwdenk
2088c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
2089c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
2090544d97e9SWolfgang Denk			FLAGADM, TQM8260
2091c609719bSwdenk
2092c609719bSwdenk- Error Recovery:
2093c609719bSwdenk		CONFIG_PANIC_HANG
2094c609719bSwdenk
2095c609719bSwdenk		Define this variable to stop the system in case of a
2096c609719bSwdenk		fatal error, so that you have to reset it manually.
2097c609719bSwdenk		This is probably NOT a good idea for an embedded
209811ccc33fSMarcel Ziswiler		system where you want the system to reboot
2099c609719bSwdenk		automatically as fast as possible, but it may be
2100c609719bSwdenk		useful during development since you can try to debug
2101c609719bSwdenk		the conditions that lead to the situation.
2102c609719bSwdenk
2103c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2104c609719bSwdenk
2105c609719bSwdenk		This variable defines the number of retries for
2106c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2107c609719bSwdenk		before giving up the operation. If not defined, a
2108c609719bSwdenk		default value of 5 is used.
2109c609719bSwdenk
211040cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
211140cb90eeSGuennadi Liakhovetski
211240cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
211340cb90eeSGuennadi Liakhovetski
2114c609719bSwdenk- Command Interpreter:
21158078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
211604a85b3bSwdenk
211704a85b3bSwdenk		Enable auto completion of commands using TAB.
211804a85b3bSwdenk
21198078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
21208078f1a5SWolfgang Denk		for the "hush" shell.
21218078f1a5SWolfgang Denk
21228078f1a5SWolfgang Denk
21236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
2124c609719bSwdenk
2125c609719bSwdenk		Define this variable to enable the "hush" shell (from
2126c609719bSwdenk		Busybox) as command line interpreter, thus enabling
2127c609719bSwdenk		powerful command line syntax like
2128c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
2129c609719bSwdenk		constructs ("shell scripts").
2130c609719bSwdenk
2131c609719bSwdenk		If undefined, you get the old, much simpler behaviour
2132c609719bSwdenk		with a somewhat smaller memory footprint.
2133c609719bSwdenk
2134c609719bSwdenk
21356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2136c609719bSwdenk
2137c609719bSwdenk		This defines the secondary prompt string, which is
2138c609719bSwdenk		printed when the command interpreter needs more input
2139c609719bSwdenk		to complete a command. Usually "> ".
2140c609719bSwdenk
2141c609719bSwdenk	Note:
2142c609719bSwdenk
2143c609719bSwdenk		In the current implementation, the local variables
2144c609719bSwdenk		space and global environment variables space are
2145c609719bSwdenk		separated. Local variables are those you define by
21463b57fe0aSwdenk		simply typing `name=value'. To access a local
2147c609719bSwdenk		variable later on, you have write `$name' or
21483b57fe0aSwdenk		`${name}'; to execute the contents of a variable
21493b57fe0aSwdenk		directly type `$name' at the command prompt.
2150c609719bSwdenk
2151c609719bSwdenk		Global environment variables are those you use
2152c609719bSwdenk		setenv/printenv to work with. To run a command stored
2153c609719bSwdenk		in such a variable, you need to use the run command,
2154c609719bSwdenk		and you must not use the '$' sign to access them.
2155c609719bSwdenk
2156c609719bSwdenk		To store commands and special characters in a
2157c609719bSwdenk		variable, please use double quotation marks
2158c609719bSwdenk		surrounding the whole text of the variable, instead
2159c609719bSwdenk		of the backslashes before semicolons and special
2160c609719bSwdenk		symbols.
2161c609719bSwdenk
2162aa0c71acSWolfgang Denk- Commandline Editing and History:
2163aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2164aa0c71acSWolfgang Denk
216511ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2166aa0c71acSWolfgang Denk		commandline input operations
2167aa0c71acSWolfgang Denk
2168a8c7c708Swdenk- Default Environment:
2169c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2170c609719bSwdenk
2171c609719bSwdenk		Define this to contain any number of null terminated
2172c609719bSwdenk		strings (variable = value pairs) that will be part of
21737152b1d0Swdenk		the default environment compiled into the boot image.
21742262cfeeSwdenk
2175c609719bSwdenk		For example, place something like this in your
2176c609719bSwdenk		board's config file:
2177c609719bSwdenk
2178c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2179c609719bSwdenk			"myvar1=value1\0" \
2180c609719bSwdenk			"myvar2=value2\0"
2181c609719bSwdenk
2182c609719bSwdenk		Warning: This method is based on knowledge about the
2183c609719bSwdenk		internal format how the environment is stored by the
21842262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2185c609719bSwdenk		interface! Although it is unlikely that this format
21867152b1d0Swdenk		will change soon, there is no guarantee either.
2187c609719bSwdenk		You better know what you are doing here.
2188c609719bSwdenk
2189c609719bSwdenk		Note: overly (ab)use of the default environment is
2190c609719bSwdenk		discouraged. Make sure to check other ways to preset
219174de7aefSWolfgang Denk		the environment like the "source" command or the
2192c609719bSwdenk		boot command first.
2193c609719bSwdenk
2194a8c7c708Swdenk- DataFlash Support:
21952abbe075Swdenk		CONFIG_HAS_DATAFLASH
21962abbe075Swdenk
21972abbe075Swdenk		Defining this option enables DataFlash features and
21982abbe075Swdenk		allows to read/write in Dataflash via the standard
21992abbe075Swdenk		commands cp, md...
22002abbe075Swdenk
2201f61ec45eSEric Nelson- Serial Flash support
2202f61ec45eSEric Nelson		CONFIG_CMD_SF
2203f61ec45eSEric Nelson
2204f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2205f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2206f61ec45eSEric Nelson
2207f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2208f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2209f61ec45eSEric Nelson		commands.
2210f61ec45eSEric Nelson
2211f61ec45eSEric Nelson		The following defaults may be provided by the platform
2212f61ec45eSEric Nelson		to handle the common case when only a single serial
2213f61ec45eSEric Nelson		flash is present on the system.
2214f61ec45eSEric Nelson
2215f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2216f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2217f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2218f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2219f61ec45eSEric Nelson
22203f85ce27Swdenk- SystemACE Support:
22213f85ce27Swdenk		CONFIG_SYSTEMACE
22223f85ce27Swdenk
22233f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
22243f85ce27Swdenk		chips attached via some sort of local bus. The address
222511ccc33fSMarcel Ziswiler		of the chip must also be defined in the
22266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
22273f85ce27Swdenk
22283f85ce27Swdenk		#define CONFIG_SYSTEMACE
22296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
22303f85ce27Swdenk
22313f85ce27Swdenk		When SystemACE support is added, the "ace" device type
22323f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
22333f85ce27Swdenk
2234ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2235ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2236ecb0ccd9SWolfgang Denk
223728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2238ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
223928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2240ecb0ccd9SWolfgang Denk		number generator is used.
2241ecb0ccd9SWolfgang Denk
224228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
224328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
224428cb9375SWolfgang Denk		defined, the normal port 69 is used.
224528cb9375SWolfgang Denk
224628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2247ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2248ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2249ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2250ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2251ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2252ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2253ecb0ccd9SWolfgang Denk
2254a8c7c708Swdenk- Show boot progress:
2255c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2256c609719bSwdenk
2257c609719bSwdenk		Defining this option allows to add some board-
2258c609719bSwdenk		specific code (calling a user-provided function
2259c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2260c609719bSwdenk		the system's boot progress on some display (for
2261c609719bSwdenk		example, some LED's) on your board. At the moment,
2262c609719bSwdenk		the following checkpoints are implemented:
2263c609719bSwdenk
2264*3a608ca0SSimon Glass- Detailed boot stage timing
2265*3a608ca0SSimon Glass		CONFIG_BOOTSTAGE
2266*3a608ca0SSimon Glass		Define this option to get detailed timing of each stage
2267*3a608ca0SSimon Glass		of the boot process.
2268*3a608ca0SSimon Glass
2269*3a608ca0SSimon Glass		CONFIG_BOOTSTAGE_USER_COUNT
2270*3a608ca0SSimon Glass		This is the number of available user bootstage records.
2271*3a608ca0SSimon Glass		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
2272*3a608ca0SSimon Glass		a new ID will be allocated from this stash. If you exceed
2273*3a608ca0SSimon Glass		the limit, recording will stop.
2274*3a608ca0SSimon Glass
2275*3a608ca0SSimon Glass		CONFIG_BOOTSTAGE_REPORT
2276*3a608ca0SSimon Glass		Define this to print a report before boot, similar to this:
2277*3a608ca0SSimon Glass
2278*3a608ca0SSimon Glass		Timer summary in microseconds:
2279*3a608ca0SSimon Glass		       Mark    Elapsed  Stage
2280*3a608ca0SSimon Glass			  0          0  reset
2281*3a608ca0SSimon Glass		  3,575,678  3,575,678  board_init_f start
2282*3a608ca0SSimon Glass		  3,575,695         17  arch_cpu_init A9
2283*3a608ca0SSimon Glass		  3,575,777         82  arch_cpu_init done
2284*3a608ca0SSimon Glass		  3,659,598     83,821  board_init_r start
2285*3a608ca0SSimon Glass		  3,910,375    250,777  main_loop
2286*3a608ca0SSimon Glass		 29,916,167 26,005,792  bootm_start
2287*3a608ca0SSimon Glass		 30,361,327    445,160  start_kernel
2288*3a608ca0SSimon Glass
22891372cce2SMarian BalakowiczLegacy uImage format:
22901372cce2SMarian Balakowicz
2291c609719bSwdenk  Arg	Where			When
2292c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2293c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2294c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2295c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2296c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2297c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2298c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2299c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2300c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
23011372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2302c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2303c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2304c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2305c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
23061372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2307c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
23081372cce2SMarian Balakowicz
23091372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
23101372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
23111372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
23121372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
23131372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
23141372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
23151372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
231611ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
23171372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
23181372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
23191372cce2SMarian Balakowicz
2320ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2321c609719bSwdenk
2322a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
232363e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
232463e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
232563e73c9aSwdenk
2326566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2327566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2328566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2329566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2330566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2331566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2332566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2333566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2334566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2335566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2336566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2337566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2338566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2339566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2340566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2341566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2342566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2343566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2344566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2345566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2346566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2347566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2348566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2349566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2350566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2351566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2352566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2353566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2354566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2355566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2356566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2357566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2358566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2359566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2360566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2361566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2362566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2363566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2364566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2365566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2366566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2367566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2368566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2369566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2370566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2371566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2372566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2373c609719bSwdenk
2374566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2375c609719bSwdenk
2376566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2377566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2378566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2379206c60cbSwdenk
2380566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2381566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
238211ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2383566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2384566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2385566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
238674de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
238774de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2388566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2389c609719bSwdenk
23901372cce2SMarian BalakowiczFIT uImage format:
23911372cce2SMarian Balakowicz
23921372cce2SMarian Balakowicz  Arg	Where			When
23931372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
23941372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
23951372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
23961372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
23971372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
23981372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2399f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
24001372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
24011372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
24021372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
24031372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
24041372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
240511ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
240611ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
24071372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
24081372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
24091372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
24101372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
24111372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
24121372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
24131372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
24141372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
24151372cce2SMarian Balakowicz
24161372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
24171372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
24181372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
241911ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
24201372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
24211372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
24221372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
24231372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
24241372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
24251372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
24261372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
24271372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
24281372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
24291372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
24301372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
24311372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
24321372cce2SMarian Balakowicz
243311ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
24341372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
24351372cce2SMarian Balakowicz
243611ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
24371372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
24381372cce2SMarian Balakowicz
243911ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
24401372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
24411372cce2SMarian Balakowicz
24424cf2609bSWolfgang Denk- Standalone program support:
24434cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
24444cf2609bSWolfgang Denk
24456feff899SWolfgang Denk		This option defines a board specific value for the
24466feff899SWolfgang Denk		address where standalone program gets loaded, thus
24476feff899SWolfgang Denk		overwriting the architecture dependent default
24484cf2609bSWolfgang Denk		settings.
24494cf2609bSWolfgang Denk
24504cf2609bSWolfgang Denk- Frame Buffer Address:
24514cf2609bSWolfgang Denk		CONFIG_FB_ADDR
24524cf2609bSWolfgang Denk
24534cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
24544cf2609bSWolfgang Denk		address for frame buffer.
24554cf2609bSWolfgang Denk		Then system will reserve the frame buffer address to
24564cf2609bSWolfgang Denk		defined address instead of lcd_setmem (this function
24576feff899SWolfgang Denk		grabs the memory for frame buffer by panel's size).
24584cf2609bSWolfgang Denk
24594cf2609bSWolfgang Denk		Please see board_init_f function.
24604cf2609bSWolfgang Denk
2461cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2462cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2463cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2464cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2465cccfc2abSDetlev Zundel
2466cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2467cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2468cccfc2abSDetlev Zundel
2469cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2470cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2471cccfc2abSDetlev Zundel
2472cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2473cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2474cccfc2abSDetlev Zundel
2475cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2476cccfc2abSDetlev Zundel
2477cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2478cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2479cccfc2abSDetlev Zundel
24806a11cf48SDaniel Schwierzeck- SPL framework
24816a11cf48SDaniel Schwierzeck		CONFIG_SPL
24826a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
24836a11cf48SDaniel Schwierzeck
24846a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
24856a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
24866a11cf48SDaniel Schwierzeck
24876a11cf48SDaniel Schwierzeck		CONFIG_SPL_LDSCRIPT
24886a11cf48SDaniel Schwierzeck		LDSCRIPT for linking the SPL binary.
24896a11cf48SDaniel Schwierzeck
24906a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
24916a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
24926a11cf48SDaniel Schwierzeck
24936a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
24946a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
24956a11cf48SDaniel Schwierzeck
24966a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
24976a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
24986a11cf48SDaniel Schwierzeck
24996a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
25006a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
25016a11cf48SDaniel Schwierzeck
25026a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
25036a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
25046a11cf48SDaniel Schwierzeck
25056a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
25066a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
25076a11cf48SDaniel Schwierzeck
25086a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
25096a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
25106a11cf48SDaniel Schwierzeck
25116a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
25126a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
25136a11cf48SDaniel Schwierzeck
25146a11cf48SDaniel Schwierzeck		CONFIG_SPL_FAT_SUPPORT
25156a11cf48SDaniel Schwierzeck		Support for fs/fat/libfat.o in SPL binary
25166a11cf48SDaniel Schwierzeck
25176a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
25186a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
25191372cce2SMarian Balakowicz
2520c609719bSwdenkModem Support:
2521c609719bSwdenk--------------
2522c609719bSwdenk
2523566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2524c609719bSwdenk
252511ccc33fSMarcel Ziswiler- Modem support enable:
2526c609719bSwdenk		CONFIG_MODEM_SUPPORT
2527c609719bSwdenk
2528c609719bSwdenk- RTS/CTS Flow control enable:
2529c609719bSwdenk		CONFIG_HWFLOW
2530c609719bSwdenk
2531c609719bSwdenk- Modem debug support:
2532c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2533c609719bSwdenk
2534c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2535c609719bSwdenk		for modem support. Useful only with BDI2000.
2536c609719bSwdenk
2537a8c7c708Swdenk- Interrupt support (PPC):
2538a8c7c708Swdenk
2539a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2540a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
254111ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2542a8c7c708Swdenk		should set decrementer_count to appropriate value. If
254311ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2544a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
254511ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2546a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2547a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2548a8c7c708Swdenk		general timer_interrupt().
2549a8c7c708Swdenk
2550c609719bSwdenk- General:
2551c609719bSwdenk
2552c609719bSwdenk		In the target system modem support is enabled when a
2553c609719bSwdenk		specific key (key combination) is pressed during
2554c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
255511ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2556c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2557c609719bSwdenk		function, returning 1 and thus enabling modem
2558c609719bSwdenk		initialization.
2559c609719bSwdenk
2560c609719bSwdenk		If there are no modem init strings in the
2561c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2562c609719bSwdenk		previous output (banner, info printfs) will be
256311ccc33fSMarcel Ziswiler		suppressed, though.
2564c609719bSwdenk
2565c609719bSwdenk		See also: doc/README.Modem
2566c609719bSwdenk
25679660e442SHelmut RaigerBoard initialization settings:
25689660e442SHelmut Raiger------------------------------
25699660e442SHelmut Raiger
25709660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
25719660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
25729660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
25739660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
25749660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
25759660e442SHelmut Raigertypically in board_init_f() and board_init_r().
25769660e442SHelmut Raiger
25779660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
25789660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
25799660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
25809660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
2581c609719bSwdenk
2582c609719bSwdenkConfiguration Settings:
2583c609719bSwdenk-----------------------
2584c609719bSwdenk
25856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2586c609719bSwdenk		undefine this when you're short of memory.
2587c609719bSwdenk
25882fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
25892fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
25902fb2604dSPeter Tyser
25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2592c609719bSwdenk		prompt for user input.
2593c609719bSwdenk
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2595c609719bSwdenk
25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2597c609719bSwdenk
25986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2599c609719bSwdenk
26006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2601c609719bSwdenk		the application (usually a Linux kernel) when it is
2602c609719bSwdenk		booted
2603c609719bSwdenk
26046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2605c609719bSwdenk		List of legal baudrate settings for this board.
2606c609719bSwdenk
26076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2608c609719bSwdenk		Suppress display of console information at boot.
2609c609719bSwdenk
26106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2611c609719bSwdenk		If the board specific function
2612c609719bSwdenk			extern int overwrite_console (void);
2613c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2614c609719bSwdenk		serial port, else the settings in the environment are used.
2615c609719bSwdenk
26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2617c609719bSwdenk		Enable the call to overwrite_console().
2618c609719bSwdenk
26196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2620c609719bSwdenk		Enable overwrite of previous console environment settings.
2621c609719bSwdenk
26226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2623c609719bSwdenk		Begin and End addresses of the area used by the
2624c609719bSwdenk		simple memory test.
2625c609719bSwdenk
26266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2627c609719bSwdenk		Enable an alternate, more extensive memory test.
2628c609719bSwdenk
26296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
26305f535fe1Swdenk		Scratch address used by the alternate memory test
26315f535fe1Swdenk		You only need to set this if address zero isn't writeable
26325f535fe1Swdenk
26336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
263514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
263611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
263714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
263814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
263914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
26405e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
264114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
26425e12e75dSStefan Roese		will have to get fixed in Linux additionally.
264314f73ca6SStefan Roese
264414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
264514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
264614f73ca6SStefan Roese		be touched.
264714f73ca6SStefan Roese
264814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
264914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
265014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
265114f73ca6SStefan Roese		non page size aligned address and this could cause major
265214f73ca6SStefan Roese		problems.
265314f73ca6SStefan Roese
26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2655c609719bSwdenk		Default load address for network file downloads
2656c609719bSwdenk
26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2658c609719bSwdenk		Enable temporary baudrate change while serial download
2659c609719bSwdenk
26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2661c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2662c609719bSwdenk
26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2664c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2665c609719bSwdenk		Cogent motherboard)
2666c609719bSwdenk
26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2668c609719bSwdenk		Physical start address of Flash memory.
2669c609719bSwdenk
26706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2671c609719bSwdenk		Physical start address of boot monitor code (set by
2672c609719bSwdenk		make config files to be same as the text base address
267314d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
26746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2675c609719bSwdenk
26766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
26773b57fe0aSwdenk		Size of memory reserved for monitor code, used to
26783b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
26793b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
26803b57fe0aSwdenk		flash sector.
2681c609719bSwdenk
26826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2683c609719bSwdenk		Size of DRAM reserved for malloc() use.
2684c609719bSwdenk
26856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
268615940c9aSStefan Roese		Normally compressed uImages are limited to an
268715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
26886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
268915940c9aSStefan Roese		to adjust this setting to your needs.
2690c609719bSwdenk
26916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2692c609719bSwdenk		Maximum size of memory mapped by the startup code of
2693c609719bSwdenk		the Linux kernel; all data that must be processed by
26947d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
26957d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
26967d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
26977d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2698c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
2699c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2700c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2701c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2702c609719bSwdenk
2703fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2704fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2705fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2706fca43cc8SJohn Rigby		is enabled.
2707fca43cc8SJohn Rigby
2708fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2709fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2710fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2711fca43cc8SJohn Rigby
2712fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2713fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2714fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2715fca43cc8SJohn Rigby
27166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2717c609719bSwdenk		Max number of Flash memory banks
2718c609719bSwdenk
27196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2720c609719bSwdenk		Max number of sectors on a Flash chip
2721c609719bSwdenk
27226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2723c609719bSwdenk		Timeout for Flash erase operations (in ms)
2724c609719bSwdenk
27256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2726c609719bSwdenk		Timeout for Flash write operations (in ms)
2727c609719bSwdenk
27286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
27298564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
27308564acf9Swdenk
27316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
27328564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
27338564acf9Swdenk
27346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
27358564acf9Swdenk		If defined, hardware flash sectors protection is used
27368564acf9Swdenk		instead of U-Boot software protection.
27378564acf9Swdenk
27386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2739c609719bSwdenk
2740c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2741c609719bSwdenk		without this option such a download has to be
2742c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2743c609719bSwdenk		copy from RAM to flash.
2744c609719bSwdenk
2745c609719bSwdenk		The two-step approach is usually more reliable, since
2746c609719bSwdenk		you can check if the download worked before you erase
274711ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
274811ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2749c609719bSwdenk		downloaded image) this option may be very useful.
2750c609719bSwdenk
27516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2752c609719bSwdenk		Define if the flash driver uses extra elements in the
27535653fc33Swdenk		common flash structure for storing flash geometry.
27545653fc33Swdenk
275500b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
27565653fc33Swdenk		This option also enables the building of the cfi_flash driver
27575653fc33Swdenk		in the drivers directory
275853cf9435Sstroese
275991809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
276091809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
276191809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
276291809ed5SPiotr Ziecik		to the MTD layer.
276391809ed5SPiotr Ziecik
27646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
276596ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
276696ef831fSGuennadi Liakhovetski
276796ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
276896ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
276996ef831fSGuennadi Liakhovetski		write commands.
277096ef831fSGuennadi Liakhovetski
27716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
27725568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
27735568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
27745568e613SStefan Roese		is useful, if some of the configured banks are only
27755568e613SStefan Roese		optionally available.
27765568e613SStefan Roese
27779a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
27789a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
27799a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
27809a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
27819a042e9cSJerry Van Baren
27826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
278311ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
278411ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
278553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
278653cf9435Sstroese		buffers can be full shortly after enabling the interface
278711ccc33fSMarcel Ziswiler		on high Ethernet traffic.
278853cf9435Sstroese		Defaults to 4 if not defined.
2789c609719bSwdenk
2790ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2791ea882bafSWolfgang Denk
2792ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2793ea882bafSWolfgang Denk	internally to store the environment settings. The default
2794ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2795ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2796ea882bafSWolfgang Denk	lib/hashtable.c for details.
2797ea882bafSWolfgang Denk
2798c609719bSwdenkThe following definitions that deal with the placement and management
2799c609719bSwdenkof environment data (variable area); in general, we support the
2800c609719bSwdenkfollowing configurations:
2801c609719bSwdenk
2802c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2803c3eb3fe4SMike Frysinger
2804c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2805c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2806c3eb3fe4SMike Frysinger
28075a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2808c609719bSwdenk
2809c609719bSwdenk	Define this if the environment is in flash memory.
2810c609719bSwdenk
2811c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2812c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2813c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2814c609719bSwdenk	   sector" type flash chips, which have several smaller
2815c609719bSwdenk	   sectors at the start or the end. For instance, such a
2816c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2817c609719bSwdenk	   such a case you would place the environment in one of the
2818c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2819c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2820c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2821c609719bSwdenk	   between U-Boot and the environment.
2822c609719bSwdenk
28230e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2824c609719bSwdenk
2825c609719bSwdenk	   Offset of environment data (variable area) to the
2826c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2827c609719bSwdenk	   type flash chips the second sector can be used: the offset
2828c609719bSwdenk	   for this sector is given here.
2829c609719bSwdenk
28306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2831c609719bSwdenk
28320e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2833c609719bSwdenk
2834c609719bSwdenk	   This is just another way to specify the start address of
2835c609719bSwdenk	   the flash sector containing the environment (instead of
28360e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2837c609719bSwdenk
28380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2839c609719bSwdenk
2840c609719bSwdenk	   Size of the sector containing the environment.
2841c609719bSwdenk
2842c609719bSwdenk
2843c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2844c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2845c609719bSwdenk	   the environment.
2846c609719bSwdenk
28470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2848c609719bSwdenk
28495a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
28500e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2851c609719bSwdenk	   of this flash sector for the environment. This saves
2852c609719bSwdenk	   memory for the RAM copy of the environment.
2853c609719bSwdenk
2854c609719bSwdenk	   It may also save flash memory if you decide to use this
2855c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2856c609719bSwdenk	   since then the remainder of the flash sector could be used
2857c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2858c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2859c609719bSwdenk	   updating the environment in flash makes it always
2860c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2861c609719bSwdenk	   wrong before the contents has been restored from a copy in
2862c609719bSwdenk	   RAM, your target system will be dead.
2863c609719bSwdenk
28640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
28650e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2866c609719bSwdenk
2867c609719bSwdenk	   These settings describe a second storage area used to hold
286811ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
28693e38691eSwdenk	   a valid backup copy in case there is a power failure during
2870c609719bSwdenk	   a "saveenv" operation.
2871c609719bSwdenk
2872c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2873c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2874c609719bSwdenkaccordingly!
2875c609719bSwdenk
2876c609719bSwdenk
28779314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2878c609719bSwdenk
2879c609719bSwdenk	Define this if you have some non-volatile memory device
2880c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2881c609719bSwdenk	environment.
2882c609719bSwdenk
28830e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
28840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2885c609719bSwdenk
288611ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2887c609719bSwdenk	  want to use for environment. It is assumed that this memory
2888c609719bSwdenk	  can just be read and written to, without any special
2889c609719bSwdenk	  provision.
2890c609719bSwdenk
2891c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2892c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
289311ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2894c609719bSwdenkU-Boot will hang.
2895c609719bSwdenk
2896c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2897c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2898c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2899c609719bSwdenkto save the current settings.
2900c609719bSwdenk
2901c609719bSwdenk
2902bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2903c609719bSwdenk
2904c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2905c609719bSwdenk	device and a driver for it.
2906c609719bSwdenk
29070e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
29080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2909c609719bSwdenk
2910c609719bSwdenk	  These two #defines specify the offset and size of the
2911c609719bSwdenk	  environment area within the total memory of your EEPROM.
2912c609719bSwdenk
29136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2914c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2915c609719bSwdenk	  The default address is zero.
2916c609719bSwdenk
29176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2918c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2919c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2920c609719bSwdenk	  would require six bits.
2921c609719bSwdenk
29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2923c609719bSwdenk	  If defined, the number of milliseconds to delay between
2924c609719bSwdenk	  page writes.	The default is zero milliseconds.
2925c609719bSwdenk
29266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2927c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2928c609719bSwdenk	  that this is NOT the chip address length!
2929c609719bSwdenk
29306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
29315cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
29325cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
29335cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
29345cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
29355cf91d6bSwdenk	  byte chips.
29365cf91d6bSwdenk
29375cf91d6bSwdenk	  Note that we consider the length of the address field to
29385cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
29395cf91d6bSwdenk	  in the chip address.
29405cf91d6bSwdenk
29416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2942c609719bSwdenk	  The size in bytes of the EEPROM device.
2943c609719bSwdenk
2944548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2945548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2946548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2947548738b4SHeiko Schocher
2948548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2949548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2950548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2951548738b4SHeiko Schocher	  EEPROM. For example:
2952548738b4SHeiko Schocher
2953548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2954548738b4SHeiko Schocher
2955548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2956548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2957c609719bSwdenk
2958057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
29595779d8d9Swdenk
29605779d8d9Swdenk	Define this if you have a DataFlash memory device which you
29615779d8d9Swdenk	want to use for the environment.
29625779d8d9Swdenk
29630e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
29640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
29650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
29665779d8d9Swdenk
29675779d8d9Swdenk	  These three #defines specify the offset and size of the
29685779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
29695779d8d9Swdenk	  at the specified address.
29705779d8d9Swdenk
297151bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
297213a5695bSwdenk
297313a5695bSwdenk	Define this if you have a NAND device which you want to use
297413a5695bSwdenk	for the environment.
297513a5695bSwdenk
29760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
29770e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
297813a5695bSwdenk
297913a5695bSwdenk	  These two #defines specify the offset and size of the environment
2980fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2981fdd813deSScott Wood	  aligned to an erase block boundary.
29825779d8d9Swdenk
2983fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2984e443c944SMarkus Klotzbuecher
29850e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2986fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2987fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2988fdd813deSScott Wood	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_RENDUND must be
2989fdd813deSScott Wood	  aligned to an erase block boundary.
2990e443c944SMarkus Klotzbuecher
2991fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2992fdd813deSScott Wood
2993fdd813deSScott Wood	  Specifies the length of the region in which the environment
2994fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2995fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2996fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2997fdd813deSScott Wood	  the range to be avoided.
2998fdd813deSScott Wood
2999fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3000fdd813deSScott Wood
3001fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3002fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3003fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3004fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3005fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3006e443c944SMarkus Klotzbuecher
3007b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3008b74ab737SGuennadi Liakhovetski
3009b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3010b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3011b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3012b74ab737SGuennadi Liakhovetski
30136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3014c609719bSwdenk
3015c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3016c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3017c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3018c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3019c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3020c609719bSwdenk	to be a good choice since it makes it far enough from the
3021c609719bSwdenk	start of the data area as well as from the stack pointer.
3022c609719bSwdenk
3023e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3024c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3025cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3026c609719bSwdenkuntil then to read environment variables.
3027c609719bSwdenk
302885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
302985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
303085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
303185ec0bccSwdenknecessary, because the first environment variable we need is the
303285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
303385ec0bccSwdenkhave any device yet where we could complain.]
3034c609719bSwdenk
3035c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3036c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
303785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3038c609719bSwdenk
30396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3040fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3041fc3e2165Swdenk
30426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3043fc3e2165Swdenk		      also needs to be defined.
3044fc3e2165Swdenk
30456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3046fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3047c609719bSwdenk
3048f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3049f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3050f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3051f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3052f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3053f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3054f5675aa5SRon Madrid
3055c609719bSwdenkLow Level (hardware related) configuration options:
3056dc7c9a1aSwdenk---------------------------------------------------
3057c609719bSwdenk
30586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3059c609719bSwdenk		Cache Line Size of the CPU.
3060c609719bSwdenk
30616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3062c609719bSwdenk		Default address of the IMMR after system reset.
30632535d602Swdenk
30642535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
30652535d602Swdenk		and RPXsuper) to be able to adjust the position of
30662535d602Swdenk		the IMMR register after a reset.
3067c609719bSwdenk
3068e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3069e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3070e46fedfeSTimur Tabi		PowerPC SOCs.
3071e46fedfeSTimur Tabi
3072e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3073e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3074e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3075e46fedfeSTimur Tabi
3076e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3077e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3078e46fedfeSTimur Tabi
3079e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3080e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3081e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3082e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3083e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3084e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3085e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3086e46fedfeSTimur Tabi
3087e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3088e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3089e46fedfeSTimur Tabi
3090e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3091e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3092e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3093e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3094e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3095e46fedfeSTimur Tabi
3096e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3097e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3098e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3099e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3100e46fedfeSTimur Tabi
3101e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3102e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3103e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3104e46fedfeSTimur Tabi
31057f6c2cbcSwdenk- Floppy Disk Support:
31066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
31077f6c2cbcSwdenk
31087f6c2cbcSwdenk		the default drive number (default value 0)
31097f6c2cbcSwdenk
31106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
31117f6c2cbcSwdenk
311211ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
31137f6c2cbcSwdenk		(default value 1)
31147f6c2cbcSwdenk
31156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
31167f6c2cbcSwdenk
31177f6c2cbcSwdenk		defines the offset of register from address. It
31187f6c2cbcSwdenk		depends on which part of the data bus is connected to
311911ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
31207f6c2cbcSwdenk
31216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
31226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
31237f6c2cbcSwdenk		default value.
31247f6c2cbcSwdenk
31256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
31267f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
31277f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
31287f6c2cbcSwdenk		source code. It is used to make hardware dependant
31297f6c2cbcSwdenk		initializations.
31307f6c2cbcSwdenk
31310abddf82SMacpaul Lin- CONFIG_IDE_AHB:
31320abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
31330abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
31340abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
31350abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
31360abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
31370abddf82SMacpaul Lin		is requierd.
31380abddf82SMacpaul Lin
31396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
314025d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
314125d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
3142c609719bSwdenk
31436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3144c609719bSwdenk
31457152b1d0Swdenk		Start address of memory area that can be used for
3146c609719bSwdenk		initial data and stack; please note that this must be
3147c609719bSwdenk		writable memory that is working WITHOUT special
3148c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3149c609719bSwdenk		will become available only after programming the
3150c609719bSwdenk		memory controller and running certain initialization
3151c609719bSwdenk		sequences.
3152c609719bSwdenk
3153c609719bSwdenk		U-Boot uses the following memory types:
3154c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
3155c609719bSwdenk		- MPC824X: data cache
3156c609719bSwdenk		- PPC4xx:  data cache
3157c609719bSwdenk
31586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3159c609719bSwdenk
3160c609719bSwdenk		Offset of the initial data structure in the memory
31616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
31626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3163c609719bSwdenk		data is located at the end of the available space
3164553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
31656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
31666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
31676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3168c609719bSwdenk
3169c609719bSwdenk	Note:
3170c609719bSwdenk		On the MPC824X (or other systems that use the data
3171c609719bSwdenk		cache for initial memory) the address chosen for
31726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3173c609719bSwdenk		point to an otherwise UNUSED address space between
3174c609719bSwdenk		the top of RAM and the start of the PCI space.
3175c609719bSwdenk
31766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
3177c609719bSwdenk
31786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
3179c609719bSwdenk
31806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
3181c609719bSwdenk
31826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
3183c609719bSwdenk
31846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
3185c609719bSwdenk
31866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3187c609719bSwdenk
31886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3189c609719bSwdenk		SDRAM timing
3190c609719bSwdenk
31916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3192c609719bSwdenk		periodic timer for refresh
3193c609719bSwdenk
31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
3195c609719bSwdenk
31966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
31976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
31986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
31996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3200c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3201c609719bSwdenk
3202c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
32036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
32046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3205c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3206c609719bSwdenk
32076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
32086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3209c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3210c609719bSwdenk		Prescaler definitions (SDRAM timing)
3211c609719bSwdenk
32126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3213c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3214c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3215c609719bSwdenk
32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3217b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3218b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3219b423d055SHeiko Schocher
32206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3221c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3222c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3223c609719bSwdenk
32246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3225c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3226c609719bSwdenk		wrong setting might damage your board. Read
3227c609719bSwdenk		doc/README.MBX before setting this variable!
3228c609719bSwdenk
32296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3230ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3231ea909b76Swdenk		(Power On Self Tests). This definition overrides
3232ea909b76Swdenk		#define'd default value in commproc.h resp.
3233ea909b76Swdenk		cpm_8260.h.
3234ea909b76Swdenk
32356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
32366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
32376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
32386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
32396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
32406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
32416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
32426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3243a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
32445d232d0eSwdenk
32459cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
32469cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
32479cacf4fcSDirk Eibach		required.
32489cacf4fcSDirk Eibach
3249a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3250a09b9b68SKumar Gala		Chip has SRIO or not
3251a09b9b68SKumar Gala
3252a09b9b68SKumar Gala- CONFIG_SRIO1:
3253a09b9b68SKumar Gala		Board has SRIO 1 port available
3254a09b9b68SKumar Gala
3255a09b9b68SKumar Gala- CONFIG_SRIO2:
3256a09b9b68SKumar Gala		Board has SRIO 2 port available
3257a09b9b68SKumar Gala
3258a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3259a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3260a09b9b68SKumar Gala
3261a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3262a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3263a09b9b68SKumar Gala
3264a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3265a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3266a09b9b68SKumar Gala
3267eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3268eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3269eced4626SAlex Waterman		16 bit bus.
3270eced4626SAlex Waterman
3271eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3272eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3273eced4626SAlex Waterman		a default value will be used.
3274eced4626SAlex Waterman
3275bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3276218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3277218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3278218ca724SWolfgang Denk
3279bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3280bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3281bb99ad6dSBen Warren
32826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3283218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3284218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3285218ca724SWolfgang Denk		to something your driver can deal with.
3286bb99ad6dSBen Warren
32871b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
32881b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
32891b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
32901b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
32911b3e3c4fSYork Sun		header files or board specific files.
32921b3e3c4fSYork Sun
32936f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
32946f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
32956f5e1dc5SYork Sun
32966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3297218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3298218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
32992ad6b513STimur Tabi
3300c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3301c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3302c26e454dSwdenk
3303c26e454dSwdenk- CONFIG_FEC[12]_PHY
3304c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
33056e592385Swdenk		to the given FEC; i. e.
3306c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3307c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3308c26e454dSwdenk
3309c26e454dSwdenk		When set to -1, means to probe for first available.
3310c26e454dSwdenk
3311c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3312c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3313c26e454dSwdenk		(so program the FEC to ignore it).
3314c26e454dSwdenk
3315c26e454dSwdenk- CONFIG_RMII
3316c26e454dSwdenk		Enable RMII mode for all FECs.
3317c26e454dSwdenk		Note that this is a global option, we can't
3318c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3319c26e454dSwdenk
33205cf91d6bSwdenk- CONFIG_CRC32_VERIFY
33215cf91d6bSwdenk		Add a verify option to the crc32 command.
33225cf91d6bSwdenk		The syntax is:
33235cf91d6bSwdenk
33245cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
33255cf91d6bSwdenk
33265cf91d6bSwdenk		Where address/count indicate a memory area
33275cf91d6bSwdenk		and crc32 is the correct crc32 which the
33285cf91d6bSwdenk		area should have.
33295cf91d6bSwdenk
333056523f12Swdenk- CONFIG_LOOPW
333156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3332602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
333356523f12Swdenk
33347b466641Sstroese- CONFIG_MX_CYCLIC
33357b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
33367b466641Sstroese		"md/mw" commands.
33377b466641Sstroese		Examples:
33387b466641Sstroese
33397b466641Sstroese		=> mdc.b 10 4 500
33407b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
33417b466641Sstroese
33427b466641Sstroese		=> mwc.l 100 12345678 10
33437b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
33447b466641Sstroese
33457b466641Sstroese		This only takes effect if the memory commands are activated
3346602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
33477b466641Sstroese
33488aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
3349afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
3350e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3351e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3352e03f3169SWolfgang Denk		relocate itself into RAM.
33538aa1a2d1Swdenk
3354e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3355e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3356e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3357e03f3169SWolfgang Denk		these initializations itself.
33588aa1a2d1Swdenk
3359401bb30bSAneesh V- CONFIG_SPL_BUILD
3360df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3361df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3362df81238bSMagnus Lilja		compiling a NAND SPL.
3363400558b5Swdenk
336468bb8295SHeiko Schocher- CONFIG_SYS_NAND_HW_ECC_OOBFIRST
336568bb8295SHeiko Schocher		define this, if you want to read first the oob data
336668bb8295SHeiko Schocher		and then the data. This is used for example on
336768bb8295SHeiko Schocher		davinci plattforms.
336868bb8295SHeiko Schocher
3369d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3370d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3371d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3372d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3373d8834a13SMatthias Weisser		conditions but may increase the binary size.
3374d8834a13SMatthias Weisser
3375f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
3376f2717b47STimur Tabi-----------------------------------
3377f2717b47STimur Tabi
3378f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
3379f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
3380f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
3381f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
3382f2717b47STimur Tabiwithin that device.
3383f2717b47STimur Tabi
3384f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_ADDR
3385f2717b47STimur Tabi	The address in the storage device where the firmware is located.  The
3386f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
3387f2717b47STimur Tabi	is also specified.
3388f2717b47STimur Tabi
3389f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
3390f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
3391f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
3392f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
3393f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
3394f2717b47STimur Tabi
3395f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
3396f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
3397f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
3398f2717b47STimur Tabi	virtual address in NOR flash.
3399f2717b47STimur Tabi
3400f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
3401f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
3402f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
3403f2717b47STimur Tabi
3404f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
3405f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
3406f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3407f2717b47STimur Tabi
3408f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
3409f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SPI
3410f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
3411f2717b47STimur Tabi
3412f2717b47STimur Tabi
3413c609719bSwdenkBuilding the Software:
3414c609719bSwdenk======================
3415c609719bSwdenk
3416218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3417218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3418218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3419218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3420218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3421218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3422c609719bSwdenk
3423218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3424218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3425218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3426218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3427218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3428c609719bSwdenk
3429218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3430218ca724SWolfgang Denk	$ export CROSS_COMPILE
3431c609719bSwdenk
34322f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
34332f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
34342f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
34352f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
34362f8d396bSPeter Tyser
34372f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
34382f8d396bSPeter Tyser
34392f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
34402f8d396bSPeter Tyser      be executed on computers running Windows.
34412f8d396bSPeter Tyser
3442c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3443c609719bSwdenksources you must configure U-Boot for one specific board type. This
3444c609719bSwdenkis done by typing:
3445c609719bSwdenk
3446c609719bSwdenk	make NAME_config
3447c609719bSwdenk
3448218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3449218ca724SWolfgang Denkrations; see the main Makefile for supported names.
345054387ac9Swdenk
3451c609719bSwdenkNote: for some board special configuration names may exist; check if
3452c609719bSwdenk      additional information is available from the board vendor; for
34532729af9dSwdenk      instance, the TQM823L systems are available without (standard)
34542729af9dSwdenk      or with LCD support. You can select such additional "features"
345511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3456c609719bSwdenk
34572729af9dSwdenk      make TQM823L_config
34582729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3459c609719bSwdenk
3460c609719bSwdenk      make TQM823L_LCD_config
3461c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3462c609719bSwdenk
3463c609719bSwdenk      etc.
3464c609719bSwdenk
3465c609719bSwdenk
3466c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
34677152b1d0Swdenkimages ready for download to / installation on your system:
3468c609719bSwdenk
3469c609719bSwdenk- "u-boot.bin" is a raw binary image
3470c609719bSwdenk- "u-boot" is an image in ELF binary format
3471c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3472c609719bSwdenk
3473baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3474baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3475baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3476baf31249SMarian Balakowicz
3477baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3478baf31249SMarian Balakowicz
3479baf31249SMarian Balakowicz	make O=/tmp/build distclean
3480baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3481baf31249SMarian Balakowicz	make O=/tmp/build all
3482baf31249SMarian Balakowicz
3483baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3484baf31249SMarian Balakowicz
3485baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3486baf31249SMarian Balakowicz	make distclean
3487baf31249SMarian Balakowicz	make NAME_config
3488baf31249SMarian Balakowicz	make all
3489baf31249SMarian Balakowicz
3490baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3491baf31249SMarian Balakowiczvariable.
3492baf31249SMarian Balakowicz
3493c609719bSwdenk
3494c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3495c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3496c609719bSwdenknative "make".
3497c609719bSwdenk
3498c609719bSwdenk
3499c609719bSwdenkIf the system board that you have is not listed, then you will need
3500c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3501c609719bSwdenksteps:
3502c609719bSwdenk
3503c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
350485ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
350585ec0bccSwdenk    entries as examples. Note that here and at many other places
35067152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
350785ec0bccSwdenk    keep this order.
3508c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
350985ec0bccSwdenk    files you need. In your board directory, you will need at least
351085ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
351185ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
351285ec0bccSwdenk    your board
3513c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3514c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
351585ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3516c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3517c609719bSwdenk    to be installed on your target system.
351885ec0bccSwdenk6.  Debug and solve any problems that might arise.
3519c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3520c609719bSwdenk
3521c609719bSwdenk
3522c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3523c609719bSwdenk==============================================================
3524c609719bSwdenk
3525c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3526c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3527c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3528c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3529218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3530c609719bSwdenk
3531c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3532c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3533c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3534c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3535c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
35367152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3537218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3538218ca724SWolfgang Denkyou can type
3539c609719bSwdenk
3540c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3541c609719bSwdenk
3542c609719bSwdenkor to build on a native PowerPC system you can type
3543c609719bSwdenk
3544c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3545c609719bSwdenk
3546218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3547218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3548218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3549218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3550218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3551218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3552218ca724SWolfgang Denkvariable. For example:
3553baf31249SMarian Balakowicz
3554baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3555baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3556baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3557baf31249SMarian Balakowicz
3558218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3559218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3560218ca724SWolfgang Denkduring the whole build process.
3561baf31249SMarian Balakowicz
3562baf31249SMarian Balakowicz
3563c609719bSwdenkSee also "U-Boot Porting Guide" below.
3564c609719bSwdenk
3565c609719bSwdenk
3566c609719bSwdenkMonitor Commands - Overview:
3567c609719bSwdenk============================
3568c609719bSwdenk
3569c609719bSwdenkgo	- start application at address 'addr'
3570c609719bSwdenkrun	- run commands in an environment variable
3571c609719bSwdenkbootm	- boot application image from memory
3572c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3573c609719bSwdenktftpboot- boot image via network using TFTP protocol
3574c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3575c609719bSwdenk	       (and eventually "gatewayip")
35761fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
3577c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3578c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3579c609719bSwdenkloads	- load S-Record file over serial line
3580c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3581c609719bSwdenkmd	- memory display
3582c609719bSwdenkmm	- memory modify (auto-incrementing)
3583c609719bSwdenknm	- memory modify (constant address)
3584c609719bSwdenkmw	- memory write (fill)
3585c609719bSwdenkcp	- memory copy
3586c609719bSwdenkcmp	- memory compare
3587c609719bSwdenkcrc32	- checksum calculation
35880f89c54bSPeter Tyseri2c	- I2C sub-system
3589c609719bSwdenksspi	- SPI utility commands
3590c609719bSwdenkbase	- print or set address offset
3591c609719bSwdenkprintenv- print environment variables
3592c609719bSwdenksetenv	- set environment variables
3593c609719bSwdenksaveenv - save environment variables to persistent storage
3594c609719bSwdenkprotect - enable or disable FLASH write protection
3595c609719bSwdenkerase	- erase FLASH memory
3596c609719bSwdenkflinfo	- print FLASH memory information
3597c609719bSwdenkbdinfo	- print Board Info structure
3598c609719bSwdenkiminfo	- print header information for application image
3599c609719bSwdenkconinfo - print console devices and informations
3600c609719bSwdenkide	- IDE sub-system
3601c609719bSwdenkloop	- infinite loop on address range
360256523f12Swdenkloopw	- infinite write loop on address range
3603c609719bSwdenkmtest	- simple RAM test
3604c609719bSwdenkicache	- enable or disable instruction cache
3605c609719bSwdenkdcache	- enable or disable data cache
3606c609719bSwdenkreset	- Perform RESET of the CPU
3607c609719bSwdenkecho	- echo args to console
3608c609719bSwdenkversion - print monitor version
3609c609719bSwdenkhelp	- print online help
3610c609719bSwdenk?	- alias for 'help'
3611c609719bSwdenk
3612c609719bSwdenk
3613c609719bSwdenkMonitor Commands - Detailed Description:
3614c609719bSwdenk========================================
3615c609719bSwdenk
3616c609719bSwdenkTODO.
3617c609719bSwdenk
3618c609719bSwdenkFor now: just type "help <command>".
3619c609719bSwdenk
3620c609719bSwdenk
3621c609719bSwdenkEnvironment Variables:
3622c609719bSwdenk======================
3623c609719bSwdenk
3624c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3625c609719bSwdenkcan be made persistent by saving to Flash memory.
3626c609719bSwdenk
3627c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3628c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3629c609719bSwdenkwithout a value can be used to delete a variable from the
3630c609719bSwdenkenvironment. As long as you don't save the environment you are
3631c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3632c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3633c609719bSwdenk
3634c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3635c96f86eeSWolfgang Denk
3636c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3637c609719bSwdenk
3638c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3639c609719bSwdenk
3640c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3641c609719bSwdenk
3642c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3643c609719bSwdenk
3644c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3645c609719bSwdenk
3646c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3647c609719bSwdenk
36487d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
36497d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
36507d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
36517d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
36527d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
36537d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3654c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3655c3624e6eSGrant Likely		  bootm_mapsize.
3656c3624e6eSGrant Likely
3657c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3658c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3659c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3660c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3661c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3662c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3663c3624e6eSGrant Likely		  used otherwise.
36647d721e34SBartlomiej Sieka
36657d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
36667d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
36677d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
36687d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
36697d721e34SBartlomiej Sieka		  environment variable.
36707d721e34SBartlomiej Sieka
36714bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
36724bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
36734bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
36744bae9090SBartlomiej Sieka
3675c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3676c609719bSwdenk		  "bootp" will just load perform a lookup of the
3677c609719bSwdenk		  configuration from the BOOTP server, but not try to
3678c609719bSwdenk		  load any image using TFTP
3679c609719bSwdenk
3680c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3681c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3682c609719bSwdenk		  be automatically started (by internally calling
3683c609719bSwdenk		  "bootm")
3684c609719bSwdenk
36854a6fd34bSwdenk		  If set to "no", a standalone image passed to the
36864a6fd34bSwdenk		  "bootm" command will be copied to the load address
36874a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
36884a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
36894a6fd34bSwdenk		  data.
36904a6fd34bSwdenk
3691a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3692a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3693fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
3694fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
3695fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
3696fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
3697fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
3698fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
3699fa34f6b2SShawn Guo		  access it during the boot procedure.
3700fa34f6b2SShawn Guo
3701a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3702a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3703a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3704a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3705a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3706a28afca5SDavid A. Long		  must be accessible by the kernel.
3707a28afca5SDavid A. Long
3708eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
3709eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
3710eea63e05SSimon Glass		  defined.
3711eea63e05SSimon Glass
371217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
371317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
371417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
371517ea1177Swdenk		  initialization code. So, for changes to be effective
371617ea1177Swdenk		  it must be saved and board must be reset.
371717ea1177Swdenk
3718c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3719c609719bSwdenk		  If this variable is not set, initrd images will be
3720c609719bSwdenk		  copied to the highest possible address in RAM; this
3721c609719bSwdenk		  is usually what you want since it allows for
3722c609719bSwdenk		  maximum initrd size. If for some reason you want to
3723c609719bSwdenk		  make sure that the initrd image is loaded below the
37246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3725c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3726c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3727c609719bSwdenk		  address to use (U-Boot will still check that it
3728c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3729c609719bSwdenk
3730c609719bSwdenk		  For instance, when you have a system with 16 MB
37317152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3732c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3733c609719bSwdenk		  the "bootargs" variable. However, now you must make
37347152b1d0Swdenk		  sure that the initrd image is placed in the first
3735c609719bSwdenk		  12 MB as well - this can be done with
3736c609719bSwdenk
3737c609719bSwdenk		  setenv initrd_high 00c00000
3738c609719bSwdenk
373938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
374038b99261Swdenk		  indication to U-Boot that all addresses are legal
374138b99261Swdenk		  for the Linux kernel, including addresses in flash
374238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
374338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
374438b99261Swdenk		  boot time on your system, but requires that this
374538b99261Swdenk		  feature is supported by your Linux kernel.
374638b99261Swdenk
3747c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3748c609719bSwdenk
3749c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3750dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3751c609719bSwdenk
3752c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3753c609719bSwdenk
3754c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3755c609719bSwdenk
3756c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3757c609719bSwdenk
3758c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3759c609719bSwdenk
3760c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3761c609719bSwdenk
3762e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
3763a3d991bdSwdenk
3764e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
3765e2a53458SMike Frysinger		  For example you can do the following
3766a3d991bdSwdenk
376748690d80SHeiko Schocher		  => setenv ethact FEC
376848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
376948690d80SHeiko Schocher		  => setenv ethact SCC
377048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3771a3d991bdSwdenk
3772e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3773e1692577SMatthias Fuchs		  available network interfaces.
3774e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3775e1692577SMatthias Fuchs
3776a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3777a3d991bdSwdenk		  either succeed or fail without retrying.
37786e592385Swdenk		  When set to "once" the network operation will
37796e592385Swdenk		  fail when all the available network interfaces
37806e592385Swdenk		  are tried once without success.
3781a3d991bdSwdenk		  Useful on scripts which control the retry operation
3782a3d991bdSwdenk		  themselves.
3783a3d991bdSwdenk
3784b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3785a1cf027aSJean-Christophe PLAGNIOL-VILLARD
378628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3787ecb0ccd9SWolfgang Denk		  UDP source port.
3788ecb0ccd9SWolfgang Denk
378928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
379028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
379128cb9375SWolfgang Denk
3792c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3793c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3794c96f86eeSWolfgang Denk
3795c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3796c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3797c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3798c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3799c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3800c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3801c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3802c96f86eeSWolfgang Denk
3803a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
380411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3805a3d991bdSwdenk		  VLAN tagged frames.
3806c609719bSwdenk
3807dc0b7b0eSJason HobbsThe following image location variables contain the location of images
3808dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
3809dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
3810dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
3811dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
3812dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
3813dc0b7b0eSJason Hobbsflash or offset in NAND flash.
3814dc0b7b0eSJason Hobbs
3815dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
3816dc0b7b0eSJason Hobbsboards currenlty use other variables for these purposes, and some
3817dc0b7b0eSJason Hobbsboards use these variables for other purposes.
3818dc0b7b0eSJason Hobbs
3819dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
3820dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
3821dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
3822dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
3823dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
3824dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
3825dc0b7b0eSJason Hobbs
3826c609719bSwdenkThe following environment variables may be used and automatically
3827c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3828c609719bSwdenkdepending the information provided by your boot server:
3829c609719bSwdenk
3830c609719bSwdenk  bootfile	- see above
3831c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3832fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3833c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3834c609719bSwdenk  hostname	- Target hostname
3835c609719bSwdenk  ipaddr	- see above
3836c609719bSwdenk  netmask	- Subnet Mask
3837c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3838c609719bSwdenk  serverip	- see above
3839c609719bSwdenk
3840c609719bSwdenk
3841c609719bSwdenkThere are two special Environment Variables:
3842c609719bSwdenk
3843c609719bSwdenk  serial#	- contains hardware identification information such
3844c609719bSwdenk		  as type string and/or serial number
3845c609719bSwdenk  ethaddr	- Ethernet address
3846c609719bSwdenk
3847c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3848c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3849c609719bSwdenkonce they have been set once.
3850c609719bSwdenk
3851c609719bSwdenk
3852c1551ea8SstroeseFurther special Environment Variables:
3853c1551ea8Sstroese
3854c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3855c1551ea8Sstroese		  with the "version" command. This variable is
3856c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3857c1551ea8Sstroese
3858c1551ea8Sstroese
3859c609719bSwdenkPlease note that changes to some configuration parameters may take
3860c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3861c609719bSwdenk
3862c609719bSwdenk
3863f07771ccSwdenkCommand Line Parsing:
3864f07771ccSwdenk=====================
3865f07771ccSwdenk
3866f07771ccSwdenkThere are two different command line parsers available with U-Boot:
38677152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3868f07771ccSwdenk
3869f07771ccSwdenkOld, simple command line parser:
3870f07771ccSwdenk--------------------------------
3871f07771ccSwdenk
3872f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3873f07771ccSwdenk- several commands on one line, separated by ';'
3874fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3875f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3876f07771ccSwdenk  for example:
3877fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3878f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3879f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3880f07771ccSwdenk
3881f07771ccSwdenkHush shell:
3882f07771ccSwdenk-----------
3883f07771ccSwdenk
3884f07771ccSwdenk- similar to Bourne shell, with control structures like
3885f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3886f07771ccSwdenk  until...do...done, ...
3887f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3888f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3889f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3890f07771ccSwdenk  command
3891f07771ccSwdenk
3892f07771ccSwdenkGeneral rules:
3893f07771ccSwdenk--------------
3894f07771ccSwdenk
3895f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3896f07771ccSwdenk    command) contains several commands separated by semicolon, and
3897f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3898f07771ccSwdenk    executed anyway.
3899f07771ccSwdenk
3900f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
390111ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3902f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3903f07771ccSwdenk    variables are not executed.
3904f07771ccSwdenk
3905c609719bSwdenkNote for Redundant Ethernet Interfaces:
3906c609719bSwdenk=======================================
3907c609719bSwdenk
390811ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3909c609719bSwdenksuch configurations and is capable of automatic selection of a
39107152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3911c609719bSwdenk
3912c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3913c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3914c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3915c609719bSwdenk
3916c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3917c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3918c609719bSwdenkding setting in the environment; if the corresponding environment
3919c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3920c609719bSwdenk
3921c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3922c609719bSwdenk  environment, the SROM's address is used.
3923c609719bSwdenk
3924c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3925c609719bSwdenk  environment exists, then the value from the environment variable is
3926c609719bSwdenk  used.
3927c609719bSwdenk
3928c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3929c609719bSwdenk  both addresses are the same, this MAC address is used.
3930c609719bSwdenk
3931c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3932c609719bSwdenk  addresses differ, the value from the environment is used and a
3933c609719bSwdenk  warning is printed.
3934c609719bSwdenk
3935c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3936c609719bSwdenk  is raised.
3937c609719bSwdenk
3938ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3939ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
3940ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3941ecee9324SBen WarrenThe naming convention is as follows:
3942ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3943c609719bSwdenk
3944c609719bSwdenkImage Formats:
3945c609719bSwdenk==============
3946c609719bSwdenk
39473310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
39483310c549SMarian Balakowiczimages in two formats:
39493310c549SMarian Balakowicz
39503310c549SMarian BalakowiczNew uImage format (FIT)
39513310c549SMarian Balakowicz-----------------------
39523310c549SMarian Balakowicz
39533310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
39543310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
39553310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
39563310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
39573310c549SMarian Balakowicz
39583310c549SMarian Balakowicz
39593310c549SMarian BalakowiczOld uImage format
39603310c549SMarian Balakowicz-----------------
39613310c549SMarian Balakowicz
39623310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
39633310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
39643310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3965c609719bSwdenk
3966c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3967c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3968f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3969f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3970f5ed9e39SPeter Tyser  INTEGRITY).
39717b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
3972afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
3973afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
3974c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3975c609719bSwdenk* Load Address
3976c609719bSwdenk* Entry Point
3977c609719bSwdenk* Image Name
3978c609719bSwdenk* Image Timestamp
3979c609719bSwdenk
3980c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3981c609719bSwdenkand the data portions of the image are secured against corruption by
3982c609719bSwdenkCRC32 checksums.
3983c609719bSwdenk
3984c609719bSwdenk
3985c609719bSwdenkLinux Support:
3986c609719bSwdenk==============
3987c609719bSwdenk
3988c609719bSwdenkAlthough U-Boot should support any OS or standalone application
39897152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3990c609719bSwdenkU-Boot.
3991c609719bSwdenk
3992c609719bSwdenkU-Boot includes many features that so far have been part of some
3993c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3994c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3995c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
39967152b1d0Swdenkserves several purposes:
3997c609719bSwdenk
3998c609719bSwdenk- the same features can be used for other OS or standalone
3999c609719bSwdenk  applications (for instance: using compressed images to reduce the
4000c609719bSwdenk  Flash memory footprint)
4001c609719bSwdenk
4002c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
40037152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4004c609719bSwdenk
4005c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4006c609719bSwdenk  images; of course this also means that different kernel images can
4007c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4008c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4009c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4010c609719bSwdenk  software is easier now.
4011c609719bSwdenk
4012c609719bSwdenk
4013c609719bSwdenkLinux HOWTO:
4014c609719bSwdenk============
4015c609719bSwdenk
4016c609719bSwdenkPorting Linux to U-Boot based systems:
4017c609719bSwdenk---------------------------------------
4018c609719bSwdenk
4019c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4020c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4021c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4022c609719bSwdenkLinux :-).
4023c609719bSwdenk
4024a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4025c609719bSwdenk
4026c609719bSwdenkJust make sure your machine specific header file (for instance
4027c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
40281dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
40291dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
40306d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4031c609719bSwdenk
4032c609719bSwdenk
4033c609719bSwdenkConfiguring the Linux kernel:
4034c609719bSwdenk-----------------------------
4035c609719bSwdenk
4036c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4037c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4038c609719bSwdenk
4039c609719bSwdenk
4040c609719bSwdenkBuilding a Linux Image:
4041c609719bSwdenk-----------------------
4042c609719bSwdenk
404324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
404424ee89b9Swdenknot used. If you use recent kernel source, a new build target
404524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
404624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
404724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
404824ee89b9Swdenk100% compatible format.
4049c609719bSwdenk
4050c609719bSwdenkExample:
4051c609719bSwdenk
4052c609719bSwdenk	make TQM850L_config
4053c609719bSwdenk	make oldconfig
4054c609719bSwdenk	make dep
405524ee89b9Swdenk	make uImage
4056c609719bSwdenk
405724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
405824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
405924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4060c609719bSwdenk
406124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
406224ee89b9Swdenk
406324ee89b9Swdenk* convert the kernel into a raw binary image:
406424ee89b9Swdenk
406524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
406624ee89b9Swdenk				 -R .note -R .comment \
406724ee89b9Swdenk				 -S vmlinux linux.bin
406824ee89b9Swdenk
406924ee89b9Swdenk* compress the binary image:
407024ee89b9Swdenk
407124ee89b9Swdenk	gzip -9 linux.bin
407224ee89b9Swdenk
407324ee89b9Swdenk* package compressed binary image for U-Boot:
407424ee89b9Swdenk
407524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
407624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
407724ee89b9Swdenk		-d linux.bin.gz uImage
407824ee89b9Swdenk
407924ee89b9Swdenk
408024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
408124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
408224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
408324ee89b9Swdenkbyte header containing information about target architecture,
408424ee89b9Swdenkoperating system, image type, compression method, entry points, time
408524ee89b9Swdenkstamp, CRC32 checksums, etc.
408624ee89b9Swdenk
408724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
408824ee89b9Swdenkprint the header information, or to build new images.
4089c609719bSwdenk
4090c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4091c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4092c609719bSwdenkchecksum verification:
4093c609719bSwdenk
4094c609719bSwdenk	tools/mkimage -l image
4095c609719bSwdenk	  -l ==> list image header information
4096c609719bSwdenk
4097c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4098c609719bSwdenkfrom a "data file" which is used as image payload:
4099c609719bSwdenk
4100c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4101c609719bSwdenk		      -n name -d data_file image
4102c609719bSwdenk	  -A ==> set architecture to 'arch'
4103c609719bSwdenk	  -O ==> set operating system to 'os'
4104c609719bSwdenk	  -T ==> set image type to 'type'
4105c609719bSwdenk	  -C ==> set compression type 'comp'
4106c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4107c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4108c609719bSwdenk	  -n ==> set image name to 'name'
4109c609719bSwdenk	  -d ==> use image data from 'datafile'
4110c609719bSwdenk
411169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
411269459791Swdenkaddress (0x00000000), but the entry point address depends on the
411369459791Swdenkkernel version:
4114c609719bSwdenk
4115c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
411624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4117c609719bSwdenk
4118c609719bSwdenkSo a typical call to build a U-Boot image would read:
4119c609719bSwdenk
412024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
412124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4122a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
412324ee89b9Swdenk	> examples/uImage.TQM850L
412424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4125c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4126c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4127c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4128c609719bSwdenk	Load Address: 0x00000000
412924ee89b9Swdenk	Entry Point:  0x00000000
4130c609719bSwdenk
4131c609719bSwdenkTo verify the contents of the image (or check for corruption):
4132c609719bSwdenk
413324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
413424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4135c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4136c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4137c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4138c609719bSwdenk	Load Address: 0x00000000
413924ee89b9Swdenk	Entry Point:  0x00000000
4140c609719bSwdenk
4141c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
4142c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
4143c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
4144c609719bSwdenkneed to be uncompressed:
4145c609719bSwdenk
4146a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
414724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
414824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
4149a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
415024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
415124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4152c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4153c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
4154c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
4155c609719bSwdenk	Load Address: 0x00000000
415624ee89b9Swdenk	Entry Point:  0x00000000
4157c609719bSwdenk
4158c609719bSwdenk
4159c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
4160c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
4161c609719bSwdenk
4162c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
4163c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
4164c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
4165c609719bSwdenk	Image Name:   Simple Ramdisk Image
4166c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
4167c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
4168c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
4169c609719bSwdenk	Load Address: 0x00000000
4170c609719bSwdenk	Entry Point:  0x00000000
4171c609719bSwdenk
4172c609719bSwdenk
4173c609719bSwdenkInstalling a Linux Image:
4174c609719bSwdenk-------------------------
4175c609719bSwdenk
4176c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
4177c609719bSwdenkyou must convert the image to S-Record format:
4178c609719bSwdenk
4179c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
4180c609719bSwdenk
4181c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
4182c609719bSwdenkimage header, so the resulting S-Record file will be relative to
4183c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
4184c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
4185c609719bSwdenkcommand.
4186c609719bSwdenk
4187c609719bSwdenkExample: install the image to address 0x40100000 (which on the
4188c609719bSwdenkTQM8xxL is in the first Flash bank):
4189c609719bSwdenk
4190c609719bSwdenk	=> erase 40100000 401FFFFF
4191c609719bSwdenk
4192c609719bSwdenk	.......... done
4193c609719bSwdenk	Erased 8 sectors
4194c609719bSwdenk
4195c609719bSwdenk	=> loads 40100000
4196c609719bSwdenk	## Ready for S-Record download ...
4197c609719bSwdenk	~>examples/image.srec
4198c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
4199c609719bSwdenk	...
4200c609719bSwdenk	15989 15990 15991 15992
4201c609719bSwdenk	[file transfer complete]
4202c609719bSwdenk	[connected]
4203c609719bSwdenk	## Start Addr = 0x00000000
4204c609719bSwdenk
4205c609719bSwdenk
4206c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
4207c609719bSwdenkthis includes a checksum verification so you can be sure no data
4208c609719bSwdenkcorruption happened:
4209c609719bSwdenk
4210c609719bSwdenk	=> imi 40100000
4211c609719bSwdenk
4212c609719bSwdenk	## Checking Image at 40100000 ...
4213c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4214c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4215c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4216c609719bSwdenk	   Load Address: 00000000
4217c609719bSwdenk	   Entry Point:	 0000000c
4218c609719bSwdenk	   Verifying Checksum ... OK
4219c609719bSwdenk
4220c609719bSwdenk
4221c609719bSwdenkBoot Linux:
4222c609719bSwdenk-----------
4223c609719bSwdenk
4224c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
4225c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
4226c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
4227c609719bSwdenkparameters. You can check and modify this variable using the
4228c609719bSwdenk"printenv" and "setenv" commands:
4229c609719bSwdenk
4230c609719bSwdenk
4231c609719bSwdenk	=> printenv bootargs
4232c609719bSwdenk	bootargs=root=/dev/ram
4233c609719bSwdenk
4234c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4235c609719bSwdenk
4236c609719bSwdenk	=> printenv bootargs
4237c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4238c609719bSwdenk
4239c609719bSwdenk	=> bootm 40020000
4240c609719bSwdenk	## Booting Linux kernel at 40020000 ...
4241c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
4242c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4243c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
4244c609719bSwdenk	   Load Address: 00000000
4245c609719bSwdenk	   Entry Point:	 0000000c
4246c609719bSwdenk	   Verifying Checksum ... OK
4247c609719bSwdenk	   Uncompressing Kernel Image ... OK
4248c609719bSwdenk	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
4249c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
4250c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4251c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4252c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
4253c609719bSwdenk	...
4254c609719bSwdenk
425511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
42567152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
4257c609719bSwdenkformat!) to the "bootm" command:
4258c609719bSwdenk
4259c609719bSwdenk	=> imi 40100000 40200000
4260c609719bSwdenk
4261c609719bSwdenk	## Checking Image at 40100000 ...
4262c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4263c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4264c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4265c609719bSwdenk	   Load Address: 00000000
4266c609719bSwdenk	   Entry Point:	 0000000c
4267c609719bSwdenk	   Verifying Checksum ... OK
4268c609719bSwdenk
4269c609719bSwdenk	## Checking Image at 40200000 ...
4270c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4271c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4272c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4273c609719bSwdenk	   Load Address: 00000000
4274c609719bSwdenk	   Entry Point:	 00000000
4275c609719bSwdenk	   Verifying Checksum ... OK
4276c609719bSwdenk
4277c609719bSwdenk	=> bootm 40100000 40200000
4278c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4279c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4280c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4281c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4282c609719bSwdenk	   Load Address: 00000000
4283c609719bSwdenk	   Entry Point:	 0000000c
4284c609719bSwdenk	   Verifying Checksum ... OK
4285c609719bSwdenk	   Uncompressing Kernel Image ... OK
4286c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4287c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4288c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4289c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4290c609719bSwdenk	   Load Address: 00000000
4291c609719bSwdenk	   Entry Point:	 00000000
4292c609719bSwdenk	   Verifying Checksum ... OK
4293c609719bSwdenk	   Loading Ramdisk ... OK
4294c609719bSwdenk	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
4295c609719bSwdenk	Boot arguments: root=/dev/ram
4296c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4297c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4298c609719bSwdenk	...
4299c609719bSwdenk	RAMDISK: Compressed image found at block 0
4300c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4301c609719bSwdenk
4302c609719bSwdenk	bash#
4303c609719bSwdenk
43040267768eSMatthew McClintockBoot Linux and pass a flat device tree:
43050267768eSMatthew McClintock-----------
43060267768eSMatthew McClintock
43070267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
43080267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
43090267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
43100267768eSMatthew McClintockflat device tree:
43110267768eSMatthew McClintock
43120267768eSMatthew McClintock=> print oftaddr
43130267768eSMatthew McClintockoftaddr=0x300000
43140267768eSMatthew McClintock=> print oft
43150267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
43160267768eSMatthew McClintock=> tftp $oftaddr $oft
43170267768eSMatthew McClintockSpeed: 1000, full duplex
43180267768eSMatthew McClintockUsing TSEC0 device
43190267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
43200267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
43210267768eSMatthew McClintockLoad address: 0x300000
43220267768eSMatthew McClintockLoading: #
43230267768eSMatthew McClintockdone
43240267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
43250267768eSMatthew McClintock=> tftp $loadaddr $bootfile
43260267768eSMatthew McClintockSpeed: 1000, full duplex
43270267768eSMatthew McClintockUsing TSEC0 device
43280267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
43290267768eSMatthew McClintockFilename 'uImage'.
43300267768eSMatthew McClintockLoad address: 0x200000
43310267768eSMatthew McClintockLoading:############
43320267768eSMatthew McClintockdone
43330267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
43340267768eSMatthew McClintock=> print loadaddr
43350267768eSMatthew McClintockloadaddr=200000
43360267768eSMatthew McClintock=> print oftaddr
43370267768eSMatthew McClintockoftaddr=0x300000
43380267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
43390267768eSMatthew McClintock## Booting image at 00200000 ...
43400267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
43410267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
43420267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
43430267768eSMatthew McClintock   Load Address: 00000000
43440267768eSMatthew McClintock   Entry Point:	 00000000
43450267768eSMatthew McClintock   Verifying Checksum ... OK
43460267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
43470267768eSMatthew McClintockBooting using flat device tree at 0x300000
43480267768eSMatthew McClintockUsing MPC85xx ADS machine description
43490267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
43500267768eSMatthew McClintock[snip]
43510267768eSMatthew McClintock
43520267768eSMatthew McClintock
43536069ff26SwdenkMore About U-Boot Image Types:
43546069ff26Swdenk------------------------------
43556069ff26Swdenk
43566069ff26SwdenkU-Boot supports the following image types:
43576069ff26Swdenk
43586069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
43596069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
43606069ff26Swdenk	well) you can continue to work in U-Boot after return from
43616069ff26Swdenk	the Standalone Program.
43626069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
43636069ff26Swdenk	will take over control completely. Usually these programs
43646069ff26Swdenk	will install their own set of exception handlers, device
43656069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
43666069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
43676069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
43686069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
43696069ff26Swdenk	being started.
43706069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
43716069ff26Swdenk	(Linux) kernel image and one or more data images like
43726069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
43736069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
43746069ff26Swdenk	server provides just a single image file, but you want to get
43756069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
43766069ff26Swdenk
43776069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
43786069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
43796069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
43806069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
43816069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
43826069ff26Swdenk	a multiple of 4 bytes).
43836069ff26Swdenk
43846069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
43856069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
43866069ff26Swdenk	flash memory.
43876069ff26Swdenk
43886069ff26Swdenk   "Script files" are command sequences that will be executed by
43896069ff26Swdenk	U-Boot's command interpreter; this feature is especially
43906069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
43916069ff26Swdenk	as command interpreter.
43926069ff26Swdenk
4393c609719bSwdenk
4394c609719bSwdenkStandalone HOWTO:
4395c609719bSwdenk=================
4396c609719bSwdenk
4397c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4398c609719bSwdenkrun "standalone" applications, which can use some resources of
4399c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4400c609719bSwdenk
4401c609719bSwdenkTwo simple examples are included with the sources:
4402c609719bSwdenk
4403c609719bSwdenk"Hello World" Demo:
4404c609719bSwdenk-------------------
4405c609719bSwdenk
4406c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4407c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4408c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4409c609719bSwdenklike that:
4410c609719bSwdenk
4411c609719bSwdenk	=> loads
4412c609719bSwdenk	## Ready for S-Record download ...
4413c609719bSwdenk	~>examples/hello_world.srec
4414c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4415c609719bSwdenk	[file transfer complete]
4416c609719bSwdenk	[connected]
4417c609719bSwdenk	## Start Addr = 0x00040004
4418c609719bSwdenk
4419c609719bSwdenk	=> go 40004 Hello World! This is a test.
4420c609719bSwdenk	## Starting application at 0x00040004 ...
4421c609719bSwdenk	Hello World
4422c609719bSwdenk	argc = 7
4423c609719bSwdenk	argv[0] = "40004"
4424c609719bSwdenk	argv[1] = "Hello"
4425c609719bSwdenk	argv[2] = "World!"
4426c609719bSwdenk	argv[3] = "This"
4427c609719bSwdenk	argv[4] = "is"
4428c609719bSwdenk	argv[5] = "a"
4429c609719bSwdenk	argv[6] = "test."
4430c609719bSwdenk	argv[7] = "<NULL>"
4431c609719bSwdenk	Hit any key to exit ...
4432c609719bSwdenk
4433c609719bSwdenk	## Application terminated, rc = 0x0
4434c609719bSwdenk
4435c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4436c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4437c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4438c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4439c609719bSwdenkcharacter, but this is just a demo program. The application can be
4440c609719bSwdenkcontrolled by the following keys:
4441c609719bSwdenk
4442c609719bSwdenk	? - print current values og the CPM Timer registers
4443c609719bSwdenk	b - enable interrupts and start timer
4444c609719bSwdenk	e - stop timer and disable interrupts
4445c609719bSwdenk	q - quit application
4446c609719bSwdenk
4447c609719bSwdenk	=> loads
4448c609719bSwdenk	## Ready for S-Record download ...
4449c609719bSwdenk	~>examples/timer.srec
4450c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4451c609719bSwdenk	[file transfer complete]
4452c609719bSwdenk	[connected]
4453c609719bSwdenk	## Start Addr = 0x00040004
4454c609719bSwdenk
4455c609719bSwdenk	=> go 40004
4456c609719bSwdenk	## Starting application at 0x00040004 ...
4457c609719bSwdenk	TIMERS=0xfff00980
4458c609719bSwdenk	Using timer 1
4459c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4460c609719bSwdenk
4461c609719bSwdenkHit 'b':
4462c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4463c609719bSwdenk	Enabling timer
4464c609719bSwdenkHit '?':
4465c609719bSwdenk	[q, b, e, ?] ........
4466c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4467c609719bSwdenkHit '?':
4468c609719bSwdenk	[q, b, e, ?] .
4469c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4470c609719bSwdenkHit '?':
4471c609719bSwdenk	[q, b, e, ?] .
4472c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4473c609719bSwdenkHit '?':
4474c609719bSwdenk	[q, b, e, ?] .
4475c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4476c609719bSwdenkHit 'e':
4477c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4478c609719bSwdenkHit 'q':
4479c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4480c609719bSwdenk
4481c609719bSwdenk
448285ec0bccSwdenkMinicom warning:
448385ec0bccSwdenk================
448485ec0bccSwdenk
44857152b1d0SwdenkOver time, many people have reported problems when trying to use the
448685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
448785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4488f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
448985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
449085ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
449185ec0bccSwdenk
449252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
449352f52c14Swdenkconfiguration to your "File transfer protocols" section:
449452f52c14Swdenk
449552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
449652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
449752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
449852f52c14Swdenk
449952f52c14Swdenk
4500c609719bSwdenkNetBSD Notes:
4501c609719bSwdenk=============
4502c609719bSwdenk
4503c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4504c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4505c609719bSwdenk
4506c609719bSwdenkBuilding requires a cross environment; it is known to work on
4507c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4508c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4509c609719bSwdenkNote that the cross-powerpc package does not install include files;
4510c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4511c609719bSwdenkmissing.  This file has to be installed and patched manually:
4512c609719bSwdenk
4513c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4514c609719bSwdenk	# mkdir powerpc
4515c609719bSwdenk	# ln -s powerpc machine
4516c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4517c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4518c609719bSwdenk
4519c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4520c609719bSwdenkand U-Boot include files.
4521c609719bSwdenk
4522c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4523c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4524c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4525c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
45262a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4527c609719bSwdenk
4528c609719bSwdenk
4529c609719bSwdenkImplementation Internals:
4530c609719bSwdenk=========================
4531c609719bSwdenk
4532c609719bSwdenkThe following is not intended to be a complete description of every
4533c609719bSwdenkimplementation detail. However, it should help to understand the
4534c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4535c609719bSwdenkhardware.
4536c609719bSwdenk
4537c609719bSwdenk
4538c609719bSwdenkInitial Stack, Global Data:
4539c609719bSwdenk---------------------------
4540c609719bSwdenk
4541c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4542c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4543c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4544c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4545c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4546c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4547c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4548c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4549c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4550c609719bSwdenklocked as (mis-) used as memory, etc.
4551c609719bSwdenk
45527152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
45530668236bSWolfgang Denk	U-Boot mailing list:
455443d9616cSwdenk
455543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
455643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
455743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
455843d9616cSwdenk	...
455943d9616cSwdenk
456043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
456143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
456243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
456343d9616cSwdenk	is that the cache is being used as a temporary supply of
456443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
456511ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
456643d9616cSwdenk	can see how this works by studying the cache architecture and
456743d9616cSwdenk	operation in the architecture and processor-specific manuals.
456843d9616cSwdenk
456943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
457043d9616cSwdenk	is another option for the system designer to use as an
457111ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
457243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
457343d9616cSwdenk	board designers haven't used it for something that would
457443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
457543d9616cSwdenk	used.
457643d9616cSwdenk
45776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
457843d9616cSwdenk	with your processor/board/system design. The default value
457943d9616cSwdenk	you will find in any recent u-boot distribution in
45808a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
458143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
458243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
458343d9616cSwdenk	that are supposed to respond to that address! That code in
458443d9616cSwdenk	start.S has been around a while and should work as is when
458543d9616cSwdenk	you get the config right.
458643d9616cSwdenk
458743d9616cSwdenk	-Chris Hallinan
458843d9616cSwdenk	DS4.COM, Inc.
458943d9616cSwdenk
4590c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4591c609719bSwdenkcode for the initialization procedures:
4592c609719bSwdenk
4593c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4594c609719bSwdenk  to write it.
4595c609719bSwdenk
459611ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4597c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
45987152b1d0Swdenk  zation is performed later (when relocating to RAM).
4599c609719bSwdenk
4600c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4601c609719bSwdenk  that.
4602c609719bSwdenk
4603c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4604c609719bSwdenknormal global data to share information beween the code. But it
4605c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4606c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4607c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4608c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4609c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4610c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4611c609719bSwdenkreserve for this purpose.
4612c609719bSwdenk
46137152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4614c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4615c609719bSwdenkGCC's implementation.
4616c609719bSwdenk
4617c609719bSwdenkFor PowerPC, the following registers have specific use:
4618c609719bSwdenk	R1:	stack pointer
4619e7670f6cSWolfgang Denk	R2:	reserved for system use
4620c609719bSwdenk	R3-R4:	parameter passing and return values
4621c609719bSwdenk	R5-R10: parameter passing
4622c609719bSwdenk	R13:	small data area pointer
4623c609719bSwdenk	R30:	GOT pointer
4624c609719bSwdenk	R31:	frame pointer
4625c609719bSwdenk
4626e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4627e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4628e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4629c609719bSwdenk
4630e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4631c609719bSwdenk
4632c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4633c609719bSwdenk    address of the global data structure is known at compile time),
4634c609719bSwdenk    but it turned out that reserving a register results in somewhat
4635c609719bSwdenk    smaller code - although the code savings are not that big (on
4636c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4637c609719bSwdenk    624 text + 127 data).
4638c609719bSwdenk
4639c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
46404c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
46414c58eb55SMike Frysinger
4642c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
46434c58eb55SMike Frysinger
4644c609719bSwdenkOn ARM, the following registers are used:
4645c609719bSwdenk
4646c609719bSwdenk	R0:	function argument word/integer result
4647c609719bSwdenk	R1-R3:	function argument word
4648c609719bSwdenk	R9:	GOT pointer
4649c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4650c609719bSwdenk	R11:	argument (frame) pointer
4651c609719bSwdenk	R12:	temporary workspace
4652c609719bSwdenk	R13:	stack pointer
4653c609719bSwdenk	R14:	link register
4654c609719bSwdenk	R15:	program counter
4655c609719bSwdenk
4656c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4657c609719bSwdenk
46580df01fd3SThomas ChouOn Nios II, the ABI is documented here:
46590df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
46600df01fd3SThomas Chou
46610df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
46620df01fd3SThomas Chou
46630df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
46640df01fd3SThomas Chou    to access small data sections, so gp is free.
46650df01fd3SThomas Chou
4666afc1ce82SMacpaul LinOn NDS32, the following registers are used:
4667afc1ce82SMacpaul Lin
4668afc1ce82SMacpaul Lin	R0-R1:	argument/return
4669afc1ce82SMacpaul Lin	R2-R5:	argument
4670afc1ce82SMacpaul Lin	R15:	temporary register for assembler
4671afc1ce82SMacpaul Lin	R16:	trampoline register
4672afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
4673afc1ce82SMacpaul Lin	R29:	global pointer (GP)
4674afc1ce82SMacpaul Lin	R30:	link register (LP)
4675afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
4676afc1ce82SMacpaul Lin	PC:	program counter (PC)
4677afc1ce82SMacpaul Lin
4678afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
4679afc1ce82SMacpaul Lin
4680d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4681d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4682c609719bSwdenk
4683c609719bSwdenkMemory Management:
4684c609719bSwdenk------------------
4685c609719bSwdenk
4686c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4687c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4688c609719bSwdenk
4689c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4690c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4691c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4692c609719bSwdenkphysical memory banks.
4693c609719bSwdenk
4694c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4695c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4696c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4697c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
46986d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4699c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4700c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4701c609719bSwdenk
4702c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4703c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4704c609719bSwdenk
4705c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4706c609719bSwdenkthis:
4707c609719bSwdenk
4708c609719bSwdenk	0x0000 0000	Exception Vector code
4709c609719bSwdenk	      :
4710c609719bSwdenk	0x0000 1FFF
4711c609719bSwdenk	0x0000 2000	Free for Application Use
4712c609719bSwdenk	      :
4713c609719bSwdenk	      :
4714c609719bSwdenk
4715c609719bSwdenk	      :
4716c609719bSwdenk	      :
4717c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4718c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4719c609719bSwdenk	0x00FC 0000	Malloc Arena
4720c609719bSwdenk	      :
4721c609719bSwdenk	0x00FD FFFF
4722c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4723c609719bSwdenk	...		eventually: LCD or video framebuffer
4724c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4725c609719bSwdenk	0x00FF FFFF	[End of RAM]
4726c609719bSwdenk
4727c609719bSwdenk
4728c609719bSwdenkSystem Initialization:
4729c609719bSwdenk----------------------
4730c609719bSwdenk
4731c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
473211ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4733c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
47347152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4735c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4736c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4737c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4738c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4739c609719bSwdenkthe caches and the SIU.
4740c609719bSwdenk
4741c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4742c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4743c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4744c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4745c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4746c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4747c609719bSwdenkbanks.
4748c609719bSwdenk
4749c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
47507152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4751c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4752c609719bSwdenk0x00000000, with any additional banks following immediately to create
4753c609719bSwdenkcontiguous memory starting from 0.
4754c609719bSwdenk
4755c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4756c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4757c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4758c609719bSwdenkpages, and the final stack is set up.
4759c609719bSwdenk
4760c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4761c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4762c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4763c609719bSwdenknew address in RAM.
4764c609719bSwdenk
4765c609719bSwdenk
4766c609719bSwdenkU-Boot Porting Guide:
4767c609719bSwdenk----------------------
4768c609719bSwdenk
4769c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
47706aff3115Swdenklist, October 2002]
4771c609719bSwdenk
4772c609719bSwdenk
4773c609719bSwdenkint main(int argc, char *argv[])
4774c609719bSwdenk{
4775c609719bSwdenk	sighandler_t no_more_time;
4776c609719bSwdenk
4777c609719bSwdenk	signal(SIGALRM, no_more_time);
4778c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4779c609719bSwdenk
4780c609719bSwdenk	if (available_money > available_manpower) {
47816c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4782c609719bSwdenk		return 0;
4783c609719bSwdenk	}
4784c609719bSwdenk
4785c609719bSwdenk	Download latest U-Boot source;
4786c609719bSwdenk
47870668236bSWolfgang Denk	Subscribe to u-boot mailing list;
47886aff3115Swdenk
47896c3fef28SJerry Van Baren	if (clueless)
4790c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4791c609719bSwdenk
4792c609719bSwdenk	while (learning) {
4793c609719bSwdenk		Read the README file in the top level directory;
47947cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
47956c3fef28SJerry Van Baren		Read applicable doc/*.README;
4796c609719bSwdenk		Read the source, Luke;
47976c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4798c609719bSwdenk	}
4799c609719bSwdenk
48006c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
48016c3fef28SJerry Van Baren		Buy a BDI3000;
48026c3fef28SJerry Van Baren	else
4803c609719bSwdenk		Add a lot of aggravation and time;
4804c609719bSwdenk
48056c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
48066c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
48076c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
48086c3fef28SJerry Van Baren	} else {
4809c609719bSwdenk		Create your own board support subdirectory;
48106c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
48116c3fef28SJerry Van Baren	}
48126c3fef28SJerry Van Baren	Edit new board/<myboard> files
48136c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4814c609719bSwdenk
48156c3fef28SJerry Van Baren	while (!accepted) {
4816c609719bSwdenk		while (!running) {
4817c609719bSwdenk			do {
4818c609719bSwdenk				Add / modify source code;
4819c609719bSwdenk			} until (compiles);
4820c609719bSwdenk			Debug;
4821c609719bSwdenk			if (clueless)
4822c609719bSwdenk				email("Hi, I am having problems...");
4823c609719bSwdenk		}
48246c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
48256c3fef28SJerry Van Baren		if (reasonable critiques)
48266c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
48276c3fef28SJerry Van Baren		else
48286c3fef28SJerry Van Baren			Defend code as written;
48296c3fef28SJerry Van Baren	}
4830c609719bSwdenk
4831c609719bSwdenk	return 0;
4832c609719bSwdenk}
4833c609719bSwdenk
4834c609719bSwdenkvoid no_more_time (int sig)
4835c609719bSwdenk{
4836c609719bSwdenk      hire_a_guru();
4837c609719bSwdenk}
4838c609719bSwdenk
4839c609719bSwdenk
4840c609719bSwdenkCoding Standards:
4841c609719bSwdenk-----------------
4842c609719bSwdenk
4843c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
48442c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
48457ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4846c609719bSwdenk
48472c051651SDetlev ZundelSource files originating from a different project (for example the
48482c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
48492c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
48502c051651SDetlev Zundelsources.
48512c051651SDetlev Zundel
48522c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
48532c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
48542c051651SDetlev Zundelin your code.
4855c609719bSwdenk
4856c178d3daSwdenkPlease also stick to the following formatting rules:
4857180d3f74Swdenk- remove any trailing white space
48587ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4859180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
48607ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4861180d3f74Swdenk- do not add trailing empty lines to source files
4862180d3f74Swdenk
4863c609719bSwdenkSubmissions which do not conform to the standards may be returned
4864c609719bSwdenkwith a request to reformat the changes.
4865c609719bSwdenk
4866c609719bSwdenk
4867c609719bSwdenkSubmitting Patches:
4868c609719bSwdenk-------------------
4869c609719bSwdenk
4870c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4871c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4872c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4873c609719bSwdenk
48740d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4875218ca724SWolfgang Denk
48760668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
48770668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
48780668236bSWolfgang Denk
4879c609719bSwdenkWhen you send a patch, please include the following information with
4880c609719bSwdenkit:
4881c609719bSwdenk
4882c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4883c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4884c609719bSwdenk  patch actually fixes something.
4885c609719bSwdenk
4886c609719bSwdenk* For new features: a description of the feature and your
4887c609719bSwdenk  implementation.
4888c609719bSwdenk
4889c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4890c609719bSwdenk
4891c609719bSwdenk* For major contributions, your entry to the CREDITS file
4892c609719bSwdenk
4893c609719bSwdenk* When you add support for a new board, don't forget to add this
48947ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
4895c609719bSwdenk
4896c609719bSwdenk* If your patch adds new configuration options, don't forget to
4897c609719bSwdenk  document these in the README file.
4898c609719bSwdenk
4899218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4900218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
49017ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
4902218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4903218ca724SWolfgang Denk  with some other mail clients.
4904c609719bSwdenk
4905218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4906218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4907218ca724SWolfgang Denk  GNU diff.
49086dff5529Swdenk
4909218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4910218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4911218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4912218ca724SWolfgang Denk  affected files).
4913218ca724SWolfgang Denk
4914218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4915218ca724SWolfgang Denk  and compressed attachments must not be used.
4916c609719bSwdenk
491752f52c14Swdenk* If one logical set of modifications affects or creates several
491852f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
491952f52c14Swdenk
492052f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
492152f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
492252f52c14Swdenk
492352f52c14Swdenk
4924c609719bSwdenkNotes:
4925c609719bSwdenk
4926c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4927c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4928c609719bSwdenk  for any of the boards.
4929c609719bSwdenk
4930c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4931c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4932c609719bSwdenk  returned with a request to re-formatting / split it.
4933c609719bSwdenk
4934c609719bSwdenk* If you modify existing code, make sure that your new code does not
4935c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4936c609719bSwdenk  When adding new features, these should compile conditionally only
4937c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4938c609719bSwdenk  disabled must not need more memory than the old code without your
4939c609719bSwdenk  modification.
494090dc6704Swdenk
49410668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
49420668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
49430668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
49440668236bSWolfgang Denk  bigger than the size limit should be avoided.
4945