xref: /openbmc/u-boot/README (revision e46fedfeb214d118b9983d11fcc929ed49f5ccd7)
1c609719bSwdenk#
26abe6fb6SDetlev Zundel# (C) Copyright 2000 - 2011
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
1848d321b81SPeter Tyser    /lib		Architecture specific library files
1858d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
1868d321b81SPeter Tyser    /cpu		CPU specific files
1878d321b81SPeter Tyser    /lib		Architecture specific library files
188a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1898d321b81SPeter Tyser    /cpu		CPU specific files
1908d321b81SPeter Tyser      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
1918d321b81SPeter Tyser      /mpc5xx		Files specific to Freescale MPC5xx CPUs
1928d321b81SPeter Tyser      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
1938d321b81SPeter Tyser      /mpc8xx		Files specific to Freescale MPC8xx CPUs
1948d321b81SPeter Tyser      /mpc8220		Files specific to Freescale MPC8220 CPUs
1958d321b81SPeter Tyser      /mpc824x		Files specific to Freescale MPC824x CPUs
1968d321b81SPeter Tyser      /mpc8260		Files specific to Freescale MPC8260 CPUs
1978d321b81SPeter Tyser      /mpc85xx		Files specific to Freescale MPC85xx CPUs
1988d321b81SPeter Tyser      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
1998d321b81SPeter Tyser    /lib		Architecture specific library files
2008d321b81SPeter Tyser  /sh			Files generic to SH architecture
2018d321b81SPeter Tyser    /cpu		CPU specific files
2028d321b81SPeter Tyser      /sh2		Files specific to sh2 CPUs
2038d321b81SPeter Tyser      /sh3		Files specific to sh3 CPUs
2048d321b81SPeter Tyser      /sh4		Files specific to sh4 CPUs
2058d321b81SPeter Tyser    /lib		Architecture specific library files
2068d321b81SPeter Tyser  /sparc		Files generic to SPARC architecture
2078d321b81SPeter Tyser    /cpu		CPU specific files
2088d321b81SPeter Tyser      /leon2		Files specific to Gaisler LEON2 SPARC CPU
2098d321b81SPeter Tyser      /leon3		Files specific to Gaisler LEON3 SPARC CPU
2108d321b81SPeter Tyser    /lib		Architecture specific library files
2118d321b81SPeter Tyser/api			Machine/arch independent API for external apps
2128d321b81SPeter Tyser/board			Board dependent files
2138d321b81SPeter Tyser/common			Misc architecture independent functions
2148d321b81SPeter Tyser/disk			Code for disk drive partition handling
2158d321b81SPeter Tyser/doc			Documentation (don't expect too much)
2168d321b81SPeter Tyser/drivers		Commonly used device drivers
2178d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
2188d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
2198d321b81SPeter Tyser/include		Header Files
2208d321b81SPeter Tyser/lib			Files generic to all architectures
2218d321b81SPeter Tyser  /libfdt		Library files to support flattened device trees
2228d321b81SPeter Tyser  /lzma			Library files to support LZMA decompression
2238d321b81SPeter Tyser  /lzo			Library files to support LZO decompression
2248d321b81SPeter Tyser/net			Networking code
2258d321b81SPeter Tyser/post			Power On Self Test
2268d321b81SPeter Tyser/rtc			Real Time Clock drivers
2278d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
228c609719bSwdenk
229c609719bSwdenkSoftware Configuration:
230c609719bSwdenk=======================
231c609719bSwdenk
232c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
233c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
234c609719bSwdenk
235c609719bSwdenkThere are two classes of configuration variables:
236c609719bSwdenk
237c609719bSwdenk* Configuration _OPTIONS_:
238c609719bSwdenk  These are selectable by the user and have names beginning with
239c609719bSwdenk  "CONFIG_".
240c609719bSwdenk
241c609719bSwdenk* Configuration _SETTINGS_:
242c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
243c609719bSwdenk  you don't know what you're doing; they have names beginning with
2446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
245c609719bSwdenk
246c609719bSwdenkLater we will add a configuration tool - probably similar to or even
247c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
248c609719bSwdenkdo the configuration by hand, which means creating some symbolic
249c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
250c609719bSwdenkas an example here.
251c609719bSwdenk
252c609719bSwdenk
253c609719bSwdenkSelection of Processor Architecture and Board Type:
254c609719bSwdenk---------------------------------------------------
255c609719bSwdenk
256c609719bSwdenkFor all supported boards there are ready-to-use default
257c609719bSwdenkconfigurations available; just type "make <board_name>_config".
258c609719bSwdenk
259c609719bSwdenkExample: For a TQM823L module type:
260c609719bSwdenk
261c609719bSwdenk	cd u-boot
262c609719bSwdenk	make TQM823L_config
263c609719bSwdenk
26411ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
265c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
266c609719bSwdenkdirectory according to the instructions in cogent/README.
267c609719bSwdenk
268c609719bSwdenk
269c609719bSwdenkConfiguration Options:
270c609719bSwdenk----------------------
271c609719bSwdenk
272c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
273c609719bSwdenksuch information is kept in a configuration file
274c609719bSwdenk"include/configs/<board_name>.h".
275c609719bSwdenk
276c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
277c609719bSwdenk"include/configs/TQM823L.h".
278c609719bSwdenk
279c609719bSwdenk
2807f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2817f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2827f6c2cbcSwdenkbuild a config tool - later.
2837f6c2cbcSwdenk
2847f6c2cbcSwdenk
285c609719bSwdenkThe following options need to be configured:
286c609719bSwdenk
2872628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
288c609719bSwdenk
2892628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2906ccec449SWolfgang Denk
2916ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
29209ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
293c609719bSwdenk
294c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
295c609719bSwdenk		Define exactly one of
296c609719bSwdenk		CONFIG_CMA286_60_OLD
297c609719bSwdenk--- FIXME --- not tested yet:
298c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
299c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
300c609719bSwdenk
301c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
302c609719bSwdenk		Define exactly one of
303c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
304c609719bSwdenk
305c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
306c609719bSwdenk		Define one or more of
307c609719bSwdenk		CONFIG_CMA302
308c609719bSwdenk
309c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
310c609719bSwdenk		Define one or more of
311c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
31211ccc33fSMarcel Ziswiler					  the LCD display every second with
313c609719bSwdenk					  a "rotator" |\-/|\-/
314c609719bSwdenk
3152535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3162535d602Swdenk		CONFIG_ADSTYPE
3172535d602Swdenk		Possible values are:
3186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
3206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
3216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
3222535d602Swdenk
323cf946c6dSLei Wen- Marvell Family Member
324cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
325cf946c6dSLei Wen					  multiple fs option at one time
326cf946c6dSLei Wen					  for marvell soc family
327cf946c6dSLei Wen
328c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
329c609719bSwdenk		Define exactly one of
330c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
331c609719bSwdenk
33211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
33366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
33466ca92a5Swdenk					  get_gclk_freq() cannot work
3355da627a4Swdenk					  e.g. if there is no 32KHz
3365da627a4Swdenk					  reference PIT/RTC clock
33766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
33866ca92a5Swdenk					  or XTAL/EXTAL)
339c609719bSwdenk
34066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
34366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
34475d1ea7fSwdenk			See doc/README.MPC866
34575d1ea7fSwdenk
3466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
34775d1ea7fSwdenk
34875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
34975d1ea7fSwdenk		of relying on the correctness of the configured
35075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
35175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
35275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
35475d1ea7fSwdenk
355506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
356506f3918SHeiko Schocher
357506f3918SHeiko Schocher		Define this option if you want to enable the
358506f3918SHeiko Schocher		ICache only when Code runs from RAM.
359506f3918SHeiko Schocher
36066412c63SKumar Gala- 85xx CPU Options:
36166412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
36266412c63SKumar Gala
36366412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
36466412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
36566412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
36666412c63SKumar Gala
3678f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3688f29084aSKumar Gala
3698f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3708f29084aSKumar Gala		tree nodes for the given platform.
3718f29084aSKumar Gala
3720b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3740b953ffcSMarkus Klotzbuecher
3750b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3760b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3770b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3780b953ffcSMarkus Klotzbuecher
3796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3800b953ffcSMarkus Klotzbuecher
3810b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3820b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3830b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3840b953ffcSMarkus Klotzbuecher		by this value.
3850b953ffcSMarkus Klotzbuecher
38692bbd64eSDaniel Schwierzeck- MIPS CPU options:
38792bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
38892bbd64eSDaniel Schwierzeck
38992bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
39092bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
39192bbd64eSDaniel Schwierzeck		relocation.
39292bbd64eSDaniel Schwierzeck
39392bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
39492bbd64eSDaniel Schwierzeck
39592bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
39692bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
39792bbd64eSDaniel Schwierzeck		Possible values are:
39892bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
39992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
40092bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
40192bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
40292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
40392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
40492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
40592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
40692bbd64eSDaniel Schwierzeck
40792bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
40892bbd64eSDaniel Schwierzeck
40992bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
41092bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
41192bbd64eSDaniel Schwierzeck
41292bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
41392bbd64eSDaniel Schwierzeck
41492bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
41592bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
41692bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
41792bbd64eSDaniel Schwierzeck
4185da627a4Swdenk- Linux Kernel Interface:
419c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
420c609719bSwdenk
421c609719bSwdenk		U-Boot stores all clock information in Hz
422c609719bSwdenk		internally. For binary compatibility with older Linux
423c609719bSwdenk		kernels (which expect the clocks passed in the
424c609719bSwdenk		bd_info data to be in MHz) the environment variable
425c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
426c609719bSwdenk		converts clock data to MHZ before passing it to the
427c609719bSwdenk		Linux kernel.
428c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
429c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
430c609719bSwdenk		default environment.
431c609719bSwdenk
4325da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4335da627a4Swdenk
43411ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
4355da627a4Swdenk		expect it to be in bytes, others in MB.
4365da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4375da627a4Swdenk
438fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
439f57f70aaSWolfgang Denk
440f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
441213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
442213bf8c8SGerald Van Baren		concepts).
443213bf8c8SGerald Van Baren
444213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
445213bf8c8SGerald Van Baren		 * New libfdt-based support
446213bf8c8SGerald Van Baren		 * Adds the "fdt" command
4473bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
448213bf8c8SGerald Van Baren
449b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
450b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
451b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
452b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
453f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
454c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
455f57f70aaSWolfgang Denk
45611ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
45711ccc33fSMarcel Ziswiler		addresses
4583bb342fcSKim Phillips
4594e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4604e253137SKumar Gala
4614e253137SKumar Gala		Board code has addition modification that it wants to make
4624e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4636705d81eSwdenk
4640267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4650267768eSMatthew McClintock
46611ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
4670267768eSMatthew McClintock		param header, the default value is zero if undefined.
4680267768eSMatthew McClintock
4693887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
4703887c3fbSHeiko Schocher
4713887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
4723887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
4733887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4743887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4753887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4763887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4773887c3fbSHeiko Schocher
4787eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
4797eb29398SIgor Grinberg
4807eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
4817eb29398SIgor Grinberg		machine type and must be used to specify the machine type
4827eb29398SIgor Grinberg		number as it appears in the ARM machine registry
4837eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
4847eb29398SIgor Grinberg		Only boards that have multiple machine types supported
4857eb29398SIgor Grinberg		in a single configuration file and the machine type is
4867eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
4877eb29398SIgor Grinberg
4880b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4890b2f4ecaSNiklaus Giger
4900b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4910b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4920b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4930b2f4ecaSNiklaus Giger
4940b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4960b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4970b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4980b2f4ecaSNiklaus Giger
4990b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
5000b2f4ecaSNiklaus Giger
5010b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
5020b2f4ecaSNiklaus Giger
5030b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
5040b2f4ecaSNiklaus Giger		the defaults discussed just above.
5050b2f4ecaSNiklaus Giger
5062c451f78SAneesh V- Cache Configuration:
5072c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
5082c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
5092c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
5102c451f78SAneesh V
51193bc2193SAneesh V- Cache Configuration for ARM:
51293bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
51393bc2193SAneesh V				      controller
51493bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
51593bc2193SAneesh V					controller register space
51693bc2193SAneesh V
5176705d81eSwdenk- Serial Ports:
51848d0192fSAndreas Engel		CONFIG_PL010_SERIAL
5196705d81eSwdenk
5206705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
5216705d81eSwdenk
52248d0192fSAndreas Engel		CONFIG_PL011_SERIAL
5236705d81eSwdenk
5246705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
5256705d81eSwdenk
5266705d81eSwdenk		CONFIG_PL011_CLOCK
5276705d81eSwdenk
5286705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5296705d81eSwdenk		the clock speed of the UARTs.
5306705d81eSwdenk
5316705d81eSwdenk		CONFIG_PL01x_PORTS
5326705d81eSwdenk
5336705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5346705d81eSwdenk		define this to a list of base addresses for each (supported)
5356705d81eSwdenk		port. See e.g. include/configs/versatile.h
5366705d81eSwdenk
537910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_RLCR
538910f1ae3SJohn Rigby
539910f1ae3SJohn Rigby		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
540910f1ae3SJohn Rigby		have separate receive and transmit line control registers.  Set
541910f1ae3SJohn Rigby		this variable to initialize the extra register.
542910f1ae3SJohn Rigby
543910f1ae3SJohn Rigby		CONFIG_PL011_SERIAL_FLUSH_ON_INIT
544910f1ae3SJohn Rigby
545910f1ae3SJohn Rigby		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
546910f1ae3SJohn Rigby		boot loader that has already initialized the UART.  Define this
547910f1ae3SJohn Rigby		variable to flush the UART at init time.
548910f1ae3SJohn Rigby
5496705d81eSwdenk
550c609719bSwdenk- Console Interface:
551c609719bSwdenk		Depending on board, define exactly one serial port
552c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
553c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
554c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
555c609719bSwdenk
556c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
557c609719bSwdenk		port routines must be defined elsewhere
558c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
559c609719bSwdenk
560c609719bSwdenk		CONFIG_CFB_CONSOLE
561c609719bSwdenk		Enables console device for a color framebuffer. Needs following
562c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
563c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
564c609719bSwdenk						(default big endian)
565c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
566c609719bSwdenk						rectangle fill
567c609719bSwdenk						(cf. smiLynxEM)
568c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
569c609719bSwdenk						bit-blit (cf. smiLynxEM)
570c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
571c609719bSwdenk						(cols=pitch)
572c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
573c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
574c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
575c609719bSwdenk						(0-5, cf. cfb_console.c)
576c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
577c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
578c609719bSwdenk						(i.e. i8042_kbd_init())
579c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
580c609719bSwdenk						(i.e. i8042_tstc)
581c609719bSwdenk			VIDEO_GETC_FCT		get char fct
582c609719bSwdenk						(i.e. i8042_getc)
583c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
584c609719bSwdenk						(requires blink timer
585c609719bSwdenk						cf. i8042.c)
5866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
587c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
588c609719bSwdenk						upper right corner
589602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
590c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
591c609719bSwdenk						upper left corner
592a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
593a6c7ad2fSwdenk						linux_logo.h for logo.
594a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
595c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
59611ccc33fSMarcel Ziswiler						additional board info beside
597c609719bSwdenk						the logo
598c609719bSwdenk
599c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
600c609719bSwdenk		default i/o. Serial console can be forced with
601c609719bSwdenk		environment 'console=serial'.
602c609719bSwdenk
603a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
604a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
605a3ad8e26Swdenk		the "silent" environment variable. See
606a3ad8e26Swdenk		doc/README.silent for more information.
607a3ad8e26Swdenk
608c609719bSwdenk- Console Baudrate:
609c609719bSwdenk		CONFIG_BAUDRATE - in bps
610c609719bSwdenk		Select one of the baudrates listed in
6116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
6126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
613c609719bSwdenk
614c92fac91SHeiko Schocher- Console Rx buffer length
615c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
616c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
6172b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
618c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
619c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
620c92fac91SHeiko Schocher		the SMC.
621c92fac91SHeiko Schocher
622c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
623c609719bSwdenk		Delay before automatically booting the default image;
624c609719bSwdenk		set to -1 to disable autoboot.
625c609719bSwdenk
626c609719bSwdenk		See doc/README.autoboot for these options that
627c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
628c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
629c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
630c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
631c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
632c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
633c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
634c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
635c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
636c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
637c609719bSwdenk		CONFIG_RESET_TO_RETRY
638c609719bSwdenk
639c609719bSwdenk- Autoboot Command:
640c609719bSwdenk		CONFIG_BOOTCOMMAND
641c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
642c609719bSwdenk		define a command string that is automatically executed
643c609719bSwdenk		when no character is read on the console interface
644c609719bSwdenk		within "Boot Delay" after reset.
645c609719bSwdenk
646c609719bSwdenk		CONFIG_BOOTARGS
647c609719bSwdenk		This can be used to pass arguments to the bootm
648c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
649c609719bSwdenk		environment value "bootargs".
650c609719bSwdenk
651c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
652c609719bSwdenk		The value of these goes into the environment as
653c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
654c609719bSwdenk		as a convenience, when switching between booting from
65511ccc33fSMarcel Ziswiler		RAM and NFS.
656c609719bSwdenk
657c609719bSwdenk- Pre-Boot Commands:
658c609719bSwdenk		CONFIG_PREBOOT
659c609719bSwdenk
660c609719bSwdenk		When this option is #defined, the existence of the
661c609719bSwdenk		environment variable "preboot" will be checked
662c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
663c609719bSwdenk		countdown and/or running the auto-boot command resp.
664c609719bSwdenk		entering interactive mode.
665c609719bSwdenk
666c609719bSwdenk		This feature is especially useful when "preboot" is
667c609719bSwdenk		automatically generated or modified. For an example
668c609719bSwdenk		see the LWMON board specific code: here "preboot" is
669c609719bSwdenk		modified when the user holds down a certain
670c609719bSwdenk		combination of keys on the (special) keyboard when
671c609719bSwdenk		booting the systems
672c609719bSwdenk
673c609719bSwdenk- Serial Download Echo Mode:
674c609719bSwdenk		CONFIG_LOADS_ECHO
675c609719bSwdenk		If defined to 1, all characters received during a
676c609719bSwdenk		serial download (using the "loads" command) are
677c609719bSwdenk		echoed back. This might be needed by some terminal
678c609719bSwdenk		emulations (like "cu"), but may as well just take
679c609719bSwdenk		time on others. This setting #define's the initial
680c609719bSwdenk		value of the "loads_echo" environment variable.
681c609719bSwdenk
682602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
683c609719bSwdenk		CONFIG_KGDB_BAUDRATE
684c609719bSwdenk		Select one of the baudrates listed in
6856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
686c609719bSwdenk
687c609719bSwdenk- Monitor Functions:
688602ad3b3SJon Loeliger		Monitor commands can be included or excluded
689602ad3b3SJon Loeliger		from the build by using the #include files
690602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
691602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
692602ad3b3SJon Loeliger		and augmenting with additional #define's
693602ad3b3SJon Loeliger		for wanted commands.
694c609719bSwdenk
695602ad3b3SJon Loeliger		The default command configuration includes all commands
696602ad3b3SJon Loeliger		except those marked below with a "*".
697602ad3b3SJon Loeliger
698602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
699602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
700602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
701602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
702602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
703602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
704602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
705602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
706710b9938SMike Frysinger		CONFIG_CMD_CRC32	* crc32
707602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
708602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
709602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
710a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
711a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
712a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
713a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
714602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
715602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
716246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
717602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
718602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
7190c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
720bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
721602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
722602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
723602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
724602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
725602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
726a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
727a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
728602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
729602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
730602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
731602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
732602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
733602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
7340c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
735602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
736602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
737602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
738602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
7391ba7fd25SMike Frysinger		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
740602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
741602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
74202c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
74302c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
744602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
74556523f12Swdenk					  loop, loopw, mtest
746602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
747602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
748602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
74968d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
750602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
751602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
752e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
753e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
754602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
755602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
756602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
757602ad3b3SJon Loeliger					  host
758602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
759602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
760602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
761602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
762602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
763602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
764602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
765602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
766602ad3b3SJon Loeliger					  (4xx only)
767c6b1ee66SAlexander Holler		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
76802c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
76974de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
770602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
7717a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
772602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
773602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
774602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
775c609719bSwdenk
776c609719bSwdenk
777c609719bSwdenk		EXAMPLE: If you want all functions except of network
778c609719bSwdenk		support you can write:
779c609719bSwdenk
780602ad3b3SJon Loeliger		#include "config_cmd_all.h"
781602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
782c609719bSwdenk
783213bf8c8SGerald Van Baren	Other Commands:
784213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
785c609719bSwdenk
786c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
787602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
788c609719bSwdenk		what you (and your U-Boot users) are doing. Data
789c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
790c609719bSwdenk		8260 (where accesses to the IMMR region must be
791c609719bSwdenk		uncached), and it cannot be disabled on all other
792c609719bSwdenk		systems where we (mis-) use the data cache to hold an
793c609719bSwdenk		initial stack and some data.
794c609719bSwdenk
795c609719bSwdenk
796c609719bSwdenk		XXX - this list needs to get updated!
797c609719bSwdenk
798c609719bSwdenk- Watchdog:
799c609719bSwdenk		CONFIG_WATCHDOG
800c609719bSwdenk		If this variable is defined, it enables watchdog
8016abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
8026abe6fb6SDetlev Zundel		specific code for a watchdog. For the 8xx and 8260
8036abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
8046abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
8056abe6fb6SDetlev Zundel		available, then no further board specific code should
8066abe6fb6SDetlev Zundel		be needed to use it.
8076abe6fb6SDetlev Zundel
8086abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
8096abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
8106abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
8116abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
812c609719bSwdenk
813c1551ea8Sstroese- U-Boot Version:
814c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
815c1551ea8Sstroese		If this variable is defined, an environment variable
816c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
817c1551ea8Sstroese		version as printed by the "version" command.
818c1551ea8Sstroese		This variable is readonly.
819c1551ea8Sstroese
820c609719bSwdenk- Real-Time Clock:
821c609719bSwdenk
822602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
823c609719bSwdenk		has to be selected, too. Define exactly one of the
824c609719bSwdenk		following options:
825c609719bSwdenk
826c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
827c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
8287ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
829c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
8301cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
831c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
8327f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
8333bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
8349536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
8354c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
8366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
83771d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
83871d19f30SHeiko Schocher					  RV3029 RTC.
839c609719bSwdenk
840b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
841b37c7e5eSwdenk		must also be configured. See I2C Support, below.
842b37c7e5eSwdenk
843e92739d3SPeter Tyser- GPIO Support:
844e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
845e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
846e92739d3SPeter Tyser
8475dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
8485dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
8495dec49caSChris Packham		pins supported by a particular chip.
8505dec49caSChris Packham
851e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
852e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
853e92739d3SPeter Tyser
854c609719bSwdenk- Timestamp Support:
855c609719bSwdenk
856c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
857c609719bSwdenk		(date and time) of an image is printed by image
858c609719bSwdenk		commands like bootm or iminfo. This option is
859602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
860c609719bSwdenk
861c609719bSwdenk- Partition Support:
862c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
86307f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
864c609719bSwdenk
865602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
866218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
867218ca724SWolfgang Denk		least one partition type as well.
868c609719bSwdenk
869c609719bSwdenk- IDE Reset method:
8704d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8714d13cbadSwdenk		board configurations files but used nowhere!
872c609719bSwdenk
8734d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8744d13cbadSwdenk		be performed by calling the function
8754d13cbadSwdenk			ide_set_reset(int reset)
8764d13cbadSwdenk		which has to be defined in a board specific file
877c609719bSwdenk
878c609719bSwdenk- ATAPI Support:
879c609719bSwdenk		CONFIG_ATAPI
880c609719bSwdenk
881c609719bSwdenk		Set this to enable ATAPI support.
882c609719bSwdenk
883c40b2956Swdenk- LBA48 Support
884c40b2956Swdenk		CONFIG_LBA48
885c40b2956Swdenk
886c40b2956Swdenk		Set this to enable support for disks larger than 137GB
8874b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
888c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
889c40b2956Swdenk		support disks up to 2.1TB.
890c40b2956Swdenk
8916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
892c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
893c40b2956Swdenk			Default is 32bit.
894c40b2956Swdenk
895c609719bSwdenk- SCSI Support:
896c609719bSwdenk		At the moment only there is only support for the
897c609719bSwdenk		SYM53C8XX SCSI controller; define
898c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
899c609719bSwdenk
9006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
9016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
9026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
903c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
904c609719bSwdenk		devices.
9056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
906c609719bSwdenk
907c609719bSwdenk- NETWORK Support (PCI):
908682011ffSwdenk		CONFIG_E1000
909682011ffSwdenk		Support for Intel 8254x gigabit chips.
910682011ffSwdenk
911ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
91211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
913ac3315c2SAndre Schwarz
914c609719bSwdenk		CONFIG_EEPRO100
915c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
91611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
917c609719bSwdenk		write routine for first time initialisation.
918c609719bSwdenk
919c609719bSwdenk		CONFIG_TULIP
920c609719bSwdenk		Support for Digital 2114x chips.
921c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
922c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
923c609719bSwdenk
924c609719bSwdenk		CONFIG_NATSEMI
925c609719bSwdenk		Support for National dp83815 chips.
926c609719bSwdenk
927c609719bSwdenk		CONFIG_NS8382X
928c609719bSwdenk		Support for National dp8382[01] gigabit chips.
929c609719bSwdenk
93045219c46Swdenk- NETWORK Support (other):
93145219c46Swdenk
932c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
933c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
934c041e9d2SJens Scharsig
935c041e9d2SJens Scharsig			CONFIG_RMII
936c041e9d2SJens Scharsig			Define this to use reduced MII inteface
937c041e9d2SJens Scharsig
938c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
939c041e9d2SJens Scharsig			If this defined, the driver is quiet.
940c041e9d2SJens Scharsig			The driver doen't show link status messages.
941c041e9d2SJens Scharsig
94245219c46Swdenk		CONFIG_DRIVER_LAN91C96
94345219c46Swdenk		Support for SMSC's LAN91C96 chips.
94445219c46Swdenk
94545219c46Swdenk			CONFIG_LAN91C96_BASE
94645219c46Swdenk			Define this to hold the physical address
94745219c46Swdenk			of the LAN91C96's I/O space
94845219c46Swdenk
94945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
95045219c46Swdenk			Define this to enable 32 bit addressing
95145219c46Swdenk
952f39748aeSwdenk		CONFIG_DRIVER_SMC91111
953f39748aeSwdenk		Support for SMSC's LAN91C111 chip
954f39748aeSwdenk
955f39748aeSwdenk			CONFIG_SMC91111_BASE
956f39748aeSwdenk			Define this to hold the physical address
957f39748aeSwdenk			of the device (I/O space)
958f39748aeSwdenk
959f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
960f39748aeSwdenk			Define this if data bus is 32 bits
961f39748aeSwdenk
962f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
963f39748aeSwdenk			Define this to use i/o functions instead of macros
964f39748aeSwdenk			(some hardware wont work with macros)
965f39748aeSwdenk
966b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
967b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
968b3dbf4a5SMacpaul Lin
969b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
970b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
971b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
972b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
973b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
974b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
975b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
976b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
977b3dbf4a5SMacpaul Lin
978c2fff331SMike Rapoport		CONFIG_SMC911X
979557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
980557b377dSJens Gehrlein
981c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
982557b377dSJens Gehrlein			Define this to hold the physical address
983557b377dSJens Gehrlein			of the device (I/O space)
984557b377dSJens Gehrlein
985c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
986557b377dSJens Gehrlein			Define this if data bus is 32 bits
987557b377dSJens Gehrlein
988c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
989557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
990557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
991c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
992557b377dSJens Gehrlein
9933d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
9943d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
9953d0075faSYoshihiro Shimoda
9963d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
9973d0075faSYoshihiro Shimoda			Define the number of ports to be used
9983d0075faSYoshihiro Shimoda
9993d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
10003d0075faSYoshihiro Shimoda			Define the ETH PHY's address
10013d0075faSYoshihiro Shimoda
100268260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
100368260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
100468260aabSYoshihiro Shimoda
1005c609719bSwdenk- USB Support:
1006c609719bSwdenk		At the moment only the UHCI host controller is
10074d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1008c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1009c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
101030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1011c609719bSwdenk		storage devices.
1012c609719bSwdenk		Note:
1013c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1014c609719bSwdenk		(TEAC FD-05PUB).
10154d13cbadSwdenk		MPC5200 USB requires additional defines:
10164d13cbadSwdenk			CONFIG_USB_CLOCK
10174d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1018307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1019307ecb6dSEric Millbrandt				for USB on PSC3
10204d13cbadSwdenk			CONFIG_USB_CONFIG
10214d13cbadSwdenk				for differential drivers: 0x00001000
10224d13cbadSwdenk				for single ended drivers: 0x00005000
1023307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1024307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
10256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1026fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1027fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
10284d13cbadSwdenk
102916c8d5e7SWolfgang Denk- USB Device:
103016c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
103116c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
103216c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
103311ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
103416c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
103516c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
103616c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
103716c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
103816c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
103916c8d5e7SWolfgang Denk		a Linux host by
104016c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
104116c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
104216c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
104316c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
104416c8d5e7SWolfgang Denk
104516c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
104616c8d5e7SWolfgang Denk			Define this to build a UDC device
104716c8d5e7SWolfgang Denk
104816c8d5e7SWolfgang Denk			CONFIG_USB_TTY
104916c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
105016c8d5e7SWolfgang Denk			talk to the UDC device
105116c8d5e7SWolfgang Denk
10526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
105316c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
105416c8d5e7SWolfgang Denk			be set to usbtty.
105516c8d5e7SWolfgang Denk
105616c8d5e7SWolfgang Denk			mpc8xx:
10576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
105816c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
10596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
106016c8d5e7SWolfgang Denk
10616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
106216c8d5e7SWolfgang Denk				Derive USB clock from brgclk
10636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
106416c8d5e7SWolfgang Denk
106516c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
106616c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
106716c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
106816c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
106916c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
107016c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
107116c8d5e7SWolfgang Denk
107216c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
107316c8d5e7SWolfgang Denk			Define this string as the name of your company for
107416c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
107516c8d5e7SWolfgang Denk
107616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
107716c8d5e7SWolfgang Denk			Define this string as the name of your product
107816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
107916c8d5e7SWolfgang Denk
108016c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
108116c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
108216c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
108316c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
108416c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
108516c8d5e7SWolfgang Denk
108616c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
108716c8d5e7SWolfgang Denk			Define this as the unique Product ID
108816c8d5e7SWolfgang Denk			for your device
108916c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1090c609719bSwdenk
1091c609719bSwdenk
1092c609719bSwdenk- MMC Support:
1093c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1094c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1095c609719bSwdenk		accessed from the boot prompt by mapping the device
1096c609719bSwdenk		to physical memory similar to flash. Command line is
1097602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1098602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1099c609719bSwdenk
1100afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1101afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1102afb35666SYoshihiro Shimoda
1103afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1104afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1105afb35666SYoshihiro Shimoda
1106afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1107afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1108afb35666SYoshihiro Shimoda
11096705d81eSwdenk- Journaling Flash filesystem support:
11106705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
11116705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
11126705d81eSwdenk		Define these for a default partition on a NAND device
11136705d81eSwdenk
11146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
11156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
11166705d81eSwdenk		Define these for a default partition on a NOR device
11176705d81eSwdenk
11186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
11196705d81eSwdenk		Define this to create an own partition. You have to provide a
11206705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
11216705d81eSwdenk
11226705d81eSwdenk		If you define only one JFFS2 partition you may also want to
11236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
11246705d81eSwdenk		to disable the command chpart. This is the default when you
11256705d81eSwdenk		have not defined a custom partition
11266705d81eSwdenk
1127c609719bSwdenk- Keyboard Support:
1128c609719bSwdenk		CONFIG_ISA_KEYBOARD
1129c609719bSwdenk
1130c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1131c609719bSwdenk		support
1132c609719bSwdenk
1133c609719bSwdenk		CONFIG_I8042_KBD
1134c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1135c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1136c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1137c609719bSwdenk		for cfb_console. Supports cursor blinking.
1138c609719bSwdenk
1139c609719bSwdenk- Video support:
1140c609719bSwdenk		CONFIG_VIDEO
1141c609719bSwdenk
1142c609719bSwdenk		Define this to enable video support (for output to
1143c609719bSwdenk		video).
1144c609719bSwdenk
1145c609719bSwdenk		CONFIG_VIDEO_CT69000
1146c609719bSwdenk
1147c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1148c609719bSwdenk
1149c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1150eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1151eeb1b77bSwdenk		video output is selected via environment 'videoout'
1152eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1153eeb1b77bSwdenk		assumed.
1154c609719bSwdenk
1155eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
115611ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1157eeb1b77bSwdenk		are possible:
1158eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1159eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1160eeb1b77bSwdenk
1161eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1162eeb1b77bSwdenk		-------------+---------------------------------------------
1163eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1164eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1165eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1166eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1167eeb1b77bSwdenk		-------------+---------------------------------------------
1168c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1169c609719bSwdenk
1170eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
11717817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1172eeb1b77bSwdenk
1173eeb1b77bSwdenk
1174a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1175a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1176a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1177a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1178a6c7ad2fSwdenk
11797d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
11807d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
11817d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
11827d3053fbSTimur Tabi		support, and should also define these other macros:
11837d3053fbSTimur Tabi
11847d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
11857d3053fbSTimur Tabi			CONFIG_VIDEO
11867d3053fbSTimur Tabi			CONFIG_CMD_BMP
11877d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
11887d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
11897d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
11907d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
11917d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
11927d3053fbSTimur Tabi
1193ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1194ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
1195ba8e76bdSTimur Tabi		boot.  See the documentation file README.video for a
1196ba8e76bdSTimur Tabi		description of this variable.
11977d3053fbSTimur Tabi
1198682011ffSwdenk- Keyboard Support:
1199682011ffSwdenk		CONFIG_KEYBOARD
1200682011ffSwdenk
1201682011ffSwdenk		Define this to enable a custom keyboard support.
1202682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1203682011ffSwdenk		defined in your board-specific files.
1204682011ffSwdenk		The only board using this so far is RBC823.
1205a6c7ad2fSwdenk
1206c609719bSwdenk- LCD Support:	CONFIG_LCD
1207c609719bSwdenk
1208c609719bSwdenk		Define this to enable LCD support (for output to LCD
1209c609719bSwdenk		display); also select one of the supported displays
1210c609719bSwdenk		by defining one of these:
1211c609719bSwdenk
121239cf4804SStelian Pop		CONFIG_ATMEL_LCD:
121339cf4804SStelian Pop
121439cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
121539cf4804SStelian Pop
1216fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1217c609719bSwdenk
1218fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1219c609719bSwdenk
1220fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1221c609719bSwdenk
1222fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1223fd3103bbSwdenk			Active, color, single scan.
1224fd3103bbSwdenk
1225fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1226fd3103bbSwdenk
1227fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1228c609719bSwdenk			Active, color, single scan.
1229c609719bSwdenk
1230c609719bSwdenk		CONFIG_SHARP_16x9
1231c609719bSwdenk
1232c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1233c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1234c609719bSwdenk
1235c609719bSwdenk		CONFIG_SHARP_LQ64D341
1236c609719bSwdenk
1237c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1238c609719bSwdenk			Active, color, single scan.
1239c609719bSwdenk
1240c609719bSwdenk		CONFIG_HLD1045
1241c609719bSwdenk
1242c609719bSwdenk			HLD1045 display, 640x480.
1243c609719bSwdenk			Active, color, single scan.
1244c609719bSwdenk
1245c609719bSwdenk		CONFIG_OPTREX_BW
1246c609719bSwdenk
1247c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1248c609719bSwdenk			or
1249c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1250c609719bSwdenk			or
1251c609719bSwdenk			Hitachi	 SP14Q002
1252c609719bSwdenk
1253c609719bSwdenk			320x240. Black & white.
1254c609719bSwdenk
1255c609719bSwdenk		Normally display is black on white background; define
12566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1257c609719bSwdenk
12587152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1259d791b1dcSwdenk
1260d791b1dcSwdenk		If this option is set, the environment is checked for
1261d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1262d791b1dcSwdenk		of logo, copyright and system information on the LCD
1263e94d2cd9Swdenk		is suppressed and the BMP image at the address
1264d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1265d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1266d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1267d791b1dcSwdenk		loaded very quickly after power-on.
1268d791b1dcSwdenk
12691ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
12701ca298ceSMatthias Weisser
12711ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
12721ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
12731ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
12741ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
12751ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
12761ca298ceSMatthias Weisser		specify 'm' for centering the image.
12771ca298ceSMatthias Weisser
12781ca298ceSMatthias Weisser		Example:
12791ca298ceSMatthias Weisser		setenv splashpos m,m
12801ca298ceSMatthias Weisser			=> image at center of screen
12811ca298ceSMatthias Weisser
12821ca298ceSMatthias Weisser		setenv splashpos 30,20
12831ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
12841ca298ceSMatthias Weisser
12851ca298ceSMatthias Weisser		setenv splashpos -10,m
12861ca298ceSMatthias Weisser			=> vertically centered image
12871ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
12881ca298ceSMatthias Weisser
128998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
129098f4a3dfSStefan Roese
129198f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
129298f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
129398f4a3dfSStefan Roese		splashscreen support or the bmp command.
129498f4a3dfSStefan Roese
1295d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1296d5011762SAnatolij Gustschin
1297d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1298d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1299d5011762SAnatolij Gustschin		bmp command.
1300d5011762SAnatolij Gustschin
1301c29fdfc1Swdenk- Compression support:
1302c29fdfc1Swdenk		CONFIG_BZIP2
1303c29fdfc1Swdenk
1304c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1305c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1306c29fdfc1Swdenk		compressed images are supported.
1307c29fdfc1Swdenk
1308c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
13096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1310c29fdfc1Swdenk		be at least 4MB.
1311d791b1dcSwdenk
1312fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1313fc9c1727SLuigi 'Comio' Mantellini
1314fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1315fc9c1727SLuigi 'Comio' Mantellini		images is included.
1316fc9c1727SLuigi 'Comio' Mantellini
1317fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1318fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1319fc9c1727SLuigi 'Comio' Mantellini		formula:
1320fc9c1727SLuigi 'Comio' Mantellini
1321fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1322fc9c1727SLuigi 'Comio' Mantellini
1323fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1324fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1325fc9c1727SLuigi 'Comio' Mantellini
1326fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1327fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1328fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1329fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1330fc9c1727SLuigi 'Comio' Mantellini
1331fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1332fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
13336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1334fc9c1727SLuigi 'Comio' Mantellini
133517ea1177Swdenk- MII/PHY support:
133617ea1177Swdenk		CONFIG_PHY_ADDR
133717ea1177Swdenk
133817ea1177Swdenk		The address of PHY on MII bus.
133917ea1177Swdenk
134017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
134117ea1177Swdenk
134217ea1177Swdenk		The clock frequency of the MII bus
134317ea1177Swdenk
134417ea1177Swdenk		CONFIG_PHY_GIGE
134517ea1177Swdenk
134617ea1177Swdenk		If this option is set, support for speed/duplex
134711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
134817ea1177Swdenk
134917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
135017ea1177Swdenk
135117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
135217ea1177Swdenk		reset before any MII register access is possible.
135317ea1177Swdenk		For such PHY, set this option to the usec delay
135417ea1177Swdenk		required. (minimum 300usec for LXT971A)
135517ea1177Swdenk
135617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
135717ea1177Swdenk
135817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
135917ea1177Swdenk		command issued before MII status register can be read
136017ea1177Swdenk
1361c609719bSwdenk- Ethernet address:
1362c609719bSwdenk		CONFIG_ETHADDR
1363c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1364c609719bSwdenk		CONFIG_ETH2ADDR
1365c609719bSwdenk		CONFIG_ETH3ADDR
1366c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1367c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1368c609719bSwdenk
136911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
137011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1371c609719bSwdenk		is not determined automatically.
1372c609719bSwdenk
1373c609719bSwdenk- IP address:
1374c609719bSwdenk		CONFIG_IPADDR
1375c609719bSwdenk
1376c609719bSwdenk		Define a default value for the IP address to use for
137711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1378c609719bSwdenk		determined through e.g. bootp.
1379c609719bSwdenk
1380c609719bSwdenk- Server IP address:
1381c609719bSwdenk		CONFIG_SERVERIP
1382c609719bSwdenk
1383c609719bSwdenk		Defines a default value for the IP address of a TFTP
1384c609719bSwdenk		server to contact when using the "tftboot" command.
1385c609719bSwdenk
138697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
138797cfe861SRobin Getz
138897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
138997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
139097cfe861SRobin Getz
139153a5c424SDavid Updegraff- Multicast TFTP Mode:
139253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
139353a5c424SDavid Updegraff
139453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
139553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
139611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
139753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
139853a5c424SDavid Updegraff		multicast group.
139953a5c424SDavid Updegraff
1400c609719bSwdenk- BOOTP Recovery Mode:
1401c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1402c609719bSwdenk
1403c609719bSwdenk		If you have many targets in a network that try to
1404c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1405c609719bSwdenk		systems send out BOOTP requests at precisely the same
1406c609719bSwdenk		moment (which would happen for instance at recovery
1407c609719bSwdenk		from a power failure, when all systems will try to
1408c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1409c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1410c609719bSwdenk		inserted before sending out BOOTP requests. The
14116c33c785SWolfgang Denk		following delays are inserted then:
1412c609719bSwdenk
1413c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1414c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1415c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1416c609719bSwdenk		4th and following
1417c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1418c609719bSwdenk
1419fe389a82Sstroese- DHCP Advanced Options:
14201fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
14211fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1422fe389a82Sstroese
14231fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
14241fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
14251fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
14261fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
14271fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
14281fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
14291fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
14301fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
14311fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
14321fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
14331fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
14341fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1435fe389a82Sstroese
14365d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
14375d110f0aSWilson Callan		environment variable, not the BOOTP server.
1438fe389a82Sstroese
1439fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1440fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1441fe389a82Sstroese		than one DNS serverip is offered to the client.
1442fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1443fe389a82Sstroese		serverip will be stored in the additional environment
1444fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1445fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
14461fe80d79SJon Loeliger		is defined.
1447fe389a82Sstroese
1448fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1449fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1450fe389a82Sstroese		need the hostname of the DHCP requester.
14515d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
14521fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
14531fe80d79SJon Loeliger		option 12 to the DHCP server.
1454fe389a82Sstroese
1455d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1456d9a2f416SAras Vaichas
1457d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1458d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1459d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1460d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1461d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1462d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1463d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1464d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1465d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1466d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1467d9a2f416SAras Vaichas		this delay.
1468d9a2f416SAras Vaichas
1469a3d991bdSwdenk - CDP Options:
1470a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1471a3d991bdSwdenk
1472a3d991bdSwdenk		The device id used in CDP trigger frames.
1473a3d991bdSwdenk
1474a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1475a3d991bdSwdenk
1476a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1477a3d991bdSwdenk		of the device.
1478a3d991bdSwdenk
1479a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1480a3d991bdSwdenk
1481a3d991bdSwdenk		A printf format string which contains the ascii name of
1482a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
148311ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1484a3d991bdSwdenk
1485a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1486a3d991bdSwdenk
1487a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1488a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1489a3d991bdSwdenk
1490a3d991bdSwdenk		CONFIG_CDP_VERSION
1491a3d991bdSwdenk
1492a3d991bdSwdenk		An ascii string containing the version of the software.
1493a3d991bdSwdenk
1494a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1495a3d991bdSwdenk
1496a3d991bdSwdenk		An ascii string containing the name of the platform.
1497a3d991bdSwdenk
1498a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1499a3d991bdSwdenk
1500a3d991bdSwdenk		A 32bit integer sent on the trigger.
1501a3d991bdSwdenk
1502a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1503a3d991bdSwdenk
1504a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1505a3d991bdSwdenk		device in .1 of milliwatts.
1506a3d991bdSwdenk
1507a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1508a3d991bdSwdenk
1509a3d991bdSwdenk		A byte containing the id of the VLAN.
1510a3d991bdSwdenk
1511c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1512c609719bSwdenk
1513c609719bSwdenk		Several configurations allow to display the current
1514c609719bSwdenk		status using a LED. For instance, the LED will blink
1515c609719bSwdenk		fast while running U-Boot code, stop blinking as
1516c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1517c609719bSwdenk		start blinking slow once the Linux kernel is running
1518c609719bSwdenk		(supported by a status LED driver in the Linux
1519c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1520c609719bSwdenk		feature in U-Boot.
1521c609719bSwdenk
1522c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1523c609719bSwdenk
1524c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1525c609719bSwdenk		on those systems that support this (optional)
1526c609719bSwdenk		feature, like the TQM8xxL modules.
1527c609719bSwdenk
1528c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1529c609719bSwdenk
1530b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1531b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
153211ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1533c609719bSwdenk
1534b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1535602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1536b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1537b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1538c609719bSwdenk		command line interface.
1539c609719bSwdenk
1540bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1541c609719bSwdenk
1542b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1543b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1544b37c7e5eSwdenk		support for I2C.
1545c609719bSwdenk
1546b37c7e5eSwdenk		There are several other quantities that must also be
1547b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1548c609719bSwdenk
15496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1550b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
15516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
155211ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1553c609719bSwdenk
15548d321b81SPeter Tyser		Now, the u-boot i2c code for the mpc8xx
1555a47a12beSStefan Roese		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
15568d321b81SPeter Tyser		and so its address should therefore be cleared to 0 (See,
15578d321b81SPeter Tyser		eg, MPC823e User's Manual p.16-473). So, set
15588d321b81SPeter Tyser		CONFIG_SYS_I2C_SLAVE to 0.
1559b37c7e5eSwdenk
15605da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
15615da71efaSEric Millbrandt
15625da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
15635da71efaSEric Millbrandt		chips might think that the current transfer is still
15645da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
15655da71efaSEric Millbrandt		commands until the slave device responds.
15665da71efaSEric Millbrandt
1567b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1568b37c7e5eSwdenk
1569b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1570b37c7e5eSwdenk		then the following macros need to be defined (examples are
1571b37c7e5eSwdenk		from include/configs/lwmon.h):
1572c609719bSwdenk
1573c609719bSwdenk		I2C_INIT
1574c609719bSwdenk
1575b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1576c609719bSwdenk		controller or configure ports.
1577c609719bSwdenk
1578b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1579b37c7e5eSwdenk
1580c609719bSwdenk		I2C_PORT
1581c609719bSwdenk
1582c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1583c609719bSwdenk		assumes both bits are on the same port). Valid values
1584c609719bSwdenk		are 0..3 for ports A..D.
1585c609719bSwdenk
1586c609719bSwdenk		I2C_ACTIVE
1587c609719bSwdenk
1588c609719bSwdenk		The code necessary to make the I2C data line active
1589c609719bSwdenk		(driven).  If the data line is open collector, this
1590c609719bSwdenk		define can be null.
1591c609719bSwdenk
1592b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1593b37c7e5eSwdenk
1594c609719bSwdenk		I2C_TRISTATE
1595c609719bSwdenk
1596c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1597c609719bSwdenk		(inactive).  If the data line is open collector, this
1598c609719bSwdenk		define can be null.
1599c609719bSwdenk
1600b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1601b37c7e5eSwdenk
1602c609719bSwdenk		I2C_READ
1603c609719bSwdenk
1604c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1605c609719bSwdenk		FALSE if it is low.
1606c609719bSwdenk
1607b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1608b37c7e5eSwdenk
1609c609719bSwdenk		I2C_SDA(bit)
1610c609719bSwdenk
1611c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1612c609719bSwdenk		is FALSE, it clears it (low).
1613c609719bSwdenk
1614b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1615b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1616b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1617b37c7e5eSwdenk
1618c609719bSwdenk		I2C_SCL(bit)
1619c609719bSwdenk
1620c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1621c609719bSwdenk		is FALSE, it clears it (low).
1622c609719bSwdenk
1623b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1624b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1625b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1626b37c7e5eSwdenk
1627c609719bSwdenk		I2C_DELAY
1628c609719bSwdenk
1629c609719bSwdenk		This delay is invoked four times per clock cycle so this
1630c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1631b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1632b37c7e5eSwdenk		like:
1633b37c7e5eSwdenk
1634b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1635c609719bSwdenk
1636793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1637793b5726SMike Frysinger
1638793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
1639793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
1640793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
1641793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
1642793b5726SMike Frysinger
1643793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
1644793b5726SMike Frysinger		the generic GPIO functions.
1645793b5726SMike Frysinger
16466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
164747cd00faSwdenk
164847cd00faSwdenk		When a board is reset during an i2c bus transfer
164947cd00faSwdenk		chips might think that the current transfer is still
165047cd00faSwdenk		in progress. On some boards it is possible to access
165147cd00faSwdenk		the i2c SCLK line directly, either by using the
165247cd00faSwdenk		processor pin as a GPIO or by having a second pin
165347cd00faSwdenk		connected to the bus. If this option is defined a
165447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
165547cd00faSwdenk		is run early in the boot sequence.
165647cd00faSwdenk
165726a33504SRichard Retanubun		CONFIG_SYS_I2C_BOARD_LATE_INIT
165826a33504SRichard Retanubun
165926a33504SRichard Retanubun		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
166026a33504SRichard Retanubun		defined a custom i2c_board_late_init() routine in
166126a33504SRichard Retanubun		boards/xxx/board.c is run AFTER the operations in i2c_init()
166226a33504SRichard Retanubun		is completed. This callpoint can be used to unreset i2c bus
166326a33504SRichard Retanubun		using CPU i2c controller register accesses for CPUs whose i2c
166426a33504SRichard Retanubun		controller provide such a method. It is called at the end of
166526a33504SRichard Retanubun		i2c_init() to allow i2c_init operations to setup the i2c bus
166626a33504SRichard Retanubun		controller on the CPU (e.g. setting bus speed & slave address).
166726a33504SRichard Retanubun
166817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
166917ea1177Swdenk
167017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
167117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
167217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
167317ea1177Swdenk
1674bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1675bb99ad6dSBen Warren
1676bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1677bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1678bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1679bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1680bb99ad6dSBen Warren
16816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1682bb99ad6dSBen Warren
1683bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
16840f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
16850f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
16860f89c54bSPeter Tyser		a 1D array of device addresses
1687bb99ad6dSBen Warren
1688bb99ad6dSBen Warren		e.g.
1689bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
16906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1691bb99ad6dSBen Warren
1692bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1693bb99ad6dSBen Warren
1694bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
16956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1696bb99ad6dSBen Warren
1697bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1698bb99ad6dSBen Warren
16996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1700be5e6181STimur Tabi
1701be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1702be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1703be5e6181STimur Tabi
17046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
17050dc018ecSStefan Roese
17060dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
17070dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
17080dc018ecSStefan Roese
17096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
17100dc018ecSStefan Roese
17110dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
17120dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
17130dc018ecSStefan Roese
17146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
17159ebbb54fSVictor Gallardo
17169ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
17179ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
17189ebbb54fSVictor Gallardo		specified DTT device.
17199ebbb54fSVictor Gallardo
1720be5e6181STimur Tabi		CONFIG_FSL_I2C
1721be5e6181STimur Tabi
1722be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
17237817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1724be5e6181STimur Tabi
172567b23a32SHeiko Schocher		CONFIG_I2C_MUX
172667b23a32SHeiko Schocher
172767b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
172867b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
172967b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
173067b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
173167b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
173267b23a32SHeiko Schocher		the muxes to activate this new "bus".
173367b23a32SHeiko Schocher
173467b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
173567b23a32SHeiko Schocher		feature!
173667b23a32SHeiko Schocher
173767b23a32SHeiko Schocher		Example:
173867b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
173967b23a32SHeiko Schocher			The First mux with address 70 and channel 6
174067b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
174167b23a32SHeiko Schocher
174267b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
174367b23a32SHeiko Schocher
174467b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
174567b23a32SHeiko Schocher		of I2C Busses with muxes:
174667b23a32SHeiko Schocher
174767b23a32SHeiko Schocher		=> i2c bus
174867b23a32SHeiko Schocher		Busses reached over muxes:
174967b23a32SHeiko Schocher		Bus ID: 2
175067b23a32SHeiko Schocher		  reached over Mux(es):
175167b23a32SHeiko Schocher		    pca9544a@70 ch: 4
175267b23a32SHeiko Schocher		Bus ID: 3
175367b23a32SHeiko Schocher		  reached over Mux(es):
175467b23a32SHeiko Schocher		    pca9544a@70 ch: 6
175567b23a32SHeiko Schocher		    pca9544a@71 ch: 4
175667b23a32SHeiko Schocher		=>
175767b23a32SHeiko Schocher
175867b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1759f9a78b8dSMichael Jones		u-boot first sends the command to the mux@70 to enable
1760f9a78b8dSMichael Jones		channel 6, and then the command to the mux@71 to enable
176167b23a32SHeiko Schocher		the channel 4.
176267b23a32SHeiko Schocher
176367b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
1764f9a78b8dSMichael Jones		usual to communicate with your I2C devices behind
176567b23a32SHeiko Schocher		the 2 muxes.
176667b23a32SHeiko Schocher
176767b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
176867b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
176967b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
177067b23a32SHeiko Schocher		to add this option to other architectures.
177167b23a32SHeiko Schocher
17722ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
17732ac6985aSAndrew Dyer
17742ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
17752ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
17762ac6985aSAndrew Dyer		between writing the address pointer and reading the
17772ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
17782ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
17792ac6985aSAndrew Dyer		devices can use either method, but some require one or
17802ac6985aSAndrew Dyer		the other.
1781be5e6181STimur Tabi
1782c609719bSwdenk- SPI Support:	CONFIG_SPI
1783c609719bSwdenk
1784c609719bSwdenk		Enables SPI driver (so far only tested with
1785c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1786c609719bSwdenk		D/As on the SACSng board)
1787c609719bSwdenk
17886639562eSYoshihiro Shimoda		CONFIG_SH_SPI
17896639562eSYoshihiro Shimoda
17906639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
17916639562eSYoshihiro Shimoda		only SH7757 is supported.
17926639562eSYoshihiro Shimoda
1793c609719bSwdenk		CONFIG_SPI_X
1794c609719bSwdenk
1795c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1796c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1797c609719bSwdenk
1798c609719bSwdenk		CONFIG_SOFT_SPI
1799c609719bSwdenk
1800c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1801c609719bSwdenk		using hardware support. This is a general purpose
1802c609719bSwdenk		driver that only requires three general I/O port pins
1803c609719bSwdenk		(two outputs, one input) to function. If this is
1804c609719bSwdenk		defined, the board configuration must define several
1805c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1806c609719bSwdenk		an example, see include/configs/sacsng.h.
1807c609719bSwdenk
180804a9e118SBen Warren		CONFIG_HARD_SPI
180904a9e118SBen Warren
181004a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
181104a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
181204a9e118SBen Warren		must define a list of chip-select function pointers.
181304a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
181404a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
181504a9e118SBen Warren
181638254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
181738254f45SGuennadi Liakhovetski
181838254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
181938254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
182038254f45SGuennadi Liakhovetski
18210133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
18220133502eSMatthias Fuchs
18230133502eSMatthias Fuchs		Enables FPGA subsystem.
18240133502eSMatthias Fuchs
18250133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
18260133502eSMatthias Fuchs
18270133502eSMatthias Fuchs		Enables support for specific chip vendors.
18280133502eSMatthias Fuchs		(ALTERA, XILINX)
18290133502eSMatthias Fuchs
18300133502eSMatthias Fuchs		CONFIG_FPGA_<family>
18310133502eSMatthias Fuchs
18320133502eSMatthias Fuchs		Enables support for FPGA family.
18330133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
18340133502eSMatthias Fuchs
18350133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1836c609719bSwdenk
1837c609719bSwdenk		Specify the number of FPGA devices to support.
1838c609719bSwdenk
18396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1840c609719bSwdenk
1841c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1842c609719bSwdenk
18436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1844c609719bSwdenk
1845c609719bSwdenk		Enable checks on FPGA configuration interface busy
1846c609719bSwdenk		status by the configuration function. This option
1847c609719bSwdenk		will require a board or device specific function to
1848c609719bSwdenk		be written.
1849c609719bSwdenk
1850c609719bSwdenk		CONFIG_FPGA_DELAY
1851c609719bSwdenk
1852c609719bSwdenk		If defined, a function that provides delays in the FPGA
1853c609719bSwdenk		configuration driver.
1854c609719bSwdenk
18556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1856c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1857c609719bSwdenk
18586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1859c609719bSwdenk
1860c609719bSwdenk		Check for configuration errors during FPGA bitfile
1861c609719bSwdenk		loading. For example, abort during Virtex II
1862c609719bSwdenk		configuration if the INIT_B line goes low (which
1863c609719bSwdenk		indicated a CRC error).
1864c609719bSwdenk
18656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1866c609719bSwdenk
1867c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1868c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1869c609719bSwdenk		FPGA configuration sequence. The default time is 500
187011ccc33fSMarcel Ziswiler		ms.
1871c609719bSwdenk
18726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1873c609719bSwdenk
1874c609719bSwdenk		Maximum time to wait for BUSY to deassert during
187511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1876c609719bSwdenk
18776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1878c609719bSwdenk
1879c609719bSwdenk		Time to wait after FPGA configuration. The default is
188011ccc33fSMarcel Ziswiler		200 ms.
1881c609719bSwdenk
1882c609719bSwdenk- Configuration Management:
1883c609719bSwdenk		CONFIG_IDENT_STRING
1884c609719bSwdenk
1885c609719bSwdenk		If defined, this string will be added to the U-Boot
1886c609719bSwdenk		version information (U_BOOT_VERSION)
1887c609719bSwdenk
1888c609719bSwdenk- Vendor Parameter Protection:
1889c609719bSwdenk
1890c609719bSwdenk		U-Boot considers the values of the environment
1891c609719bSwdenk		variables "serial#" (Board Serial Number) and
18927152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1893c609719bSwdenk		are set once by the board vendor / manufacturer, and
1894c609719bSwdenk		protects these variables from casual modification by
1895c609719bSwdenk		the user. Once set, these variables are read-only,
1896c609719bSwdenk		and write or delete attempts are rejected. You can
189711ccc33fSMarcel Ziswiler		change this behaviour:
1898c609719bSwdenk
1899c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1900c609719bSwdenk		file, the write protection for vendor parameters is
190147cd00faSwdenk		completely disabled. Anybody can change or delete
1902c609719bSwdenk		these parameters.
1903c609719bSwdenk
1904c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1905c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
190611ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1907c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1908c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1909c609719bSwdenk		read-only.]
1910c609719bSwdenk
1911c609719bSwdenk- Protected RAM:
1912c609719bSwdenk		CONFIG_PRAM
1913c609719bSwdenk
1914c609719bSwdenk		Define this variable to enable the reservation of
1915c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1916c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1917c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1918c609719bSwdenk		this default value by defining an environment
1919c609719bSwdenk		variable "pram" to the number of kB you want to
1920c609719bSwdenk		reserve. Note that the board info structure will
1921c609719bSwdenk		still show the full amount of RAM. If pRAM is
1922c609719bSwdenk		reserved, a new environment variable "mem" will
1923c609719bSwdenk		automatically be defined to hold the amount of
1924c609719bSwdenk		remaining RAM in a form that can be passed as boot
1925c609719bSwdenk		argument to Linux, for instance like that:
1926c609719bSwdenk
1927fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1928c609719bSwdenk			saveenv
1929c609719bSwdenk
1930c609719bSwdenk		This way you can tell Linux not to use this memory,
1931c609719bSwdenk		either, which results in a memory region that will
1932c609719bSwdenk		not be affected by reboots.
1933c609719bSwdenk
1934c609719bSwdenk		*WARNING* If your board configuration uses automatic
1935c609719bSwdenk		detection of the RAM size, you must make sure that
1936c609719bSwdenk		this memory test is non-destructive. So far, the
1937c609719bSwdenk		following board configurations are known to be
1938c609719bSwdenk		"pRAM-clean":
1939c609719bSwdenk
1940c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1941c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1942544d97e9SWolfgang Denk			FLAGADM, TQM8260
1943c609719bSwdenk
1944c609719bSwdenk- Error Recovery:
1945c609719bSwdenk		CONFIG_PANIC_HANG
1946c609719bSwdenk
1947c609719bSwdenk		Define this variable to stop the system in case of a
1948c609719bSwdenk		fatal error, so that you have to reset it manually.
1949c609719bSwdenk		This is probably NOT a good idea for an embedded
195011ccc33fSMarcel Ziswiler		system where you want the system to reboot
1951c609719bSwdenk		automatically as fast as possible, but it may be
1952c609719bSwdenk		useful during development since you can try to debug
1953c609719bSwdenk		the conditions that lead to the situation.
1954c609719bSwdenk
1955c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1956c609719bSwdenk
1957c609719bSwdenk		This variable defines the number of retries for
1958c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1959c609719bSwdenk		before giving up the operation. If not defined, a
1960c609719bSwdenk		default value of 5 is used.
1961c609719bSwdenk
196240cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
196340cb90eeSGuennadi Liakhovetski
196440cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
196540cb90eeSGuennadi Liakhovetski
1966c609719bSwdenk- Command Interpreter:
19678078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
196804a85b3bSwdenk
196904a85b3bSwdenk		Enable auto completion of commands using TAB.
197004a85b3bSwdenk
19718078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
19728078f1a5SWolfgang Denk		for the "hush" shell.
19738078f1a5SWolfgang Denk
19748078f1a5SWolfgang Denk
19756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1976c609719bSwdenk
1977c609719bSwdenk		Define this variable to enable the "hush" shell (from
1978c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1979c609719bSwdenk		powerful command line syntax like
1980c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1981c609719bSwdenk		constructs ("shell scripts").
1982c609719bSwdenk
1983c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1984c609719bSwdenk		with a somewhat smaller memory footprint.
1985c609719bSwdenk
1986c609719bSwdenk
19876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1988c609719bSwdenk
1989c609719bSwdenk		This defines the secondary prompt string, which is
1990c609719bSwdenk		printed when the command interpreter needs more input
1991c609719bSwdenk		to complete a command. Usually "> ".
1992c609719bSwdenk
1993c609719bSwdenk	Note:
1994c609719bSwdenk
1995c609719bSwdenk		In the current implementation, the local variables
1996c609719bSwdenk		space and global environment variables space are
1997c609719bSwdenk		separated. Local variables are those you define by
19983b57fe0aSwdenk		simply typing `name=value'. To access a local
1999c609719bSwdenk		variable later on, you have write `$name' or
20003b57fe0aSwdenk		`${name}'; to execute the contents of a variable
20013b57fe0aSwdenk		directly type `$name' at the command prompt.
2002c609719bSwdenk
2003c609719bSwdenk		Global environment variables are those you use
2004c609719bSwdenk		setenv/printenv to work with. To run a command stored
2005c609719bSwdenk		in such a variable, you need to use the run command,
2006c609719bSwdenk		and you must not use the '$' sign to access them.
2007c609719bSwdenk
2008c609719bSwdenk		To store commands and special characters in a
2009c609719bSwdenk		variable, please use double quotation marks
2010c609719bSwdenk		surrounding the whole text of the variable, instead
2011c609719bSwdenk		of the backslashes before semicolons and special
2012c609719bSwdenk		symbols.
2013c609719bSwdenk
2014aa0c71acSWolfgang Denk- Commandline Editing and History:
2015aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2016aa0c71acSWolfgang Denk
201711ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2018aa0c71acSWolfgang Denk		commandline input operations
2019aa0c71acSWolfgang Denk
2020a8c7c708Swdenk- Default Environment:
2021c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2022c609719bSwdenk
2023c609719bSwdenk		Define this to contain any number of null terminated
2024c609719bSwdenk		strings (variable = value pairs) that will be part of
20257152b1d0Swdenk		the default environment compiled into the boot image.
20262262cfeeSwdenk
2027c609719bSwdenk		For example, place something like this in your
2028c609719bSwdenk		board's config file:
2029c609719bSwdenk
2030c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2031c609719bSwdenk			"myvar1=value1\0" \
2032c609719bSwdenk			"myvar2=value2\0"
2033c609719bSwdenk
2034c609719bSwdenk		Warning: This method is based on knowledge about the
2035c609719bSwdenk		internal format how the environment is stored by the
20362262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2037c609719bSwdenk		interface! Although it is unlikely that this format
20387152b1d0Swdenk		will change soon, there is no guarantee either.
2039c609719bSwdenk		You better know what you are doing here.
2040c609719bSwdenk
2041c609719bSwdenk		Note: overly (ab)use of the default environment is
2042c609719bSwdenk		discouraged. Make sure to check other ways to preset
204374de7aefSWolfgang Denk		the environment like the "source" command or the
2044c609719bSwdenk		boot command first.
2045c609719bSwdenk
2046a8c7c708Swdenk- DataFlash Support:
20472abbe075Swdenk		CONFIG_HAS_DATAFLASH
20482abbe075Swdenk
20492abbe075Swdenk		Defining this option enables DataFlash features and
20502abbe075Swdenk		allows to read/write in Dataflash via the standard
20512abbe075Swdenk		commands cp, md...
20522abbe075Swdenk
20533f85ce27Swdenk- SystemACE Support:
20543f85ce27Swdenk		CONFIG_SYSTEMACE
20553f85ce27Swdenk
20563f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
20573f85ce27Swdenk		chips attached via some sort of local bus. The address
205811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
20596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
20603f85ce27Swdenk
20613f85ce27Swdenk		#define CONFIG_SYSTEMACE
20626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
20633f85ce27Swdenk
20643f85ce27Swdenk		When SystemACE support is added, the "ace" device type
20653f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
20663f85ce27Swdenk
2067ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2068ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2069ecb0ccd9SWolfgang Denk
207028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2071ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
207228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2073ecb0ccd9SWolfgang Denk		number generator is used.
2074ecb0ccd9SWolfgang Denk
207528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
207628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
207728cb9375SWolfgang Denk		defined, the normal port 69 is used.
207828cb9375SWolfgang Denk
207928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2080ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2081ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2082ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2083ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2084ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2085ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2086ecb0ccd9SWolfgang Denk
2087a8c7c708Swdenk- Show boot progress:
2088c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2089c609719bSwdenk
2090c609719bSwdenk		Defining this option allows to add some board-
2091c609719bSwdenk		specific code (calling a user-provided function
2092c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2093c609719bSwdenk		the system's boot progress on some display (for
2094c609719bSwdenk		example, some LED's) on your board. At the moment,
2095c609719bSwdenk		the following checkpoints are implemented:
2096c609719bSwdenk
20978ae86b76SWolfgang Denk- Standalone program support:
20988ae86b76SWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
20998ae86b76SWolfgang Denk
21008ae86b76SWolfgang Denk		This option allows to define board specific values
21018ae86b76SWolfgang Denk		for the address where standalone program gets loaded,
21028ae86b76SWolfgang Denk		thus overwriting the architecutre dependent default
21038ae86b76SWolfgang Denk		settings.
21048ae86b76SWolfgang Denk
2105d32a1a4cSMinkyu Kang- Frame Buffer Address:
2106d32a1a4cSMinkyu Kang	CONFIG_FB_ADDR
2107d32a1a4cSMinkyu Kang
2108d32a1a4cSMinkyu Kang	Define CONFIG_FB_ADDR if you want to use specific address for
2109d32a1a4cSMinkyu Kang	frame buffer.
2110d32a1a4cSMinkyu Kang	Then system will reserve the frame buffer address to defined address
2111d32a1a4cSMinkyu Kang	instead of lcd_setmem (this function grab the memory for frame buffer
2112d32a1a4cSMinkyu Kang	by panel's size).
2113d32a1a4cSMinkyu Kang
2114d32a1a4cSMinkyu Kang	Please see board_init_f function.
2115d32a1a4cSMinkyu Kang
2116d32a1a4cSMinkyu Kang	If you want this config option then,
2117d32a1a4cSMinkyu Kang	please define it at your board config file
2118d32a1a4cSMinkyu Kang
21191372cce2SMarian BalakowiczLegacy uImage format:
21201372cce2SMarian Balakowicz
2121c609719bSwdenk  Arg	Where			When
2122c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2123c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2124c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2125c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2126c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2127c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2128c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2129c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2130c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
21311372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2132c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2133c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2134c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2135c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
21361372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2137c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
21381372cce2SMarian Balakowicz
21391372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
21401372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
21411372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
21421372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
21431372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
21441372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
21451372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
214611ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
21471372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
21481372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
21491372cce2SMarian Balakowicz
2150ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c	All preparation done, transferring control to OS
2151c609719bSwdenk
2152a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
215363e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
215463e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
215563e73c9aSwdenk
2156566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2157566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2158566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2159566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2160566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2161566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2162566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2163566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2164566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2165566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2166566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2167566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2168566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2169566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2170566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2171566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2172566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2173566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2174566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2175566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2176566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2177566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2178566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2179566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2180566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2181566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2182566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2183566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2184566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2185566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2186566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2187566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2188566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2189566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2190566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2191566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2192566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2193566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2194566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2195566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2196566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2197566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2198566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2199566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2200566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2201566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2202566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2203c609719bSwdenk
2204566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2205c609719bSwdenk
2206566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2207566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2208566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2209206c60cbSwdenk
2210566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2211566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
221211ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2213566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2214566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2215566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
221674de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
221774de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2218566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2219c609719bSwdenk
22201372cce2SMarian BalakowiczFIT uImage format:
22211372cce2SMarian Balakowicz
22221372cce2SMarian Balakowicz  Arg	Where			When
22231372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
22241372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
22251372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
22261372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
22271372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
22281372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2229f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
22301372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
22311372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
22321372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
22331372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
22341372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
223511ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
223611ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
22371372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
22381372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
22391372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
22401372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
22411372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
22421372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
22431372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
22441372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
22451372cce2SMarian Balakowicz
22461372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
22471372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
22481372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
224911ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
22501372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
22511372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
22521372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
22531372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
22541372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
22551372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
22561372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
22571372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
22581372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
22591372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
22601372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
22611372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
22621372cce2SMarian Balakowicz
226311ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
22641372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
22651372cce2SMarian Balakowicz
226611ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
22671372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
22681372cce2SMarian Balakowicz
226911ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
22701372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
22711372cce2SMarian Balakowicz
2272cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2273cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2274cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2275cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2276cccfc2abSDetlev Zundel
2277cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2278cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2279cccfc2abSDetlev Zundel
2280cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2281cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2282cccfc2abSDetlev Zundel
2283cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2284cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2285cccfc2abSDetlev Zundel
2286cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2287cccfc2abSDetlev Zundel
2288cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2289cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2290cccfc2abSDetlev Zundel
22916a11cf48SDaniel Schwierzeck- SPL framework
22926a11cf48SDaniel Schwierzeck		CONFIG_SPL
22936a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
22946a11cf48SDaniel Schwierzeck
22956a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
22966a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
22976a11cf48SDaniel Schwierzeck
22986a11cf48SDaniel Schwierzeck		CONFIG_SPL_LDSCRIPT
22996a11cf48SDaniel Schwierzeck		LDSCRIPT for linking the SPL binary.
23006a11cf48SDaniel Schwierzeck
23016a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBCOMMON_SUPPORT
23026a11cf48SDaniel Schwierzeck		Support for common/libcommon.o in SPL binary
23036a11cf48SDaniel Schwierzeck
23046a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBDISK_SUPPORT
23056a11cf48SDaniel Schwierzeck		Support for disk/libdisk.o in SPL binary
23066a11cf48SDaniel Schwierzeck
23076a11cf48SDaniel Schwierzeck		CONFIG_SPL_I2C_SUPPORT
23086a11cf48SDaniel Schwierzeck		Support for drivers/i2c/libi2c.o in SPL binary
23096a11cf48SDaniel Schwierzeck
23106a11cf48SDaniel Schwierzeck		CONFIG_SPL_GPIO_SUPPORT
23116a11cf48SDaniel Schwierzeck		Support for drivers/gpio/libgpio.o in SPL binary
23126a11cf48SDaniel Schwierzeck
23136a11cf48SDaniel Schwierzeck		CONFIG_SPL_MMC_SUPPORT
23146a11cf48SDaniel Schwierzeck		Support for drivers/mmc/libmmc.o in SPL binary
23156a11cf48SDaniel Schwierzeck
23166a11cf48SDaniel Schwierzeck		CONFIG_SPL_SERIAL_SUPPORT
23176a11cf48SDaniel Schwierzeck		Support for drivers/serial/libserial.o in SPL binary
23186a11cf48SDaniel Schwierzeck
23196a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_FLASH_SUPPORT
23206a11cf48SDaniel Schwierzeck		Support for drivers/mtd/spi/libspi_flash.o in SPL binary
23216a11cf48SDaniel Schwierzeck
23226a11cf48SDaniel Schwierzeck		CONFIG_SPL_SPI_SUPPORT
23236a11cf48SDaniel Schwierzeck		Support for drivers/spi/libspi.o in SPL binary
23246a11cf48SDaniel Schwierzeck
23256a11cf48SDaniel Schwierzeck		CONFIG_SPL_FAT_SUPPORT
23266a11cf48SDaniel Schwierzeck		Support for fs/fat/libfat.o in SPL binary
23276a11cf48SDaniel Schwierzeck
23286a11cf48SDaniel Schwierzeck		CONFIG_SPL_LIBGENERIC_SUPPORT
23296a11cf48SDaniel Schwierzeck		Support for lib/libgeneric.o in SPL binary
23301372cce2SMarian Balakowicz
2331c609719bSwdenkModem Support:
2332c609719bSwdenk--------------
2333c609719bSwdenk
2334566e5cf4SWolfgang Denk[so far only for SMDK2400 boards]
2335c609719bSwdenk
233611ccc33fSMarcel Ziswiler- Modem support enable:
2337c609719bSwdenk		CONFIG_MODEM_SUPPORT
2338c609719bSwdenk
2339c609719bSwdenk- RTS/CTS Flow control enable:
2340c609719bSwdenk		CONFIG_HWFLOW
2341c609719bSwdenk
2342c609719bSwdenk- Modem debug support:
2343c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2344c609719bSwdenk
2345c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2346c609719bSwdenk		for modem support. Useful only with BDI2000.
2347c609719bSwdenk
2348a8c7c708Swdenk- Interrupt support (PPC):
2349a8c7c708Swdenk
2350a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2351a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
235211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2353a8c7c708Swdenk		should set decrementer_count to appropriate value. If
235411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2355a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
235611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2357a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2358a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2359a8c7c708Swdenk		general timer_interrupt().
2360a8c7c708Swdenk
2361c609719bSwdenk- General:
2362c609719bSwdenk
2363c609719bSwdenk		In the target system modem support is enabled when a
2364c609719bSwdenk		specific key (key combination) is pressed during
2365c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
236611ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2367c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2368c609719bSwdenk		function, returning 1 and thus enabling modem
2369c609719bSwdenk		initialization.
2370c609719bSwdenk
2371c609719bSwdenk		If there are no modem init strings in the
2372c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2373c609719bSwdenk		previous output (banner, info printfs) will be
237411ccc33fSMarcel Ziswiler		suppressed, though.
2375c609719bSwdenk
2376c609719bSwdenk		See also: doc/README.Modem
2377c609719bSwdenk
2378c609719bSwdenk
2379c609719bSwdenkConfiguration Settings:
2380c609719bSwdenk-----------------------
2381c609719bSwdenk
23826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2383c609719bSwdenk		undefine this when you're short of memory.
2384c609719bSwdenk
23852fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
23862fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
23872fb2604dSPeter Tyser
23886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2389c609719bSwdenk		prompt for user input.
2390c609719bSwdenk
23916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2392c609719bSwdenk
23936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2394c609719bSwdenk
23956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2396c609719bSwdenk
23976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2398c609719bSwdenk		the application (usually a Linux kernel) when it is
2399c609719bSwdenk		booted
2400c609719bSwdenk
24016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2402c609719bSwdenk		List of legal baudrate settings for this board.
2403c609719bSwdenk
24046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2405c609719bSwdenk		Suppress display of console information at boot.
2406c609719bSwdenk
24076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2408c609719bSwdenk		If the board specific function
2409c609719bSwdenk			extern int overwrite_console (void);
2410c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2411c609719bSwdenk		serial port, else the settings in the environment are used.
2412c609719bSwdenk
24136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2414c609719bSwdenk		Enable the call to overwrite_console().
2415c609719bSwdenk
24166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2417c609719bSwdenk		Enable overwrite of previous console environment settings.
2418c609719bSwdenk
24196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2420c609719bSwdenk		Begin and End addresses of the area used by the
2421c609719bSwdenk		simple memory test.
2422c609719bSwdenk
24236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2424c609719bSwdenk		Enable an alternate, more extensive memory test.
2425c609719bSwdenk
24266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
24275f535fe1Swdenk		Scratch address used by the alternate memory test
24285f535fe1Swdenk		You only need to set this if address zero isn't writeable
24295f535fe1Swdenk
24306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
24316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
243214f73ca6SStefan Roese		this specified memory area will get subtracted from the top
243311ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
243414f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
243514f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
243614f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
24375e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
243814f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
24395e12e75dSStefan Roese		will have to get fixed in Linux additionally.
244014f73ca6SStefan Roese
244114f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
244214f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
244314f73ca6SStefan Roese		be touched.
244414f73ca6SStefan Roese
244514f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
244614f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
244714f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
244814f73ca6SStefan Roese		non page size aligned address and this could cause major
244914f73ca6SStefan Roese		problems.
245014f73ca6SStefan Roese
24516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2452c609719bSwdenk		Default load address for network file downloads
2453c609719bSwdenk
24546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2455c609719bSwdenk		Enable temporary baudrate change while serial download
2456c609719bSwdenk
24576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2458c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2459c609719bSwdenk
24606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2461c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2462c609719bSwdenk		Cogent motherboard)
2463c609719bSwdenk
24646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2465c609719bSwdenk		Physical start address of Flash memory.
2466c609719bSwdenk
24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2468c609719bSwdenk		Physical start address of boot monitor code (set by
2469c609719bSwdenk		make config files to be same as the text base address
247014d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2472c609719bSwdenk
24736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
24743b57fe0aSwdenk		Size of memory reserved for monitor code, used to
24753b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
24763b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
24773b57fe0aSwdenk		flash sector.
2478c609719bSwdenk
24796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2480c609719bSwdenk		Size of DRAM reserved for malloc() use.
2481c609719bSwdenk
24826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
248315940c9aSStefan Roese		Normally compressed uImages are limited to an
248415940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
24856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
248615940c9aSStefan Roese		to adjust this setting to your needs.
2487c609719bSwdenk
24886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2489c609719bSwdenk		Maximum size of memory mapped by the startup code of
2490c609719bSwdenk		the Linux kernel; all data that must be processed by
24917d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
24927d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
24937d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
24947d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
2495c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
2496c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
2497c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
2498c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
2499c609719bSwdenk
2500fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
2501fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
2502fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
2503fca43cc8SJohn Rigby		is enabled.
2504fca43cc8SJohn Rigby
2505fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
2506fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
2507fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
2508fca43cc8SJohn Rigby
2509fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
2510fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
2511fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
2512fca43cc8SJohn Rigby
25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2514c609719bSwdenk		Max number of Flash memory banks
2515c609719bSwdenk
25166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2517c609719bSwdenk		Max number of sectors on a Flash chip
2518c609719bSwdenk
25196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2520c609719bSwdenk		Timeout for Flash erase operations (in ms)
2521c609719bSwdenk
25226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2523c609719bSwdenk		Timeout for Flash write operations (in ms)
2524c609719bSwdenk
25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
25268564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
25278564acf9Swdenk
25286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
25298564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
25308564acf9Swdenk
25316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
25328564acf9Swdenk		If defined, hardware flash sectors protection is used
25338564acf9Swdenk		instead of U-Boot software protection.
25348564acf9Swdenk
25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2536c609719bSwdenk
2537c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2538c609719bSwdenk		without this option such a download has to be
2539c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2540c609719bSwdenk		copy from RAM to flash.
2541c609719bSwdenk
2542c609719bSwdenk		The two-step approach is usually more reliable, since
2543c609719bSwdenk		you can check if the download worked before you erase
254411ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
254511ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2546c609719bSwdenk		downloaded image) this option may be very useful.
2547c609719bSwdenk
25486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2549c609719bSwdenk		Define if the flash driver uses extra elements in the
25505653fc33Swdenk		common flash structure for storing flash geometry.
25515653fc33Swdenk
255200b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
25535653fc33Swdenk		This option also enables the building of the cfi_flash driver
25545653fc33Swdenk		in the drivers directory
255553cf9435Sstroese
255691809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
255791809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
255891809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
255991809ed5SPiotr Ziecik		to the MTD layer.
256091809ed5SPiotr Ziecik
25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
256296ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
256396ef831fSGuennadi Liakhovetski
256496ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
256596ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
256696ef831fSGuennadi Liakhovetski		write commands.
256796ef831fSGuennadi Liakhovetski
25686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
25695568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
25705568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
25715568e613SStefan Roese		is useful, if some of the configured banks are only
25725568e613SStefan Roese		optionally available.
25735568e613SStefan Roese
25749a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
25759a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
25769a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
25779a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
25789a042e9cSJerry Van Baren
25796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
258011ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
258111ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
258253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
258353cf9435Sstroese		buffers can be full shortly after enabling the interface
258411ccc33fSMarcel Ziswiler		on high Ethernet traffic.
258553cf9435Sstroese		Defaults to 4 if not defined.
2586c609719bSwdenk
2587ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
2588ea882bafSWolfgang Denk
2589ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
2590ea882bafSWolfgang Denk	internally to store the environment settings. The default
2591ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
2592ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
2593ea882bafSWolfgang Denk	lib/hashtable.c for details.
2594ea882bafSWolfgang Denk
2595c609719bSwdenkThe following definitions that deal with the placement and management
2596c609719bSwdenkof environment data (variable area); in general, we support the
2597c609719bSwdenkfollowing configurations:
2598c609719bSwdenk
2599c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
2600c3eb3fe4SMike Frysinger
2601c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
2602c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
2603c3eb3fe4SMike Frysinger
26045a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2605c609719bSwdenk
2606c609719bSwdenk	Define this if the environment is in flash memory.
2607c609719bSwdenk
2608c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2609c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2610c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2611c609719bSwdenk	   sector" type flash chips, which have several smaller
2612c609719bSwdenk	   sectors at the start or the end. For instance, such a
2613c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2614c609719bSwdenk	   such a case you would place the environment in one of the
2615c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2616c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2617c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2618c609719bSwdenk	   between U-Boot and the environment.
2619c609719bSwdenk
26200e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2621c609719bSwdenk
2622c609719bSwdenk	   Offset of environment data (variable area) to the
2623c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2624c609719bSwdenk	   type flash chips the second sector can be used: the offset
2625c609719bSwdenk	   for this sector is given here.
2626c609719bSwdenk
26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2628c609719bSwdenk
26290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2630c609719bSwdenk
2631c609719bSwdenk	   This is just another way to specify the start address of
2632c609719bSwdenk	   the flash sector containing the environment (instead of
26330e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2634c609719bSwdenk
26350e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2636c609719bSwdenk
2637c609719bSwdenk	   Size of the sector containing the environment.
2638c609719bSwdenk
2639c609719bSwdenk
2640c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2641c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2642c609719bSwdenk	   the environment.
2643c609719bSwdenk
26440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2645c609719bSwdenk
26465a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
26470e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2648c609719bSwdenk	   of this flash sector for the environment. This saves
2649c609719bSwdenk	   memory for the RAM copy of the environment.
2650c609719bSwdenk
2651c609719bSwdenk	   It may also save flash memory if you decide to use this
2652c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2653c609719bSwdenk	   since then the remainder of the flash sector could be used
2654c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2655c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2656c609719bSwdenk	   updating the environment in flash makes it always
2657c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2658c609719bSwdenk	   wrong before the contents has been restored from a copy in
2659c609719bSwdenk	   RAM, your target system will be dead.
2660c609719bSwdenk
26610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
26620e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2663c609719bSwdenk
2664c609719bSwdenk	   These settings describe a second storage area used to hold
266511ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
26663e38691eSwdenk	   a valid backup copy in case there is a power failure during
2667c609719bSwdenk	   a "saveenv" operation.
2668c609719bSwdenk
2669c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2670c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2671c609719bSwdenkaccordingly!
2672c609719bSwdenk
2673c609719bSwdenk
26749314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2675c609719bSwdenk
2676c609719bSwdenk	Define this if you have some non-volatile memory device
2677c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2678c609719bSwdenk	environment.
2679c609719bSwdenk
26800e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
26810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2682c609719bSwdenk
268311ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2684c609719bSwdenk	  want to use for environment. It is assumed that this memory
2685c609719bSwdenk	  can just be read and written to, without any special
2686c609719bSwdenk	  provision.
2687c609719bSwdenk
2688c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2689c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
269011ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2691c609719bSwdenkU-Boot will hang.
2692c609719bSwdenk
2693c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2694c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2695c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2696c609719bSwdenkto save the current settings.
2697c609719bSwdenk
2698c609719bSwdenk
2699bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2700c609719bSwdenk
2701c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2702c609719bSwdenk	device and a driver for it.
2703c609719bSwdenk
27040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2706c609719bSwdenk
2707c609719bSwdenk	  These two #defines specify the offset and size of the
2708c609719bSwdenk	  environment area within the total memory of your EEPROM.
2709c609719bSwdenk
27106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2711c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2712c609719bSwdenk	  The default address is zero.
2713c609719bSwdenk
27146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2715c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2716c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2717c609719bSwdenk	  would require six bits.
2718c609719bSwdenk
27196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2720c609719bSwdenk	  If defined, the number of milliseconds to delay between
2721c609719bSwdenk	  page writes.	The default is zero milliseconds.
2722c609719bSwdenk
27236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2724c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2725c609719bSwdenk	  that this is NOT the chip address length!
2726c609719bSwdenk
27276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
27285cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
27295cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
27305cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
27315cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
27325cf91d6bSwdenk	  byte chips.
27335cf91d6bSwdenk
27345cf91d6bSwdenk	  Note that we consider the length of the address field to
27355cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
27365cf91d6bSwdenk	  in the chip address.
27375cf91d6bSwdenk
27386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2739c609719bSwdenk	  The size in bytes of the EEPROM device.
2740c609719bSwdenk
2741548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2742548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2743548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2744548738b4SHeiko Schocher
2745548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2746548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2747548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2748548738b4SHeiko Schocher	  EEPROM. For example:
2749548738b4SHeiko Schocher
2750548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  "pca9547:70:d\0"
2751548738b4SHeiko Schocher
2752548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2753548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2754c609719bSwdenk
2755057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
27565779d8d9Swdenk
27575779d8d9Swdenk	Define this if you have a DataFlash memory device which you
27585779d8d9Swdenk	want to use for the environment.
27595779d8d9Swdenk
27600e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
27620e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
27635779d8d9Swdenk
27645779d8d9Swdenk	  These three #defines specify the offset and size of the
27655779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
27665779d8d9Swdenk	  at the specified address.
27675779d8d9Swdenk
276851bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
276913a5695bSwdenk
277013a5695bSwdenk	Define this if you have a NAND device which you want to use
277113a5695bSwdenk	for the environment.
277213a5695bSwdenk
27730e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
27740e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
277513a5695bSwdenk
277613a5695bSwdenk	  These two #defines specify the offset and size of the environment
2777fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
2778fdd813deSScott Wood	  aligned to an erase block boundary.
27795779d8d9Swdenk
2780fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
2781e443c944SMarkus Klotzbuecher
27820e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2783fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
2784fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
2785fdd813deSScott Wood	  during a "saveenv" operation.  CONFIG_ENV_OFFSET_RENDUND must be
2786fdd813deSScott Wood	  aligned to an erase block boundary.
2787e443c944SMarkus Klotzbuecher
2788fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
2789fdd813deSScott Wood
2790fdd813deSScott Wood	  Specifies the length of the region in which the environment
2791fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
2792fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
2793fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
2794fdd813deSScott Wood	  the range to be avoided.
2795fdd813deSScott Wood
2796fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
2797fdd813deSScott Wood
2798fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
2799fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
2800fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
2801fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
2802fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
2803e443c944SMarkus Klotzbuecher
2804b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2805b74ab737SGuennadi Liakhovetski
2806b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2807b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2808b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2809b74ab737SGuennadi Liakhovetski
28106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2811c609719bSwdenk
2812c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2813c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2814c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2815c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2816c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2817c609719bSwdenk	to be a good choice since it makes it far enough from the
2818c609719bSwdenk	start of the data area as well as from the stack pointer.
2819c609719bSwdenk
2820e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2821c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2822cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
2823c609719bSwdenkuntil then to read environment variables.
2824c609719bSwdenk
282585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
282685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
282785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
282885ec0bccSwdenknecessary, because the first environment variable we need is the
282985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
283085ec0bccSwdenkhave any device yet where we could complain.]
2831c609719bSwdenk
2832c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2833c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
283485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2835c609719bSwdenk
28366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2837fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2838fc3e2165Swdenk
28396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2840fc3e2165Swdenk		      also needs to be defined.
2841fc3e2165Swdenk
28426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2843fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2844c609719bSwdenk
2845f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2846f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2847f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2848f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2849f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2850f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2851f5675aa5SRon Madrid
2852c609719bSwdenkLow Level (hardware related) configuration options:
2853dc7c9a1aSwdenk---------------------------------------------------
2854c609719bSwdenk
28556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2856c609719bSwdenk		Cache Line Size of the CPU.
2857c609719bSwdenk
28586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2859c609719bSwdenk		Default address of the IMMR after system reset.
28602535d602Swdenk
28612535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
28622535d602Swdenk		and RPXsuper) to be able to adjust the position of
28632535d602Swdenk		the IMMR register after a reset.
2864c609719bSwdenk
2865*e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
2866*e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
2867*e46fedfeSTimur Tabi		PowerPC SOCs.
2868*e46fedfeSTimur Tabi
2869*e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
2870*e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
2871*e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
2872*e46fedfeSTimur Tabi
2873*e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
2874*e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
2875*e46fedfeSTimur Tabi
2876*e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
2877*e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
2878*e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
2879*e46fedfeSTimur Tabi		be set to that address.  Otherwise, it should be set to the
2880*e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
2881*e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
2882*e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
2883*e46fedfeSTimur Tabi
2884*e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
2885*e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
2886*e46fedfeSTimur Tabi
2887*e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
2888*e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.  This value is typically
2889*e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).  This macro is
2890*e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2891*e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2892*e46fedfeSTimur Tabi
2893*e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
2894*e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
2895*e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
2896*e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
2897*e46fedfeSTimur Tabi
2898*e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
2899*e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
2900*e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
2901*e46fedfeSTimur Tabi
29027f6c2cbcSwdenk- Floppy Disk Support:
29036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
29047f6c2cbcSwdenk
29057f6c2cbcSwdenk		the default drive number (default value 0)
29067f6c2cbcSwdenk
29076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
29087f6c2cbcSwdenk
290911ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
29107f6c2cbcSwdenk		(default value 1)
29117f6c2cbcSwdenk
29126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
29137f6c2cbcSwdenk
29147f6c2cbcSwdenk		defines the offset of register from address. It
29157f6c2cbcSwdenk		depends on which part of the data bus is connected to
291611ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
29177f6c2cbcSwdenk
29186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
29196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
29207f6c2cbcSwdenk		default value.
29217f6c2cbcSwdenk
29226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
29237f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
29247f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
29257f6c2cbcSwdenk		source code. It is used to make hardware dependant
29267f6c2cbcSwdenk		initializations.
29277f6c2cbcSwdenk
29280abddf82SMacpaul Lin- CONFIG_IDE_AHB:
29290abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
29300abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
29310abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
29320abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
29330abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
29340abddf82SMacpaul Lin		is requierd.
29350abddf82SMacpaul Lin
29366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
293725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
293825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2939c609719bSwdenk
29406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2941c609719bSwdenk
29427152b1d0Swdenk		Start address of memory area that can be used for
2943c609719bSwdenk		initial data and stack; please note that this must be
2944c609719bSwdenk		writable memory that is working WITHOUT special
2945c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2946c609719bSwdenk		will become available only after programming the
2947c609719bSwdenk		memory controller and running certain initialization
2948c609719bSwdenk		sequences.
2949c609719bSwdenk
2950c609719bSwdenk		U-Boot uses the following memory types:
2951c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2952c609719bSwdenk		- MPC824X: data cache
2953c609719bSwdenk		- PPC4xx:  data cache
2954c609719bSwdenk
29556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2956c609719bSwdenk
2957c609719bSwdenk		Offset of the initial data structure in the memory
29586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
29596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2960c609719bSwdenk		data is located at the end of the available space
2961553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
29636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
29646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2965c609719bSwdenk
2966c609719bSwdenk	Note:
2967c609719bSwdenk		On the MPC824X (or other systems that use the data
2968c609719bSwdenk		cache for initial memory) the address chosen for
29696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2970c609719bSwdenk		point to an otherwise UNUSED address space between
2971c609719bSwdenk		the top of RAM and the start of the PCI space.
2972c609719bSwdenk
29736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2974c609719bSwdenk
29756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2976c609719bSwdenk
29776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2978c609719bSwdenk
29796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2980c609719bSwdenk
29816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2982c609719bSwdenk
29836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2984c609719bSwdenk
29856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2986c609719bSwdenk		SDRAM timing
2987c609719bSwdenk
29886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2989c609719bSwdenk		periodic timer for refresh
2990c609719bSwdenk
29916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2992c609719bSwdenk
29936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
29946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
29956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2997c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2998c609719bSwdenk
2999c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
30006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
30016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3002c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3003c609719bSwdenk
30046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
30056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
3006c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
3007c609719bSwdenk		Prescaler definitions (SDRAM timing)
3008c609719bSwdenk
30096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
3010c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
3011c609719bSwdenk		define relocation offset in DPRAM [DSP2]
3012c609719bSwdenk
30136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
3014b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
3015b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
3016b423d055SHeiko Schocher
30176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
3018c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
3019c609719bSwdenk		define relocation offset in DPRAM [SCC4]
3020c609719bSwdenk
30216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
3022c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
3023c609719bSwdenk		wrong setting might damage your board. Read
3024c609719bSwdenk		doc/README.MBX before setting this variable!
3025c609719bSwdenk
30266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
3027ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
3028ea909b76Swdenk		(Power On Self Tests). This definition overrides
3029ea909b76Swdenk		#define'd default value in commproc.h resp.
3030ea909b76Swdenk		cpm_8260.h.
3031ea909b76Swdenk
30326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
30336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
30356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
30366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
30376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
30386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
30396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
3040a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
30415d232d0eSwdenk
30429cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
30439cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
30449cacf4fcSDirk Eibach		required.
30459cacf4fcSDirk Eibach
3046a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
3047a09b9b68SKumar Gala		Chip has SRIO or not
3048a09b9b68SKumar Gala
3049a09b9b68SKumar Gala- CONFIG_SRIO1:
3050a09b9b68SKumar Gala		Board has SRIO 1 port available
3051a09b9b68SKumar Gala
3052a09b9b68SKumar Gala- CONFIG_SRIO2:
3053a09b9b68SKumar Gala		Board has SRIO 2 port available
3054a09b9b68SKumar Gala
3055a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
3056a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
3057a09b9b68SKumar Gala
3058a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
3059a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
3060a09b9b68SKumar Gala
3061a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
3062a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
3063a09b9b68SKumar Gala
3064eced4626SAlex Waterman- CONFIG_SYS_NDFC_16
3065eced4626SAlex Waterman		Defined to tell the NDFC that the NAND chip is using a
3066eced4626SAlex Waterman		16 bit bus.
3067eced4626SAlex Waterman
3068eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
3069eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
3070eced4626SAlex Waterman		a default value will be used.
3071eced4626SAlex Waterman
3072bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
3073218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
3074218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
3075218ca724SWolfgang Denk
3076bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
3077bb99ad6dSBen Warren		I2C address of the SPD EEPROM
3078bb99ad6dSBen Warren
30796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
3080218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
3081218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
3082218ca724SWolfgang Denk		to something your driver can deal with.
3083bb99ad6dSBen Warren
30841b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
30851b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
30861b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
30871b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
30881b3e3c4fSYork Sun		header files or board specific files.
30891b3e3c4fSYork Sun
30906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
3091218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
3092218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
30932ad6b513STimur Tabi
3094c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
3095c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
3096c26e454dSwdenk
3097c26e454dSwdenk- CONFIG_FEC[12]_PHY
3098c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
30996e592385Swdenk		to the given FEC; i. e.
3100c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
3101c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
3102c26e454dSwdenk
3103c26e454dSwdenk		When set to -1, means to probe for first available.
3104c26e454dSwdenk
3105c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
3106c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
3107c26e454dSwdenk		(so program the FEC to ignore it).
3108c26e454dSwdenk
3109c26e454dSwdenk- CONFIG_RMII
3110c26e454dSwdenk		Enable RMII mode for all FECs.
3111c26e454dSwdenk		Note that this is a global option, we can't
3112c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
3113c26e454dSwdenk
31145cf91d6bSwdenk- CONFIG_CRC32_VERIFY
31155cf91d6bSwdenk		Add a verify option to the crc32 command.
31165cf91d6bSwdenk		The syntax is:
31175cf91d6bSwdenk
31185cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
31195cf91d6bSwdenk
31205cf91d6bSwdenk		Where address/count indicate a memory area
31215cf91d6bSwdenk		and crc32 is the correct crc32 which the
31225cf91d6bSwdenk		area should have.
31235cf91d6bSwdenk
312456523f12Swdenk- CONFIG_LOOPW
312556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
3126602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
312756523f12Swdenk
31287b466641Sstroese- CONFIG_MX_CYCLIC
31297b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
31307b466641Sstroese		"md/mw" commands.
31317b466641Sstroese		Examples:
31327b466641Sstroese
31337b466641Sstroese		=> mdc.b 10 4 500
31347b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
31357b466641Sstroese
31367b466641Sstroese		=> mwc.l 100 12345678 10
31377b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
31387b466641Sstroese
31397b466641Sstroese		This only takes effect if the memory commands are activated
3140602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
31417b466641Sstroese
31428aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
314392bbd64eSDaniel Schwierzeck		[ARM, MIPS only] If this variable is defined, then certain
3144e03f3169SWolfgang Denk		low level initializations (like setting up the memory
3145e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
3146e03f3169SWolfgang Denk		relocate itself into RAM.
31478aa1a2d1Swdenk
3148e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
3149e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
3150e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
3151e03f3169SWolfgang Denk		these initializations itself.
31528aa1a2d1Swdenk
3153401bb30bSAneesh V- CONFIG_SPL_BUILD
3154df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
3155df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
3156df81238bSMagnus Lilja		compiling a NAND SPL.
3157400558b5Swdenk
3158d8834a13SMatthias Weisser- CONFIG_USE_ARCH_MEMCPY
3159d8834a13SMatthias Weisser  CONFIG_USE_ARCH_MEMSET
3160d8834a13SMatthias Weisser		If these options are used a optimized version of memcpy/memset will
3161d8834a13SMatthias Weisser		be used if available. These functions may be faster under some
3162d8834a13SMatthias Weisser		conditions but may increase the binary size.
3163d8834a13SMatthias Weisser
3164c609719bSwdenkBuilding the Software:
3165c609719bSwdenk======================
3166c609719bSwdenk
3167218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
3168218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
3169218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
3170218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
3171218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
3172218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
3173c609719bSwdenk
3174218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
3175218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
3176218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
3177218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
3178218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
3179c609719bSwdenk
3180218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
3181218ca724SWolfgang Denk	$ export CROSS_COMPILE
3182c609719bSwdenk
31832f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
31842f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
31852f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
31862f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
31872f8d396bSPeter Tyser
31882f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
31892f8d396bSPeter Tyser
31902f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
31912f8d396bSPeter Tyser      be executed on computers running Windows.
31922f8d396bSPeter Tyser
3193c609719bSwdenkU-Boot is intended to be simple to build. After installing the
3194c609719bSwdenksources you must configure U-Boot for one specific board type. This
3195c609719bSwdenkis done by typing:
3196c609719bSwdenk
3197c609719bSwdenk	make NAME_config
3198c609719bSwdenk
3199218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
3200218ca724SWolfgang Denkrations; see the main Makefile for supported names.
320154387ac9Swdenk
3202c609719bSwdenkNote: for some board special configuration names may exist; check if
3203c609719bSwdenk      additional information is available from the board vendor; for
32042729af9dSwdenk      instance, the TQM823L systems are available without (standard)
32052729af9dSwdenk      or with LCD support. You can select such additional "features"
320611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
3207c609719bSwdenk
32082729af9dSwdenk      make TQM823L_config
32092729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
3210c609719bSwdenk
3211c609719bSwdenk      make TQM823L_LCD_config
3212c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
3213c609719bSwdenk
3214c609719bSwdenk      etc.
3215c609719bSwdenk
3216c609719bSwdenk
3217c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
32187152b1d0Swdenkimages ready for download to / installation on your system:
3219c609719bSwdenk
3220c609719bSwdenk- "u-boot.bin" is a raw binary image
3221c609719bSwdenk- "u-boot" is an image in ELF binary format
3222c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
3223c609719bSwdenk
3224baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
3225baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
3226baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
3227baf31249SMarian Balakowicz
3228baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
3229baf31249SMarian Balakowicz
3230baf31249SMarian Balakowicz	make O=/tmp/build distclean
3231baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
3232baf31249SMarian Balakowicz	make O=/tmp/build all
3233baf31249SMarian Balakowicz
3234baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
3235baf31249SMarian Balakowicz
3236baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3237baf31249SMarian Balakowicz	make distclean
3238baf31249SMarian Balakowicz	make NAME_config
3239baf31249SMarian Balakowicz	make all
3240baf31249SMarian Balakowicz
3241baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
3242baf31249SMarian Balakowiczvariable.
3243baf31249SMarian Balakowicz
3244c609719bSwdenk
3245c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
3246c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
3247c609719bSwdenknative "make".
3248c609719bSwdenk
3249c609719bSwdenk
3250c609719bSwdenkIf the system board that you have is not listed, then you will need
3251c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
3252c609719bSwdenksteps:
3253c609719bSwdenk
3254c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
325585ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
325685ec0bccSwdenk    entries as examples. Note that here and at many other places
32577152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
325885ec0bccSwdenk    keep this order.
3259c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
326085ec0bccSwdenk    files you need. In your board directory, you will need at least
326185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
326285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
326385ec0bccSwdenk    your board
3264c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
3265c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
326685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
3267c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
3268c609719bSwdenk    to be installed on your target system.
326985ec0bccSwdenk6.  Debug and solve any problems that might arise.
3270c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
3271c609719bSwdenk
3272c609719bSwdenk
3273c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
3274c609719bSwdenk==============================================================
3275c609719bSwdenk
3276c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
3277c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
3278c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
3279c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
3280218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
3281c609719bSwdenk
3282c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
3283c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
3284c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
3285c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
3286c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
32877152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
3288218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
3289218ca724SWolfgang Denkyou can type
3290c609719bSwdenk
3291c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
3292c609719bSwdenk
3293c609719bSwdenkor to build on a native PowerPC system you can type
3294c609719bSwdenk
3295c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
3296c609719bSwdenk
3297218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
3298218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
3299218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
3300218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
3301218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
3302218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
3303218ca724SWolfgang Denkvariable. For example:
3304baf31249SMarian Balakowicz
3305baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
3306baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
3307baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
3308baf31249SMarian Balakowicz
3309218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
3310218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
3311218ca724SWolfgang Denkduring the whole build process.
3312baf31249SMarian Balakowicz
3313baf31249SMarian Balakowicz
3314c609719bSwdenkSee also "U-Boot Porting Guide" below.
3315c609719bSwdenk
3316c609719bSwdenk
3317c609719bSwdenkMonitor Commands - Overview:
3318c609719bSwdenk============================
3319c609719bSwdenk
3320c609719bSwdenkgo	- start application at address 'addr'
3321c609719bSwdenkrun	- run commands in an environment variable
3322c609719bSwdenkbootm	- boot application image from memory
3323c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
3324c609719bSwdenktftpboot- boot image via network using TFTP protocol
3325c609719bSwdenk	       and env variables "ipaddr" and "serverip"
3326c609719bSwdenk	       (and eventually "gatewayip")
3327c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
3328c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
3329c609719bSwdenkloads	- load S-Record file over serial line
3330c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
3331c609719bSwdenkmd	- memory display
3332c609719bSwdenkmm	- memory modify (auto-incrementing)
3333c609719bSwdenknm	- memory modify (constant address)
3334c609719bSwdenkmw	- memory write (fill)
3335c609719bSwdenkcp	- memory copy
3336c609719bSwdenkcmp	- memory compare
3337c609719bSwdenkcrc32	- checksum calculation
33380f89c54bSPeter Tyseri2c	- I2C sub-system
3339c609719bSwdenksspi	- SPI utility commands
3340c609719bSwdenkbase	- print or set address offset
3341c609719bSwdenkprintenv- print environment variables
3342c609719bSwdenksetenv	- set environment variables
3343c609719bSwdenksaveenv - save environment variables to persistent storage
3344c609719bSwdenkprotect - enable or disable FLASH write protection
3345c609719bSwdenkerase	- erase FLASH memory
3346c609719bSwdenkflinfo	- print FLASH memory information
3347c609719bSwdenkbdinfo	- print Board Info structure
3348c609719bSwdenkiminfo	- print header information for application image
3349c609719bSwdenkconinfo - print console devices and informations
3350c609719bSwdenkide	- IDE sub-system
3351c609719bSwdenkloop	- infinite loop on address range
335256523f12Swdenkloopw	- infinite write loop on address range
3353c609719bSwdenkmtest	- simple RAM test
3354c609719bSwdenkicache	- enable or disable instruction cache
3355c609719bSwdenkdcache	- enable or disable data cache
3356c609719bSwdenkreset	- Perform RESET of the CPU
3357c609719bSwdenkecho	- echo args to console
3358c609719bSwdenkversion - print monitor version
3359c609719bSwdenkhelp	- print online help
3360c609719bSwdenk?	- alias for 'help'
3361c609719bSwdenk
3362c609719bSwdenk
3363c609719bSwdenkMonitor Commands - Detailed Description:
3364c609719bSwdenk========================================
3365c609719bSwdenk
3366c609719bSwdenkTODO.
3367c609719bSwdenk
3368c609719bSwdenkFor now: just type "help <command>".
3369c609719bSwdenk
3370c609719bSwdenk
3371c609719bSwdenkEnvironment Variables:
3372c609719bSwdenk======================
3373c609719bSwdenk
3374c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3375c609719bSwdenkcan be made persistent by saving to Flash memory.
3376c609719bSwdenk
3377c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3378c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3379c609719bSwdenkwithout a value can be used to delete a variable from the
3380c609719bSwdenkenvironment. As long as you don't save the environment you are
3381c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3382c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3383c609719bSwdenk
3384c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3385c96f86eeSWolfgang Denk
3386c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3387c609719bSwdenk
3388c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3389c609719bSwdenk
3390c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3391c609719bSwdenk
3392c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3393c609719bSwdenk
3394c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3395c609719bSwdenk
3396c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3397c609719bSwdenk
33987d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
33997d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34007d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
34017d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
34027d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
34037d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
3404c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
3405c3624e6eSGrant Likely		  bootm_mapsize.
3406c3624e6eSGrant Likely
3407c3624e6eSGrant Likely  bootm_mapsize	- Size of the initial memory mapping for the Linux kernel.
3408c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
3409c3624e6eSGrant Likely		  defines the size of the memory region starting at base
3410c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
3411c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
3412c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
3413c3624e6eSGrant Likely		  used otherwise.
34147d721e34SBartlomiej Sieka
34157d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
34167d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
34177d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
34187d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
34197d721e34SBartlomiej Sieka		  environment variable.
34207d721e34SBartlomiej Sieka
34214bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
34224bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
34234bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
34244bae9090SBartlomiej Sieka
3425c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3426c609719bSwdenk		  "bootp" will just load perform a lookup of the
3427c609719bSwdenk		  configuration from the BOOTP server, but not try to
3428c609719bSwdenk		  load any image using TFTP
3429c609719bSwdenk
3430c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3431c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3432c609719bSwdenk		  be automatically started (by internally calling
3433c609719bSwdenk		  "bootm")
3434c609719bSwdenk
34354a6fd34bSwdenk		  If set to "no", a standalone image passed to the
34364a6fd34bSwdenk		  "bootm" command will be copied to the load address
34374a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
34384a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
34394a6fd34bSwdenk		  data.
34404a6fd34bSwdenk
3441a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
3442a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
3443a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
3444a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
3445a28afca5SDavid A. Long		  to work it must reside in writable memory, have
3446a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
3447a28afca5SDavid A. Long		  add the information it needs into it, and the memory
3448a28afca5SDavid A. Long		  must be accessible by the kernel.
3449a28afca5SDavid A. Long
345017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
345117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
345217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
345317ea1177Swdenk		  initialization code. So, for changes to be effective
345417ea1177Swdenk		  it must be saved and board must be reset.
345517ea1177Swdenk
3456c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3457c609719bSwdenk		  If this variable is not set, initrd images will be
3458c609719bSwdenk		  copied to the highest possible address in RAM; this
3459c609719bSwdenk		  is usually what you want since it allows for
3460c609719bSwdenk		  maximum initrd size. If for some reason you want to
3461c609719bSwdenk		  make sure that the initrd image is loaded below the
34626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3463c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3464c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3465c609719bSwdenk		  address to use (U-Boot will still check that it
3466c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3467c609719bSwdenk
3468c609719bSwdenk		  For instance, when you have a system with 16 MB
34697152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3470c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3471c609719bSwdenk		  the "bootargs" variable. However, now you must make
34727152b1d0Swdenk		  sure that the initrd image is placed in the first
3473c609719bSwdenk		  12 MB as well - this can be done with
3474c609719bSwdenk
3475c609719bSwdenk		  setenv initrd_high 00c00000
3476c609719bSwdenk
347738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
347838b99261Swdenk		  indication to U-Boot that all addresses are legal
347938b99261Swdenk		  for the Linux kernel, including addresses in flash
348038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
348138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
348238b99261Swdenk		  boot time on your system, but requires that this
348338b99261Swdenk		  feature is supported by your Linux kernel.
348438b99261Swdenk
3485c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3486c609719bSwdenk
3487c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3488dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3489c609719bSwdenk
3490c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3491c609719bSwdenk
3492c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3493c609719bSwdenk
3494c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3495c609719bSwdenk
3496c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3497c609719bSwdenk
3498c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3499c609719bSwdenk
3500a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3501a3d991bdSwdenk		  interface is used first.
3502a3d991bdSwdenk
3503a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3504a3d991bdSwdenk		  interface is currently active. For example you
3505a3d991bdSwdenk		  can do the following
3506a3d991bdSwdenk
350748690d80SHeiko Schocher		  => setenv ethact FEC
350848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
350948690d80SHeiko Schocher		  => setenv ethact SCC
351048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
3511a3d991bdSwdenk
3512e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3513e1692577SMatthias Fuchs		  available network interfaces.
3514e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3515e1692577SMatthias Fuchs
3516a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3517a3d991bdSwdenk		  either succeed or fail without retrying.
35186e592385Swdenk		  When set to "once" the network operation will
35196e592385Swdenk		  fail when all the available network interfaces
35206e592385Swdenk		  are tried once without success.
3521a3d991bdSwdenk		  Useful on scripts which control the retry operation
3522a3d991bdSwdenk		  themselves.
3523a3d991bdSwdenk
3524b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3525a1cf027aSJean-Christophe PLAGNIOL-VILLARD
352628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3527ecb0ccd9SWolfgang Denk		  UDP source port.
3528ecb0ccd9SWolfgang Denk
352928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
353028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
353128cb9375SWolfgang Denk
3532c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3533c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3534c96f86eeSWolfgang Denk
3535c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3536c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3537c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3538c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3539c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3540c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3541c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3542c96f86eeSWolfgang Denk
3543a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
354411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3545a3d991bdSwdenk		  VLAN tagged frames.
3546c609719bSwdenk
3547c609719bSwdenkThe following environment variables may be used and automatically
3548c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3549c609719bSwdenkdepending the information provided by your boot server:
3550c609719bSwdenk
3551c609719bSwdenk  bootfile	- see above
3552c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3553fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3554c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3555c609719bSwdenk  hostname	- Target hostname
3556c609719bSwdenk  ipaddr	- see above
3557c609719bSwdenk  netmask	- Subnet Mask
3558c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3559c609719bSwdenk  serverip	- see above
3560c609719bSwdenk
3561c609719bSwdenk
3562c609719bSwdenkThere are two special Environment Variables:
3563c609719bSwdenk
3564c609719bSwdenk  serial#	- contains hardware identification information such
3565c609719bSwdenk		  as type string and/or serial number
3566c609719bSwdenk  ethaddr	- Ethernet address
3567c609719bSwdenk
3568c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3569c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3570c609719bSwdenkonce they have been set once.
3571c609719bSwdenk
3572c609719bSwdenk
3573c1551ea8SstroeseFurther special Environment Variables:
3574c1551ea8Sstroese
3575c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3576c1551ea8Sstroese		  with the "version" command. This variable is
3577c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3578c1551ea8Sstroese
3579c1551ea8Sstroese
3580c609719bSwdenkPlease note that changes to some configuration parameters may take
3581c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3582c609719bSwdenk
3583c609719bSwdenk
3584f07771ccSwdenkCommand Line Parsing:
3585f07771ccSwdenk=====================
3586f07771ccSwdenk
3587f07771ccSwdenkThere are two different command line parsers available with U-Boot:
35887152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3589f07771ccSwdenk
3590f07771ccSwdenkOld, simple command line parser:
3591f07771ccSwdenk--------------------------------
3592f07771ccSwdenk
3593f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3594f07771ccSwdenk- several commands on one line, separated by ';'
3595fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3596f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3597f07771ccSwdenk  for example:
3598fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3599f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3600f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3601f07771ccSwdenk
3602f07771ccSwdenkHush shell:
3603f07771ccSwdenk-----------
3604f07771ccSwdenk
3605f07771ccSwdenk- similar to Bourne shell, with control structures like
3606f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3607f07771ccSwdenk  until...do...done, ...
3608f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3609f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3610f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3611f07771ccSwdenk  command
3612f07771ccSwdenk
3613f07771ccSwdenkGeneral rules:
3614f07771ccSwdenk--------------
3615f07771ccSwdenk
3616f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3617f07771ccSwdenk    command) contains several commands separated by semicolon, and
3618f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3619f07771ccSwdenk    executed anyway.
3620f07771ccSwdenk
3621f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
362211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3623f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3624f07771ccSwdenk    variables are not executed.
3625f07771ccSwdenk
3626c609719bSwdenkNote for Redundant Ethernet Interfaces:
3627c609719bSwdenk=======================================
3628c609719bSwdenk
362911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3630c609719bSwdenksuch configurations and is capable of automatic selection of a
36317152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3632c609719bSwdenk
3633c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3634c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3635c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3636c609719bSwdenk
3637c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3638c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3639c609719bSwdenkding setting in the environment; if the corresponding environment
3640c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3641c609719bSwdenk
3642c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3643c609719bSwdenk  environment, the SROM's address is used.
3644c609719bSwdenk
3645c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3646c609719bSwdenk  environment exists, then the value from the environment variable is
3647c609719bSwdenk  used.
3648c609719bSwdenk
3649c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3650c609719bSwdenk  both addresses are the same, this MAC address is used.
3651c609719bSwdenk
3652c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3653c609719bSwdenk  addresses differ, the value from the environment is used and a
3654c609719bSwdenk  warning is printed.
3655c609719bSwdenk
3656c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3657c609719bSwdenk  is raised.
3658c609719bSwdenk
3659ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
3660ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.  This
3661ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
3662ecee9324SBen WarrenThe naming convention is as follows:
3663ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
3664c609719bSwdenk
3665c609719bSwdenkImage Formats:
3666c609719bSwdenk==============
3667c609719bSwdenk
36683310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
36693310c549SMarian Balakowiczimages in two formats:
36703310c549SMarian Balakowicz
36713310c549SMarian BalakowiczNew uImage format (FIT)
36723310c549SMarian Balakowicz-----------------------
36733310c549SMarian Balakowicz
36743310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
36753310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
36763310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
36773310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
36783310c549SMarian Balakowicz
36793310c549SMarian Balakowicz
36803310c549SMarian BalakowiczOld uImage format
36813310c549SMarian Balakowicz-----------------
36823310c549SMarian Balakowicz
36833310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
36843310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
36853310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3686c609719bSwdenk
3687c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3688c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3689f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3690f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3691f5ed9e39SPeter Tyser  INTEGRITY).
36927b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
36931117cbf2SThomas Chou  IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
36941117cbf2SThomas Chou  Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC).
3695c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3696c609719bSwdenk* Load Address
3697c609719bSwdenk* Entry Point
3698c609719bSwdenk* Image Name
3699c609719bSwdenk* Image Timestamp
3700c609719bSwdenk
3701c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3702c609719bSwdenkand the data portions of the image are secured against corruption by
3703c609719bSwdenkCRC32 checksums.
3704c609719bSwdenk
3705c609719bSwdenk
3706c609719bSwdenkLinux Support:
3707c609719bSwdenk==============
3708c609719bSwdenk
3709c609719bSwdenkAlthough U-Boot should support any OS or standalone application
37107152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3711c609719bSwdenkU-Boot.
3712c609719bSwdenk
3713c609719bSwdenkU-Boot includes many features that so far have been part of some
3714c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3715c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3716c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
37177152b1d0Swdenkserves several purposes:
3718c609719bSwdenk
3719c609719bSwdenk- the same features can be used for other OS or standalone
3720c609719bSwdenk  applications (for instance: using compressed images to reduce the
3721c609719bSwdenk  Flash memory footprint)
3722c609719bSwdenk
3723c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
37247152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3725c609719bSwdenk
3726c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3727c609719bSwdenk  images; of course this also means that different kernel images can
3728c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3729c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3730c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3731c609719bSwdenk  software is easier now.
3732c609719bSwdenk
3733c609719bSwdenk
3734c609719bSwdenkLinux HOWTO:
3735c609719bSwdenk============
3736c609719bSwdenk
3737c609719bSwdenkPorting Linux to U-Boot based systems:
3738c609719bSwdenk---------------------------------------
3739c609719bSwdenk
3740c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3741c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3742c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3743c609719bSwdenkLinux :-).
3744c609719bSwdenk
3745a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
3746c609719bSwdenk
3747c609719bSwdenkJust make sure your machine specific header file (for instance
3748c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
37491dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
37501dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
37516d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3752c609719bSwdenk
3753c609719bSwdenk
3754c609719bSwdenkConfiguring the Linux kernel:
3755c609719bSwdenk-----------------------------
3756c609719bSwdenk
3757c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3758c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3759c609719bSwdenk
3760c609719bSwdenk
3761c609719bSwdenkBuilding a Linux Image:
3762c609719bSwdenk-----------------------
3763c609719bSwdenk
376424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
376524ee89b9Swdenknot used. If you use recent kernel source, a new build target
376624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
376724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
376824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
376924ee89b9Swdenk100% compatible format.
3770c609719bSwdenk
3771c609719bSwdenkExample:
3772c609719bSwdenk
3773c609719bSwdenk	make TQM850L_config
3774c609719bSwdenk	make oldconfig
3775c609719bSwdenk	make dep
377624ee89b9Swdenk	make uImage
3777c609719bSwdenk
377824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
377924ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
378024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3781c609719bSwdenk
378224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
378324ee89b9Swdenk
378424ee89b9Swdenk* convert the kernel into a raw binary image:
378524ee89b9Swdenk
378624ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
378724ee89b9Swdenk				 -R .note -R .comment \
378824ee89b9Swdenk				 -S vmlinux linux.bin
378924ee89b9Swdenk
379024ee89b9Swdenk* compress the binary image:
379124ee89b9Swdenk
379224ee89b9Swdenk	gzip -9 linux.bin
379324ee89b9Swdenk
379424ee89b9Swdenk* package compressed binary image for U-Boot:
379524ee89b9Swdenk
379624ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
379724ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
379824ee89b9Swdenk		-d linux.bin.gz uImage
379924ee89b9Swdenk
380024ee89b9Swdenk
380124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
380224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
380324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
380424ee89b9Swdenkbyte header containing information about target architecture,
380524ee89b9Swdenkoperating system, image type, compression method, entry points, time
380624ee89b9Swdenkstamp, CRC32 checksums, etc.
380724ee89b9Swdenk
380824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
380924ee89b9Swdenkprint the header information, or to build new images.
3810c609719bSwdenk
3811c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3812c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3813c609719bSwdenkchecksum verification:
3814c609719bSwdenk
3815c609719bSwdenk	tools/mkimage -l image
3816c609719bSwdenk	  -l ==> list image header information
3817c609719bSwdenk
3818c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3819c609719bSwdenkfrom a "data file" which is used as image payload:
3820c609719bSwdenk
3821c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3822c609719bSwdenk		      -n name -d data_file image
3823c609719bSwdenk	  -A ==> set architecture to 'arch'
3824c609719bSwdenk	  -O ==> set operating system to 'os'
3825c609719bSwdenk	  -T ==> set image type to 'type'
3826c609719bSwdenk	  -C ==> set compression type 'comp'
3827c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3828c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3829c609719bSwdenk	  -n ==> set image name to 'name'
3830c609719bSwdenk	  -d ==> use image data from 'datafile'
3831c609719bSwdenk
383269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
383369459791Swdenkaddress (0x00000000), but the entry point address depends on the
383469459791Swdenkkernel version:
3835c609719bSwdenk
3836c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
383724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3838c609719bSwdenk
3839c609719bSwdenkSo a typical call to build a U-Boot image would read:
3840c609719bSwdenk
384124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
384224ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
3843a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
384424ee89b9Swdenk	> examples/uImage.TQM850L
384524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3846c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3847c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3848c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3849c609719bSwdenk	Load Address: 0x00000000
385024ee89b9Swdenk	Entry Point:  0x00000000
3851c609719bSwdenk
3852c609719bSwdenkTo verify the contents of the image (or check for corruption):
3853c609719bSwdenk
385424ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
385524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3856c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3857c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3858c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3859c609719bSwdenk	Load Address: 0x00000000
386024ee89b9Swdenk	Entry Point:  0x00000000
3861c609719bSwdenk
3862c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3863c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3864c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3865c609719bSwdenkneed to be uncompressed:
3866c609719bSwdenk
3867a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
386824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
386924ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
3870a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
387124ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
387224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3873c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3874c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3875c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3876c609719bSwdenk	Load Address: 0x00000000
387724ee89b9Swdenk	Entry Point:  0x00000000
3878c609719bSwdenk
3879c609719bSwdenk
3880c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3881c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3882c609719bSwdenk
3883c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3884c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3885c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3886c609719bSwdenk	Image Name:   Simple Ramdisk Image
3887c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3888c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3889c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3890c609719bSwdenk	Load Address: 0x00000000
3891c609719bSwdenk	Entry Point:  0x00000000
3892c609719bSwdenk
3893c609719bSwdenk
3894c609719bSwdenkInstalling a Linux Image:
3895c609719bSwdenk-------------------------
3896c609719bSwdenk
3897c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3898c609719bSwdenkyou must convert the image to S-Record format:
3899c609719bSwdenk
3900c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3901c609719bSwdenk
3902c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3903c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3904c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3905c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3906c609719bSwdenkcommand.
3907c609719bSwdenk
3908c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3909c609719bSwdenkTQM8xxL is in the first Flash bank):
3910c609719bSwdenk
3911c609719bSwdenk	=> erase 40100000 401FFFFF
3912c609719bSwdenk
3913c609719bSwdenk	.......... done
3914c609719bSwdenk	Erased 8 sectors
3915c609719bSwdenk
3916c609719bSwdenk	=> loads 40100000
3917c609719bSwdenk	## Ready for S-Record download ...
3918c609719bSwdenk	~>examples/image.srec
3919c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3920c609719bSwdenk	...
3921c609719bSwdenk	15989 15990 15991 15992
3922c609719bSwdenk	[file transfer complete]
3923c609719bSwdenk	[connected]
3924c609719bSwdenk	## Start Addr = 0x00000000
3925c609719bSwdenk
3926c609719bSwdenk
3927c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3928c609719bSwdenkthis includes a checksum verification so you can be sure no data
3929c609719bSwdenkcorruption happened:
3930c609719bSwdenk
3931c609719bSwdenk	=> imi 40100000
3932c609719bSwdenk
3933c609719bSwdenk	## Checking Image at 40100000 ...
3934c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3935c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3936c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3937c609719bSwdenk	   Load Address: 00000000
3938c609719bSwdenk	   Entry Point:	 0000000c
3939c609719bSwdenk	   Verifying Checksum ... OK
3940c609719bSwdenk
3941c609719bSwdenk
3942c609719bSwdenkBoot Linux:
3943c609719bSwdenk-----------
3944c609719bSwdenk
3945c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3946c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3947c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3948c609719bSwdenkparameters. You can check and modify this variable using the
3949c609719bSwdenk"printenv" and "setenv" commands:
3950c609719bSwdenk
3951c609719bSwdenk
3952c609719bSwdenk	=> printenv bootargs
3953c609719bSwdenk	bootargs=root=/dev/ram
3954c609719bSwdenk
3955c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3956c609719bSwdenk
3957c609719bSwdenk	=> printenv bootargs
3958c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3959c609719bSwdenk
3960c609719bSwdenk	=> bootm 40020000
3961c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3962c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3963c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3964c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3965c609719bSwdenk	   Load Address: 00000000
3966c609719bSwdenk	   Entry Point:	 0000000c
3967c609719bSwdenk	   Verifying Checksum ... OK
3968c609719bSwdenk	   Uncompressing Kernel Image ... OK
3969c609719bSwdenk	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
3970c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3971c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3972c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3973c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3974c609719bSwdenk	...
3975c609719bSwdenk
397611ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
39777152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3978c609719bSwdenkformat!) to the "bootm" command:
3979c609719bSwdenk
3980c609719bSwdenk	=> imi 40100000 40200000
3981c609719bSwdenk
3982c609719bSwdenk	## Checking Image at 40100000 ...
3983c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3984c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3985c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3986c609719bSwdenk	   Load Address: 00000000
3987c609719bSwdenk	   Entry Point:	 0000000c
3988c609719bSwdenk	   Verifying Checksum ... OK
3989c609719bSwdenk
3990c609719bSwdenk	## Checking Image at 40200000 ...
3991c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3992c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3993c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3994c609719bSwdenk	   Load Address: 00000000
3995c609719bSwdenk	   Entry Point:	 00000000
3996c609719bSwdenk	   Verifying Checksum ... OK
3997c609719bSwdenk
3998c609719bSwdenk	=> bootm 40100000 40200000
3999c609719bSwdenk	## Booting Linux kernel at 40100000 ...
4000c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
4001c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
4002c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
4003c609719bSwdenk	   Load Address: 00000000
4004c609719bSwdenk	   Entry Point:	 0000000c
4005c609719bSwdenk	   Verifying Checksum ... OK
4006c609719bSwdenk	   Uncompressing Kernel Image ... OK
4007c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
4008c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
4009c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
4010c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
4011c609719bSwdenk	   Load Address: 00000000
4012c609719bSwdenk	   Entry Point:	 00000000
4013c609719bSwdenk	   Verifying Checksum ... OK
4014c609719bSwdenk	   Loading Ramdisk ... OK
4015c609719bSwdenk	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
4016c609719bSwdenk	Boot arguments: root=/dev/ram
4017c609719bSwdenk	time_init: decrementer frequency = 187500000/60
4018c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
4019c609719bSwdenk	...
4020c609719bSwdenk	RAMDISK: Compressed image found at block 0
4021c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
4022c609719bSwdenk
4023c609719bSwdenk	bash#
4024c609719bSwdenk
40250267768eSMatthew McClintockBoot Linux and pass a flat device tree:
40260267768eSMatthew McClintock-----------
40270267768eSMatthew McClintock
40280267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
40290267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
40300267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
40310267768eSMatthew McClintockflat device tree:
40320267768eSMatthew McClintock
40330267768eSMatthew McClintock=> print oftaddr
40340267768eSMatthew McClintockoftaddr=0x300000
40350267768eSMatthew McClintock=> print oft
40360267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
40370267768eSMatthew McClintock=> tftp $oftaddr $oft
40380267768eSMatthew McClintockSpeed: 1000, full duplex
40390267768eSMatthew McClintockUsing TSEC0 device
40400267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
40410267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
40420267768eSMatthew McClintockLoad address: 0x300000
40430267768eSMatthew McClintockLoading: #
40440267768eSMatthew McClintockdone
40450267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
40460267768eSMatthew McClintock=> tftp $loadaddr $bootfile
40470267768eSMatthew McClintockSpeed: 1000, full duplex
40480267768eSMatthew McClintockUsing TSEC0 device
40490267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
40500267768eSMatthew McClintockFilename 'uImage'.
40510267768eSMatthew McClintockLoad address: 0x200000
40520267768eSMatthew McClintockLoading:############
40530267768eSMatthew McClintockdone
40540267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
40550267768eSMatthew McClintock=> print loadaddr
40560267768eSMatthew McClintockloadaddr=200000
40570267768eSMatthew McClintock=> print oftaddr
40580267768eSMatthew McClintockoftaddr=0x300000
40590267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
40600267768eSMatthew McClintock## Booting image at 00200000 ...
40610267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
40620267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
40630267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
40640267768eSMatthew McClintock   Load Address: 00000000
40650267768eSMatthew McClintock   Entry Point:	 00000000
40660267768eSMatthew McClintock   Verifying Checksum ... OK
40670267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
40680267768eSMatthew McClintockBooting using flat device tree at 0x300000
40690267768eSMatthew McClintockUsing MPC85xx ADS machine description
40700267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
40710267768eSMatthew McClintock[snip]
40720267768eSMatthew McClintock
40730267768eSMatthew McClintock
40746069ff26SwdenkMore About U-Boot Image Types:
40756069ff26Swdenk------------------------------
40766069ff26Swdenk
40776069ff26SwdenkU-Boot supports the following image types:
40786069ff26Swdenk
40796069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
40806069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
40816069ff26Swdenk	well) you can continue to work in U-Boot after return from
40826069ff26Swdenk	the Standalone Program.
40836069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
40846069ff26Swdenk	will take over control completely. Usually these programs
40856069ff26Swdenk	will install their own set of exception handlers, device
40866069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
40876069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
40886069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
40896069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
40906069ff26Swdenk	being started.
40916069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
40926069ff26Swdenk	(Linux) kernel image and one or more data images like
40936069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
40946069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
40956069ff26Swdenk	server provides just a single image file, but you want to get
40966069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
40976069ff26Swdenk
40986069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
40996069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
41006069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
41016069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
41026069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
41036069ff26Swdenk	a multiple of 4 bytes).
41046069ff26Swdenk
41056069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
41066069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
41076069ff26Swdenk	flash memory.
41086069ff26Swdenk
41096069ff26Swdenk   "Script files" are command sequences that will be executed by
41106069ff26Swdenk	U-Boot's command interpreter; this feature is especially
41116069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
41126069ff26Swdenk	as command interpreter.
41136069ff26Swdenk
4114c609719bSwdenk
4115c609719bSwdenkStandalone HOWTO:
4116c609719bSwdenk=================
4117c609719bSwdenk
4118c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
4119c609719bSwdenkrun "standalone" applications, which can use some resources of
4120c609719bSwdenkU-Boot like console I/O functions or interrupt services.
4121c609719bSwdenk
4122c609719bSwdenkTwo simple examples are included with the sources:
4123c609719bSwdenk
4124c609719bSwdenk"Hello World" Demo:
4125c609719bSwdenk-------------------
4126c609719bSwdenk
4127c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
4128c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
4129c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
4130c609719bSwdenklike that:
4131c609719bSwdenk
4132c609719bSwdenk	=> loads
4133c609719bSwdenk	## Ready for S-Record download ...
4134c609719bSwdenk	~>examples/hello_world.srec
4135c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4136c609719bSwdenk	[file transfer complete]
4137c609719bSwdenk	[connected]
4138c609719bSwdenk	## Start Addr = 0x00040004
4139c609719bSwdenk
4140c609719bSwdenk	=> go 40004 Hello World! This is a test.
4141c609719bSwdenk	## Starting application at 0x00040004 ...
4142c609719bSwdenk	Hello World
4143c609719bSwdenk	argc = 7
4144c609719bSwdenk	argv[0] = "40004"
4145c609719bSwdenk	argv[1] = "Hello"
4146c609719bSwdenk	argv[2] = "World!"
4147c609719bSwdenk	argv[3] = "This"
4148c609719bSwdenk	argv[4] = "is"
4149c609719bSwdenk	argv[5] = "a"
4150c609719bSwdenk	argv[6] = "test."
4151c609719bSwdenk	argv[7] = "<NULL>"
4152c609719bSwdenk	Hit any key to exit ...
4153c609719bSwdenk
4154c609719bSwdenk	## Application terminated, rc = 0x0
4155c609719bSwdenk
4156c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
4157c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
4158c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
4159c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
4160c609719bSwdenkcharacter, but this is just a demo program. The application can be
4161c609719bSwdenkcontrolled by the following keys:
4162c609719bSwdenk
4163c609719bSwdenk	? - print current values og the CPM Timer registers
4164c609719bSwdenk	b - enable interrupts and start timer
4165c609719bSwdenk	e - stop timer and disable interrupts
4166c609719bSwdenk	q - quit application
4167c609719bSwdenk
4168c609719bSwdenk	=> loads
4169c609719bSwdenk	## Ready for S-Record download ...
4170c609719bSwdenk	~>examples/timer.srec
4171c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
4172c609719bSwdenk	[file transfer complete]
4173c609719bSwdenk	[connected]
4174c609719bSwdenk	## Start Addr = 0x00040004
4175c609719bSwdenk
4176c609719bSwdenk	=> go 40004
4177c609719bSwdenk	## Starting application at 0x00040004 ...
4178c609719bSwdenk	TIMERS=0xfff00980
4179c609719bSwdenk	Using timer 1
4180c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
4181c609719bSwdenk
4182c609719bSwdenkHit 'b':
4183c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
4184c609719bSwdenk	Enabling timer
4185c609719bSwdenkHit '?':
4186c609719bSwdenk	[q, b, e, ?] ........
4187c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
4188c609719bSwdenkHit '?':
4189c609719bSwdenk	[q, b, e, ?] .
4190c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
4191c609719bSwdenkHit '?':
4192c609719bSwdenk	[q, b, e, ?] .
4193c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
4194c609719bSwdenkHit '?':
4195c609719bSwdenk	[q, b, e, ?] .
4196c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
4197c609719bSwdenkHit 'e':
4198c609719bSwdenk	[q, b, e, ?] ...Stopping timer
4199c609719bSwdenkHit 'q':
4200c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
4201c609719bSwdenk
4202c609719bSwdenk
420385ec0bccSwdenkMinicom warning:
420485ec0bccSwdenk================
420585ec0bccSwdenk
42067152b1d0SwdenkOver time, many people have reported problems when trying to use the
420785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
420885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
4209f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
421085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
421185ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
421285ec0bccSwdenk
421352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
421452f52c14Swdenkconfiguration to your "File transfer protocols" section:
421552f52c14Swdenk
421652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
421752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
421852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
421952f52c14Swdenk
422052f52c14Swdenk
4221c609719bSwdenkNetBSD Notes:
4222c609719bSwdenk=============
4223c609719bSwdenk
4224c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
4225c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
4226c609719bSwdenk
4227c609719bSwdenkBuilding requires a cross environment; it is known to work on
4228c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
4229c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
4230c609719bSwdenkNote that the cross-powerpc package does not install include files;
4231c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
4232c609719bSwdenkmissing.  This file has to be installed and patched manually:
4233c609719bSwdenk
4234c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
4235c609719bSwdenk	# mkdir powerpc
4236c609719bSwdenk	# ln -s powerpc machine
4237c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
4238c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
4239c609719bSwdenk
4240c609719bSwdenkNative builds *don't* work due to incompatibilities between native
4241c609719bSwdenkand U-Boot include files.
4242c609719bSwdenk
4243c609719bSwdenkBooting assumes that (the first part of) the image booted is a
4244c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
4245c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
4246c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
42472a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
4248c609719bSwdenk
4249c609719bSwdenk
4250c609719bSwdenkImplementation Internals:
4251c609719bSwdenk=========================
4252c609719bSwdenk
4253c609719bSwdenkThe following is not intended to be a complete description of every
4254c609719bSwdenkimplementation detail. However, it should help to understand the
4255c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
4256c609719bSwdenkhardware.
4257c609719bSwdenk
4258c609719bSwdenk
4259c609719bSwdenkInitial Stack, Global Data:
4260c609719bSwdenk---------------------------
4261c609719bSwdenk
4262c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
4263c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
4264c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
4265c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
4266c609719bSwdenkis not initialized as zero. To be able to get a C environment working
4267c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
4268c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
4269c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
4270c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
4271c609719bSwdenklocked as (mis-) used as memory, etc.
4272c609719bSwdenk
42737152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
42740668236bSWolfgang Denk	U-Boot mailing list:
427543d9616cSwdenk
427643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
427743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
427843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
427943d9616cSwdenk	...
428043d9616cSwdenk
428143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
428243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
428343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
428443d9616cSwdenk	is that the cache is being used as a temporary supply of
428543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
428611ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
428743d9616cSwdenk	can see how this works by studying the cache architecture and
428843d9616cSwdenk	operation in the architecture and processor-specific manuals.
428943d9616cSwdenk
429043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
429143d9616cSwdenk	is another option for the system designer to use as an
429211ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
429343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
429443d9616cSwdenk	board designers haven't used it for something that would
429543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
429643d9616cSwdenk	used.
429743d9616cSwdenk
42986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
429943d9616cSwdenk	with your processor/board/system design. The default value
430043d9616cSwdenk	you will find in any recent u-boot distribution in
43018a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
430243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
430343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
430443d9616cSwdenk	that are supposed to respond to that address! That code in
430543d9616cSwdenk	start.S has been around a while and should work as is when
430643d9616cSwdenk	you get the config right.
430743d9616cSwdenk
430843d9616cSwdenk	-Chris Hallinan
430943d9616cSwdenk	DS4.COM, Inc.
431043d9616cSwdenk
4311c609719bSwdenkIt is essential to remember this, since it has some impact on the C
4312c609719bSwdenkcode for the initialization procedures:
4313c609719bSwdenk
4314c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
4315c609719bSwdenk  to write it.
4316c609719bSwdenk
431711ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
4318c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
43197152b1d0Swdenk  zation is performed later (when relocating to RAM).
4320c609719bSwdenk
4321c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
4322c609719bSwdenk  that.
4323c609719bSwdenk
4324c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
4325c609719bSwdenknormal global data to share information beween the code. But it
4326c609719bSwdenkturned out that the implementation of U-Boot can be greatly
4327c609719bSwdenksimplified by making a global data structure (gd_t) available to all
4328c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
4329c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
4330c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
4331c609719bSwdenkplace a pointer (gd) to the global data into a register which we
4332c609719bSwdenkreserve for this purpose.
4333c609719bSwdenk
43347152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
4335c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
4336c609719bSwdenkGCC's implementation.
4337c609719bSwdenk
4338c609719bSwdenkFor PowerPC, the following registers have specific use:
4339c609719bSwdenk	R1:	stack pointer
4340e7670f6cSWolfgang Denk	R2:	reserved for system use
4341c609719bSwdenk	R3-R4:	parameter passing and return values
4342c609719bSwdenk	R5-R10: parameter passing
4343c609719bSwdenk	R13:	small data area pointer
4344c609719bSwdenk	R30:	GOT pointer
4345c609719bSwdenk	R31:	frame pointer
4346c609719bSwdenk
4347e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
4348e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
4349e6bee808SJoakim Tjernlund	going back and forth between asm and C)
4350c609719bSwdenk
4351e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
4352c609719bSwdenk
4353c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
4354c609719bSwdenk    address of the global data structure is known at compile time),
4355c609719bSwdenk    but it turned out that reserving a register results in somewhat
4356c609719bSwdenk    smaller code - although the code savings are not that big (on
4357c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
4358c609719bSwdenk    624 text + 127 data).
4359c609719bSwdenk
4360c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
43614c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
43624c58eb55SMike Frysinger
4363c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
43644c58eb55SMike Frysinger
4365c609719bSwdenkOn ARM, the following registers are used:
4366c609719bSwdenk
4367c609719bSwdenk	R0:	function argument word/integer result
4368c609719bSwdenk	R1-R3:	function argument word
4369c609719bSwdenk	R9:	GOT pointer
4370c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
4371c609719bSwdenk	R11:	argument (frame) pointer
4372c609719bSwdenk	R12:	temporary workspace
4373c609719bSwdenk	R13:	stack pointer
4374c609719bSwdenk	R14:	link register
4375c609719bSwdenk	R15:	program counter
4376c609719bSwdenk
4377c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
4378c609719bSwdenk
43790df01fd3SThomas ChouOn Nios II, the ABI is documented here:
43800df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
43810df01fd3SThomas Chou
43820df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
43830df01fd3SThomas Chou
43840df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
43850df01fd3SThomas Chou    to access small data sections, so gp is free.
43860df01fd3SThomas Chou
4387d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
4388d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
4389c609719bSwdenk
4390c609719bSwdenkMemory Management:
4391c609719bSwdenk------------------
4392c609719bSwdenk
4393c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
4394c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
4395c609719bSwdenk
4396c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
4397c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
4398c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
4399c609719bSwdenkphysical memory banks.
4400c609719bSwdenk
4401c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4402c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4403c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4404c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
44056d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4406c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4407c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4408c609719bSwdenk
4409c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4410c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4411c609719bSwdenk
4412c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4413c609719bSwdenkthis:
4414c609719bSwdenk
4415c609719bSwdenk	0x0000 0000	Exception Vector code
4416c609719bSwdenk	      :
4417c609719bSwdenk	0x0000 1FFF
4418c609719bSwdenk	0x0000 2000	Free for Application Use
4419c609719bSwdenk	      :
4420c609719bSwdenk	      :
4421c609719bSwdenk
4422c609719bSwdenk	      :
4423c609719bSwdenk	      :
4424c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4425c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4426c609719bSwdenk	0x00FC 0000	Malloc Arena
4427c609719bSwdenk	      :
4428c609719bSwdenk	0x00FD FFFF
4429c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4430c609719bSwdenk	...		eventually: LCD or video framebuffer
4431c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4432c609719bSwdenk	0x00FF FFFF	[End of RAM]
4433c609719bSwdenk
4434c609719bSwdenk
4435c609719bSwdenkSystem Initialization:
4436c609719bSwdenk----------------------
4437c609719bSwdenk
4438c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
443911ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4440c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
44417152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4442c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4443c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4444c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4445c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4446c609719bSwdenkthe caches and the SIU.
4447c609719bSwdenk
4448c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4449c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4450c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4451c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4452c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4453c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4454c609719bSwdenkbanks.
4455c609719bSwdenk
4456c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
44577152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4458c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4459c609719bSwdenk0x00000000, with any additional banks following immediately to create
4460c609719bSwdenkcontiguous memory starting from 0.
4461c609719bSwdenk
4462c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4463c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4464c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4465c609719bSwdenkpages, and the final stack is set up.
4466c609719bSwdenk
4467c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4468c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4469c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4470c609719bSwdenknew address in RAM.
4471c609719bSwdenk
4472c609719bSwdenk
4473c609719bSwdenkU-Boot Porting Guide:
4474c609719bSwdenk----------------------
4475c609719bSwdenk
4476c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
44776aff3115Swdenklist, October 2002]
4478c609719bSwdenk
4479c609719bSwdenk
4480c609719bSwdenkint main(int argc, char *argv[])
4481c609719bSwdenk{
4482c609719bSwdenk	sighandler_t no_more_time;
4483c609719bSwdenk
4484c609719bSwdenk	signal(SIGALRM, no_more_time);
4485c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4486c609719bSwdenk
4487c609719bSwdenk	if (available_money > available_manpower) {
44886c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4489c609719bSwdenk		return 0;
4490c609719bSwdenk	}
4491c609719bSwdenk
4492c609719bSwdenk	Download latest U-Boot source;
4493c609719bSwdenk
44940668236bSWolfgang Denk	Subscribe to u-boot mailing list;
44956aff3115Swdenk
44966c3fef28SJerry Van Baren	if (clueless)
4497c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4498c609719bSwdenk
4499c609719bSwdenk	while (learning) {
4500c609719bSwdenk		Read the README file in the top level directory;
45017cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
45026c3fef28SJerry Van Baren		Read applicable doc/*.README;
4503c609719bSwdenk		Read the source, Luke;
45046c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4505c609719bSwdenk	}
4506c609719bSwdenk
45076c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
45086c3fef28SJerry Van Baren		Buy a BDI3000;
45096c3fef28SJerry Van Baren	else
4510c609719bSwdenk		Add a lot of aggravation and time;
4511c609719bSwdenk
45126c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
45136c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
45146c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
45156c3fef28SJerry Van Baren	} else {
4516c609719bSwdenk		Create your own board support subdirectory;
45176c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
45186c3fef28SJerry Van Baren	}
45196c3fef28SJerry Van Baren	Edit new board/<myboard> files
45206c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4521c609719bSwdenk
45226c3fef28SJerry Van Baren	while (!accepted) {
4523c609719bSwdenk		while (!running) {
4524c609719bSwdenk			do {
4525c609719bSwdenk				Add / modify source code;
4526c609719bSwdenk			} until (compiles);
4527c609719bSwdenk			Debug;
4528c609719bSwdenk			if (clueless)
4529c609719bSwdenk				email("Hi, I am having problems...");
4530c609719bSwdenk		}
45316c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
45326c3fef28SJerry Van Baren		if (reasonable critiques)
45336c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
45346c3fef28SJerry Van Baren		else
45356c3fef28SJerry Van Baren			Defend code as written;
45366c3fef28SJerry Van Baren	}
4537c609719bSwdenk
4538c609719bSwdenk	return 0;
4539c609719bSwdenk}
4540c609719bSwdenk
4541c609719bSwdenkvoid no_more_time (int sig)
4542c609719bSwdenk{
4543c609719bSwdenk      hire_a_guru();
4544c609719bSwdenk}
4545c609719bSwdenk
4546c609719bSwdenk
4547c609719bSwdenkCoding Standards:
4548c609719bSwdenk-----------------
4549c609719bSwdenk
4550c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
45512c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
45527ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
4553c609719bSwdenk
45542c051651SDetlev ZundelSource files originating from a different project (for example the
45552c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
45562c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
45572c051651SDetlev Zundelsources.
45582c051651SDetlev Zundel
45592c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
45602c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
45612c051651SDetlev Zundelin your code.
4562c609719bSwdenk
4563c178d3daSwdenkPlease also stick to the following formatting rules:
4564180d3f74Swdenk- remove any trailing white space
45657ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
4566180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
45677ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
4568180d3f74Swdenk- do not add trailing empty lines to source files
4569180d3f74Swdenk
4570c609719bSwdenkSubmissions which do not conform to the standards may be returned
4571c609719bSwdenkwith a request to reformat the changes.
4572c609719bSwdenk
4573c609719bSwdenk
4574c609719bSwdenkSubmitting Patches:
4575c609719bSwdenk-------------------
4576c609719bSwdenk
4577c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4578c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4579c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4580c609719bSwdenk
45810d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4582218ca724SWolfgang Denk
45830668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
45840668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
45850668236bSWolfgang Denk
4586c609719bSwdenkWhen you send a patch, please include the following information with
4587c609719bSwdenkit:
4588c609719bSwdenk
4589c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4590c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4591c609719bSwdenk  patch actually fixes something.
4592c609719bSwdenk
4593c609719bSwdenk* For new features: a description of the feature and your
4594c609719bSwdenk  implementation.
4595c609719bSwdenk
4596c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4597c609719bSwdenk
4598c609719bSwdenk* For major contributions, your entry to the CREDITS file
4599c609719bSwdenk
4600c609719bSwdenk* When you add support for a new board, don't forget to add this
46017ca9296eSWolfgang Denk  board to the MAINTAINERS file, too.
4602c609719bSwdenk
4603c609719bSwdenk* If your patch adds new configuration options, don't forget to
4604c609719bSwdenk  document these in the README file.
4605c609719bSwdenk
4606218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4607218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
46087ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
4609218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4610218ca724SWolfgang Denk  with some other mail clients.
4611c609719bSwdenk
4612218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4613218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4614218ca724SWolfgang Denk  GNU diff.
46156dff5529Swdenk
4616218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4617218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4618218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4619218ca724SWolfgang Denk  affected files).
4620218ca724SWolfgang Denk
4621218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4622218ca724SWolfgang Denk  and compressed attachments must not be used.
4623c609719bSwdenk
462452f52c14Swdenk* If one logical set of modifications affects or creates several
462552f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
462652f52c14Swdenk
462752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
462852f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
462952f52c14Swdenk
463052f52c14Swdenk
4631c609719bSwdenkNotes:
4632c609719bSwdenk
4633c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4634c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4635c609719bSwdenk  for any of the boards.
4636c609719bSwdenk
4637c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4638c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4639c609719bSwdenk  returned with a request to re-formatting / split it.
4640c609719bSwdenk
4641c609719bSwdenk* If you modify existing code, make sure that your new code does not
4642c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4643c609719bSwdenk  When adding new features, these should compile conditionally only
4644c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4645c609719bSwdenk  disabled must not need more memory than the old code without your
4646c609719bSwdenk  modification.
464790dc6704Swdenk
46480668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
46490668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
46500668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
46510668236bSWolfgang Denk  bigger than the size limit should be avoided.
4652