xref: /openbmc/u-boot/README (revision d5011762)
1c609719bSwdenk#
2cccfc2abSDetlev Zundel# (C) Copyright 2000 - 2009
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
12993f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
13093f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
13193f19cc0Swdenksub-version "34", and patchlevel "4".
13293f19cc0Swdenk
13393f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
13493f19cc0Swdenkbetween released versions, i. e. officially released versions of
13593f19cc0SwdenkU-Boot will always have a patchlevel of "0".
13693f19cc0Swdenk
13793f19cc0Swdenk
138c609719bSwdenkDirectory Hierarchy:
139c609719bSwdenk====================
140c609719bSwdenk
141ad532261SRobert P. J. Day- api		Machine/arch independent API for external apps
1427152b1d0Swdenk- board		Board dependent files
1437152b1d0Swdenk- common	Misc architecture independent functions
144c609719bSwdenk- cpu		CPU specific files
145983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
14611dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
14711dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
148a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
149983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1501d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
15111dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
15211dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1538ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
15472a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
155adbfeeb7SMike Frysinger  - blackfin	Files specific to Analog Devices Blackfin CPUs
15611dadd54Swdenk  - i386	Files specific to i386 CPUs
15711dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
158b330990cSDaniel Hellstrom  - leon2	Files specific to Gaisler LEON2 SPARC CPU
1591e9a164eSDaniel Hellstrom  - leon3	Files specific to Gaisler LEON3 SPARC CPU
160983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
1611552af70STsiChungLiew  - mcf5227x	Files specific to Freescale ColdFire MCF5227x CPUs
1628e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
1638ae158cdSTsiChungLiew  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
16457a12720STsiChungLiew  - mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
16511dadd54Swdenk  - mips	Files specific to MIPS CPUs
166983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
167983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
168983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
169983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
170983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
171983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
172983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
17311dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1745c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1750c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
17611dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
17711dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
17811dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
179c609719bSwdenk- disk		Code for disk drive partition handling
180c609719bSwdenk- doc		Documentation (don't expect too much)
1817152b1d0Swdenk- drivers	Commonly used device drivers
182c609719bSwdenk- examples	Example code for standalone applications, etc.
183ad532261SRobert P. J. Day- fs		Filesystem code (cramfs, ext2, jffs2, etc.)
184c609719bSwdenk- include	Header Files
18511dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1867b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
187adbfeeb7SMike Frysinger- lib_blackfin	Files generic to Blackfin architecture
18811dadd54Swdenk- lib_generic	Files generic to all	 architectures
18911dadd54Swdenk- lib_i386	Files generic to i386	 architecture
19011dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
191ad532261SRobert P. J. Day- lib_microblaze Files generic to microblaze architecture
19211dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
19311dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
194ad532261SRobert P. J. Day- lib_nios2	Files generic to NIOS2	 architecture
19511dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
196ad532261SRobert P. J. Day- lib_sh	Files generic to SH	 architecture
197c2f02da2SDaniel Hellstrom- lib_sparc	Files generic to SPARC	 architecture
198213bf8c8SGerald Van Baren- libfdt	Library files to support flattened device trees
199c609719bSwdenk- net		Networking code
200c609719bSwdenk- post		Power On Self Test
201c609719bSwdenk- rtc		Real Time Clock drivers
202c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
203c609719bSwdenk
204c609719bSwdenkSoftware Configuration:
205c609719bSwdenk=======================
206c609719bSwdenk
207c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
208c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
209c609719bSwdenk
210c609719bSwdenkThere are two classes of configuration variables:
211c609719bSwdenk
212c609719bSwdenk* Configuration _OPTIONS_:
213c609719bSwdenk  These are selectable by the user and have names beginning with
214c609719bSwdenk  "CONFIG_".
215c609719bSwdenk
216c609719bSwdenk* Configuration _SETTINGS_:
217c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
218c609719bSwdenk  you don't know what you're doing; they have names beginning with
2196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
220c609719bSwdenk
221c609719bSwdenkLater we will add a configuration tool - probably similar to or even
222c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
223c609719bSwdenkdo the configuration by hand, which means creating some symbolic
224c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
225c609719bSwdenkas an example here.
226c609719bSwdenk
227c609719bSwdenk
228c609719bSwdenkSelection of Processor Architecture and Board Type:
229c609719bSwdenk---------------------------------------------------
230c609719bSwdenk
231c609719bSwdenkFor all supported boards there are ready-to-use default
232c609719bSwdenkconfigurations available; just type "make <board_name>_config".
233c609719bSwdenk
234c609719bSwdenkExample: For a TQM823L module type:
235c609719bSwdenk
236c609719bSwdenk	cd u-boot
237c609719bSwdenk	make TQM823L_config
238c609719bSwdenk
23911ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
240c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
241c609719bSwdenkdirectory according to the instructions in cogent/README.
242c609719bSwdenk
243c609719bSwdenk
244c609719bSwdenkConfiguration Options:
245c609719bSwdenk----------------------
246c609719bSwdenk
247c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
248c609719bSwdenksuch information is kept in a configuration file
249c609719bSwdenk"include/configs/<board_name>.h".
250c609719bSwdenk
251c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
252c609719bSwdenk"include/configs/TQM823L.h".
253c609719bSwdenk
254c609719bSwdenk
2557f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2567f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2577f6c2cbcSwdenkbuild a config tool - later.
2587f6c2cbcSwdenk
2597f6c2cbcSwdenk
260c609719bSwdenkThe following options need to be configured:
261c609719bSwdenk
2622628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
263c609719bSwdenk
2642628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2656ccec449SWolfgang Denk
2666ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
26709ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
268c609719bSwdenk
269c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
270c609719bSwdenk		Define exactly one of
271c609719bSwdenk		CONFIG_CMA286_60_OLD
272c609719bSwdenk--- FIXME --- not tested yet:
273c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
274c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
275c609719bSwdenk
276c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
277c609719bSwdenk		Define exactly one of
278c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
279c609719bSwdenk
280c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
281c609719bSwdenk		Define one or more of
282c609719bSwdenk		CONFIG_CMA302
283c609719bSwdenk
284c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
285c609719bSwdenk		Define one or more of
286c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
28711ccc33fSMarcel Ziswiler					  the LCD display every second with
288c609719bSwdenk					  a "rotator" |\-/|\-/
289c609719bSwdenk
2902535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
2912535d602Swdenk		CONFIG_ADSTYPE
2922535d602Swdenk		Possible values are:
2936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
2946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
2956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
2966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
2972535d602Swdenk
298c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
299c609719bSwdenk		Define exactly one of
300c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
301c609719bSwdenk
30211ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
30366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
30466ca92a5Swdenk					  get_gclk_freq() cannot work
3055da627a4Swdenk					  e.g. if there is no 32KHz
3065da627a4Swdenk					  reference PIT/RTC clock
30766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
30866ca92a5Swdenk					  or XTAL/EXTAL)
309c609719bSwdenk
31066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
31366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
31475d1ea7fSwdenk			See doc/README.MPC866
31575d1ea7fSwdenk
3166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
31775d1ea7fSwdenk
31875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
31975d1ea7fSwdenk		of relying on the correctness of the configured
32075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
32175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
32275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
32475d1ea7fSwdenk
325506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
326506f3918SHeiko Schocher
327506f3918SHeiko Schocher		Define this option if you want to enable the
328506f3918SHeiko Schocher		ICache only when Code runs from RAM.
329506f3918SHeiko Schocher
3300b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3320b953ffcSMarkus Klotzbuecher
3330b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3340b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3350b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3360b953ffcSMarkus Klotzbuecher
3376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3380b953ffcSMarkus Klotzbuecher
3390b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3400b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3410b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3420b953ffcSMarkus Klotzbuecher		by this value.
3430b953ffcSMarkus Klotzbuecher
3445da627a4Swdenk- Linux Kernel Interface:
345c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
346c609719bSwdenk
347c609719bSwdenk		U-Boot stores all clock information in Hz
348c609719bSwdenk		internally. For binary compatibility with older Linux
349c609719bSwdenk		kernels (which expect the clocks passed in the
350c609719bSwdenk		bd_info data to be in MHz) the environment variable
351c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
352c609719bSwdenk		converts clock data to MHZ before passing it to the
353c609719bSwdenk		Linux kernel.
354c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
355c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
356c609719bSwdenk		default environment.
357c609719bSwdenk
3585da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3595da627a4Swdenk
36011ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3615da627a4Swdenk		expect it to be in bytes, others in MB.
3625da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3635da627a4Swdenk
364fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
365f57f70aaSWolfgang Denk
366f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
367213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
368213bf8c8SGerald Van Baren		concepts).
369213bf8c8SGerald Van Baren
370213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
371213bf8c8SGerald Van Baren		 * New libfdt-based support
372213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3733bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
374213bf8c8SGerald Van Baren
375b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
376b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
377b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
378b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
379f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
380c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
381f57f70aaSWolfgang Denk
38211ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
38311ccc33fSMarcel Ziswiler		addresses
3843bb342fcSKim Phillips
3854e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
3864e253137SKumar Gala
3874e253137SKumar Gala		Board code has addition modification that it wants to make
3884e253137SKumar Gala		to the flat device tree before handing it off to the kernel
3896705d81eSwdenk
3900267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
3910267768eSMatthew McClintock
39211ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
3930267768eSMatthew McClintock		param header, the default value is zero if undefined.
3940267768eSMatthew McClintock
3953887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
3963887c3fbSHeiko Schocher
3973887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
3983887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
3993887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
4003887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
4013887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
4023887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
4033887c3fbSHeiko Schocher
4040b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4050b2f4ecaSNiklaus Giger
4060b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4070b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4080b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4090b2f4ecaSNiklaus Giger
4100b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4110b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4120b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4130b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4140b2f4ecaSNiklaus Giger
4150b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4160b2f4ecaSNiklaus Giger
4170b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4180b2f4ecaSNiklaus Giger
4190b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4200b2f4ecaSNiklaus Giger		the defaults discussed just above.
4210b2f4ecaSNiklaus Giger
4226705d81eSwdenk- Serial Ports:
42348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4246705d81eSwdenk
4256705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4266705d81eSwdenk
42748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4286705d81eSwdenk
4296705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4306705d81eSwdenk
4316705d81eSwdenk		CONFIG_PL011_CLOCK
4326705d81eSwdenk
4336705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4346705d81eSwdenk		the clock speed of the UARTs.
4356705d81eSwdenk
4366705d81eSwdenk		CONFIG_PL01x_PORTS
4376705d81eSwdenk
4386705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4396705d81eSwdenk		define this to a list of base addresses for each (supported)
4406705d81eSwdenk		port. See e.g. include/configs/versatile.h
4416705d81eSwdenk
4426705d81eSwdenk
443c609719bSwdenk- Console Interface:
444c609719bSwdenk		Depending on board, define exactly one serial port
445c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
446c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
447c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
448c609719bSwdenk
449c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
450c609719bSwdenk		port routines must be defined elsewhere
451c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
452c609719bSwdenk
453c609719bSwdenk		CONFIG_CFB_CONSOLE
454c609719bSwdenk		Enables console device for a color framebuffer. Needs following
455c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
456c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
457c609719bSwdenk						(default big endian)
458c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
459c609719bSwdenk						rectangle fill
460c609719bSwdenk						(cf. smiLynxEM)
461c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
462c609719bSwdenk						bit-blit (cf. smiLynxEM)
463c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
464c609719bSwdenk						(cols=pitch)
465c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
466c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
467c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
468c609719bSwdenk						(0-5, cf. cfb_console.c)
469c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
470c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
471c609719bSwdenk						(i.e. i8042_kbd_init())
472c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
473c609719bSwdenk						(i.e. i8042_tstc)
474c609719bSwdenk			VIDEO_GETC_FCT		get char fct
475c609719bSwdenk						(i.e. i8042_getc)
476c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
477c609719bSwdenk						(requires blink timer
478c609719bSwdenk						cf. i8042.c)
4796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
480c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
481c609719bSwdenk						upper right corner
482602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
483c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
484c609719bSwdenk						upper left corner
485a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
486a6c7ad2fSwdenk						linux_logo.h for logo.
487a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
488c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
48911ccc33fSMarcel Ziswiler						additional board info beside
490c609719bSwdenk						the logo
491c609719bSwdenk
492c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
493c609719bSwdenk		default i/o. Serial console can be forced with
494c609719bSwdenk		environment 'console=serial'.
495c609719bSwdenk
496a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
497a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
498a3ad8e26Swdenk		the "silent" environment variable. See
499a3ad8e26Swdenk		doc/README.silent for more information.
500a3ad8e26Swdenk
501c609719bSwdenk- Console Baudrate:
502c609719bSwdenk		CONFIG_BAUDRATE - in bps
503c609719bSwdenk		Select one of the baudrates listed in
5046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
506c609719bSwdenk
507c92fac91SHeiko Schocher- Console Rx buffer length
508c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
509c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5102b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
511c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
512c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
513c92fac91SHeiko Schocher		the SMC.
514c92fac91SHeiko Schocher
515c609719bSwdenk- Interrupt driven serial port input:
516c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
517c609719bSwdenk
518c609719bSwdenk		PPC405GP only.
519c609719bSwdenk		Use an interrupt handler for receiving data on the
520c609719bSwdenk		serial port. It also enables using hardware handshake
521c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
522c609719bSwdenk		bytes the interrupt driven input buffer should have.
523c609719bSwdenk
524109c0e3aSwdenk		Leave undefined to disable this feature, including
525109c0e3aSwdenk		disable the buffer and hardware handshake.
526c609719bSwdenk
5271d49b1f3Sstroese- Console UART Number:
5281d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5291d49b1f3Sstroese
5300c8721a4SWolfgang Denk		AMCC PPC4xx only.
5311d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5321d49b1f3Sstroese		as default U-Boot console.
5331d49b1f3Sstroese
534c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
535c609719bSwdenk		Delay before automatically booting the default image;
536c609719bSwdenk		set to -1 to disable autoboot.
537c609719bSwdenk
538c609719bSwdenk		See doc/README.autoboot for these options that
539c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
540c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
541c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
542c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
543c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
544c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
545c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
546c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
547c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
548c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
549c609719bSwdenk		CONFIG_RESET_TO_RETRY
550c609719bSwdenk
551c609719bSwdenk- Autoboot Command:
552c609719bSwdenk		CONFIG_BOOTCOMMAND
553c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
554c609719bSwdenk		define a command string that is automatically executed
555c609719bSwdenk		when no character is read on the console interface
556c609719bSwdenk		within "Boot Delay" after reset.
557c609719bSwdenk
558c609719bSwdenk		CONFIG_BOOTARGS
559c609719bSwdenk		This can be used to pass arguments to the bootm
560c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
561c609719bSwdenk		environment value "bootargs".
562c609719bSwdenk
563c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
564c609719bSwdenk		The value of these goes into the environment as
565c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
566c609719bSwdenk		as a convenience, when switching between booting from
56711ccc33fSMarcel Ziswiler		RAM and NFS.
568c609719bSwdenk
569c609719bSwdenk- Pre-Boot Commands:
570c609719bSwdenk		CONFIG_PREBOOT
571c609719bSwdenk
572c609719bSwdenk		When this option is #defined, the existence of the
573c609719bSwdenk		environment variable "preboot" will be checked
574c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
575c609719bSwdenk		countdown and/or running the auto-boot command resp.
576c609719bSwdenk		entering interactive mode.
577c609719bSwdenk
578c609719bSwdenk		This feature is especially useful when "preboot" is
579c609719bSwdenk		automatically generated or modified. For an example
580c609719bSwdenk		see the LWMON board specific code: here "preboot" is
581c609719bSwdenk		modified when the user holds down a certain
582c609719bSwdenk		combination of keys on the (special) keyboard when
583c609719bSwdenk		booting the systems
584c609719bSwdenk
585c609719bSwdenk- Serial Download Echo Mode:
586c609719bSwdenk		CONFIG_LOADS_ECHO
587c609719bSwdenk		If defined to 1, all characters received during a
588c609719bSwdenk		serial download (using the "loads" command) are
589c609719bSwdenk		echoed back. This might be needed by some terminal
590c609719bSwdenk		emulations (like "cu"), but may as well just take
591c609719bSwdenk		time on others. This setting #define's the initial
592c609719bSwdenk		value of the "loads_echo" environment variable.
593c609719bSwdenk
594602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
595c609719bSwdenk		CONFIG_KGDB_BAUDRATE
596c609719bSwdenk		Select one of the baudrates listed in
5976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
598c609719bSwdenk
599c609719bSwdenk- Monitor Functions:
600602ad3b3SJon Loeliger		Monitor commands can be included or excluded
601602ad3b3SJon Loeliger		from the build by using the #include files
602602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
603602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
604602ad3b3SJon Loeliger		and augmenting with additional #define's
605602ad3b3SJon Loeliger		for wanted commands.
606c609719bSwdenk
607602ad3b3SJon Loeliger		The default command configuration includes all commands
608602ad3b3SJon Loeliger		except those marked below with a "*".
609602ad3b3SJon Loeliger
610602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
611602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
612602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
613602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
614602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
615602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
616602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
617602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
618602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
619602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
620602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
621a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
622a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
623a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
624a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
625602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
626602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
627246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
628602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
629602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
630bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
631602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
632602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
633602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
634602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
635602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
636602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
637602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
638602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
639602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
640602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
641602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
642602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
643602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
644602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
645602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
646602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
647602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
64802c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
64902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
650602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
65156523f12Swdenk					  loop, loopw, mtest
652602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
653602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
654602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
65568d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
656602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
657602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
658e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
659e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
660602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
661602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
662602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
663602ad3b3SJon Loeliger					  host
664602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
665602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
666602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
667602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
668602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
669602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
670602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
671602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
672602ad3b3SJon Loeliger					  (4xx only)
67302c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
67402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
67574de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
676602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
677602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
678602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
679602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
680602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
681c609719bSwdenk
682c609719bSwdenk
683c609719bSwdenk		EXAMPLE: If you want all functions except of network
684c609719bSwdenk		support you can write:
685c609719bSwdenk
686602ad3b3SJon Loeliger		#include "config_cmd_all.h"
687602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
688c609719bSwdenk
689213bf8c8SGerald Van Baren	Other Commands:
690213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
691c609719bSwdenk
692c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
693602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
694c609719bSwdenk		what you (and your U-Boot users) are doing. Data
695c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
696c609719bSwdenk		8260 (where accesses to the IMMR region must be
697c609719bSwdenk		uncached), and it cannot be disabled on all other
698c609719bSwdenk		systems where we (mis-) use the data cache to hold an
699c609719bSwdenk		initial stack and some data.
700c609719bSwdenk
701c609719bSwdenk
702c609719bSwdenk		XXX - this list needs to get updated!
703c609719bSwdenk
704c609719bSwdenk- Watchdog:
705c609719bSwdenk		CONFIG_WATCHDOG
706c609719bSwdenk		If this variable is defined, it enables watchdog
7077152b1d0Swdenk		support. There must be support in the platform specific
708c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
709c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
710c609719bSwdenk		register.
711c609719bSwdenk
712c1551ea8Sstroese- U-Boot Version:
713c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
714c1551ea8Sstroese		If this variable is defined, an environment variable
715c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
716c1551ea8Sstroese		version as printed by the "version" command.
717c1551ea8Sstroese		This variable is readonly.
718c1551ea8Sstroese
719c609719bSwdenk- Real-Time Clock:
720c609719bSwdenk
721602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
722c609719bSwdenk		has to be selected, too. Define exactly one of the
723c609719bSwdenk		following options:
724c609719bSwdenk
725c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
726c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7277ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
728c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7291cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
730c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7317f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7323bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7339536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7344c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
736c609719bSwdenk
737b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
738b37c7e5eSwdenk		must also be configured. See I2C Support, below.
739b37c7e5eSwdenk
740e92739d3SPeter Tyser- GPIO Support:
741e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
742e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
743e92739d3SPeter Tyser
744e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
745e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
746e92739d3SPeter Tyser
747c609719bSwdenk- Timestamp Support:
748c609719bSwdenk
749c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
750c609719bSwdenk		(date and time) of an image is printed by image
751c609719bSwdenk		commands like bootm or iminfo. This option is
752602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
753c609719bSwdenk
754c609719bSwdenk- Partition Support:
755c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
75607f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
757c609719bSwdenk
758602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
759218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
760218ca724SWolfgang Denk		least one partition type as well.
761c609719bSwdenk
762c609719bSwdenk- IDE Reset method:
7634d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7644d13cbadSwdenk		board configurations files but used nowhere!
765c609719bSwdenk
7664d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7674d13cbadSwdenk		be performed by calling the function
7684d13cbadSwdenk			ide_set_reset(int reset)
7694d13cbadSwdenk		which has to be defined in a board specific file
770c609719bSwdenk
771c609719bSwdenk- ATAPI Support:
772c609719bSwdenk		CONFIG_ATAPI
773c609719bSwdenk
774c609719bSwdenk		Set this to enable ATAPI support.
775c609719bSwdenk
776c40b2956Swdenk- LBA48 Support
777c40b2956Swdenk		CONFIG_LBA48
778c40b2956Swdenk
779c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7804b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
781c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
782c40b2956Swdenk		support disks up to 2.1TB.
783c40b2956Swdenk
7846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
785c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
786c40b2956Swdenk			Default is 32bit.
787c40b2956Swdenk
788c609719bSwdenk- SCSI Support:
789c609719bSwdenk		At the moment only there is only support for the
790c609719bSwdenk		SYM53C8XX SCSI controller; define
791c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
792c609719bSwdenk
7936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
7946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
7956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
796c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
797c609719bSwdenk		devices.
7986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
799c609719bSwdenk
800c609719bSwdenk- NETWORK Support (PCI):
801682011ffSwdenk		CONFIG_E1000
802682011ffSwdenk		Support for Intel 8254x gigabit chips.
803682011ffSwdenk
804ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
80511ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
806ac3315c2SAndre Schwarz
807c609719bSwdenk		CONFIG_EEPRO100
808c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
80911ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
810c609719bSwdenk		write routine for first time initialisation.
811c609719bSwdenk
812c609719bSwdenk		CONFIG_TULIP
813c609719bSwdenk		Support for Digital 2114x chips.
814c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
815c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
816c609719bSwdenk
817c609719bSwdenk		CONFIG_NATSEMI
818c609719bSwdenk		Support for National dp83815 chips.
819c609719bSwdenk
820c609719bSwdenk		CONFIG_NS8382X
821c609719bSwdenk		Support for National dp8382[01] gigabit chips.
822c609719bSwdenk
82345219c46Swdenk- NETWORK Support (other):
82445219c46Swdenk
825c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
826c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
827c041e9d2SJens Scharsig
828c041e9d2SJens Scharsig			CONFIG_RMII
829c041e9d2SJens Scharsig			Define this to use reduced MII inteface
830c041e9d2SJens Scharsig
831c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
832c041e9d2SJens Scharsig			If this defined, the driver is quiet.
833c041e9d2SJens Scharsig			The driver doen't show link status messages.
834c041e9d2SJens Scharsig
83545219c46Swdenk		CONFIG_DRIVER_LAN91C96
83645219c46Swdenk		Support for SMSC's LAN91C96 chips.
83745219c46Swdenk
83845219c46Swdenk			CONFIG_LAN91C96_BASE
83945219c46Swdenk			Define this to hold the physical address
84045219c46Swdenk			of the LAN91C96's I/O space
84145219c46Swdenk
84245219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
84345219c46Swdenk			Define this to enable 32 bit addressing
84445219c46Swdenk
845f39748aeSwdenk		CONFIG_DRIVER_SMC91111
846f39748aeSwdenk		Support for SMSC's LAN91C111 chip
847f39748aeSwdenk
848f39748aeSwdenk			CONFIG_SMC91111_BASE
849f39748aeSwdenk			Define this to hold the physical address
850f39748aeSwdenk			of the device (I/O space)
851f39748aeSwdenk
852f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
853f39748aeSwdenk			Define this if data bus is 32 bits
854f39748aeSwdenk
855f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
856f39748aeSwdenk			Define this to use i/o functions instead of macros
857f39748aeSwdenk			(some hardware wont work with macros)
858f39748aeSwdenk
859c2fff331SMike Rapoport		CONFIG_SMC911X
860557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
861557b377dSJens Gehrlein
862c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
863557b377dSJens Gehrlein			Define this to hold the physical address
864557b377dSJens Gehrlein			of the device (I/O space)
865557b377dSJens Gehrlein
866c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
867557b377dSJens Gehrlein			Define this if data bus is 32 bits
868557b377dSJens Gehrlein
869c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
870557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
871557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
872c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
873557b377dSJens Gehrlein
874c609719bSwdenk- USB Support:
875c609719bSwdenk		At the moment only the UHCI host controller is
8764d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
877c609719bSwdenk		CONFIG_USB_UHCI to enable it.
878c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
87930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
880c609719bSwdenk		storage devices.
881c609719bSwdenk		Note:
882c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
883c609719bSwdenk		(TEAC FD-05PUB).
8844d13cbadSwdenk		MPC5200 USB requires additional defines:
8854d13cbadSwdenk			CONFIG_USB_CLOCK
8864d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
887307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
888307ecb6dSEric Millbrandt				for USB on PSC3
8894d13cbadSwdenk			CONFIG_USB_CONFIG
8904d13cbadSwdenk				for differential drivers: 0x00001000
8914d13cbadSwdenk				for single ended drivers: 0x00005000
892307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
893307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
8946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
895fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
896fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
8974d13cbadSwdenk
89816c8d5e7SWolfgang Denk- USB Device:
89916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
90016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
90116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
90211ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
90316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
90416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
90516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
90616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
90716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
90816c8d5e7SWolfgang Denk		a Linux host by
90916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
91016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
91116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
91216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
91316c8d5e7SWolfgang Denk
91416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
91516c8d5e7SWolfgang Denk			Define this to build a UDC device
91616c8d5e7SWolfgang Denk
91716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
91816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
91916c8d5e7SWolfgang Denk			talk to the UDC device
92016c8d5e7SWolfgang Denk
9216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
92216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
92316c8d5e7SWolfgang Denk			be set to usbtty.
92416c8d5e7SWolfgang Denk
92516c8d5e7SWolfgang Denk			mpc8xx:
9266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
92716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
92916c8d5e7SWolfgang Denk
9306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
93116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
93316c8d5e7SWolfgang Denk
93416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
93516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
93616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
93716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
93816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
93916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
94016c8d5e7SWolfgang Denk
94116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
94216c8d5e7SWolfgang Denk			Define this string as the name of your company for
94316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
94416c8d5e7SWolfgang Denk
94516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
94616c8d5e7SWolfgang Denk			Define this string as the name of your product
94716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
94816c8d5e7SWolfgang Denk
94916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
95016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
95116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
95216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
95316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
95416c8d5e7SWolfgang Denk
95516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
95616c8d5e7SWolfgang Denk			Define this as the unique Product ID
95716c8d5e7SWolfgang Denk			for your device
95816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
959c609719bSwdenk
960c609719bSwdenk
961c609719bSwdenk- MMC Support:
962c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
963c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
964c609719bSwdenk		accessed from the boot prompt by mapping the device
965c609719bSwdenk		to physical memory similar to flash. Command line is
966602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
967602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
968c609719bSwdenk
9696705d81eSwdenk- Journaling Flash filesystem support:
9706705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9716705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9726705d81eSwdenk		Define these for a default partition on a NAND device
9736705d81eSwdenk
9746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9766705d81eSwdenk		Define these for a default partition on a NOR device
9776705d81eSwdenk
9786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9796705d81eSwdenk		Define this to create an own partition. You have to provide a
9806705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9816705d81eSwdenk
9826705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
9846705d81eSwdenk		to disable the command chpart. This is the default when you
9856705d81eSwdenk		have not defined a custom partition
9866705d81eSwdenk
987c609719bSwdenk- Keyboard Support:
988c609719bSwdenk		CONFIG_ISA_KEYBOARD
989c609719bSwdenk
990c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
991c609719bSwdenk		support
992c609719bSwdenk
993c609719bSwdenk		CONFIG_I8042_KBD
994c609719bSwdenk		Standard PC keyboard driver with US (is default) and
995c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
996c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
997c609719bSwdenk		for cfb_console. Supports cursor blinking.
998c609719bSwdenk
999c609719bSwdenk- Video support:
1000c609719bSwdenk		CONFIG_VIDEO
1001c609719bSwdenk
1002c609719bSwdenk		Define this to enable video support (for output to
1003c609719bSwdenk		video).
1004c609719bSwdenk
1005c609719bSwdenk		CONFIG_VIDEO_CT69000
1006c609719bSwdenk
1007c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1008c609719bSwdenk
1009c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1010eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1011eeb1b77bSwdenk		video output is selected via environment 'videoout'
1012eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1013eeb1b77bSwdenk		assumed.
1014c609719bSwdenk
1015eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
101611ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1017eeb1b77bSwdenk		are possible:
1018eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1019eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1020eeb1b77bSwdenk
1021eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1022eeb1b77bSwdenk		-------------+---------------------------------------------
1023eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1024eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1025eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1026eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1027eeb1b77bSwdenk		-------------+---------------------------------------------
1028c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1029c609719bSwdenk
1030eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10317817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1032eeb1b77bSwdenk
1033eeb1b77bSwdenk
1034a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1035a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1036a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1037a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1038a6c7ad2fSwdenk
1039682011ffSwdenk- Keyboard Support:
1040682011ffSwdenk		CONFIG_KEYBOARD
1041682011ffSwdenk
1042682011ffSwdenk		Define this to enable a custom keyboard support.
1043682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1044682011ffSwdenk		defined in your board-specific files.
1045682011ffSwdenk		The only board using this so far is RBC823.
1046a6c7ad2fSwdenk
1047c609719bSwdenk- LCD Support:	CONFIG_LCD
1048c609719bSwdenk
1049c609719bSwdenk		Define this to enable LCD support (for output to LCD
1050c609719bSwdenk		display); also select one of the supported displays
1051c609719bSwdenk		by defining one of these:
1052c609719bSwdenk
105339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
105439cf4804SStelian Pop
105539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
105639cf4804SStelian Pop
1057fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1058c609719bSwdenk
1059fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1060c609719bSwdenk
1061fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1062c609719bSwdenk
1063fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1064fd3103bbSwdenk			Active, color, single scan.
1065fd3103bbSwdenk
1066fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1067fd3103bbSwdenk
1068fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1069c609719bSwdenk			Active, color, single scan.
1070c609719bSwdenk
1071c609719bSwdenk		CONFIG_SHARP_16x9
1072c609719bSwdenk
1073c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1074c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1075c609719bSwdenk
1076c609719bSwdenk		CONFIG_SHARP_LQ64D341
1077c609719bSwdenk
1078c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1079c609719bSwdenk			Active, color, single scan.
1080c609719bSwdenk
1081c609719bSwdenk		CONFIG_HLD1045
1082c609719bSwdenk
1083c609719bSwdenk			HLD1045 display, 640x480.
1084c609719bSwdenk			Active, color, single scan.
1085c609719bSwdenk
1086c609719bSwdenk		CONFIG_OPTREX_BW
1087c609719bSwdenk
1088c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1089c609719bSwdenk			or
1090c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1091c609719bSwdenk			or
1092c609719bSwdenk			Hitachi	 SP14Q002
1093c609719bSwdenk
1094c609719bSwdenk			320x240. Black & white.
1095c609719bSwdenk
1096c609719bSwdenk		Normally display is black on white background; define
10976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1098c609719bSwdenk
10997152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1100d791b1dcSwdenk
1101d791b1dcSwdenk		If this option is set, the environment is checked for
1102d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1103d791b1dcSwdenk		of logo, copyright and system information on the LCD
1104e94d2cd9Swdenk		is suppressed and the BMP image at the address
1105d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1106d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1107d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1108d791b1dcSwdenk		loaded very quickly after power-on.
1109d791b1dcSwdenk
11101ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
11111ca298ceSMatthias Weisser
11121ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
11131ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
11141ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11151ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11161ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11171ca298ceSMatthias Weisser		specify 'm' for centering the image.
11181ca298ceSMatthias Weisser
11191ca298ceSMatthias Weisser		Example:
11201ca298ceSMatthias Weisser		setenv splashpos m,m
11211ca298ceSMatthias Weisser			=> image at center of screen
11221ca298ceSMatthias Weisser
11231ca298ceSMatthias Weisser		setenv splashpos 30,20
11241ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11251ca298ceSMatthias Weisser
11261ca298ceSMatthias Weisser		setenv splashpos -10,m
11271ca298ceSMatthias Weisser			=> vertically centered image
11281ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11291ca298ceSMatthias Weisser
113098f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
113198f4a3dfSStefan Roese
113298f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
113398f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
113498f4a3dfSStefan Roese		splashscreen support or the bmp command.
113598f4a3dfSStefan Roese
1136*d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1137*d5011762SAnatolij Gustschin
1138*d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1139*d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1140*d5011762SAnatolij Gustschin		bmp command.
1141*d5011762SAnatolij Gustschin
1142c29fdfc1Swdenk- Compression support:
1143c29fdfc1Swdenk		CONFIG_BZIP2
1144c29fdfc1Swdenk
1145c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1146c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1147c29fdfc1Swdenk		compressed images are supported.
1148c29fdfc1Swdenk
1149c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1151c29fdfc1Swdenk		be at least 4MB.
1152d791b1dcSwdenk
1153fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1154fc9c1727SLuigi 'Comio' Mantellini
1155fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1156fc9c1727SLuigi 'Comio' Mantellini		images is included.
1157fc9c1727SLuigi 'Comio' Mantellini
1158fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1159fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1160fc9c1727SLuigi 'Comio' Mantellini		formula:
1161fc9c1727SLuigi 'Comio' Mantellini
1162fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1163fc9c1727SLuigi 'Comio' Mantellini
1164fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1165fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1166fc9c1727SLuigi 'Comio' Mantellini
1167fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1168fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1169fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1170fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1171fc9c1727SLuigi 'Comio' Mantellini
1172fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1173fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1175fc9c1727SLuigi 'Comio' Mantellini
117617ea1177Swdenk- MII/PHY support:
117717ea1177Swdenk		CONFIG_PHY_ADDR
117817ea1177Swdenk
117917ea1177Swdenk		The address of PHY on MII bus.
118017ea1177Swdenk
118117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
118217ea1177Swdenk
118317ea1177Swdenk		The clock frequency of the MII bus
118417ea1177Swdenk
118517ea1177Swdenk		CONFIG_PHY_GIGE
118617ea1177Swdenk
118717ea1177Swdenk		If this option is set, support for speed/duplex
118811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
118917ea1177Swdenk
119017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
119117ea1177Swdenk
119217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
119317ea1177Swdenk		reset before any MII register access is possible.
119417ea1177Swdenk		For such PHY, set this option to the usec delay
119517ea1177Swdenk		required. (minimum 300usec for LXT971A)
119617ea1177Swdenk
119717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
119817ea1177Swdenk
119917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
120017ea1177Swdenk		command issued before MII status register can be read
120117ea1177Swdenk
1202c609719bSwdenk- Ethernet address:
1203c609719bSwdenk		CONFIG_ETHADDR
1204c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1205c609719bSwdenk		CONFIG_ETH2ADDR
1206c609719bSwdenk		CONFIG_ETH3ADDR
1207c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1208c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1209c609719bSwdenk
121011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
121111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1212c609719bSwdenk		is not determined automatically.
1213c609719bSwdenk
1214c609719bSwdenk- IP address:
1215c609719bSwdenk		CONFIG_IPADDR
1216c609719bSwdenk
1217c609719bSwdenk		Define a default value for the IP address to use for
121811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1219c609719bSwdenk		determined through e.g. bootp.
1220c609719bSwdenk
1221c609719bSwdenk- Server IP address:
1222c609719bSwdenk		CONFIG_SERVERIP
1223c609719bSwdenk
1224c609719bSwdenk		Defines a default value for the IP address of a TFTP
1225c609719bSwdenk		server to contact when using the "tftboot" command.
1226c609719bSwdenk
122797cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
122897cfe861SRobin Getz
122997cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
123097cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
123197cfe861SRobin Getz
123253a5c424SDavid Updegraff- Multicast TFTP Mode:
123353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
123453a5c424SDavid Updegraff
123553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
123653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
123711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
123853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
123953a5c424SDavid Updegraff		multicast group.
124053a5c424SDavid Updegraff
124153a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1242c609719bSwdenk- BOOTP Recovery Mode:
1243c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1244c609719bSwdenk
1245c609719bSwdenk		If you have many targets in a network that try to
1246c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1247c609719bSwdenk		systems send out BOOTP requests at precisely the same
1248c609719bSwdenk		moment (which would happen for instance at recovery
1249c609719bSwdenk		from a power failure, when all systems will try to
1250c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1251c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1252c609719bSwdenk		inserted before sending out BOOTP requests. The
12536c33c785SWolfgang Denk		following delays are inserted then:
1254c609719bSwdenk
1255c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1256c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1257c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1258c609719bSwdenk		4th and following
1259c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1260c609719bSwdenk
1261fe389a82Sstroese- DHCP Advanced Options:
12621fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12631fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1264fe389a82Sstroese
12651fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12661fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12671fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12681fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12691fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12701fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12711fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12721fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12731fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12741fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12751fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12761fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1277fe389a82Sstroese
12785d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12795d110f0aSWilson Callan		environment variable, not the BOOTP server.
1280fe389a82Sstroese
1281fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1282fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1283fe389a82Sstroese		than one DNS serverip is offered to the client.
1284fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1285fe389a82Sstroese		serverip will be stored in the additional environment
1286fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1287fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
12881fe80d79SJon Loeliger		is defined.
1289fe389a82Sstroese
1290fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1291fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1292fe389a82Sstroese		need the hostname of the DHCP requester.
12935d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
12941fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
12951fe80d79SJon Loeliger		option 12 to the DHCP server.
1296fe389a82Sstroese
1297d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1298d9a2f416SAras Vaichas
1299d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1300d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1301d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1302d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1303d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1304d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1305d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1306d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1307d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1308d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1309d9a2f416SAras Vaichas		this delay.
1310d9a2f416SAras Vaichas
1311a3d991bdSwdenk - CDP Options:
1312a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1313a3d991bdSwdenk
1314a3d991bdSwdenk		The device id used in CDP trigger frames.
1315a3d991bdSwdenk
1316a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1317a3d991bdSwdenk
1318a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1319a3d991bdSwdenk		of the device.
1320a3d991bdSwdenk
1321a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1322a3d991bdSwdenk
1323a3d991bdSwdenk		A printf format string which contains the ascii name of
1324a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
132511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1326a3d991bdSwdenk
1327a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1328a3d991bdSwdenk
1329a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1330a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1331a3d991bdSwdenk
1332a3d991bdSwdenk		CONFIG_CDP_VERSION
1333a3d991bdSwdenk
1334a3d991bdSwdenk		An ascii string containing the version of the software.
1335a3d991bdSwdenk
1336a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1337a3d991bdSwdenk
1338a3d991bdSwdenk		An ascii string containing the name of the platform.
1339a3d991bdSwdenk
1340a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1341a3d991bdSwdenk
1342a3d991bdSwdenk		A 32bit integer sent on the trigger.
1343a3d991bdSwdenk
1344a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1345a3d991bdSwdenk
1346a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1347a3d991bdSwdenk		device in .1 of milliwatts.
1348a3d991bdSwdenk
1349a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1350a3d991bdSwdenk
1351a3d991bdSwdenk		A byte containing the id of the VLAN.
1352a3d991bdSwdenk
1353c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1354c609719bSwdenk
1355c609719bSwdenk		Several configurations allow to display the current
1356c609719bSwdenk		status using a LED. For instance, the LED will blink
1357c609719bSwdenk		fast while running U-Boot code, stop blinking as
1358c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1359c609719bSwdenk		start blinking slow once the Linux kernel is running
1360c609719bSwdenk		(supported by a status LED driver in the Linux
1361c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1362c609719bSwdenk		feature in U-Boot.
1363c609719bSwdenk
1364c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1365c609719bSwdenk
1366c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1367c609719bSwdenk		on those systems that support this (optional)
1368c609719bSwdenk		feature, like the TQM8xxL modules.
1369c609719bSwdenk
1370c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1371c609719bSwdenk
1372b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1373b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
137411ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1375c609719bSwdenk
1376b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1377602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1378b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1379b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1380c609719bSwdenk		command line interface.
1381c609719bSwdenk
1382bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1383c609719bSwdenk
1384b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1385b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1386b37c7e5eSwdenk		support for I2C.
1387c609719bSwdenk
1388b37c7e5eSwdenk		There are several other quantities that must also be
1389b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1390c609719bSwdenk
13916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1392b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
13936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
139411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1395c609719bSwdenk
1396b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
139711ccc33fSMarcel Ziswiler		sets the CPU up as a master node and so its address should
1398b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
13996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
1400b37c7e5eSwdenk
14015da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
14025da71efaSEric Millbrandt
14035da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
14045da71efaSEric Millbrandt		chips might think that the current transfer is still
14055da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
14065da71efaSEric Millbrandt		commands until the slave device responds.
14075da71efaSEric Millbrandt
1408b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1409b37c7e5eSwdenk
1410b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1411b37c7e5eSwdenk		then the following macros need to be defined (examples are
1412b37c7e5eSwdenk		from include/configs/lwmon.h):
1413c609719bSwdenk
1414c609719bSwdenk		I2C_INIT
1415c609719bSwdenk
1416b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1417c609719bSwdenk		controller or configure ports.
1418c609719bSwdenk
1419b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1420b37c7e5eSwdenk
1421c609719bSwdenk		I2C_PORT
1422c609719bSwdenk
1423c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1424c609719bSwdenk		assumes both bits are on the same port). Valid values
1425c609719bSwdenk		are 0..3 for ports A..D.
1426c609719bSwdenk
1427c609719bSwdenk		I2C_ACTIVE
1428c609719bSwdenk
1429c609719bSwdenk		The code necessary to make the I2C data line active
1430c609719bSwdenk		(driven).  If the data line is open collector, this
1431c609719bSwdenk		define can be null.
1432c609719bSwdenk
1433b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1434b37c7e5eSwdenk
1435c609719bSwdenk		I2C_TRISTATE
1436c609719bSwdenk
1437c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1438c609719bSwdenk		(inactive).  If the data line is open collector, this
1439c609719bSwdenk		define can be null.
1440c609719bSwdenk
1441b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1442b37c7e5eSwdenk
1443c609719bSwdenk		I2C_READ
1444c609719bSwdenk
1445c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1446c609719bSwdenk		FALSE if it is low.
1447c609719bSwdenk
1448b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1449b37c7e5eSwdenk
1450c609719bSwdenk		I2C_SDA(bit)
1451c609719bSwdenk
1452c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1453c609719bSwdenk		is FALSE, it clears it (low).
1454c609719bSwdenk
1455b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1456b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1457b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1458b37c7e5eSwdenk
1459c609719bSwdenk		I2C_SCL(bit)
1460c609719bSwdenk
1461c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1462c609719bSwdenk		is FALSE, it clears it (low).
1463c609719bSwdenk
1464b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1465b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1466b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1467b37c7e5eSwdenk
1468c609719bSwdenk		I2C_DELAY
1469c609719bSwdenk
1470c609719bSwdenk		This delay is invoked four times per clock cycle so this
1471c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1472b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1473b37c7e5eSwdenk		like:
1474b37c7e5eSwdenk
1475b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1476c609719bSwdenk
14776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
147847cd00faSwdenk
147947cd00faSwdenk		When a board is reset during an i2c bus transfer
148047cd00faSwdenk		chips might think that the current transfer is still
148147cd00faSwdenk		in progress. On some boards it is possible to access
148247cd00faSwdenk		the i2c SCLK line directly, either by using the
148347cd00faSwdenk		processor pin as a GPIO or by having a second pin
148447cd00faSwdenk		connected to the bus. If this option is defined a
148547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
148647cd00faSwdenk		is run early in the boot sequence.
148747cd00faSwdenk
148817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
148917ea1177Swdenk
149017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
149117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
149217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
149317ea1177Swdenk
1494bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1495bb99ad6dSBen Warren
1496bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1497bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1498bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1499bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1500bb99ad6dSBen Warren
15016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1502bb99ad6dSBen Warren
1503bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
15040f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
15050f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
15060f89c54bSPeter Tyser		a 1D array of device addresses
1507bb99ad6dSBen Warren
1508bb99ad6dSBen Warren		e.g.
1509bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
15106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1511bb99ad6dSBen Warren
1512bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1513bb99ad6dSBen Warren
1514bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
15156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1516bb99ad6dSBen Warren
1517bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1518bb99ad6dSBen Warren
15196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1520be5e6181STimur Tabi
1521be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1522be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1523be5e6181STimur Tabi
15246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
15250dc018ecSStefan Roese
15260dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
15270dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
15280dc018ecSStefan Roese
15296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15300dc018ecSStefan Roese
15310dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15320dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15330dc018ecSStefan Roese
15346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15359ebbb54fSVictor Gallardo
15369ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15379ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15389ebbb54fSVictor Gallardo		specified DTT device.
15399ebbb54fSVictor Gallardo
1540be5e6181STimur Tabi		CONFIG_FSL_I2C
1541be5e6181STimur Tabi
1542be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15437817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1544be5e6181STimur Tabi
154567b23a32SHeiko Schocher		CONFIG_I2C_MUX
154667b23a32SHeiko Schocher
154767b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
154867b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
154967b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
155067b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
155167b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
155267b23a32SHeiko Schocher		the muxes to activate this new "bus".
155367b23a32SHeiko Schocher
155467b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
155567b23a32SHeiko Schocher		feature!
155667b23a32SHeiko Schocher
155767b23a32SHeiko Schocher		Example:
155867b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
155967b23a32SHeiko Schocher			The First mux with address 70 and channel 6
156067b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
156167b23a32SHeiko Schocher
156267b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
156367b23a32SHeiko Schocher
156467b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
156567b23a32SHeiko Schocher		of I2C Busses with muxes:
156667b23a32SHeiko Schocher
156767b23a32SHeiko Schocher		=> i2c bus
156867b23a32SHeiko Schocher		Busses reached over muxes:
156967b23a32SHeiko Schocher		Bus ID: 2
157067b23a32SHeiko Schocher		  reached over Mux(es):
157167b23a32SHeiko Schocher		    pca9544a@70 ch: 4
157267b23a32SHeiko Schocher		Bus ID: 3
157367b23a32SHeiko Schocher		  reached over Mux(es):
157467b23a32SHeiko Schocher		    pca9544a@70 ch: 6
157567b23a32SHeiko Schocher		    pca9544a@71 ch: 4
157667b23a32SHeiko Schocher		=>
157767b23a32SHeiko Schocher
157867b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
157967b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
158067b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
158167b23a32SHeiko Schocher		the channel 4.
158267b23a32SHeiko Schocher
158367b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
158467b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
158567b23a32SHeiko Schocher		the 2 muxes.
158667b23a32SHeiko Schocher
158767b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
158867b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
158967b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
159067b23a32SHeiko Schocher		to add this option to other architectures.
159167b23a32SHeiko Schocher
15922ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
15932ac6985aSAndrew Dyer
15942ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
15952ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
15962ac6985aSAndrew Dyer		between writing the address pointer and reading the
15972ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
15982ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
15992ac6985aSAndrew Dyer		devices can use either method, but some require one or
16002ac6985aSAndrew Dyer		the other.
1601be5e6181STimur Tabi
1602c609719bSwdenk- SPI Support:	CONFIG_SPI
1603c609719bSwdenk
1604c609719bSwdenk		Enables SPI driver (so far only tested with
1605c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1606c609719bSwdenk		D/As on the SACSng board)
1607c609719bSwdenk
1608c609719bSwdenk		CONFIG_SPI_X
1609c609719bSwdenk
1610c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1611c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1612c609719bSwdenk
1613c609719bSwdenk		CONFIG_SOFT_SPI
1614c609719bSwdenk
1615c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1616c609719bSwdenk		using hardware support. This is a general purpose
1617c609719bSwdenk		driver that only requires three general I/O port pins
1618c609719bSwdenk		(two outputs, one input) to function. If this is
1619c609719bSwdenk		defined, the board configuration must define several
1620c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1621c609719bSwdenk		an example, see include/configs/sacsng.h.
1622c609719bSwdenk
162304a9e118SBen Warren		CONFIG_HARD_SPI
162404a9e118SBen Warren
162504a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
162604a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
162704a9e118SBen Warren		must define a list of chip-select function pointers.
162804a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
162904a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
163004a9e118SBen Warren
163138254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
163238254f45SGuennadi Liakhovetski
163338254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
163438254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
163538254f45SGuennadi Liakhovetski
16360133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16370133502eSMatthias Fuchs
16380133502eSMatthias Fuchs		Enables FPGA subsystem.
16390133502eSMatthias Fuchs
16400133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16410133502eSMatthias Fuchs
16420133502eSMatthias Fuchs		Enables support for specific chip vendors.
16430133502eSMatthias Fuchs		(ALTERA, XILINX)
16440133502eSMatthias Fuchs
16450133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16460133502eSMatthias Fuchs
16470133502eSMatthias Fuchs		Enables support for FPGA family.
16480133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16490133502eSMatthias Fuchs
16500133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1651c609719bSwdenk
1652c609719bSwdenk		Specify the number of FPGA devices to support.
1653c609719bSwdenk
16546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1655c609719bSwdenk
1656c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1657c609719bSwdenk
16586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1659c609719bSwdenk
1660c609719bSwdenk		Enable checks on FPGA configuration interface busy
1661c609719bSwdenk		status by the configuration function. This option
1662c609719bSwdenk		will require a board or device specific function to
1663c609719bSwdenk		be written.
1664c609719bSwdenk
1665c609719bSwdenk		CONFIG_FPGA_DELAY
1666c609719bSwdenk
1667c609719bSwdenk		If defined, a function that provides delays in the FPGA
1668c609719bSwdenk		configuration driver.
1669c609719bSwdenk
16706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1671c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1672c609719bSwdenk
16736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1674c609719bSwdenk
1675c609719bSwdenk		Check for configuration errors during FPGA bitfile
1676c609719bSwdenk		loading. For example, abort during Virtex II
1677c609719bSwdenk		configuration if the INIT_B line goes low (which
1678c609719bSwdenk		indicated a CRC error).
1679c609719bSwdenk
16806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1681c609719bSwdenk
1682c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1683c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1684c609719bSwdenk		FPGA configuration sequence. The default time is 500
168511ccc33fSMarcel Ziswiler		ms.
1686c609719bSwdenk
16876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1688c609719bSwdenk
1689c609719bSwdenk		Maximum time to wait for BUSY to deassert during
169011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1691c609719bSwdenk
16926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1693c609719bSwdenk
1694c609719bSwdenk		Time to wait after FPGA configuration. The default is
169511ccc33fSMarcel Ziswiler		200 ms.
1696c609719bSwdenk
1697c609719bSwdenk- Configuration Management:
1698c609719bSwdenk		CONFIG_IDENT_STRING
1699c609719bSwdenk
1700c609719bSwdenk		If defined, this string will be added to the U-Boot
1701c609719bSwdenk		version information (U_BOOT_VERSION)
1702c609719bSwdenk
1703c609719bSwdenk- Vendor Parameter Protection:
1704c609719bSwdenk
1705c609719bSwdenk		U-Boot considers the values of the environment
1706c609719bSwdenk		variables "serial#" (Board Serial Number) and
17077152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1708c609719bSwdenk		are set once by the board vendor / manufacturer, and
1709c609719bSwdenk		protects these variables from casual modification by
1710c609719bSwdenk		the user. Once set, these variables are read-only,
1711c609719bSwdenk		and write or delete attempts are rejected. You can
171211ccc33fSMarcel Ziswiler		change this behaviour:
1713c609719bSwdenk
1714c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1715c609719bSwdenk		file, the write protection for vendor parameters is
171647cd00faSwdenk		completely disabled. Anybody can change or delete
1717c609719bSwdenk		these parameters.
1718c609719bSwdenk
1719c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1720c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
172111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1722c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1723c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1724c609719bSwdenk		read-only.]
1725c609719bSwdenk
1726c609719bSwdenk- Protected RAM:
1727c609719bSwdenk		CONFIG_PRAM
1728c609719bSwdenk
1729c609719bSwdenk		Define this variable to enable the reservation of
1730c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1731c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1732c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1733c609719bSwdenk		this default value by defining an environment
1734c609719bSwdenk		variable "pram" to the number of kB you want to
1735c609719bSwdenk		reserve. Note that the board info structure will
1736c609719bSwdenk		still show the full amount of RAM. If pRAM is
1737c609719bSwdenk		reserved, a new environment variable "mem" will
1738c609719bSwdenk		automatically be defined to hold the amount of
1739c609719bSwdenk		remaining RAM in a form that can be passed as boot
1740c609719bSwdenk		argument to Linux, for instance like that:
1741c609719bSwdenk
1742fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1743c609719bSwdenk			saveenv
1744c609719bSwdenk
1745c609719bSwdenk		This way you can tell Linux not to use this memory,
1746c609719bSwdenk		either, which results in a memory region that will
1747c609719bSwdenk		not be affected by reboots.
1748c609719bSwdenk
1749c609719bSwdenk		*WARNING* If your board configuration uses automatic
1750c609719bSwdenk		detection of the RAM size, you must make sure that
1751c609719bSwdenk		this memory test is non-destructive. So far, the
1752c609719bSwdenk		following board configurations are known to be
1753c609719bSwdenk		"pRAM-clean":
1754c609719bSwdenk
1755c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1756c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1757c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1758c609719bSwdenk
1759c609719bSwdenk- Error Recovery:
1760c609719bSwdenk		CONFIG_PANIC_HANG
1761c609719bSwdenk
1762c609719bSwdenk		Define this variable to stop the system in case of a
1763c609719bSwdenk		fatal error, so that you have to reset it manually.
1764c609719bSwdenk		This is probably NOT a good idea for an embedded
176511ccc33fSMarcel Ziswiler		system where you want the system to reboot
1766c609719bSwdenk		automatically as fast as possible, but it may be
1767c609719bSwdenk		useful during development since you can try to debug
1768c609719bSwdenk		the conditions that lead to the situation.
1769c609719bSwdenk
1770c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1771c609719bSwdenk
1772c609719bSwdenk		This variable defines the number of retries for
1773c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1774c609719bSwdenk		before giving up the operation. If not defined, a
1775c609719bSwdenk		default value of 5 is used.
1776c609719bSwdenk
177740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
177840cb90eeSGuennadi Liakhovetski
177940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
178040cb90eeSGuennadi Liakhovetski
1781c609719bSwdenk- Command Interpreter:
17828078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
178304a85b3bSwdenk
178404a85b3bSwdenk		Enable auto completion of commands using TAB.
178504a85b3bSwdenk
17868078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
17878078f1a5SWolfgang Denk		for the "hush" shell.
17888078f1a5SWolfgang Denk
17898078f1a5SWolfgang Denk
17906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1791c609719bSwdenk
1792c609719bSwdenk		Define this variable to enable the "hush" shell (from
1793c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1794c609719bSwdenk		powerful command line syntax like
1795c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1796c609719bSwdenk		constructs ("shell scripts").
1797c609719bSwdenk
1798c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1799c609719bSwdenk		with a somewhat smaller memory footprint.
1800c609719bSwdenk
1801c609719bSwdenk
18026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1803c609719bSwdenk
1804c609719bSwdenk		This defines the secondary prompt string, which is
1805c609719bSwdenk		printed when the command interpreter needs more input
1806c609719bSwdenk		to complete a command. Usually "> ".
1807c609719bSwdenk
1808c609719bSwdenk	Note:
1809c609719bSwdenk
1810c609719bSwdenk		In the current implementation, the local variables
1811c609719bSwdenk		space and global environment variables space are
1812c609719bSwdenk		separated. Local variables are those you define by
18133b57fe0aSwdenk		simply typing `name=value'. To access a local
1814c609719bSwdenk		variable later on, you have write `$name' or
18153b57fe0aSwdenk		`${name}'; to execute the contents of a variable
18163b57fe0aSwdenk		directly type `$name' at the command prompt.
1817c609719bSwdenk
1818c609719bSwdenk		Global environment variables are those you use
1819c609719bSwdenk		setenv/printenv to work with. To run a command stored
1820c609719bSwdenk		in such a variable, you need to use the run command,
1821c609719bSwdenk		and you must not use the '$' sign to access them.
1822c609719bSwdenk
1823c609719bSwdenk		To store commands and special characters in a
1824c609719bSwdenk		variable, please use double quotation marks
1825c609719bSwdenk		surrounding the whole text of the variable, instead
1826c609719bSwdenk		of the backslashes before semicolons and special
1827c609719bSwdenk		symbols.
1828c609719bSwdenk
1829aa0c71acSWolfgang Denk- Commandline Editing and History:
1830aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1831aa0c71acSWolfgang Denk
183211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1833aa0c71acSWolfgang Denk		commandline input operations
1834aa0c71acSWolfgang Denk
1835a8c7c708Swdenk- Default Environment:
1836c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1837c609719bSwdenk
1838c609719bSwdenk		Define this to contain any number of null terminated
1839c609719bSwdenk		strings (variable = value pairs) that will be part of
18407152b1d0Swdenk		the default environment compiled into the boot image.
18412262cfeeSwdenk
1842c609719bSwdenk		For example, place something like this in your
1843c609719bSwdenk		board's config file:
1844c609719bSwdenk
1845c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1846c609719bSwdenk			"myvar1=value1\0" \
1847c609719bSwdenk			"myvar2=value2\0"
1848c609719bSwdenk
1849c609719bSwdenk		Warning: This method is based on knowledge about the
1850c609719bSwdenk		internal format how the environment is stored by the
18512262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1852c609719bSwdenk		interface! Although it is unlikely that this format
18537152b1d0Swdenk		will change soon, there is no guarantee either.
1854c609719bSwdenk		You better know what you are doing here.
1855c609719bSwdenk
1856c609719bSwdenk		Note: overly (ab)use of the default environment is
1857c609719bSwdenk		discouraged. Make sure to check other ways to preset
185874de7aefSWolfgang Denk		the environment like the "source" command or the
1859c609719bSwdenk		boot command first.
1860c609719bSwdenk
1861a8c7c708Swdenk- DataFlash Support:
18622abbe075Swdenk		CONFIG_HAS_DATAFLASH
18632abbe075Swdenk
18642abbe075Swdenk		Defining this option enables DataFlash features and
18652abbe075Swdenk		allows to read/write in Dataflash via the standard
18662abbe075Swdenk		commands cp, md...
18672abbe075Swdenk
18683f85ce27Swdenk- SystemACE Support:
18693f85ce27Swdenk		CONFIG_SYSTEMACE
18703f85ce27Swdenk
18713f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
18723f85ce27Swdenk		chips attached via some sort of local bus. The address
187311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
18746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
18753f85ce27Swdenk
18763f85ce27Swdenk		#define CONFIG_SYSTEMACE
18776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
18783f85ce27Swdenk
18793f85ce27Swdenk		When SystemACE support is added, the "ace" device type
18803f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
18813f85ce27Swdenk
1882ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1883ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1884ecb0ccd9SWolfgang Denk
188528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1886ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
188728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1888ecb0ccd9SWolfgang Denk		number generator is used.
1889ecb0ccd9SWolfgang Denk
189028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
189128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
189228cb9375SWolfgang Denk		defined, the normal port 69 is used.
189328cb9375SWolfgang Denk
189428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1895ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1896ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1897ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1898ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1899ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1900ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1901ecb0ccd9SWolfgang Denk
1902a8c7c708Swdenk- Show boot progress:
1903c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1904c609719bSwdenk
1905c609719bSwdenk		Defining this option allows to add some board-
1906c609719bSwdenk		specific code (calling a user-provided function
1907c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1908c609719bSwdenk		the system's boot progress on some display (for
1909c609719bSwdenk		example, some LED's) on your board. At the moment,
1910c609719bSwdenk		the following checkpoints are implemented:
1911c609719bSwdenk
19121372cce2SMarian BalakowiczLegacy uImage format:
19131372cce2SMarian Balakowicz
1914c609719bSwdenk  Arg	Where			When
1915c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1916c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1917c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1918c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1919c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1920c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1921c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1922c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1923c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19241372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1925c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1926c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1927c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1928c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19291372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1930c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19311372cce2SMarian Balakowicz
19321372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19331372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19341372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19351372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19361372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19371372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19381372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
193911ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19401372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19411372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19421372cce2SMarian Balakowicz
19431372cce2SMarian Balakowicz   15	lib_<arch>/bootm.c	All preparation done, transferring control to OS
1944c609719bSwdenk
194563e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
194663e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
194763e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
194863e73c9aSwdenk
1949566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1950566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1951566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1952566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1953566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1954566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1955566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1956566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1957566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1958566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1959566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1960566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1961566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1962566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1963566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1964566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1965566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1966566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1967566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1968566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1969566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1970566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1971566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1972566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1973566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1974566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1975566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1976566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1977566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1978566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1979566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1980566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1981566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1982566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1983566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1984566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1985566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1986566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1987566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1988566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1989566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1990566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1991566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1992566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1993566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1994566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1995566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1996c609719bSwdenk
1997566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1998c609719bSwdenk
1999566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2000566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2001566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2002206c60cbSwdenk
2003566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2004566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
200511ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2006566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2007566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2008566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
200974de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
201074de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2011566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2012c609719bSwdenk
20131372cce2SMarian BalakowiczFIT uImage format:
20141372cce2SMarian Balakowicz
20151372cce2SMarian Balakowicz  Arg	Where			When
20161372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20171372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20181372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20191372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20201372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20211372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2022f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20231372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20241372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20251372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20261372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20271372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
202811ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
202911ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20301372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20311372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20321372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20331372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20341372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20351372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20361372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20371372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20381372cce2SMarian Balakowicz
20391372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20401372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20411372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
204211ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20431372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20441372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20451372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20461372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20471372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20481372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20491372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20501372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20511372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20521372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20531372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20541372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20551372cce2SMarian Balakowicz
205611ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20571372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20581372cce2SMarian Balakowicz
205911ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20601372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20611372cce2SMarian Balakowicz
206211ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20631372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20641372cce2SMarian Balakowicz
2065cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2066cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2067cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2068cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2069cccfc2abSDetlev Zundel
2070cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2071cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2072cccfc2abSDetlev Zundel
2073cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2074cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2075cccfc2abSDetlev Zundel
2076cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2077cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2078cccfc2abSDetlev Zundel
2079cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2080cccfc2abSDetlev Zundel
2081cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2082cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2083cccfc2abSDetlev Zundel
20841372cce2SMarian Balakowicz
2085c609719bSwdenkModem Support:
2086c609719bSwdenk--------------
2087c609719bSwdenk
208885ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2089c609719bSwdenk
209011ccc33fSMarcel Ziswiler- Modem support enable:
2091c609719bSwdenk		CONFIG_MODEM_SUPPORT
2092c609719bSwdenk
2093c609719bSwdenk- RTS/CTS Flow control enable:
2094c609719bSwdenk		CONFIG_HWFLOW
2095c609719bSwdenk
2096c609719bSwdenk- Modem debug support:
2097c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2098c609719bSwdenk
2099c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2100c609719bSwdenk		for modem support. Useful only with BDI2000.
2101c609719bSwdenk
2102a8c7c708Swdenk- Interrupt support (PPC):
2103a8c7c708Swdenk
2104a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2105a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
210611ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2107a8c7c708Swdenk		should set decrementer_count to appropriate value. If
210811ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2109a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
211011ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2111a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2112a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2113a8c7c708Swdenk		general timer_interrupt().
2114a8c7c708Swdenk
2115c609719bSwdenk- General:
2116c609719bSwdenk
2117c609719bSwdenk		In the target system modem support is enabled when a
2118c609719bSwdenk		specific key (key combination) is pressed during
2119c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
212011ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2121c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2122c609719bSwdenk		function, returning 1 and thus enabling modem
2123c609719bSwdenk		initialization.
2124c609719bSwdenk
2125c609719bSwdenk		If there are no modem init strings in the
2126c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2127c609719bSwdenk		previous output (banner, info printfs) will be
212811ccc33fSMarcel Ziswiler		suppressed, though.
2129c609719bSwdenk
2130c609719bSwdenk		See also: doc/README.Modem
2131c609719bSwdenk
2132c609719bSwdenk
2133c609719bSwdenkConfiguration Settings:
2134c609719bSwdenk-----------------------
2135c609719bSwdenk
21366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2137c609719bSwdenk		undefine this when you're short of memory.
2138c609719bSwdenk
21392fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21402fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21412fb2604dSPeter Tyser
21426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2143c609719bSwdenk		prompt for user input.
2144c609719bSwdenk
21456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2146c609719bSwdenk
21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2148c609719bSwdenk
21496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2150c609719bSwdenk
21516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2152c609719bSwdenk		the application (usually a Linux kernel) when it is
2153c609719bSwdenk		booted
2154c609719bSwdenk
21556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2156c609719bSwdenk		List of legal baudrate settings for this board.
2157c609719bSwdenk
21586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2159c609719bSwdenk		Suppress display of console information at boot.
2160c609719bSwdenk
21616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2162c609719bSwdenk		If the board specific function
2163c609719bSwdenk			extern int overwrite_console (void);
2164c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2165c609719bSwdenk		serial port, else the settings in the environment are used.
2166c609719bSwdenk
21676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2168c609719bSwdenk		Enable the call to overwrite_console().
2169c609719bSwdenk
21706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2171c609719bSwdenk		Enable overwrite of previous console environment settings.
2172c609719bSwdenk
21736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2174c609719bSwdenk		Begin and End addresses of the area used by the
2175c609719bSwdenk		simple memory test.
2176c609719bSwdenk
21776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2178c609719bSwdenk		Enable an alternate, more extensive memory test.
2179c609719bSwdenk
21806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
21815f535fe1Swdenk		Scratch address used by the alternate memory test
21825f535fe1Swdenk		You only need to set this if address zero isn't writeable
21835f535fe1Swdenk
21846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
21856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
218614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
218711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
218814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
218914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
219014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
21915e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
219214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
21935e12e75dSStefan Roese		will have to get fixed in Linux additionally.
219414f73ca6SStefan Roese
219514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
219614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
219714f73ca6SStefan Roese		be touched.
219814f73ca6SStefan Roese
219914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
220014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
220114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
220214f73ca6SStefan Roese		non page size aligned address and this could cause major
220314f73ca6SStefan Roese		problems.
220414f73ca6SStefan Roese
22056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2206c609719bSwdenk		Default load address for network file downloads
2207c609719bSwdenk
22086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2209c609719bSwdenk		Enable temporary baudrate change while serial download
2210c609719bSwdenk
22116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2212c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2213c609719bSwdenk
22146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2215c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2216c609719bSwdenk		Cogent motherboard)
2217c609719bSwdenk
22186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2219c609719bSwdenk		Physical start address of Flash memory.
2220c609719bSwdenk
22216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2222c609719bSwdenk		Physical start address of boot monitor code (set by
2223c609719bSwdenk		make config files to be same as the text base address
2224c609719bSwdenk		(TEXT_BASE) used when linking) - same as
22256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2226c609719bSwdenk
22276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
22283b57fe0aSwdenk		Size of memory reserved for monitor code, used to
22293b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22303b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22313b57fe0aSwdenk		flash sector.
2232c609719bSwdenk
22336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2234c609719bSwdenk		Size of DRAM reserved for malloc() use.
2235c609719bSwdenk
22366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
223715940c9aSStefan Roese		Normally compressed uImages are limited to an
223815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
224015940c9aSStefan Roese		to adjust this setting to your needs.
2241c609719bSwdenk
22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2243c609719bSwdenk		Maximum size of memory mapped by the startup code of
2244c609719bSwdenk		the Linux kernel; all data that must be processed by
22457d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22467d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22477d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22487d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2250c609719bSwdenk
22516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2252c609719bSwdenk		Max number of Flash memory banks
2253c609719bSwdenk
22546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2255c609719bSwdenk		Max number of sectors on a Flash chip
2256c609719bSwdenk
22576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2258c609719bSwdenk		Timeout for Flash erase operations (in ms)
2259c609719bSwdenk
22606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2261c609719bSwdenk		Timeout for Flash write operations (in ms)
2262c609719bSwdenk
22636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
22648564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
22658564acf9Swdenk
22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
22678564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
22688564acf9Swdenk
22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
22708564acf9Swdenk		If defined, hardware flash sectors protection is used
22718564acf9Swdenk		instead of U-Boot software protection.
22728564acf9Swdenk
22736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2274c609719bSwdenk
2275c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2276c609719bSwdenk		without this option such a download has to be
2277c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2278c609719bSwdenk		copy from RAM to flash.
2279c609719bSwdenk
2280c609719bSwdenk		The two-step approach is usually more reliable, since
2281c609719bSwdenk		you can check if the download worked before you erase
228211ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
228311ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2284c609719bSwdenk		downloaded image) this option may be very useful.
2285c609719bSwdenk
22866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2287c609719bSwdenk		Define if the flash driver uses extra elements in the
22885653fc33Swdenk		common flash structure for storing flash geometry.
22895653fc33Swdenk
229000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
22915653fc33Swdenk		This option also enables the building of the cfi_flash driver
22925653fc33Swdenk		in the drivers directory
229353cf9435Sstroese
229491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
229591809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
229691809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
229791809ed5SPiotr Ziecik		to the MTD layer.
229891809ed5SPiotr Ziecik
22996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
230096ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
230196ef831fSGuennadi Liakhovetski
230296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
230396ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
230496ef831fSGuennadi Liakhovetski		write commands.
230596ef831fSGuennadi Liakhovetski
23066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
23075568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
23085568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
23095568e613SStefan Roese		is useful, if some of the configured banks are only
23105568e613SStefan Roese		optionally available.
23115568e613SStefan Roese
23129a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
23139a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
23149a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
23159a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
23169a042e9cSJerry Van Baren
23176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
231811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
231911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
232053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
232153cf9435Sstroese		buffers can be full shortly after enabling the interface
232211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
232353cf9435Sstroese		Defaults to 4 if not defined.
2324c609719bSwdenk
2325c609719bSwdenkThe following definitions that deal with the placement and management
2326c609719bSwdenkof environment data (variable area); in general, we support the
2327c609719bSwdenkfollowing configurations:
2328c609719bSwdenk
23295a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2330c609719bSwdenk
2331c609719bSwdenk	Define this if the environment is in flash memory.
2332c609719bSwdenk
2333c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2334c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2335c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2336c609719bSwdenk	   sector" type flash chips, which have several smaller
2337c609719bSwdenk	   sectors at the start or the end. For instance, such a
2338c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2339c609719bSwdenk	   such a case you would place the environment in one of the
2340c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2341c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2342c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2343c609719bSwdenk	   between U-Boot and the environment.
2344c609719bSwdenk
23450e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2346c609719bSwdenk
2347c609719bSwdenk	   Offset of environment data (variable area) to the
2348c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2349c609719bSwdenk	   type flash chips the second sector can be used: the offset
2350c609719bSwdenk	   for this sector is given here.
2351c609719bSwdenk
23526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2353c609719bSwdenk
23540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2355c609719bSwdenk
2356c609719bSwdenk	   This is just another way to specify the start address of
2357c609719bSwdenk	   the flash sector containing the environment (instead of
23580e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2359c609719bSwdenk
23600e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2361c609719bSwdenk
2362c609719bSwdenk	   Size of the sector containing the environment.
2363c609719bSwdenk
2364c609719bSwdenk
2365c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2366c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2367c609719bSwdenk	   the environment.
2368c609719bSwdenk
23690e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2370c609719bSwdenk
23715a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
23720e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2373c609719bSwdenk	   of this flash sector for the environment. This saves
2374c609719bSwdenk	   memory for the RAM copy of the environment.
2375c609719bSwdenk
2376c609719bSwdenk	   It may also save flash memory if you decide to use this
2377c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2378c609719bSwdenk	   since then the remainder of the flash sector could be used
2379c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2380c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2381c609719bSwdenk	   updating the environment in flash makes it always
2382c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2383c609719bSwdenk	   wrong before the contents has been restored from a copy in
2384c609719bSwdenk	   RAM, your target system will be dead.
2385c609719bSwdenk
23860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
23870e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2388c609719bSwdenk
2389c609719bSwdenk	   These settings describe a second storage area used to hold
239011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
23913e38691eSwdenk	   a valid backup copy in case there is a power failure during
2392c609719bSwdenk	   a "saveenv" operation.
2393c609719bSwdenk
2394c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2395c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2396c609719bSwdenkaccordingly!
2397c609719bSwdenk
2398c609719bSwdenk
23999314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2400c609719bSwdenk
2401c609719bSwdenk	Define this if you have some non-volatile memory device
2402c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2403c609719bSwdenk	environment.
2404c609719bSwdenk
24050e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2407c609719bSwdenk
240811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2409c609719bSwdenk	  want to use for environment. It is assumed that this memory
2410c609719bSwdenk	  can just be read and written to, without any special
2411c609719bSwdenk	  provision.
2412c609719bSwdenk
2413c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2414c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
241511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2416c609719bSwdenkU-Boot will hang.
2417c609719bSwdenk
2418c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2419c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2420c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2421c609719bSwdenkto save the current settings.
2422c609719bSwdenk
2423c609719bSwdenk
2424bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2425c609719bSwdenk
2426c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2427c609719bSwdenk	device and a driver for it.
2428c609719bSwdenk
24290e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2431c609719bSwdenk
2432c609719bSwdenk	  These two #defines specify the offset and size of the
2433c609719bSwdenk	  environment area within the total memory of your EEPROM.
2434c609719bSwdenk
24356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2436c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2437c609719bSwdenk	  The default address is zero.
2438c609719bSwdenk
24396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2440c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2441c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2442c609719bSwdenk	  would require six bits.
2443c609719bSwdenk
24446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2445c609719bSwdenk	  If defined, the number of milliseconds to delay between
2446c609719bSwdenk	  page writes.	The default is zero milliseconds.
2447c609719bSwdenk
24486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2449c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2450c609719bSwdenk	  that this is NOT the chip address length!
2451c609719bSwdenk
24526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
24535cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
24545cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
24555cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
24565cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
24575cf91d6bSwdenk	  byte chips.
24585cf91d6bSwdenk
24595cf91d6bSwdenk	  Note that we consider the length of the address field to
24605cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
24615cf91d6bSwdenk	  in the chip address.
24625cf91d6bSwdenk
24636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2464c609719bSwdenk	  The size in bytes of the EEPROM device.
2465c609719bSwdenk
2466548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
2467548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
2468548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
2469548738b4SHeiko Schocher
2470548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
2471548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
2472548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
2473548738b4SHeiko Schocher	  EEPROM. For example:
2474548738b4SHeiko Schocher
2475548738b4SHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
2476548738b4SHeiko Schocher
2477548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
2478548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
2479c609719bSwdenk
2480057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
24815779d8d9Swdenk
24825779d8d9Swdenk	Define this if you have a DataFlash memory device which you
24835779d8d9Swdenk	want to use for the environment.
24845779d8d9Swdenk
24850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24860e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24870e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
24885779d8d9Swdenk
24895779d8d9Swdenk	  These three #defines specify the offset and size of the
24905779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
24915779d8d9Swdenk	  at the specified address.
24925779d8d9Swdenk
249351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
249413a5695bSwdenk
249513a5695bSwdenk	Define this if you have a NAND device which you want to use
249613a5695bSwdenk	for the environment.
249713a5695bSwdenk
24980e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
250013a5695bSwdenk
250113a5695bSwdenk	  These two #defines specify the offset and size of the environment
250213a5695bSwdenk	  area within the first NAND device.
25035779d8d9Swdenk
25040e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2505e443c944SMarkus Klotzbuecher
25060e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2507e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2508e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2509e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2510e443c944SMarkus Klotzbuecher
25110e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
25120e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2513e443c944SMarkus Klotzbuecher	the NAND devices block size.
2514e443c944SMarkus Klotzbuecher
2515b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2516b74ab737SGuennadi Liakhovetski
2517b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2518b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2519b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2520b74ab737SGuennadi Liakhovetski
25216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2522c609719bSwdenk
2523c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2524c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2525c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2526c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2527c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2528c609719bSwdenk	to be a good choice since it makes it far enough from the
2529c609719bSwdenk	start of the data area as well as from the stack pointer.
2530c609719bSwdenk
2531e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2532c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2533c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2534c609719bSwdenkuntil then to read environment variables.
2535c609719bSwdenk
253685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
253785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
253885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
253985ec0bccSwdenknecessary, because the first environment variable we need is the
254085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
254185ec0bccSwdenkhave any device yet where we could complain.]
2542c609719bSwdenk
2543c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2544c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
254585ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2546c609719bSwdenk
25476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2548fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2549fc3e2165Swdenk
25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2551fc3e2165Swdenk		      also needs to be defined.
2552fc3e2165Swdenk
25536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2554fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2555c609719bSwdenk
2556f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2557f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2558f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2559f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2560f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2561f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2562f5675aa5SRon Madrid
2563c609719bSwdenkLow Level (hardware related) configuration options:
2564dc7c9a1aSwdenk---------------------------------------------------
2565c609719bSwdenk
25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2567c609719bSwdenk		Cache Line Size of the CPU.
2568c609719bSwdenk
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2570c609719bSwdenk		Default address of the IMMR after system reset.
25712535d602Swdenk
25722535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
25732535d602Swdenk		and RPXsuper) to be able to adjust the position of
25742535d602Swdenk		the IMMR register after a reset.
2575c609719bSwdenk
25767f6c2cbcSwdenk- Floppy Disk Support:
25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
25787f6c2cbcSwdenk
25797f6c2cbcSwdenk		the default drive number (default value 0)
25807f6c2cbcSwdenk
25816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
25827f6c2cbcSwdenk
258311ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
25847f6c2cbcSwdenk		(default value 1)
25857f6c2cbcSwdenk
25866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
25877f6c2cbcSwdenk
25887f6c2cbcSwdenk		defines the offset of register from address. It
25897f6c2cbcSwdenk		depends on which part of the data bus is connected to
259011ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
25917f6c2cbcSwdenk
25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
25936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
25947f6c2cbcSwdenk		default value.
25957f6c2cbcSwdenk
25966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
25977f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
25987f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
25997f6c2cbcSwdenk		source code. It is used to make hardware dependant
26007f6c2cbcSwdenk		initializations.
26017f6c2cbcSwdenk
26026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
260325d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
260425d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2605c609719bSwdenk
26066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2607c609719bSwdenk
26087152b1d0Swdenk		Start address of memory area that can be used for
2609c609719bSwdenk		initial data and stack; please note that this must be
2610c609719bSwdenk		writable memory that is working WITHOUT special
2611c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2612c609719bSwdenk		will become available only after programming the
2613c609719bSwdenk		memory controller and running certain initialization
2614c609719bSwdenk		sequences.
2615c609719bSwdenk
2616c609719bSwdenk		U-Boot uses the following memory types:
2617c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2618c609719bSwdenk		- MPC824X: data cache
2619c609719bSwdenk		- PPC4xx:  data cache
2620c609719bSwdenk
26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2622c609719bSwdenk
2623c609719bSwdenk		Offset of the initial data structure in the memory
26246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
26256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2626c609719bSwdenk		data is located at the end of the available space
26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
26286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
26296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2631c609719bSwdenk
2632c609719bSwdenk	Note:
2633c609719bSwdenk		On the MPC824X (or other systems that use the data
2634c609719bSwdenk		cache for initial memory) the address chosen for
26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2636c609719bSwdenk		point to an otherwise UNUSED address space between
2637c609719bSwdenk		the top of RAM and the start of the PCI space.
2638c609719bSwdenk
26396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2640c609719bSwdenk
26416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2642c609719bSwdenk
26436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2644c609719bSwdenk
26456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2646c609719bSwdenk
26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2648c609719bSwdenk
26496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2650c609719bSwdenk
26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2652c609719bSwdenk		SDRAM timing
2653c609719bSwdenk
26546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2655c609719bSwdenk		periodic timer for refresh
2656c609719bSwdenk
26576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2658c609719bSwdenk
26596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
26616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
26626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2663c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2664c609719bSwdenk
2665c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
26666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2668c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2669c609719bSwdenk
26706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
26716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2672c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2673c609719bSwdenk		Prescaler definitions (SDRAM timing)
2674c609719bSwdenk
26756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2676c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2677c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2678c609719bSwdenk
26796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2680b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2681b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2682b423d055SHeiko Schocher
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2684c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2685c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2686c609719bSwdenk
26876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2688c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2689c609719bSwdenk		wrong setting might damage your board. Read
2690c609719bSwdenk		doc/README.MBX before setting this variable!
2691c609719bSwdenk
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2693ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2694ea909b76Swdenk		(Power On Self Tests). This definition overrides
2695ea909b76Swdenk		#define'd default value in commproc.h resp.
2696ea909b76Swdenk		cpm_8260.h.
2697ea909b76Swdenk
26986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
26996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
27006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
27016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
27026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
27036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
27046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
27056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
27065d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
27075d232d0eSwdenk
27089cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
27099cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
27109cacf4fcSDirk Eibach		required.
27119cacf4fcSDirk Eibach
2712bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2713218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2714218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2715218ca724SWolfgang Denk
2716bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2717bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2718bb99ad6dSBen Warren
27196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2720218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2721218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2722218ca724SWolfgang Denk		to something your driver can deal with.
2723bb99ad6dSBen Warren
27246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2725218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2726218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
27272ad6b513STimur Tabi
2728c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2729c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2730c26e454dSwdenk
2731c26e454dSwdenk- CONFIG_FEC[12]_PHY
2732c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
27336e592385Swdenk		to the given FEC; i. e.
2734c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2735c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2736c26e454dSwdenk
2737c26e454dSwdenk		When set to -1, means to probe for first available.
2738c26e454dSwdenk
2739c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2740c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2741c26e454dSwdenk		(so program the FEC to ignore it).
2742c26e454dSwdenk
2743c26e454dSwdenk- CONFIG_RMII
2744c26e454dSwdenk		Enable RMII mode for all FECs.
2745c26e454dSwdenk		Note that this is a global option, we can't
2746c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2747c26e454dSwdenk
27485cf91d6bSwdenk- CONFIG_CRC32_VERIFY
27495cf91d6bSwdenk		Add a verify option to the crc32 command.
27505cf91d6bSwdenk		The syntax is:
27515cf91d6bSwdenk
27525cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
27535cf91d6bSwdenk
27545cf91d6bSwdenk		Where address/count indicate a memory area
27555cf91d6bSwdenk		and crc32 is the correct crc32 which the
27565cf91d6bSwdenk		area should have.
27575cf91d6bSwdenk
275856523f12Swdenk- CONFIG_LOOPW
275956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2760602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
276156523f12Swdenk
27627b466641Sstroese- CONFIG_MX_CYCLIC
27637b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
27647b466641Sstroese		"md/mw" commands.
27657b466641Sstroese		Examples:
27667b466641Sstroese
27677b466641Sstroese		=> mdc.b 10 4 500
27687b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
27697b466641Sstroese
27707b466641Sstroese		=> mwc.l 100 12345678 10
27717b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
27727b466641Sstroese
27737b466641Sstroese		This only takes effect if the memory commands are activated
2774602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
27757b466641Sstroese
27768aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
27778aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
27788aa1a2d1Swdenk
27798aa1a2d1Swdenk		[ARM only] If these variables are defined, then
27808aa1a2d1Swdenk		certain low level initializations (like setting up
27818aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
27828aa1a2d1Swdenk		not relocate itself into RAM.
27838aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
27848aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
27858aa1a2d1Swdenk		some other boot loader or by a debugger which
278611ccc33fSMarcel Ziswiler		performs these initializations itself.
27878aa1a2d1Swdenk
2788df81238bSMagnus Lilja- CONFIG_PRELOADER
2789df81238bSMagnus Lilja
2790df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2791df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2792df81238bSMagnus Lilja		compiling a NAND SPL.
2793400558b5Swdenk
2794c609719bSwdenkBuilding the Software:
2795c609719bSwdenk======================
2796c609719bSwdenk
2797218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2798218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2799218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2800218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2801218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2802218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2803c609719bSwdenk
2804218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2805218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2806218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2807218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2808218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2809c609719bSwdenk
2810218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2811218ca724SWolfgang Denk	$ export CROSS_COMPILE
2812c609719bSwdenk
28132f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
28142f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
28152f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
28162f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
28172f8d396bSPeter Tyser
28182f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
28192f8d396bSPeter Tyser
28202f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
28212f8d396bSPeter Tyser      be executed on computers running Windows.
28222f8d396bSPeter Tyser
2823c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2824c609719bSwdenksources you must configure U-Boot for one specific board type. This
2825c609719bSwdenkis done by typing:
2826c609719bSwdenk
2827c609719bSwdenk	make NAME_config
2828c609719bSwdenk
2829218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2830218ca724SWolfgang Denkrations; see the main Makefile for supported names.
283154387ac9Swdenk
2832c609719bSwdenkNote: for some board special configuration names may exist; check if
2833c609719bSwdenk      additional information is available from the board vendor; for
28342729af9dSwdenk      instance, the TQM823L systems are available without (standard)
28352729af9dSwdenk      or with LCD support. You can select such additional "features"
283611ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2837c609719bSwdenk
28382729af9dSwdenk      make TQM823L_config
28392729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2840c609719bSwdenk
2841c609719bSwdenk      make TQM823L_LCD_config
2842c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2843c609719bSwdenk
2844c609719bSwdenk      etc.
2845c609719bSwdenk
2846c609719bSwdenk
2847c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
28487152b1d0Swdenkimages ready for download to / installation on your system:
2849c609719bSwdenk
2850c609719bSwdenk- "u-boot.bin" is a raw binary image
2851c609719bSwdenk- "u-boot" is an image in ELF binary format
2852c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2853c609719bSwdenk
2854baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2855baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2856baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2857baf31249SMarian Balakowicz
2858baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2859baf31249SMarian Balakowicz
2860baf31249SMarian Balakowicz	make O=/tmp/build distclean
2861baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2862baf31249SMarian Balakowicz	make O=/tmp/build all
2863baf31249SMarian Balakowicz
2864baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2865baf31249SMarian Balakowicz
2866baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2867baf31249SMarian Balakowicz	make distclean
2868baf31249SMarian Balakowicz	make NAME_config
2869baf31249SMarian Balakowicz	make all
2870baf31249SMarian Balakowicz
2871baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2872baf31249SMarian Balakowiczvariable.
2873baf31249SMarian Balakowicz
2874c609719bSwdenk
2875c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2876c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2877c609719bSwdenknative "make".
2878c609719bSwdenk
2879c609719bSwdenk
2880c609719bSwdenkIf the system board that you have is not listed, then you will need
2881c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2882c609719bSwdenksteps:
2883c609719bSwdenk
2884c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
288585ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
288685ec0bccSwdenk    entries as examples. Note that here and at many other places
28877152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
288885ec0bccSwdenk    keep this order.
2889c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
289085ec0bccSwdenk    files you need. In your board directory, you will need at least
289185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
289285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
289385ec0bccSwdenk    your board
2894c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2895c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
289685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2897c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2898c609719bSwdenk    to be installed on your target system.
289985ec0bccSwdenk6.  Debug and solve any problems that might arise.
2900c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2901c609719bSwdenk
2902c609719bSwdenk
2903c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2904c609719bSwdenk==============================================================
2905c609719bSwdenk
2906c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2907c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2908c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2909c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2910218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2911c609719bSwdenk
2912c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2913c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2914c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2915c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2916c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
29177152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2918218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2919218ca724SWolfgang Denkyou can type
2920c609719bSwdenk
2921c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2922c609719bSwdenk
2923c609719bSwdenkor to build on a native PowerPC system you can type
2924c609719bSwdenk
2925c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2926c609719bSwdenk
2927218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2928218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2929218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2930218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2931218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2932218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2933218ca724SWolfgang Denkvariable. For example:
2934baf31249SMarian Balakowicz
2935baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2936baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2937baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2938baf31249SMarian Balakowicz
2939218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2940218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2941218ca724SWolfgang Denkduring the whole build process.
2942baf31249SMarian Balakowicz
2943baf31249SMarian Balakowicz
2944c609719bSwdenkSee also "U-Boot Porting Guide" below.
2945c609719bSwdenk
2946c609719bSwdenk
2947c609719bSwdenkMonitor Commands - Overview:
2948c609719bSwdenk============================
2949c609719bSwdenk
2950c609719bSwdenkgo	- start application at address 'addr'
2951c609719bSwdenkrun	- run commands in an environment variable
2952c609719bSwdenkbootm	- boot application image from memory
2953c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2954c609719bSwdenktftpboot- boot image via network using TFTP protocol
2955c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2956c609719bSwdenk	       (and eventually "gatewayip")
2957c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2958c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2959c609719bSwdenkloads	- load S-Record file over serial line
2960c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2961c609719bSwdenkmd	- memory display
2962c609719bSwdenkmm	- memory modify (auto-incrementing)
2963c609719bSwdenknm	- memory modify (constant address)
2964c609719bSwdenkmw	- memory write (fill)
2965c609719bSwdenkcp	- memory copy
2966c609719bSwdenkcmp	- memory compare
2967c609719bSwdenkcrc32	- checksum calculation
29680f89c54bSPeter Tyseri2c	- I2C sub-system
2969c609719bSwdenksspi	- SPI utility commands
2970c609719bSwdenkbase	- print or set address offset
2971c609719bSwdenkprintenv- print environment variables
2972c609719bSwdenksetenv	- set environment variables
2973c609719bSwdenksaveenv - save environment variables to persistent storage
2974c609719bSwdenkprotect - enable or disable FLASH write protection
2975c609719bSwdenkerase	- erase FLASH memory
2976c609719bSwdenkflinfo	- print FLASH memory information
2977c609719bSwdenkbdinfo	- print Board Info structure
2978c609719bSwdenkiminfo	- print header information for application image
2979c609719bSwdenkconinfo - print console devices and informations
2980c609719bSwdenkide	- IDE sub-system
2981c609719bSwdenkloop	- infinite loop on address range
298256523f12Swdenkloopw	- infinite write loop on address range
2983c609719bSwdenkmtest	- simple RAM test
2984c609719bSwdenkicache	- enable or disable instruction cache
2985c609719bSwdenkdcache	- enable or disable data cache
2986c609719bSwdenkreset	- Perform RESET of the CPU
2987c609719bSwdenkecho	- echo args to console
2988c609719bSwdenkversion - print monitor version
2989c609719bSwdenkhelp	- print online help
2990c609719bSwdenk?	- alias for 'help'
2991c609719bSwdenk
2992c609719bSwdenk
2993c609719bSwdenkMonitor Commands - Detailed Description:
2994c609719bSwdenk========================================
2995c609719bSwdenk
2996c609719bSwdenkTODO.
2997c609719bSwdenk
2998c609719bSwdenkFor now: just type "help <command>".
2999c609719bSwdenk
3000c609719bSwdenk
3001c609719bSwdenkEnvironment Variables:
3002c609719bSwdenk======================
3003c609719bSwdenk
3004c609719bSwdenkU-Boot supports user configuration using Environment Variables which
3005c609719bSwdenkcan be made persistent by saving to Flash memory.
3006c609719bSwdenk
3007c609719bSwdenkEnvironment Variables are set using "setenv", printed using
3008c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
3009c609719bSwdenkwithout a value can be used to delete a variable from the
3010c609719bSwdenkenvironment. As long as you don't save the environment you are
3011c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
3012c609719bSwdenkenvironment is erased by accident, a default environment is provided.
3013c609719bSwdenk
3014c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
3015c96f86eeSWolfgang Denk
3016c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
3017c609719bSwdenk
3018c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
3019c609719bSwdenk
3020c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
3021c609719bSwdenk
3022c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
3023c609719bSwdenk
3024c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
3025c609719bSwdenk
3026c609719bSwdenk  bootfile	- Name of the image to load with TFTP
3027c609719bSwdenk
30287d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
30297d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30307d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
30317d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
30327d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
30337d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
30346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
30357d721e34SBartlomiej Sieka
30367d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
30377d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30387d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
30397d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
30407d721e34SBartlomiej Sieka		  environment variable.
30417d721e34SBartlomiej Sieka
30424bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
30434bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
30444bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
30454bae9090SBartlomiej Sieka
3046c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3047c609719bSwdenk		  "bootp" will just load perform a lookup of the
3048c609719bSwdenk		  configuration from the BOOTP server, but not try to
3049c609719bSwdenk		  load any image using TFTP
3050c609719bSwdenk
3051c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3052c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3053c609719bSwdenk		  be automatically started (by internally calling
3054c609719bSwdenk		  "bootm")
3055c609719bSwdenk
30564a6fd34bSwdenk		  If set to "no", a standalone image passed to the
30574a6fd34bSwdenk		  "bootm" command will be copied to the load address
30584a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
30594a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
30604a6fd34bSwdenk		  data.
30614a6fd34bSwdenk
306217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
306317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
306417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
306517ea1177Swdenk		  initialization code. So, for changes to be effective
306617ea1177Swdenk		  it must be saved and board must be reset.
306717ea1177Swdenk
3068c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3069c609719bSwdenk		  If this variable is not set, initrd images will be
3070c609719bSwdenk		  copied to the highest possible address in RAM; this
3071c609719bSwdenk		  is usually what you want since it allows for
3072c609719bSwdenk		  maximum initrd size. If for some reason you want to
3073c609719bSwdenk		  make sure that the initrd image is loaded below the
30746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3075c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3076c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3077c609719bSwdenk		  address to use (U-Boot will still check that it
3078c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3079c609719bSwdenk
3080c609719bSwdenk		  For instance, when you have a system with 16 MB
30817152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3082c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3083c609719bSwdenk		  the "bootargs" variable. However, now you must make
30847152b1d0Swdenk		  sure that the initrd image is placed in the first
3085c609719bSwdenk		  12 MB as well - this can be done with
3086c609719bSwdenk
3087c609719bSwdenk		  setenv initrd_high 00c00000
3088c609719bSwdenk
308938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
309038b99261Swdenk		  indication to U-Boot that all addresses are legal
309138b99261Swdenk		  for the Linux kernel, including addresses in flash
309238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
309338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
309438b99261Swdenk		  boot time on your system, but requires that this
309538b99261Swdenk		  feature is supported by your Linux kernel.
309638b99261Swdenk
3097c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3098c609719bSwdenk
3099c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3100dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3101c609719bSwdenk
3102c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3103c609719bSwdenk
3104c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3105c609719bSwdenk
3106c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3107c609719bSwdenk
3108c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3109c609719bSwdenk
3110c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3111c609719bSwdenk
3112a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3113a3d991bdSwdenk		  interface is used first.
3114a3d991bdSwdenk
3115a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3116a3d991bdSwdenk		  interface is currently active. For example you
3117a3d991bdSwdenk		  can do the following
3118a3d991bdSwdenk
3119a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3120a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3121a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3122a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3123a3d991bdSwdenk
3124e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3125e1692577SMatthias Fuchs		  available network interfaces.
3126e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3127e1692577SMatthias Fuchs
3128a3d991bdSwdenk  netretry	- When set to "no" each network operation will
3129a3d991bdSwdenk		  either succeed or fail without retrying.
31306e592385Swdenk		  When set to "once" the network operation will
31316e592385Swdenk		  fail when all the available network interfaces
31326e592385Swdenk		  are tried once without success.
3133a3d991bdSwdenk		  Useful on scripts which control the retry operation
3134a3d991bdSwdenk		  themselves.
3135a3d991bdSwdenk
3136b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3137a1cf027aSJean-Christophe PLAGNIOL-VILLARD
313828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3139ecb0ccd9SWolfgang Denk		  UDP source port.
3140ecb0ccd9SWolfgang Denk
314128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
314228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
314328cb9375SWolfgang Denk
3144c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
3145c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
3146c96f86eeSWolfgang Denk
3147c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
3148c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
3149c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
3150c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
3151c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
3152c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
3153c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
3154c96f86eeSWolfgang Denk
3155a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
315611ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3157a3d991bdSwdenk		  VLAN tagged frames.
3158c609719bSwdenk
3159c609719bSwdenkThe following environment variables may be used and automatically
3160c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3161c609719bSwdenkdepending the information provided by your boot server:
3162c609719bSwdenk
3163c609719bSwdenk  bootfile	- see above
3164c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3165fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3166c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3167c609719bSwdenk  hostname	- Target hostname
3168c609719bSwdenk  ipaddr	- see above
3169c609719bSwdenk  netmask	- Subnet Mask
3170c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3171c609719bSwdenk  serverip	- see above
3172c609719bSwdenk
3173c609719bSwdenk
3174c609719bSwdenkThere are two special Environment Variables:
3175c609719bSwdenk
3176c609719bSwdenk  serial#	- contains hardware identification information such
3177c609719bSwdenk		  as type string and/or serial number
3178c609719bSwdenk  ethaddr	- Ethernet address
3179c609719bSwdenk
3180c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3181c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3182c609719bSwdenkonce they have been set once.
3183c609719bSwdenk
3184c609719bSwdenk
3185c1551ea8SstroeseFurther special Environment Variables:
3186c1551ea8Sstroese
3187c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3188c1551ea8Sstroese		  with the "version" command. This variable is
3189c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3190c1551ea8Sstroese
3191c1551ea8Sstroese
3192c609719bSwdenkPlease note that changes to some configuration parameters may take
3193c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3194c609719bSwdenk
3195c609719bSwdenk
3196f07771ccSwdenkCommand Line Parsing:
3197f07771ccSwdenk=====================
3198f07771ccSwdenk
3199f07771ccSwdenkThere are two different command line parsers available with U-Boot:
32007152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3201f07771ccSwdenk
3202f07771ccSwdenkOld, simple command line parser:
3203f07771ccSwdenk--------------------------------
3204f07771ccSwdenk
3205f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3206f07771ccSwdenk- several commands on one line, separated by ';'
3207fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3208f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3209f07771ccSwdenk  for example:
3210fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3211f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3212f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3213f07771ccSwdenk
3214f07771ccSwdenkHush shell:
3215f07771ccSwdenk-----------
3216f07771ccSwdenk
3217f07771ccSwdenk- similar to Bourne shell, with control structures like
3218f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3219f07771ccSwdenk  until...do...done, ...
3220f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3221f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3222f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3223f07771ccSwdenk  command
3224f07771ccSwdenk
3225f07771ccSwdenkGeneral rules:
3226f07771ccSwdenk--------------
3227f07771ccSwdenk
3228f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3229f07771ccSwdenk    command) contains several commands separated by semicolon, and
3230f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3231f07771ccSwdenk    executed anyway.
3232f07771ccSwdenk
3233f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
323411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3235f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3236f07771ccSwdenk    variables are not executed.
3237f07771ccSwdenk
3238c609719bSwdenkNote for Redundant Ethernet Interfaces:
3239c609719bSwdenk=======================================
3240c609719bSwdenk
324111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3242c609719bSwdenksuch configurations and is capable of automatic selection of a
32437152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3244c609719bSwdenk
3245c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3246c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3247c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3248c609719bSwdenk
3249c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3250c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3251c609719bSwdenkding setting in the environment; if the corresponding environment
3252c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3253c609719bSwdenk
3254c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3255c609719bSwdenk  environment, the SROM's address is used.
3256c609719bSwdenk
3257c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3258c609719bSwdenk  environment exists, then the value from the environment variable is
3259c609719bSwdenk  used.
3260c609719bSwdenk
3261c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3262c609719bSwdenk  both addresses are the same, this MAC address is used.
3263c609719bSwdenk
3264c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3265c609719bSwdenk  addresses differ, the value from the environment is used and a
3266c609719bSwdenk  warning is printed.
3267c609719bSwdenk
3268c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3269c609719bSwdenk  is raised.
3270c609719bSwdenk
3271c609719bSwdenk
3272c609719bSwdenkImage Formats:
3273c609719bSwdenk==============
3274c609719bSwdenk
32753310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
32763310c549SMarian Balakowiczimages in two formats:
32773310c549SMarian Balakowicz
32783310c549SMarian BalakowiczNew uImage format (FIT)
32793310c549SMarian Balakowicz-----------------------
32803310c549SMarian Balakowicz
32813310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
32823310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
32833310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
32843310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
32853310c549SMarian Balakowicz
32863310c549SMarian Balakowicz
32873310c549SMarian BalakowiczOld uImage format
32883310c549SMarian Balakowicz-----------------
32893310c549SMarian Balakowicz
32903310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
32913310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
32923310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3293c609719bSwdenk
3294c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3295c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3296f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3297f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3298f5ed9e39SPeter Tyser  INTEGRITY).
32997b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
33003d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
33017b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3302c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3303c609719bSwdenk* Load Address
3304c609719bSwdenk* Entry Point
3305c609719bSwdenk* Image Name
3306c609719bSwdenk* Image Timestamp
3307c609719bSwdenk
3308c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3309c609719bSwdenkand the data portions of the image are secured against corruption by
3310c609719bSwdenkCRC32 checksums.
3311c609719bSwdenk
3312c609719bSwdenk
3313c609719bSwdenkLinux Support:
3314c609719bSwdenk==============
3315c609719bSwdenk
3316c609719bSwdenkAlthough U-Boot should support any OS or standalone application
33177152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3318c609719bSwdenkU-Boot.
3319c609719bSwdenk
3320c609719bSwdenkU-Boot includes many features that so far have been part of some
3321c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3322c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3323c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
33247152b1d0Swdenkserves several purposes:
3325c609719bSwdenk
3326c609719bSwdenk- the same features can be used for other OS or standalone
3327c609719bSwdenk  applications (for instance: using compressed images to reduce the
3328c609719bSwdenk  Flash memory footprint)
3329c609719bSwdenk
3330c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
33317152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3332c609719bSwdenk
3333c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3334c609719bSwdenk  images; of course this also means that different kernel images can
3335c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3336c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3337c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3338c609719bSwdenk  software is easier now.
3339c609719bSwdenk
3340c609719bSwdenk
3341c609719bSwdenkLinux HOWTO:
3342c609719bSwdenk============
3343c609719bSwdenk
3344c609719bSwdenkPorting Linux to U-Boot based systems:
3345c609719bSwdenk---------------------------------------
3346c609719bSwdenk
3347c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3348c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3349c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3350c609719bSwdenkLinux :-).
3351c609719bSwdenk
3352c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
3353c609719bSwdenk
3354c609719bSwdenkJust make sure your machine specific header file (for instance
3355c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
33561dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
33571dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
33586d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3359c609719bSwdenk
3360c609719bSwdenk
3361c609719bSwdenkConfiguring the Linux kernel:
3362c609719bSwdenk-----------------------------
3363c609719bSwdenk
3364c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3365c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3366c609719bSwdenk
3367c609719bSwdenk
3368c609719bSwdenkBuilding a Linux Image:
3369c609719bSwdenk-----------------------
3370c609719bSwdenk
337124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
337224ee89b9Swdenknot used. If you use recent kernel source, a new build target
337324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
337424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
337524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
337624ee89b9Swdenk100% compatible format.
3377c609719bSwdenk
3378c609719bSwdenkExample:
3379c609719bSwdenk
3380c609719bSwdenk	make TQM850L_config
3381c609719bSwdenk	make oldconfig
3382c609719bSwdenk	make dep
338324ee89b9Swdenk	make uImage
3384c609719bSwdenk
338524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
338624ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
338724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3388c609719bSwdenk
338924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
339024ee89b9Swdenk
339124ee89b9Swdenk* convert the kernel into a raw binary image:
339224ee89b9Swdenk
339324ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
339424ee89b9Swdenk				 -R .note -R .comment \
339524ee89b9Swdenk				 -S vmlinux linux.bin
339624ee89b9Swdenk
339724ee89b9Swdenk* compress the binary image:
339824ee89b9Swdenk
339924ee89b9Swdenk	gzip -9 linux.bin
340024ee89b9Swdenk
340124ee89b9Swdenk* package compressed binary image for U-Boot:
340224ee89b9Swdenk
340324ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
340424ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
340524ee89b9Swdenk		-d linux.bin.gz uImage
340624ee89b9Swdenk
340724ee89b9Swdenk
340824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
340924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
341024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
341124ee89b9Swdenkbyte header containing information about target architecture,
341224ee89b9Swdenkoperating system, image type, compression method, entry points, time
341324ee89b9Swdenkstamp, CRC32 checksums, etc.
341424ee89b9Swdenk
341524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
341624ee89b9Swdenkprint the header information, or to build new images.
3417c609719bSwdenk
3418c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3419c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3420c609719bSwdenkchecksum verification:
3421c609719bSwdenk
3422c609719bSwdenk	tools/mkimage -l image
3423c609719bSwdenk	  -l ==> list image header information
3424c609719bSwdenk
3425c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3426c609719bSwdenkfrom a "data file" which is used as image payload:
3427c609719bSwdenk
3428c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3429c609719bSwdenk		      -n name -d data_file image
3430c609719bSwdenk	  -A ==> set architecture to 'arch'
3431c609719bSwdenk	  -O ==> set operating system to 'os'
3432c609719bSwdenk	  -T ==> set image type to 'type'
3433c609719bSwdenk	  -C ==> set compression type 'comp'
3434c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3435c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3436c609719bSwdenk	  -n ==> set image name to 'name'
3437c609719bSwdenk	  -d ==> use image data from 'datafile'
3438c609719bSwdenk
343969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
344069459791Swdenkaddress (0x00000000), but the entry point address depends on the
344169459791Swdenkkernel version:
3442c609719bSwdenk
3443c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
344424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3445c609719bSwdenk
3446c609719bSwdenkSo a typical call to build a U-Boot image would read:
3447c609719bSwdenk
344824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
344924ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
345024ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
345124ee89b9Swdenk	> examples/uImage.TQM850L
345224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3453c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3454c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3455c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3456c609719bSwdenk	Load Address: 0x00000000
345724ee89b9Swdenk	Entry Point:  0x00000000
3458c609719bSwdenk
3459c609719bSwdenkTo verify the contents of the image (or check for corruption):
3460c609719bSwdenk
346124ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
346224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3463c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3464c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3465c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3466c609719bSwdenk	Load Address: 0x00000000
346724ee89b9Swdenk	Entry Point:  0x00000000
3468c609719bSwdenk
3469c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3470c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3471c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3472c609719bSwdenkneed to be uncompressed:
3473c609719bSwdenk
347424ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
347524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
347624ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
347724ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
347824ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
347924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3480c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3481c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3482c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3483c609719bSwdenk	Load Address: 0x00000000
348424ee89b9Swdenk	Entry Point:  0x00000000
3485c609719bSwdenk
3486c609719bSwdenk
3487c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3488c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3489c609719bSwdenk
3490c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3491c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3492c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3493c609719bSwdenk	Image Name:   Simple Ramdisk Image
3494c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3495c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3496c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3497c609719bSwdenk	Load Address: 0x00000000
3498c609719bSwdenk	Entry Point:  0x00000000
3499c609719bSwdenk
3500c609719bSwdenk
3501c609719bSwdenkInstalling a Linux Image:
3502c609719bSwdenk-------------------------
3503c609719bSwdenk
3504c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3505c609719bSwdenkyou must convert the image to S-Record format:
3506c609719bSwdenk
3507c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3508c609719bSwdenk
3509c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3510c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3511c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3512c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3513c609719bSwdenkcommand.
3514c609719bSwdenk
3515c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3516c609719bSwdenkTQM8xxL is in the first Flash bank):
3517c609719bSwdenk
3518c609719bSwdenk	=> erase 40100000 401FFFFF
3519c609719bSwdenk
3520c609719bSwdenk	.......... done
3521c609719bSwdenk	Erased 8 sectors
3522c609719bSwdenk
3523c609719bSwdenk	=> loads 40100000
3524c609719bSwdenk	## Ready for S-Record download ...
3525c609719bSwdenk	~>examples/image.srec
3526c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3527c609719bSwdenk	...
3528c609719bSwdenk	15989 15990 15991 15992
3529c609719bSwdenk	[file transfer complete]
3530c609719bSwdenk	[connected]
3531c609719bSwdenk	## Start Addr = 0x00000000
3532c609719bSwdenk
3533c609719bSwdenk
3534c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3535c609719bSwdenkthis includes a checksum verification so you can be sure no data
3536c609719bSwdenkcorruption happened:
3537c609719bSwdenk
3538c609719bSwdenk	=> imi 40100000
3539c609719bSwdenk
3540c609719bSwdenk	## Checking Image at 40100000 ...
3541c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3542c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3543c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3544c609719bSwdenk	   Load Address: 00000000
3545c609719bSwdenk	   Entry Point:	 0000000c
3546c609719bSwdenk	   Verifying Checksum ... OK
3547c609719bSwdenk
3548c609719bSwdenk
3549c609719bSwdenkBoot Linux:
3550c609719bSwdenk-----------
3551c609719bSwdenk
3552c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3553c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3554c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3555c609719bSwdenkparameters. You can check and modify this variable using the
3556c609719bSwdenk"printenv" and "setenv" commands:
3557c609719bSwdenk
3558c609719bSwdenk
3559c609719bSwdenk	=> printenv bootargs
3560c609719bSwdenk	bootargs=root=/dev/ram
3561c609719bSwdenk
3562c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3563c609719bSwdenk
3564c609719bSwdenk	=> printenv bootargs
3565c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3566c609719bSwdenk
3567c609719bSwdenk	=> bootm 40020000
3568c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3569c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3570c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3571c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3572c609719bSwdenk	   Load Address: 00000000
3573c609719bSwdenk	   Entry Point:	 0000000c
3574c609719bSwdenk	   Verifying Checksum ... OK
3575c609719bSwdenk	   Uncompressing Kernel Image ... OK
3576c609719bSwdenk	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
3577c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3578c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3579c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3580c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3581c609719bSwdenk	...
3582c609719bSwdenk
358311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
35847152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3585c609719bSwdenkformat!) to the "bootm" command:
3586c609719bSwdenk
3587c609719bSwdenk	=> imi 40100000 40200000
3588c609719bSwdenk
3589c609719bSwdenk	## Checking Image at 40100000 ...
3590c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3591c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3592c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3593c609719bSwdenk	   Load Address: 00000000
3594c609719bSwdenk	   Entry Point:	 0000000c
3595c609719bSwdenk	   Verifying Checksum ... OK
3596c609719bSwdenk
3597c609719bSwdenk	## Checking Image at 40200000 ...
3598c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3599c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3600c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3601c609719bSwdenk	   Load Address: 00000000
3602c609719bSwdenk	   Entry Point:	 00000000
3603c609719bSwdenk	   Verifying Checksum ... OK
3604c609719bSwdenk
3605c609719bSwdenk	=> bootm 40100000 40200000
3606c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3607c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3608c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3609c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3610c609719bSwdenk	   Load Address: 00000000
3611c609719bSwdenk	   Entry Point:	 0000000c
3612c609719bSwdenk	   Verifying Checksum ... OK
3613c609719bSwdenk	   Uncompressing Kernel Image ... OK
3614c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3615c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3616c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3617c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3618c609719bSwdenk	   Load Address: 00000000
3619c609719bSwdenk	   Entry Point:	 00000000
3620c609719bSwdenk	   Verifying Checksum ... OK
3621c609719bSwdenk	   Loading Ramdisk ... OK
3622c609719bSwdenk	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
3623c609719bSwdenk	Boot arguments: root=/dev/ram
3624c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3625c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3626c609719bSwdenk	...
3627c609719bSwdenk	RAMDISK: Compressed image found at block 0
3628c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3629c609719bSwdenk
3630c609719bSwdenk	bash#
3631c609719bSwdenk
36320267768eSMatthew McClintockBoot Linux and pass a flat device tree:
36330267768eSMatthew McClintock-----------
36340267768eSMatthew McClintock
36350267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
36360267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
36370267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
36380267768eSMatthew McClintockflat device tree:
36390267768eSMatthew McClintock
36400267768eSMatthew McClintock=> print oftaddr
36410267768eSMatthew McClintockoftaddr=0x300000
36420267768eSMatthew McClintock=> print oft
36430267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
36440267768eSMatthew McClintock=> tftp $oftaddr $oft
36450267768eSMatthew McClintockSpeed: 1000, full duplex
36460267768eSMatthew McClintockUsing TSEC0 device
36470267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
36480267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
36490267768eSMatthew McClintockLoad address: 0x300000
36500267768eSMatthew McClintockLoading: #
36510267768eSMatthew McClintockdone
36520267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
36530267768eSMatthew McClintock=> tftp $loadaddr $bootfile
36540267768eSMatthew McClintockSpeed: 1000, full duplex
36550267768eSMatthew McClintockUsing TSEC0 device
36560267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
36570267768eSMatthew McClintockFilename 'uImage'.
36580267768eSMatthew McClintockLoad address: 0x200000
36590267768eSMatthew McClintockLoading:############
36600267768eSMatthew McClintockdone
36610267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
36620267768eSMatthew McClintock=> print loadaddr
36630267768eSMatthew McClintockloadaddr=200000
36640267768eSMatthew McClintock=> print oftaddr
36650267768eSMatthew McClintockoftaddr=0x300000
36660267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
36670267768eSMatthew McClintock## Booting image at 00200000 ...
36680267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
36690267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
36700267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
36710267768eSMatthew McClintock   Load Address: 00000000
36720267768eSMatthew McClintock   Entry Point:	 00000000
36730267768eSMatthew McClintock   Verifying Checksum ... OK
36740267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
36750267768eSMatthew McClintockBooting using flat device tree at 0x300000
36760267768eSMatthew McClintockUsing MPC85xx ADS machine description
36770267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
36780267768eSMatthew McClintock[snip]
36790267768eSMatthew McClintock
36800267768eSMatthew McClintock
36816069ff26SwdenkMore About U-Boot Image Types:
36826069ff26Swdenk------------------------------
36836069ff26Swdenk
36846069ff26SwdenkU-Boot supports the following image types:
36856069ff26Swdenk
36866069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
36876069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
36886069ff26Swdenk	well) you can continue to work in U-Boot after return from
36896069ff26Swdenk	the Standalone Program.
36906069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
36916069ff26Swdenk	will take over control completely. Usually these programs
36926069ff26Swdenk	will install their own set of exception handlers, device
36936069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
36946069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
36956069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
36966069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
36976069ff26Swdenk	being started.
36986069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
36996069ff26Swdenk	(Linux) kernel image and one or more data images like
37006069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
37016069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
37026069ff26Swdenk	server provides just a single image file, but you want to get
37036069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
37046069ff26Swdenk
37056069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
37066069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
37076069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
37086069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
37096069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
37106069ff26Swdenk	a multiple of 4 bytes).
37116069ff26Swdenk
37126069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
37136069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
37146069ff26Swdenk	flash memory.
37156069ff26Swdenk
37166069ff26Swdenk   "Script files" are command sequences that will be executed by
37176069ff26Swdenk	U-Boot's command interpreter; this feature is especially
37186069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
37196069ff26Swdenk	as command interpreter.
37206069ff26Swdenk
3721c609719bSwdenk
3722c609719bSwdenkStandalone HOWTO:
3723c609719bSwdenk=================
3724c609719bSwdenk
3725c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3726c609719bSwdenkrun "standalone" applications, which can use some resources of
3727c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3728c609719bSwdenk
3729c609719bSwdenkTwo simple examples are included with the sources:
3730c609719bSwdenk
3731c609719bSwdenk"Hello World" Demo:
3732c609719bSwdenk-------------------
3733c609719bSwdenk
3734c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3735c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3736c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3737c609719bSwdenklike that:
3738c609719bSwdenk
3739c609719bSwdenk	=> loads
3740c609719bSwdenk	## Ready for S-Record download ...
3741c609719bSwdenk	~>examples/hello_world.srec
3742c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3743c609719bSwdenk	[file transfer complete]
3744c609719bSwdenk	[connected]
3745c609719bSwdenk	## Start Addr = 0x00040004
3746c609719bSwdenk
3747c609719bSwdenk	=> go 40004 Hello World! This is a test.
3748c609719bSwdenk	## Starting application at 0x00040004 ...
3749c609719bSwdenk	Hello World
3750c609719bSwdenk	argc = 7
3751c609719bSwdenk	argv[0] = "40004"
3752c609719bSwdenk	argv[1] = "Hello"
3753c609719bSwdenk	argv[2] = "World!"
3754c609719bSwdenk	argv[3] = "This"
3755c609719bSwdenk	argv[4] = "is"
3756c609719bSwdenk	argv[5] = "a"
3757c609719bSwdenk	argv[6] = "test."
3758c609719bSwdenk	argv[7] = "<NULL>"
3759c609719bSwdenk	Hit any key to exit ...
3760c609719bSwdenk
3761c609719bSwdenk	## Application terminated, rc = 0x0
3762c609719bSwdenk
3763c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3764c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3765c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3766c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3767c609719bSwdenkcharacter, but this is just a demo program. The application can be
3768c609719bSwdenkcontrolled by the following keys:
3769c609719bSwdenk
3770c609719bSwdenk	? - print current values og the CPM Timer registers
3771c609719bSwdenk	b - enable interrupts and start timer
3772c609719bSwdenk	e - stop timer and disable interrupts
3773c609719bSwdenk	q - quit application
3774c609719bSwdenk
3775c609719bSwdenk	=> loads
3776c609719bSwdenk	## Ready for S-Record download ...
3777c609719bSwdenk	~>examples/timer.srec
3778c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3779c609719bSwdenk	[file transfer complete]
3780c609719bSwdenk	[connected]
3781c609719bSwdenk	## Start Addr = 0x00040004
3782c609719bSwdenk
3783c609719bSwdenk	=> go 40004
3784c609719bSwdenk	## Starting application at 0x00040004 ...
3785c609719bSwdenk	TIMERS=0xfff00980
3786c609719bSwdenk	Using timer 1
3787c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3788c609719bSwdenk
3789c609719bSwdenkHit 'b':
3790c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3791c609719bSwdenk	Enabling timer
3792c609719bSwdenkHit '?':
3793c609719bSwdenk	[q, b, e, ?] ........
3794c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3795c609719bSwdenkHit '?':
3796c609719bSwdenk	[q, b, e, ?] .
3797c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3798c609719bSwdenkHit '?':
3799c609719bSwdenk	[q, b, e, ?] .
3800c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3801c609719bSwdenkHit '?':
3802c609719bSwdenk	[q, b, e, ?] .
3803c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3804c609719bSwdenkHit 'e':
3805c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3806c609719bSwdenkHit 'q':
3807c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3808c609719bSwdenk
3809c609719bSwdenk
381085ec0bccSwdenkMinicom warning:
381185ec0bccSwdenk================
381285ec0bccSwdenk
38137152b1d0SwdenkOver time, many people have reported problems when trying to use the
381485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
381585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3816f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
381785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
381885ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
381985ec0bccSwdenk
382052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
382152f52c14Swdenkconfiguration to your "File transfer protocols" section:
382252f52c14Swdenk
382352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
382452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
382552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
382652f52c14Swdenk
382752f52c14Swdenk
3828c609719bSwdenkNetBSD Notes:
3829c609719bSwdenk=============
3830c609719bSwdenk
3831c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3832c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3833c609719bSwdenk
3834c609719bSwdenkBuilding requires a cross environment; it is known to work on
3835c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3836c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3837c609719bSwdenkNote that the cross-powerpc package does not install include files;
3838c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3839c609719bSwdenkmissing.  This file has to be installed and patched manually:
3840c609719bSwdenk
3841c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3842c609719bSwdenk	# mkdir powerpc
3843c609719bSwdenk	# ln -s powerpc machine
3844c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3845c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3846c609719bSwdenk
3847c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3848c609719bSwdenkand U-Boot include files.
3849c609719bSwdenk
3850c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3851c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3852c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3853c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
38542a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3855c609719bSwdenk
3856c609719bSwdenk
3857c609719bSwdenkImplementation Internals:
3858c609719bSwdenk=========================
3859c609719bSwdenk
3860c609719bSwdenkThe following is not intended to be a complete description of every
3861c609719bSwdenkimplementation detail. However, it should help to understand the
3862c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3863c609719bSwdenkhardware.
3864c609719bSwdenk
3865c609719bSwdenk
3866c609719bSwdenkInitial Stack, Global Data:
3867c609719bSwdenk---------------------------
3868c609719bSwdenk
3869c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3870c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3871c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3872c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3873c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3874c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3875c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3876c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3877c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3878c609719bSwdenklocked as (mis-) used as memory, etc.
3879c609719bSwdenk
38807152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
38810668236bSWolfgang Denk	U-Boot mailing list:
388243d9616cSwdenk
388343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
388443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
388543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
388643d9616cSwdenk	...
388743d9616cSwdenk
388843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
388943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
389043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
389143d9616cSwdenk	is that the cache is being used as a temporary supply of
389243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
389311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
389443d9616cSwdenk	can see how this works by studying the cache architecture and
389543d9616cSwdenk	operation in the architecture and processor-specific manuals.
389643d9616cSwdenk
389743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
389843d9616cSwdenk	is another option for the system designer to use as an
389911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
390043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
390143d9616cSwdenk	board designers haven't used it for something that would
390243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
390343d9616cSwdenk	used.
390443d9616cSwdenk
39056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
390643d9616cSwdenk	with your processor/board/system design. The default value
390743d9616cSwdenk	you will find in any recent u-boot distribution in
39088a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
390943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
391043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
391143d9616cSwdenk	that are supposed to respond to that address! That code in
391243d9616cSwdenk	start.S has been around a while and should work as is when
391343d9616cSwdenk	you get the config right.
391443d9616cSwdenk
391543d9616cSwdenk	-Chris Hallinan
391643d9616cSwdenk	DS4.COM, Inc.
391743d9616cSwdenk
3918c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3919c609719bSwdenkcode for the initialization procedures:
3920c609719bSwdenk
3921c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3922c609719bSwdenk  to write it.
3923c609719bSwdenk
392411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3925c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
39267152b1d0Swdenk  zation is performed later (when relocating to RAM).
3927c609719bSwdenk
3928c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3929c609719bSwdenk  that.
3930c609719bSwdenk
3931c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3932c609719bSwdenknormal global data to share information beween the code. But it
3933c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3934c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3935c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3936c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3937c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3938c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3939c609719bSwdenkreserve for this purpose.
3940c609719bSwdenk
39417152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3942c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3943c609719bSwdenkGCC's implementation.
3944c609719bSwdenk
3945c609719bSwdenkFor PowerPC, the following registers have specific use:
3946c609719bSwdenk	R1:	stack pointer
3947e7670f6cSWolfgang Denk	R2:	reserved for system use
3948c609719bSwdenk	R3-R4:	parameter passing and return values
3949c609719bSwdenk	R5-R10: parameter passing
3950c609719bSwdenk	R13:	small data area pointer
3951c609719bSwdenk	R30:	GOT pointer
3952c609719bSwdenk	R31:	frame pointer
3953c609719bSwdenk
3954e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
3955e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
3956e6bee808SJoakim Tjernlund	going back and forth between asm and C)
3957c609719bSwdenk
3958e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3959c609719bSwdenk
3960c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3961c609719bSwdenk    address of the global data structure is known at compile time),
3962c609719bSwdenk    but it turned out that reserving a register results in somewhat
3963c609719bSwdenk    smaller code - although the code savings are not that big (on
3964c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3965c609719bSwdenk    624 text + 127 data).
3966c609719bSwdenk
3967c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
39684c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
39694c58eb55SMike Frysinger
3970c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
39714c58eb55SMike Frysinger
3972c609719bSwdenkOn ARM, the following registers are used:
3973c609719bSwdenk
3974c609719bSwdenk	R0:	function argument word/integer result
3975c609719bSwdenk	R1-R3:	function argument word
3976c609719bSwdenk	R9:	GOT pointer
3977c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3978c609719bSwdenk	R11:	argument (frame) pointer
3979c609719bSwdenk	R12:	temporary workspace
3980c609719bSwdenk	R13:	stack pointer
3981c609719bSwdenk	R14:	link register
3982c609719bSwdenk	R15:	program counter
3983c609719bSwdenk
3984c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3985c609719bSwdenk
3986d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3987d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3988c609719bSwdenk
3989c609719bSwdenkMemory Management:
3990c609719bSwdenk------------------
3991c609719bSwdenk
3992c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3993c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3994c609719bSwdenk
3995c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3996c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3997c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3998c609719bSwdenkphysical memory banks.
3999c609719bSwdenk
4000c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
4001c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
4002c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
4003c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
4005c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
4006c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
4007c609719bSwdenk
4008c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
4009c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
4010c609719bSwdenk
4011c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
4012c609719bSwdenkthis:
4013c609719bSwdenk
4014c609719bSwdenk	0x0000 0000	Exception Vector code
4015c609719bSwdenk	      :
4016c609719bSwdenk	0x0000 1FFF
4017c609719bSwdenk	0x0000 2000	Free for Application Use
4018c609719bSwdenk	      :
4019c609719bSwdenk	      :
4020c609719bSwdenk
4021c609719bSwdenk	      :
4022c609719bSwdenk	      :
4023c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
4024c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
4025c609719bSwdenk	0x00FC 0000	Malloc Arena
4026c609719bSwdenk	      :
4027c609719bSwdenk	0x00FD FFFF
4028c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
4029c609719bSwdenk	...		eventually: LCD or video framebuffer
4030c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
4031c609719bSwdenk	0x00FF FFFF	[End of RAM]
4032c609719bSwdenk
4033c609719bSwdenk
4034c609719bSwdenkSystem Initialization:
4035c609719bSwdenk----------------------
4036c609719bSwdenk
4037c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
403811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
4039c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
40407152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
4041c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4042c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4043c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4044c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4045c609719bSwdenkthe caches and the SIU.
4046c609719bSwdenk
4047c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4048c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4049c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4050c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4051c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4052c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4053c609719bSwdenkbanks.
4054c609719bSwdenk
4055c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
40567152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4057c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4058c609719bSwdenk0x00000000, with any additional banks following immediately to create
4059c609719bSwdenkcontiguous memory starting from 0.
4060c609719bSwdenk
4061c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4062c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4063c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4064c609719bSwdenkpages, and the final stack is set up.
4065c609719bSwdenk
4066c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4067c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4068c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4069c609719bSwdenknew address in RAM.
4070c609719bSwdenk
4071c609719bSwdenk
4072c609719bSwdenkU-Boot Porting Guide:
4073c609719bSwdenk----------------------
4074c609719bSwdenk
4075c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
40766aff3115Swdenklist, October 2002]
4077c609719bSwdenk
4078c609719bSwdenk
4079c609719bSwdenkint main(int argc, char *argv[])
4080c609719bSwdenk{
4081c609719bSwdenk	sighandler_t no_more_time;
4082c609719bSwdenk
4083c609719bSwdenk	signal(SIGALRM, no_more_time);
4084c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4085c609719bSwdenk
4086c609719bSwdenk	if (available_money > available_manpower) {
40876c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4088c609719bSwdenk		return 0;
4089c609719bSwdenk	}
4090c609719bSwdenk
4091c609719bSwdenk	Download latest U-Boot source;
4092c609719bSwdenk
40930668236bSWolfgang Denk	Subscribe to u-boot mailing list;
40946aff3115Swdenk
40956c3fef28SJerry Van Baren	if (clueless)
4096c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4097c609719bSwdenk
4098c609719bSwdenk	while (learning) {
4099c609719bSwdenk		Read the README file in the top level directory;
41007cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
41016c3fef28SJerry Van Baren		Read applicable doc/*.README;
4102c609719bSwdenk		Read the source, Luke;
41036c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4104c609719bSwdenk	}
4105c609719bSwdenk
41066c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
41076c3fef28SJerry Van Baren		Buy a BDI3000;
41086c3fef28SJerry Van Baren	else
4109c609719bSwdenk		Add a lot of aggravation and time;
4110c609719bSwdenk
41116c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
41126c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
41136c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
41146c3fef28SJerry Van Baren	} else {
4115c609719bSwdenk		Create your own board support subdirectory;
41166c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
41176c3fef28SJerry Van Baren	}
41186c3fef28SJerry Van Baren	Edit new board/<myboard> files
41196c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4120c609719bSwdenk
41216c3fef28SJerry Van Baren	while (!accepted) {
4122c609719bSwdenk		while (!running) {
4123c609719bSwdenk			do {
4124c609719bSwdenk				Add / modify source code;
4125c609719bSwdenk			} until (compiles);
4126c609719bSwdenk			Debug;
4127c609719bSwdenk			if (clueless)
4128c609719bSwdenk				email("Hi, I am having problems...");
4129c609719bSwdenk		}
41306c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
41316c3fef28SJerry Van Baren		if (reasonable critiques)
41326c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
41336c3fef28SJerry Van Baren		else
41346c3fef28SJerry Van Baren			Defend code as written;
41356c3fef28SJerry Van Baren	}
4136c609719bSwdenk
4137c609719bSwdenk	return 0;
4138c609719bSwdenk}
4139c609719bSwdenk
4140c609719bSwdenkvoid no_more_time (int sig)
4141c609719bSwdenk{
4142c609719bSwdenk      hire_a_guru();
4143c609719bSwdenk}
4144c609719bSwdenk
4145c609719bSwdenk
4146c609719bSwdenkCoding Standards:
4147c609719bSwdenk-----------------
4148c609719bSwdenk
4149c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
41502c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
41512c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
41522c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
41532c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4154c609719bSwdenk
41552c051651SDetlev ZundelSource files originating from a different project (for example the
41562c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
41572c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
41582c051651SDetlev Zundelsources.
41592c051651SDetlev Zundel
41602c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
41612c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
41622c051651SDetlev Zundelin your code.
4163c609719bSwdenk
4164c178d3daSwdenkPlease also stick to the following formatting rules:
4165180d3f74Swdenk- remove any trailing white space
4166180d3f74Swdenk- use TAB characters for indentation, not spaces
4167180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4168180d3f74Swdenk- do not add more than 2 empty lines to source files
4169180d3f74Swdenk- do not add trailing empty lines to source files
4170180d3f74Swdenk
4171c609719bSwdenkSubmissions which do not conform to the standards may be returned
4172c609719bSwdenkwith a request to reformat the changes.
4173c609719bSwdenk
4174c609719bSwdenk
4175c609719bSwdenkSubmitting Patches:
4176c609719bSwdenk-------------------
4177c609719bSwdenk
4178c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4179c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4180c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4181c609719bSwdenk
41820d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4183218ca724SWolfgang Denk
41840668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
41850668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
41860668236bSWolfgang Denk
4187c609719bSwdenkWhen you send a patch, please include the following information with
4188c609719bSwdenkit:
4189c609719bSwdenk
4190c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4191c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4192c609719bSwdenk  patch actually fixes something.
4193c609719bSwdenk
4194c609719bSwdenk* For new features: a description of the feature and your
4195c609719bSwdenk  implementation.
4196c609719bSwdenk
4197c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4198c609719bSwdenk
4199c609719bSwdenk* For major contributions, your entry to the CREDITS file
4200c609719bSwdenk
4201c609719bSwdenk* When you add support for a new board, don't forget to add this
4202c609719bSwdenk  board to the MAKEALL script, too.
4203c609719bSwdenk
4204c609719bSwdenk* If your patch adds new configuration options, don't forget to
4205c609719bSwdenk  document these in the README file.
4206c609719bSwdenk
4207218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4208218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4209218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4210218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4211218ca724SWolfgang Denk  with some other mail clients.
4212c609719bSwdenk
4213218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4214218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4215218ca724SWolfgang Denk  GNU diff.
42166dff5529Swdenk
4217218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4218218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4219218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4220218ca724SWolfgang Denk  affected files).
4221218ca724SWolfgang Denk
4222218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4223218ca724SWolfgang Denk  and compressed attachments must not be used.
4224c609719bSwdenk
422552f52c14Swdenk* If one logical set of modifications affects or creates several
422652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
422752f52c14Swdenk
422852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
422952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
423052f52c14Swdenk
423152f52c14Swdenk
4232c609719bSwdenkNotes:
4233c609719bSwdenk
4234c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4235c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4236c609719bSwdenk  for any of the boards.
4237c609719bSwdenk
4238c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4239c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4240c609719bSwdenk  returned with a request to re-formatting / split it.
4241c609719bSwdenk
4242c609719bSwdenk* If you modify existing code, make sure that your new code does not
4243c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4244c609719bSwdenk  When adding new features, these should compile conditionally only
4245c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4246c609719bSwdenk  disabled must not need more memory than the old code without your
4247c609719bSwdenk  modification.
424890dc6704Swdenk
42490668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
42500668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
42510668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
42520668236bSWolfgang Denk  bigger than the size limit should be avoided.
4253