xref: /openbmc/u-boot/README (revision 3887c3fbdbbe6bbb4df60ed415c8e1ab9fe56b5e)
1c609719bSwdenk#
2218ca724SWolfgang Denk# (C) Copyright 2000 - 2008
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
1417152b1d0Swdenk- board		Board dependent files
1427152b1d0Swdenk- common	Misc architecture independent functions
143c609719bSwdenk- cpu		CPU specific files
144983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
14511dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
14611dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
147a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
148983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1491d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
15011dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
15111dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1528ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
15372a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
154adbfeeb7SMike Frysinger  - blackfin	Files specific to Analog Devices Blackfin CPUs
15511dadd54Swdenk  - i386	Files specific to i386 CPUs
15611dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
157b330990cSDaniel Hellstrom  - leon2	Files specific to Gaisler LEON2 SPARC CPU
1581e9a164eSDaniel Hellstrom  - leon3	Files specific to Gaisler LEON3 SPARC CPU
159983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
1601552af70STsiChungLiew  - mcf5227x	Files specific to Freescale ColdFire MCF5227x CPUs
1618e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
1628ae158cdSTsiChungLiew  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
16357a12720STsiChungLiew  - mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
16411dadd54Swdenk  - mips	Files specific to MIPS CPUs
165983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
166983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
167983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
168983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
169983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
170983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
171983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
17211dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1735c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1740c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
17511dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
17611dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
17711dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
178c609719bSwdenk- disk		Code for disk drive partition handling
179c609719bSwdenk- doc		Documentation (don't expect too much)
1807152b1d0Swdenk- drivers	Commonly used device drivers
181c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
182c609719bSwdenk- examples	Example code for standalone applications, etc.
183c609719bSwdenk- include	Header Files
18411dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1857b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
186adbfeeb7SMike Frysinger- lib_blackfin	Files generic to Blackfin architecture
18711dadd54Swdenk- lib_generic	Files generic to all	 architectures
18811dadd54Swdenk- lib_i386	Files generic to i386	 architecture
18911dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
19011dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
19111dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
19211dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
193c2f02da2SDaniel Hellstrom- lib_sparc	Files generic to SPARC	 architecture
194213bf8c8SGerald Van Baren- libfdt	Library files to support flattened device trees
195c609719bSwdenk- net		Networking code
196c609719bSwdenk- post		Power On Self Test
197c609719bSwdenk- rtc		Real Time Clock drivers
198c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
199c609719bSwdenk
200c609719bSwdenkSoftware Configuration:
201c609719bSwdenk=======================
202c609719bSwdenk
203c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
204c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
205c609719bSwdenk
206c609719bSwdenkThere are two classes of configuration variables:
207c609719bSwdenk
208c609719bSwdenk* Configuration _OPTIONS_:
209c609719bSwdenk  These are selectable by the user and have names beginning with
210c609719bSwdenk  "CONFIG_".
211c609719bSwdenk
212c609719bSwdenk* Configuration _SETTINGS_:
213c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
214c609719bSwdenk  you don't know what you're doing; they have names beginning with
2156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
216c609719bSwdenk
217c609719bSwdenkLater we will add a configuration tool - probably similar to or even
218c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
219c609719bSwdenkdo the configuration by hand, which means creating some symbolic
220c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
221c609719bSwdenkas an example here.
222c609719bSwdenk
223c609719bSwdenk
224c609719bSwdenkSelection of Processor Architecture and Board Type:
225c609719bSwdenk---------------------------------------------------
226c609719bSwdenk
227c609719bSwdenkFor all supported boards there are ready-to-use default
228c609719bSwdenkconfigurations available; just type "make <board_name>_config".
229c609719bSwdenk
230c609719bSwdenkExample: For a TQM823L module type:
231c609719bSwdenk
232c609719bSwdenk	cd u-boot
233c609719bSwdenk	make TQM823L_config
234c609719bSwdenk
23511ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
236c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
237c609719bSwdenkdirectory according to the instructions in cogent/README.
238c609719bSwdenk
239c609719bSwdenk
240c609719bSwdenkConfiguration Options:
241c609719bSwdenk----------------------
242c609719bSwdenk
243c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
244c609719bSwdenksuch information is kept in a configuration file
245c609719bSwdenk"include/configs/<board_name>.h".
246c609719bSwdenk
247c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
248c609719bSwdenk"include/configs/TQM823L.h".
249c609719bSwdenk
250c609719bSwdenk
2517f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2527f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2537f6c2cbcSwdenkbuild a config tool - later.
2547f6c2cbcSwdenk
2557f6c2cbcSwdenk
256c609719bSwdenkThe following options need to be configured:
257c609719bSwdenk
2582628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
259c609719bSwdenk
2602628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2616ccec449SWolfgang Denk
2626ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
26309ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
264c609719bSwdenk
265c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
266c609719bSwdenk		Define exactly one of
267c609719bSwdenk		CONFIG_CMA286_60_OLD
268c609719bSwdenk--- FIXME --- not tested yet:
269c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
271c609719bSwdenk
272c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
273c609719bSwdenk		Define exactly one of
274c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
275c609719bSwdenk
276c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277c609719bSwdenk		Define one or more of
278c609719bSwdenk		CONFIG_CMA302
279c609719bSwdenk
280c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281c609719bSwdenk		Define one or more of
282c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
28311ccc33fSMarcel Ziswiler					  the LCD display every second with
284c609719bSwdenk					  a "rotator" |\-/|\-/
285c609719bSwdenk
2862535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
2872535d602Swdenk		CONFIG_ADSTYPE
2882535d602Swdenk		Possible values are:
2896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
2906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
2916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
2926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
2932535d602Swdenk
294c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
295c609719bSwdenk		Define exactly one of
296c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
297c609719bSwdenk
29811ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
29966ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
30066ca92a5Swdenk					  get_gclk_freq() cannot work
3015da627a4Swdenk					  e.g. if there is no 32KHz
3025da627a4Swdenk					  reference PIT/RTC clock
30366ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
30466ca92a5Swdenk					  or XTAL/EXTAL)
305c609719bSwdenk
30666ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
30966ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
31075d1ea7fSwdenk			See doc/README.MPC866
31175d1ea7fSwdenk
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
31375d1ea7fSwdenk
31475d1ea7fSwdenk		Define this to measure the actual CPU clock instead
31575d1ea7fSwdenk		of relying on the correctness of the configured
31675d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
31775d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
31875d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
32075d1ea7fSwdenk
321506f3918SHeiko Schocher		CONFIG_SYS_DELAYED_ICACHE
322506f3918SHeiko Schocher
323506f3918SHeiko Schocher		Define this option if you want to enable the
324506f3918SHeiko Schocher		ICache only when Code runs from RAM.
325506f3918SHeiko Schocher
3260b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3280b953ffcSMarkus Klotzbuecher
3290b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3300b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3310b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3320b953ffcSMarkus Klotzbuecher
3336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3340b953ffcSMarkus Klotzbuecher
3350b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3360b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3370b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3380b953ffcSMarkus Klotzbuecher		by this value.
3390b953ffcSMarkus Klotzbuecher
3405da627a4Swdenk- Linux Kernel Interface:
341c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
342c609719bSwdenk
343c609719bSwdenk		U-Boot stores all clock information in Hz
344c609719bSwdenk		internally. For binary compatibility with older Linux
345c609719bSwdenk		kernels (which expect the clocks passed in the
346c609719bSwdenk		bd_info data to be in MHz) the environment variable
347c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
348c609719bSwdenk		converts clock data to MHZ before passing it to the
349c609719bSwdenk		Linux kernel.
350c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
351c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
352c609719bSwdenk		default environment.
353c609719bSwdenk
3545da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3555da627a4Swdenk
35611ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3575da627a4Swdenk		expect it to be in bytes, others in MB.
3585da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3595da627a4Swdenk
360fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
361f57f70aaSWolfgang Denk
362f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
363213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
364213bf8c8SGerald Van Baren		concepts).
365213bf8c8SGerald Van Baren
366213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
367213bf8c8SGerald Van Baren		 * New libfdt-based support
368213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3693bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
370213bf8c8SGerald Van Baren
371b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
372b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
373b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
374b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
375f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
376c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
377f57f70aaSWolfgang Denk
37811ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
37911ccc33fSMarcel Ziswiler		addresses
3803bb342fcSKim Phillips
3814e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
3824e253137SKumar Gala
3834e253137SKumar Gala		Board code has addition modification that it wants to make
3844e253137SKumar Gala		to the flat device tree before handing it off to the kernel
3856705d81eSwdenk
3860267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
3870267768eSMatthew McClintock
38811ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
3890267768eSMatthew McClintock		param header, the default value is zero if undefined.
3900267768eSMatthew McClintock
391*3887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
392*3887c3fbSHeiko Schocher
393*3887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
394*3887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
395*3887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
396*3887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
397*3887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
398*3887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
399*3887c3fbSHeiko Schocher
4000b2f4ecaSNiklaus Giger- vxWorks boot parameters:
4010b2f4ecaSNiklaus Giger
4020b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
4030b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
4040b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
4050b2f4ecaSNiklaus Giger
4060b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
4070b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
4080b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4090b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4100b2f4ecaSNiklaus Giger
4110b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4120b2f4ecaSNiklaus Giger
4130b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4140b2f4ecaSNiklaus Giger
4150b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4160b2f4ecaSNiklaus Giger		the defaults discussed just above.
4170b2f4ecaSNiklaus Giger
4186705d81eSwdenk- Serial Ports:
41948d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4206705d81eSwdenk
4216705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4226705d81eSwdenk
42348d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4246705d81eSwdenk
4256705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4266705d81eSwdenk
4276705d81eSwdenk		CONFIG_PL011_CLOCK
4286705d81eSwdenk
4296705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4306705d81eSwdenk		the clock speed of the UARTs.
4316705d81eSwdenk
4326705d81eSwdenk		CONFIG_PL01x_PORTS
4336705d81eSwdenk
4346705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4356705d81eSwdenk		define this to a list of base addresses for each (supported)
4366705d81eSwdenk		port. See e.g. include/configs/versatile.h
4376705d81eSwdenk
4386705d81eSwdenk
439c609719bSwdenk- Console Interface:
440c609719bSwdenk		Depending on board, define exactly one serial port
441c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
442c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
443c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
444c609719bSwdenk
445c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
446c609719bSwdenk		port routines must be defined elsewhere
447c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
448c609719bSwdenk
449c609719bSwdenk		CONFIG_CFB_CONSOLE
450c609719bSwdenk		Enables console device for a color framebuffer. Needs following
451c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
452c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
453c609719bSwdenk						(default big endian)
454c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
455c609719bSwdenk						rectangle fill
456c609719bSwdenk						(cf. smiLynxEM)
457c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
458c609719bSwdenk						bit-blit (cf. smiLynxEM)
459c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
460c609719bSwdenk						(cols=pitch)
461c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
462c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
463c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
464c609719bSwdenk						(0-5, cf. cfb_console.c)
465c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
466c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
467c609719bSwdenk						(i.e. i8042_kbd_init())
468c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
469c609719bSwdenk						(i.e. i8042_tstc)
470c609719bSwdenk			VIDEO_GETC_FCT		get char fct
471c609719bSwdenk						(i.e. i8042_getc)
472c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
473c609719bSwdenk						(requires blink timer
474c609719bSwdenk						cf. i8042.c)
4756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
476c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
477c609719bSwdenk						upper right corner
478602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
479c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
480c609719bSwdenk						upper left corner
481a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
482a6c7ad2fSwdenk						linux_logo.h for logo.
483a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
484c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
48511ccc33fSMarcel Ziswiler						additional board info beside
486c609719bSwdenk						the logo
487c609719bSwdenk
488c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
489c609719bSwdenk		default i/o. Serial console can be forced with
490c609719bSwdenk		environment 'console=serial'.
491c609719bSwdenk
492a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
493a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
494a3ad8e26Swdenk		the "silent" environment variable. See
495a3ad8e26Swdenk		doc/README.silent for more information.
496a3ad8e26Swdenk
497c609719bSwdenk- Console Baudrate:
498c609719bSwdenk		CONFIG_BAUDRATE - in bps
499c609719bSwdenk		Select one of the baudrates listed in
5006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
5016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
502c609719bSwdenk
503c92fac91SHeiko Schocher- Console Rx buffer length
504c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
505c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
5062b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
507c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
508c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
509c92fac91SHeiko Schocher		the SMC.
510c92fac91SHeiko Schocher
511c609719bSwdenk- Interrupt driven serial port input:
512c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
513c609719bSwdenk
514c609719bSwdenk		PPC405GP only.
515c609719bSwdenk		Use an interrupt handler for receiving data on the
516c609719bSwdenk		serial port. It also enables using hardware handshake
517c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
518c609719bSwdenk		bytes the interrupt driven input buffer should have.
519c609719bSwdenk
520109c0e3aSwdenk		Leave undefined to disable this feature, including
521109c0e3aSwdenk		disable the buffer and hardware handshake.
522c609719bSwdenk
5231d49b1f3Sstroese- Console UART Number:
5241d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5251d49b1f3Sstroese
5260c8721a4SWolfgang Denk		AMCC PPC4xx only.
5271d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5281d49b1f3Sstroese		as default U-Boot console.
5291d49b1f3Sstroese
530c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
531c609719bSwdenk		Delay before automatically booting the default image;
532c609719bSwdenk		set to -1 to disable autoboot.
533c609719bSwdenk
534c609719bSwdenk		See doc/README.autoboot for these options that
535c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
536c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
537c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
538c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
539c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
540c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
541c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
542c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
543c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
544c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
545c609719bSwdenk		CONFIG_RESET_TO_RETRY
546c609719bSwdenk
547c609719bSwdenk- Autoboot Command:
548c609719bSwdenk		CONFIG_BOOTCOMMAND
549c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
550c609719bSwdenk		define a command string that is automatically executed
551c609719bSwdenk		when no character is read on the console interface
552c609719bSwdenk		within "Boot Delay" after reset.
553c609719bSwdenk
554c609719bSwdenk		CONFIG_BOOTARGS
555c609719bSwdenk		This can be used to pass arguments to the bootm
556c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
557c609719bSwdenk		environment value "bootargs".
558c609719bSwdenk
559c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
560c609719bSwdenk		The value of these goes into the environment as
561c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
562c609719bSwdenk		as a convenience, when switching between booting from
56311ccc33fSMarcel Ziswiler		RAM and NFS.
564c609719bSwdenk
565c609719bSwdenk- Pre-Boot Commands:
566c609719bSwdenk		CONFIG_PREBOOT
567c609719bSwdenk
568c609719bSwdenk		When this option is #defined, the existence of the
569c609719bSwdenk		environment variable "preboot" will be checked
570c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
571c609719bSwdenk		countdown and/or running the auto-boot command resp.
572c609719bSwdenk		entering interactive mode.
573c609719bSwdenk
574c609719bSwdenk		This feature is especially useful when "preboot" is
575c609719bSwdenk		automatically generated or modified. For an example
576c609719bSwdenk		see the LWMON board specific code: here "preboot" is
577c609719bSwdenk		modified when the user holds down a certain
578c609719bSwdenk		combination of keys on the (special) keyboard when
579c609719bSwdenk		booting the systems
580c609719bSwdenk
581c609719bSwdenk- Serial Download Echo Mode:
582c609719bSwdenk		CONFIG_LOADS_ECHO
583c609719bSwdenk		If defined to 1, all characters received during a
584c609719bSwdenk		serial download (using the "loads" command) are
585c609719bSwdenk		echoed back. This might be needed by some terminal
586c609719bSwdenk		emulations (like "cu"), but may as well just take
587c609719bSwdenk		time on others. This setting #define's the initial
588c609719bSwdenk		value of the "loads_echo" environment variable.
589c609719bSwdenk
590602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
591c609719bSwdenk		CONFIG_KGDB_BAUDRATE
592c609719bSwdenk		Select one of the baudrates listed in
5936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
594c609719bSwdenk
595c609719bSwdenk- Monitor Functions:
596602ad3b3SJon Loeliger		Monitor commands can be included or excluded
597602ad3b3SJon Loeliger		from the build by using the #include files
598602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
599602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
600602ad3b3SJon Loeliger		and augmenting with additional #define's
601602ad3b3SJon Loeliger		for wanted commands.
602c609719bSwdenk
603602ad3b3SJon Loeliger		The default command configuration includes all commands
604602ad3b3SJon Loeliger		except those marked below with a "*".
605602ad3b3SJon Loeliger
606602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
607602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
608602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
609602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
610602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
611602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
612602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
613602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
614602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
615602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
616602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
617a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
618a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
619a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
620a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
621602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
622602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
623602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
624602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
625bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
626602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
627602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
628602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
629602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
630602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
631602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
632602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
633602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
634602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
635602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
636602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
637602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
638602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
639602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
640602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
641602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
642602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
64302c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
64402c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
645602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
64656523f12Swdenk					  loop, loopw, mtest
647602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
648602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
649602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
65068d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
651602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
652602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
653e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
654e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
655602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
656602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
657602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
658602ad3b3SJon Loeliger					  host
659602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
660602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
661602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
662602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
663602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
664602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
665602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
666602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
667602ad3b3SJon Loeliger					  (4xx only)
66802c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
66902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
67074de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
671602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
672602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
673602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
674602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
675602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
676c609719bSwdenk
677c609719bSwdenk
678c609719bSwdenk		EXAMPLE: If you want all functions except of network
679c609719bSwdenk		support you can write:
680c609719bSwdenk
681602ad3b3SJon Loeliger		#include "config_cmd_all.h"
682602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
683c609719bSwdenk
684213bf8c8SGerald Van Baren	Other Commands:
685213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
686c609719bSwdenk
687c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
688602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
689c609719bSwdenk		what you (and your U-Boot users) are doing. Data
690c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
691c609719bSwdenk		8260 (where accesses to the IMMR region must be
692c609719bSwdenk		uncached), and it cannot be disabled on all other
693c609719bSwdenk		systems where we (mis-) use the data cache to hold an
694c609719bSwdenk		initial stack and some data.
695c609719bSwdenk
696c609719bSwdenk
697c609719bSwdenk		XXX - this list needs to get updated!
698c609719bSwdenk
699c609719bSwdenk- Watchdog:
700c609719bSwdenk		CONFIG_WATCHDOG
701c609719bSwdenk		If this variable is defined, it enables watchdog
7027152b1d0Swdenk		support. There must be support in the platform specific
703c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
704c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
705c609719bSwdenk		register.
706c609719bSwdenk
707c1551ea8Sstroese- U-Boot Version:
708c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
709c1551ea8Sstroese		If this variable is defined, an environment variable
710c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
711c1551ea8Sstroese		version as printed by the "version" command.
712c1551ea8Sstroese		This variable is readonly.
713c1551ea8Sstroese
714c609719bSwdenk- Real-Time Clock:
715c609719bSwdenk
716602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
717c609719bSwdenk		has to be selected, too. Define exactly one of the
718c609719bSwdenk		following options:
719c609719bSwdenk
720c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
721c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7227ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
723c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7241cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
725c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7267f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7273bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7289536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7294c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
731c609719bSwdenk
732b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
733b37c7e5eSwdenk		must also be configured. See I2C Support, below.
734b37c7e5eSwdenk
735e92739d3SPeter Tyser- GPIO Support:
736e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
737e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
738e92739d3SPeter Tyser
739e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
740e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
741e92739d3SPeter Tyser
742c609719bSwdenk- Timestamp Support:
743c609719bSwdenk
744c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
745c609719bSwdenk		(date and time) of an image is printed by image
746c609719bSwdenk		commands like bootm or iminfo. This option is
747602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
748c609719bSwdenk
749c609719bSwdenk- Partition Support:
750c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
75107f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
752c609719bSwdenk
753602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
754218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
755218ca724SWolfgang Denk		least one partition type as well.
756c609719bSwdenk
757c609719bSwdenk- IDE Reset method:
7584d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7594d13cbadSwdenk		board configurations files but used nowhere!
760c609719bSwdenk
7614d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7624d13cbadSwdenk		be performed by calling the function
7634d13cbadSwdenk			ide_set_reset(int reset)
7644d13cbadSwdenk		which has to be defined in a board specific file
765c609719bSwdenk
766c609719bSwdenk- ATAPI Support:
767c609719bSwdenk		CONFIG_ATAPI
768c609719bSwdenk
769c609719bSwdenk		Set this to enable ATAPI support.
770c609719bSwdenk
771c40b2956Swdenk- LBA48 Support
772c40b2956Swdenk		CONFIG_LBA48
773c40b2956Swdenk
774c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
776c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
777c40b2956Swdenk		support disks up to 2.1TB.
778c40b2956Swdenk
7796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
780c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
781c40b2956Swdenk			Default is 32bit.
782c40b2956Swdenk
783c609719bSwdenk- SCSI Support:
784c609719bSwdenk		At the moment only there is only support for the
785c609719bSwdenk		SYM53C8XX SCSI controller; define
786c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
787c609719bSwdenk
7886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
7896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
7906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
791c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
792c609719bSwdenk		devices.
7936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
794c609719bSwdenk
795c609719bSwdenk- NETWORK Support (PCI):
796682011ffSwdenk		CONFIG_E1000
797682011ffSwdenk		Support for Intel 8254x gigabit chips.
798682011ffSwdenk
799ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
80011ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
801ac3315c2SAndre Schwarz
802c609719bSwdenk		CONFIG_EEPRO100
803c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
80411ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
805c609719bSwdenk		write routine for first time initialisation.
806c609719bSwdenk
807c609719bSwdenk		CONFIG_TULIP
808c609719bSwdenk		Support for Digital 2114x chips.
809c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
810c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
811c609719bSwdenk
812c609719bSwdenk		CONFIG_NATSEMI
813c609719bSwdenk		Support for National dp83815 chips.
814c609719bSwdenk
815c609719bSwdenk		CONFIG_NS8382X
816c609719bSwdenk		Support for National dp8382[01] gigabit chips.
817c609719bSwdenk
81845219c46Swdenk- NETWORK Support (other):
81945219c46Swdenk
82045219c46Swdenk		CONFIG_DRIVER_LAN91C96
82145219c46Swdenk		Support for SMSC's LAN91C96 chips.
82245219c46Swdenk
82345219c46Swdenk			CONFIG_LAN91C96_BASE
82445219c46Swdenk			Define this to hold the physical address
82545219c46Swdenk			of the LAN91C96's I/O space
82645219c46Swdenk
82745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
82845219c46Swdenk			Define this to enable 32 bit addressing
82945219c46Swdenk
830f39748aeSwdenk		CONFIG_DRIVER_SMC91111
831f39748aeSwdenk		Support for SMSC's LAN91C111 chip
832f39748aeSwdenk
833f39748aeSwdenk			CONFIG_SMC91111_BASE
834f39748aeSwdenk			Define this to hold the physical address
835f39748aeSwdenk			of the device (I/O space)
836f39748aeSwdenk
837f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
838f39748aeSwdenk			Define this if data bus is 32 bits
839f39748aeSwdenk
840f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
841f39748aeSwdenk			Define this to use i/o functions instead of macros
842f39748aeSwdenk			(some hardware wont work with macros)
843f39748aeSwdenk
844557b377dSJens Gehrlein		CONFIG_DRIVER_SMC911X
845557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
846557b377dSJens Gehrlein
847557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_BASE
848557b377dSJens Gehrlein			Define this to hold the physical address
849557b377dSJens Gehrlein			of the device (I/O space)
850557b377dSJens Gehrlein
851557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_32_BIT
852557b377dSJens Gehrlein			Define this if data bus is 32 bits
853557b377dSJens Gehrlein
854557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_16_BIT
855557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
856557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
857557b377dSJens Gehrlein			words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
858557b377dSJens Gehrlein
859c609719bSwdenk- USB Support:
860c609719bSwdenk		At the moment only the UHCI host controller is
8614d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
862c609719bSwdenk		CONFIG_USB_UHCI to enable it.
863c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
86430d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
865c609719bSwdenk		storage devices.
866c609719bSwdenk		Note:
867c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
868c609719bSwdenk		(TEAC FD-05PUB).
8694d13cbadSwdenk		MPC5200 USB requires additional defines:
8704d13cbadSwdenk			CONFIG_USB_CLOCK
8714d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
872307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
873307ecb6dSEric Millbrandt				for USB on PSC3
8744d13cbadSwdenk			CONFIG_USB_CONFIG
8754d13cbadSwdenk				for differential drivers: 0x00001000
8764d13cbadSwdenk				for single ended drivers: 0x00005000
877307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
878307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
8796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
880fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
881fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
8824d13cbadSwdenk
88316c8d5e7SWolfgang Denk- USB Device:
88416c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
88516c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
88616c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
88711ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
88816c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
88916c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
89016c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
89116c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
89216c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
89316c8d5e7SWolfgang Denk		a Linux host by
89416c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
89516c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
89616c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
89716c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
89816c8d5e7SWolfgang Denk
89916c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
90016c8d5e7SWolfgang Denk			Define this to build a UDC device
90116c8d5e7SWolfgang Denk
90216c8d5e7SWolfgang Denk			CONFIG_USB_TTY
90316c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
90416c8d5e7SWolfgang Denk			talk to the UDC device
90516c8d5e7SWolfgang Denk
9066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
90716c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
90816c8d5e7SWolfgang Denk			be set to usbtty.
90916c8d5e7SWolfgang Denk
91016c8d5e7SWolfgang Denk			mpc8xx:
9116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
91216c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
91416c8d5e7SWolfgang Denk
9156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
91616c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
91816c8d5e7SWolfgang Denk
91916c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
92016c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
92116c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
92216c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
92316c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
92416c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
92516c8d5e7SWolfgang Denk
92616c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
92716c8d5e7SWolfgang Denk			Define this string as the name of your company for
92816c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
92916c8d5e7SWolfgang Denk
93016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
93116c8d5e7SWolfgang Denk			Define this string as the name of your product
93216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
93316c8d5e7SWolfgang Denk
93416c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
93516c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
93616c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
93716c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
93816c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
93916c8d5e7SWolfgang Denk
94016c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
94116c8d5e7SWolfgang Denk			Define this as the unique Product ID
94216c8d5e7SWolfgang Denk			for your device
94316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
944c609719bSwdenk
945c609719bSwdenk
946c609719bSwdenk- MMC Support:
947c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
948c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
949c609719bSwdenk		accessed from the boot prompt by mapping the device
950c609719bSwdenk		to physical memory similar to flash. Command line is
951602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
952602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
953c609719bSwdenk
9546705d81eSwdenk- Journaling Flash filesystem support:
9556705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9566705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9576705d81eSwdenk		Define these for a default partition on a NAND device
9586705d81eSwdenk
9596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9616705d81eSwdenk		Define these for a default partition on a NOR device
9626705d81eSwdenk
9636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9646705d81eSwdenk		Define this to create an own partition. You have to provide a
9656705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9666705d81eSwdenk
9676705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
9696705d81eSwdenk		to disable the command chpart. This is the default when you
9706705d81eSwdenk		have not defined a custom partition
9716705d81eSwdenk
972c609719bSwdenk- Keyboard Support:
973c609719bSwdenk		CONFIG_ISA_KEYBOARD
974c609719bSwdenk
975c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
976c609719bSwdenk		support
977c609719bSwdenk
978c609719bSwdenk		CONFIG_I8042_KBD
979c609719bSwdenk		Standard PC keyboard driver with US (is default) and
980c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
981c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
982c609719bSwdenk		for cfb_console. Supports cursor blinking.
983c609719bSwdenk
984c609719bSwdenk- Video support:
985c609719bSwdenk		CONFIG_VIDEO
986c609719bSwdenk
987c609719bSwdenk		Define this to enable video support (for output to
988c609719bSwdenk		video).
989c609719bSwdenk
990c609719bSwdenk		CONFIG_VIDEO_CT69000
991c609719bSwdenk
992c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
993c609719bSwdenk
994c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
995eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
996eeb1b77bSwdenk		video output is selected via environment 'videoout'
997eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
998eeb1b77bSwdenk		assumed.
999c609719bSwdenk
1000eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
100111ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
1002eeb1b77bSwdenk		are possible:
1003eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1004eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1005eeb1b77bSwdenk
1006eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1007eeb1b77bSwdenk		-------------+---------------------------------------------
1008eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1009eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1010eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1011eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1012eeb1b77bSwdenk		-------------+---------------------------------------------
1013c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1014c609719bSwdenk
1015eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10167817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1017eeb1b77bSwdenk
1018eeb1b77bSwdenk
1019a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1020a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1021a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1022a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1023a6c7ad2fSwdenk
1024682011ffSwdenk- Keyboard Support:
1025682011ffSwdenk		CONFIG_KEYBOARD
1026682011ffSwdenk
1027682011ffSwdenk		Define this to enable a custom keyboard support.
1028682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1029682011ffSwdenk		defined in your board-specific files.
1030682011ffSwdenk		The only board using this so far is RBC823.
1031a6c7ad2fSwdenk
1032c609719bSwdenk- LCD Support:	CONFIG_LCD
1033c609719bSwdenk
1034c609719bSwdenk		Define this to enable LCD support (for output to LCD
1035c609719bSwdenk		display); also select one of the supported displays
1036c609719bSwdenk		by defining one of these:
1037c609719bSwdenk
103839cf4804SStelian Pop		CONFIG_ATMEL_LCD:
103939cf4804SStelian Pop
104039cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
104139cf4804SStelian Pop
1042fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1043c609719bSwdenk
1044fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1045c609719bSwdenk
1046fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1047c609719bSwdenk
1048fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1049fd3103bbSwdenk			Active, color, single scan.
1050fd3103bbSwdenk
1051fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1052fd3103bbSwdenk
1053fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1054c609719bSwdenk			Active, color, single scan.
1055c609719bSwdenk
1056c609719bSwdenk		CONFIG_SHARP_16x9
1057c609719bSwdenk
1058c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1059c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1060c609719bSwdenk
1061c609719bSwdenk		CONFIG_SHARP_LQ64D341
1062c609719bSwdenk
1063c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1064c609719bSwdenk			Active, color, single scan.
1065c609719bSwdenk
1066c609719bSwdenk		CONFIG_HLD1045
1067c609719bSwdenk
1068c609719bSwdenk			HLD1045 display, 640x480.
1069c609719bSwdenk			Active, color, single scan.
1070c609719bSwdenk
1071c609719bSwdenk		CONFIG_OPTREX_BW
1072c609719bSwdenk
1073c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1074c609719bSwdenk			or
1075c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1076c609719bSwdenk			or
1077c609719bSwdenk			Hitachi	 SP14Q002
1078c609719bSwdenk
1079c609719bSwdenk			320x240. Black & white.
1080c609719bSwdenk
1081c609719bSwdenk		Normally display is black on white background; define
10826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1083c609719bSwdenk
10847152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1085d791b1dcSwdenk
1086d791b1dcSwdenk		If this option is set, the environment is checked for
1087d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1088d791b1dcSwdenk		of logo, copyright and system information on the LCD
1089e94d2cd9Swdenk		is suppressed and the BMP image at the address
1090d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1091d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1092d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1093d791b1dcSwdenk		loaded very quickly after power-on.
1094d791b1dcSwdenk
10951ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
10961ca298ceSMatthias Weisser
10971ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
10981ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
10991ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
11001ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
11011ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
11021ca298ceSMatthias Weisser		specify 'm' for centering the image.
11031ca298ceSMatthias Weisser
11041ca298ceSMatthias Weisser		Example:
11051ca298ceSMatthias Weisser		setenv splashpos m,m
11061ca298ceSMatthias Weisser			=> image at center of screen
11071ca298ceSMatthias Weisser
11081ca298ceSMatthias Weisser		setenv splashpos 30,20
11091ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11101ca298ceSMatthias Weisser
11111ca298ceSMatthias Weisser		setenv splashpos -10,m
11121ca298ceSMatthias Weisser			=> vertically centered image
11131ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11141ca298ceSMatthias Weisser
111598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
111698f4a3dfSStefan Roese
111798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
111898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
111998f4a3dfSStefan Roese		splashscreen support or the bmp command.
112098f4a3dfSStefan Roese
1121c29fdfc1Swdenk- Compression support:
1122c29fdfc1Swdenk		CONFIG_BZIP2
1123c29fdfc1Swdenk
1124c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1125c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1126c29fdfc1Swdenk		compressed images are supported.
1127c29fdfc1Swdenk
1128c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1130c29fdfc1Swdenk		be at least 4MB.
1131d791b1dcSwdenk
1132fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1133fc9c1727SLuigi 'Comio' Mantellini
1134fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1135fc9c1727SLuigi 'Comio' Mantellini		images is included.
1136fc9c1727SLuigi 'Comio' Mantellini
1137fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1138fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1139fc9c1727SLuigi 'Comio' Mantellini		formula:
1140fc9c1727SLuigi 'Comio' Mantellini
1141fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1142fc9c1727SLuigi 'Comio' Mantellini
1143fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1144fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1145fc9c1727SLuigi 'Comio' Mantellini
1146fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1147fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1148fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1149fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1150fc9c1727SLuigi 'Comio' Mantellini
1151fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1152fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1154fc9c1727SLuigi 'Comio' Mantellini
115517ea1177Swdenk- MII/PHY support:
115617ea1177Swdenk		CONFIG_PHY_ADDR
115717ea1177Swdenk
115817ea1177Swdenk		The address of PHY on MII bus.
115917ea1177Swdenk
116017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
116117ea1177Swdenk
116217ea1177Swdenk		The clock frequency of the MII bus
116317ea1177Swdenk
116417ea1177Swdenk		CONFIG_PHY_GIGE
116517ea1177Swdenk
116617ea1177Swdenk		If this option is set, support for speed/duplex
116711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
116817ea1177Swdenk
116917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
117017ea1177Swdenk
117117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
117217ea1177Swdenk		reset before any MII register access is possible.
117317ea1177Swdenk		For such PHY, set this option to the usec delay
117417ea1177Swdenk		required. (minimum 300usec for LXT971A)
117517ea1177Swdenk
117617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
117717ea1177Swdenk
117817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
117917ea1177Swdenk		command issued before MII status register can be read
118017ea1177Swdenk
1181c609719bSwdenk- Ethernet address:
1182c609719bSwdenk		CONFIG_ETHADDR
1183c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1184c609719bSwdenk		CONFIG_ETH2ADDR
1185c609719bSwdenk		CONFIG_ETH3ADDR
1186c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1187c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1188c609719bSwdenk
118911ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
119011ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1191c609719bSwdenk		is not determined automatically.
1192c609719bSwdenk
1193c609719bSwdenk- IP address:
1194c609719bSwdenk		CONFIG_IPADDR
1195c609719bSwdenk
1196c609719bSwdenk		Define a default value for the IP address to use for
119711ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1198c609719bSwdenk		determined through e.g. bootp.
1199c609719bSwdenk
1200c609719bSwdenk- Server IP address:
1201c609719bSwdenk		CONFIG_SERVERIP
1202c609719bSwdenk
1203c609719bSwdenk		Defines a default value for the IP address of a TFTP
1204c609719bSwdenk		server to contact when using the "tftboot" command.
1205c609719bSwdenk
120697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
120797cfe861SRobin Getz
120897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
120997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
121097cfe861SRobin Getz
121153a5c424SDavid Updegraff- Multicast TFTP Mode:
121253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
121353a5c424SDavid Updegraff
121453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
121553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
121611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
121753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
121853a5c424SDavid Updegraff		multicast group.
121953a5c424SDavid Updegraff
122053a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1221c609719bSwdenk- BOOTP Recovery Mode:
1222c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1223c609719bSwdenk
1224c609719bSwdenk		If you have many targets in a network that try to
1225c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1226c609719bSwdenk		systems send out BOOTP requests at precisely the same
1227c609719bSwdenk		moment (which would happen for instance at recovery
1228c609719bSwdenk		from a power failure, when all systems will try to
1229c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1230c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1231c609719bSwdenk		inserted before sending out BOOTP requests. The
12326c33c785SWolfgang Denk		following delays are inserted then:
1233c609719bSwdenk
1234c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1235c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1236c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1237c609719bSwdenk		4th and following
1238c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1239c609719bSwdenk
1240fe389a82Sstroese- DHCP Advanced Options:
12411fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12421fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1243fe389a82Sstroese
12441fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12451fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12461fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12471fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12481fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12491fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12501fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12511fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12521fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12531fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12541fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12551fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1256fe389a82Sstroese
12575d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12585d110f0aSWilson Callan		environment variable, not the BOOTP server.
1259fe389a82Sstroese
1260fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1261fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1262fe389a82Sstroese		than one DNS serverip is offered to the client.
1263fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1264fe389a82Sstroese		serverip will be stored in the additional environment
1265fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1266fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
12671fe80d79SJon Loeliger		is defined.
1268fe389a82Sstroese
1269fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1270fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1271fe389a82Sstroese		need the hostname of the DHCP requester.
12725d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
12731fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
12741fe80d79SJon Loeliger		option 12 to the DHCP server.
1275fe389a82Sstroese
1276d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1277d9a2f416SAras Vaichas
1278d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1279d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1280d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1281d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1282d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1283d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1284d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1285d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1286d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1287d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1288d9a2f416SAras Vaichas		this delay.
1289d9a2f416SAras Vaichas
1290a3d991bdSwdenk - CDP Options:
1291a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1292a3d991bdSwdenk
1293a3d991bdSwdenk		The device id used in CDP trigger frames.
1294a3d991bdSwdenk
1295a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1296a3d991bdSwdenk
1297a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1298a3d991bdSwdenk		of the device.
1299a3d991bdSwdenk
1300a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1301a3d991bdSwdenk
1302a3d991bdSwdenk		A printf format string which contains the ascii name of
1303a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
130411ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1305a3d991bdSwdenk
1306a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1307a3d991bdSwdenk
1308a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1309a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1310a3d991bdSwdenk
1311a3d991bdSwdenk		CONFIG_CDP_VERSION
1312a3d991bdSwdenk
1313a3d991bdSwdenk		An ascii string containing the version of the software.
1314a3d991bdSwdenk
1315a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1316a3d991bdSwdenk
1317a3d991bdSwdenk		An ascii string containing the name of the platform.
1318a3d991bdSwdenk
1319a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1320a3d991bdSwdenk
1321a3d991bdSwdenk		A 32bit integer sent on the trigger.
1322a3d991bdSwdenk
1323a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1324a3d991bdSwdenk
1325a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1326a3d991bdSwdenk		device in .1 of milliwatts.
1327a3d991bdSwdenk
1328a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1329a3d991bdSwdenk
1330a3d991bdSwdenk		A byte containing the id of the VLAN.
1331a3d991bdSwdenk
1332c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1333c609719bSwdenk
1334c609719bSwdenk		Several configurations allow to display the current
1335c609719bSwdenk		status using a LED. For instance, the LED will blink
1336c609719bSwdenk		fast while running U-Boot code, stop blinking as
1337c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1338c609719bSwdenk		start blinking slow once the Linux kernel is running
1339c609719bSwdenk		(supported by a status LED driver in the Linux
1340c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1341c609719bSwdenk		feature in U-Boot.
1342c609719bSwdenk
1343c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1344c609719bSwdenk
1345c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1346c609719bSwdenk		on those systems that support this (optional)
1347c609719bSwdenk		feature, like the TQM8xxL modules.
1348c609719bSwdenk
1349c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1350c609719bSwdenk
1351b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1352b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
135311ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1354c609719bSwdenk
1355b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1356602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1357b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1358b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1359c609719bSwdenk		command line interface.
1360c609719bSwdenk
1361bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1362c609719bSwdenk
1363b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1364b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1365b37c7e5eSwdenk		support for I2C.
1366c609719bSwdenk
1367b37c7e5eSwdenk		There are several other quantities that must also be
1368b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1369c609719bSwdenk
13706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1371b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
13726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
137311ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1374c609719bSwdenk
1375b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
137611ccc33fSMarcel Ziswiler		sets the CPU up as a master node and so its address should
1377b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
13786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
1379b37c7e5eSwdenk
13805da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
13815da71efaSEric Millbrandt
13825da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
13835da71efaSEric Millbrandt		chips might think that the current transfer is still
13845da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
13855da71efaSEric Millbrandt		commands until the slave device responds.
13865da71efaSEric Millbrandt
1387b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1388b37c7e5eSwdenk
1389b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1390b37c7e5eSwdenk		then the following macros need to be defined (examples are
1391b37c7e5eSwdenk		from include/configs/lwmon.h):
1392c609719bSwdenk
1393c609719bSwdenk		I2C_INIT
1394c609719bSwdenk
1395b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1396c609719bSwdenk		controller or configure ports.
1397c609719bSwdenk
1398b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1399b37c7e5eSwdenk
1400c609719bSwdenk		I2C_PORT
1401c609719bSwdenk
1402c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1403c609719bSwdenk		assumes both bits are on the same port). Valid values
1404c609719bSwdenk		are 0..3 for ports A..D.
1405c609719bSwdenk
1406c609719bSwdenk		I2C_ACTIVE
1407c609719bSwdenk
1408c609719bSwdenk		The code necessary to make the I2C data line active
1409c609719bSwdenk		(driven).  If the data line is open collector, this
1410c609719bSwdenk		define can be null.
1411c609719bSwdenk
1412b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1413b37c7e5eSwdenk
1414c609719bSwdenk		I2C_TRISTATE
1415c609719bSwdenk
1416c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1417c609719bSwdenk		(inactive).  If the data line is open collector, this
1418c609719bSwdenk		define can be null.
1419c609719bSwdenk
1420b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1421b37c7e5eSwdenk
1422c609719bSwdenk		I2C_READ
1423c609719bSwdenk
1424c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1425c609719bSwdenk		FALSE if it is low.
1426c609719bSwdenk
1427b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1428b37c7e5eSwdenk
1429c609719bSwdenk		I2C_SDA(bit)
1430c609719bSwdenk
1431c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1432c609719bSwdenk		is FALSE, it clears it (low).
1433c609719bSwdenk
1434b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1435b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1436b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1437b37c7e5eSwdenk
1438c609719bSwdenk		I2C_SCL(bit)
1439c609719bSwdenk
1440c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1441c609719bSwdenk		is FALSE, it clears it (low).
1442c609719bSwdenk
1443b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1444b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1445b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1446b37c7e5eSwdenk
1447c609719bSwdenk		I2C_DELAY
1448c609719bSwdenk
1449c609719bSwdenk		This delay is invoked four times per clock cycle so this
1450c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1451b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1452b37c7e5eSwdenk		like:
1453b37c7e5eSwdenk
1454b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1455c609719bSwdenk
14566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
145747cd00faSwdenk
145847cd00faSwdenk		When a board is reset during an i2c bus transfer
145947cd00faSwdenk		chips might think that the current transfer is still
146047cd00faSwdenk		in progress. On some boards it is possible to access
146147cd00faSwdenk		the i2c SCLK line directly, either by using the
146247cd00faSwdenk		processor pin as a GPIO or by having a second pin
146347cd00faSwdenk		connected to the bus. If this option is defined a
146447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
146547cd00faSwdenk		is run early in the boot sequence.
146647cd00faSwdenk
146717ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
146817ea1177Swdenk
146917ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
147017ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
147117ea1177Swdenk		variable "i2cfast". (see also i2cfast)
147217ea1177Swdenk
1473bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1474bb99ad6dSBen Warren
1475bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1476bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1477bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1478bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1479bb99ad6dSBen Warren
14806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1481bb99ad6dSBen Warren
1482bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
14830f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
14840f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
14850f89c54bSPeter Tyser		a 1D array of device addresses
1486bb99ad6dSBen Warren
1487bb99ad6dSBen Warren		e.g.
1488bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
14896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1490bb99ad6dSBen Warren
1491bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1492bb99ad6dSBen Warren
1493bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
14946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1495bb99ad6dSBen Warren
1496bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1497bb99ad6dSBen Warren
14986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1499be5e6181STimur Tabi
1500be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1501be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1502be5e6181STimur Tabi
15036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
15040dc018ecSStefan Roese
15050dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
15060dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
15070dc018ecSStefan Roese
15086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15090dc018ecSStefan Roese
15100dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15110dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15120dc018ecSStefan Roese
15136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15149ebbb54fSVictor Gallardo
15159ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15169ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15179ebbb54fSVictor Gallardo		specified DTT device.
15189ebbb54fSVictor Gallardo
1519be5e6181STimur Tabi		CONFIG_FSL_I2C
1520be5e6181STimur Tabi
1521be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15227817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1523be5e6181STimur Tabi
152467b23a32SHeiko Schocher		CONFIG_I2C_MUX
152567b23a32SHeiko Schocher
152667b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
152767b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
152867b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
152967b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
153067b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
153167b23a32SHeiko Schocher		the muxes to activate this new "bus".
153267b23a32SHeiko Schocher
153367b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
153467b23a32SHeiko Schocher		feature!
153567b23a32SHeiko Schocher
153667b23a32SHeiko Schocher		Example:
153767b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
153867b23a32SHeiko Schocher			The First mux with address 70 and channel 6
153967b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
154067b23a32SHeiko Schocher
154167b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
154267b23a32SHeiko Schocher
154367b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
154467b23a32SHeiko Schocher		of I2C Busses with muxes:
154567b23a32SHeiko Schocher
154667b23a32SHeiko Schocher		=> i2c bus
154767b23a32SHeiko Schocher		Busses reached over muxes:
154867b23a32SHeiko Schocher		Bus ID: 2
154967b23a32SHeiko Schocher		  reached over Mux(es):
155067b23a32SHeiko Schocher		    pca9544a@70 ch: 4
155167b23a32SHeiko Schocher		Bus ID: 3
155267b23a32SHeiko Schocher		  reached over Mux(es):
155367b23a32SHeiko Schocher		    pca9544a@70 ch: 6
155467b23a32SHeiko Schocher		    pca9544a@71 ch: 4
155567b23a32SHeiko Schocher		=>
155667b23a32SHeiko Schocher
155767b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
155867b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
155967b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
156067b23a32SHeiko Schocher		the channel 4.
156167b23a32SHeiko Schocher
156267b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
156367b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
156467b23a32SHeiko Schocher		the 2 muxes.
156567b23a32SHeiko Schocher
156667b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
156767b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
156867b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
156967b23a32SHeiko Schocher		to add this option to other architectures.
157067b23a32SHeiko Schocher
15712ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
15722ac6985aSAndrew Dyer
15732ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
15742ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
15752ac6985aSAndrew Dyer		between writing the address pointer and reading the
15762ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
15772ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
15782ac6985aSAndrew Dyer		devices can use either method, but some require one or
15792ac6985aSAndrew Dyer		the other.
1580be5e6181STimur Tabi
1581c609719bSwdenk- SPI Support:	CONFIG_SPI
1582c609719bSwdenk
1583c609719bSwdenk		Enables SPI driver (so far only tested with
1584c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1585c609719bSwdenk		D/As on the SACSng board)
1586c609719bSwdenk
1587c609719bSwdenk		CONFIG_SPI_X
1588c609719bSwdenk
1589c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1590c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1591c609719bSwdenk
1592c609719bSwdenk		CONFIG_SOFT_SPI
1593c609719bSwdenk
1594c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1595c609719bSwdenk		using hardware support. This is a general purpose
1596c609719bSwdenk		driver that only requires three general I/O port pins
1597c609719bSwdenk		(two outputs, one input) to function. If this is
1598c609719bSwdenk		defined, the board configuration must define several
1599c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1600c609719bSwdenk		an example, see include/configs/sacsng.h.
1601c609719bSwdenk
160204a9e118SBen Warren		CONFIG_HARD_SPI
160304a9e118SBen Warren
160404a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
160504a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
160604a9e118SBen Warren		must define a list of chip-select function pointers.
160704a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
160804a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
160904a9e118SBen Warren
161038254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
161138254f45SGuennadi Liakhovetski
161238254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
161338254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
161438254f45SGuennadi Liakhovetski
16150133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16160133502eSMatthias Fuchs
16170133502eSMatthias Fuchs		Enables FPGA subsystem.
16180133502eSMatthias Fuchs
16190133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16200133502eSMatthias Fuchs
16210133502eSMatthias Fuchs		Enables support for specific chip vendors.
16220133502eSMatthias Fuchs		(ALTERA, XILINX)
16230133502eSMatthias Fuchs
16240133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16250133502eSMatthias Fuchs
16260133502eSMatthias Fuchs		Enables support for FPGA family.
16270133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16280133502eSMatthias Fuchs
16290133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1630c609719bSwdenk
1631c609719bSwdenk		Specify the number of FPGA devices to support.
1632c609719bSwdenk
16336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1634c609719bSwdenk
1635c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1636c609719bSwdenk
16376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1638c609719bSwdenk
1639c609719bSwdenk		Enable checks on FPGA configuration interface busy
1640c609719bSwdenk		status by the configuration function. This option
1641c609719bSwdenk		will require a board or device specific function to
1642c609719bSwdenk		be written.
1643c609719bSwdenk
1644c609719bSwdenk		CONFIG_FPGA_DELAY
1645c609719bSwdenk
1646c609719bSwdenk		If defined, a function that provides delays in the FPGA
1647c609719bSwdenk		configuration driver.
1648c609719bSwdenk
16496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1650c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1651c609719bSwdenk
16526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1653c609719bSwdenk
1654c609719bSwdenk		Check for configuration errors during FPGA bitfile
1655c609719bSwdenk		loading. For example, abort during Virtex II
1656c609719bSwdenk		configuration if the INIT_B line goes low (which
1657c609719bSwdenk		indicated a CRC error).
1658c609719bSwdenk
16596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1660c609719bSwdenk
1661c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1662c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1663c609719bSwdenk		FPGA configuration sequence. The default time is 500
166411ccc33fSMarcel Ziswiler		ms.
1665c609719bSwdenk
16666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1667c609719bSwdenk
1668c609719bSwdenk		Maximum time to wait for BUSY to deassert during
166911ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1670c609719bSwdenk
16716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1672c609719bSwdenk
1673c609719bSwdenk		Time to wait after FPGA configuration. The default is
167411ccc33fSMarcel Ziswiler		200 ms.
1675c609719bSwdenk
1676c609719bSwdenk- Configuration Management:
1677c609719bSwdenk		CONFIG_IDENT_STRING
1678c609719bSwdenk
1679c609719bSwdenk		If defined, this string will be added to the U-Boot
1680c609719bSwdenk		version information (U_BOOT_VERSION)
1681c609719bSwdenk
1682c609719bSwdenk- Vendor Parameter Protection:
1683c609719bSwdenk
1684c609719bSwdenk		U-Boot considers the values of the environment
1685c609719bSwdenk		variables "serial#" (Board Serial Number) and
16867152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1687c609719bSwdenk		are set once by the board vendor / manufacturer, and
1688c609719bSwdenk		protects these variables from casual modification by
1689c609719bSwdenk		the user. Once set, these variables are read-only,
1690c609719bSwdenk		and write or delete attempts are rejected. You can
169111ccc33fSMarcel Ziswiler		change this behaviour:
1692c609719bSwdenk
1693c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1694c609719bSwdenk		file, the write protection for vendor parameters is
169547cd00faSwdenk		completely disabled. Anybody can change or delete
1696c609719bSwdenk		these parameters.
1697c609719bSwdenk
1698c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1699c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
170011ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1701c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1702c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1703c609719bSwdenk		read-only.]
1704c609719bSwdenk
1705c609719bSwdenk- Protected RAM:
1706c609719bSwdenk		CONFIG_PRAM
1707c609719bSwdenk
1708c609719bSwdenk		Define this variable to enable the reservation of
1709c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1710c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1711c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1712c609719bSwdenk		this default value by defining an environment
1713c609719bSwdenk		variable "pram" to the number of kB you want to
1714c609719bSwdenk		reserve. Note that the board info structure will
1715c609719bSwdenk		still show the full amount of RAM. If pRAM is
1716c609719bSwdenk		reserved, a new environment variable "mem" will
1717c609719bSwdenk		automatically be defined to hold the amount of
1718c609719bSwdenk		remaining RAM in a form that can be passed as boot
1719c609719bSwdenk		argument to Linux, for instance like that:
1720c609719bSwdenk
1721fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1722c609719bSwdenk			saveenv
1723c609719bSwdenk
1724c609719bSwdenk		This way you can tell Linux not to use this memory,
1725c609719bSwdenk		either, which results in a memory region that will
1726c609719bSwdenk		not be affected by reboots.
1727c609719bSwdenk
1728c609719bSwdenk		*WARNING* If your board configuration uses automatic
1729c609719bSwdenk		detection of the RAM size, you must make sure that
1730c609719bSwdenk		this memory test is non-destructive. So far, the
1731c609719bSwdenk		following board configurations are known to be
1732c609719bSwdenk		"pRAM-clean":
1733c609719bSwdenk
1734c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1735c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1736c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1737c609719bSwdenk
1738c609719bSwdenk- Error Recovery:
1739c609719bSwdenk		CONFIG_PANIC_HANG
1740c609719bSwdenk
1741c609719bSwdenk		Define this variable to stop the system in case of a
1742c609719bSwdenk		fatal error, so that you have to reset it manually.
1743c609719bSwdenk		This is probably NOT a good idea for an embedded
174411ccc33fSMarcel Ziswiler		system where you want the system to reboot
1745c609719bSwdenk		automatically as fast as possible, but it may be
1746c609719bSwdenk		useful during development since you can try to debug
1747c609719bSwdenk		the conditions that lead to the situation.
1748c609719bSwdenk
1749c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1750c609719bSwdenk
1751c609719bSwdenk		This variable defines the number of retries for
1752c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1753c609719bSwdenk		before giving up the operation. If not defined, a
1754c609719bSwdenk		default value of 5 is used.
1755c609719bSwdenk
175640cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
175740cb90eeSGuennadi Liakhovetski
175840cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
175940cb90eeSGuennadi Liakhovetski
1760c609719bSwdenk- Command Interpreter:
17618078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
176204a85b3bSwdenk
176304a85b3bSwdenk		Enable auto completion of commands using TAB.
176404a85b3bSwdenk
17658078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
17668078f1a5SWolfgang Denk		for the "hush" shell.
17678078f1a5SWolfgang Denk
17688078f1a5SWolfgang Denk
17696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1770c609719bSwdenk
1771c609719bSwdenk		Define this variable to enable the "hush" shell (from
1772c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1773c609719bSwdenk		powerful command line syntax like
1774c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1775c609719bSwdenk		constructs ("shell scripts").
1776c609719bSwdenk
1777c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1778c609719bSwdenk		with a somewhat smaller memory footprint.
1779c609719bSwdenk
1780c609719bSwdenk
17816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1782c609719bSwdenk
1783c609719bSwdenk		This defines the secondary prompt string, which is
1784c609719bSwdenk		printed when the command interpreter needs more input
1785c609719bSwdenk		to complete a command. Usually "> ".
1786c609719bSwdenk
1787c609719bSwdenk	Note:
1788c609719bSwdenk
1789c609719bSwdenk		In the current implementation, the local variables
1790c609719bSwdenk		space and global environment variables space are
1791c609719bSwdenk		separated. Local variables are those you define by
17923b57fe0aSwdenk		simply typing `name=value'. To access a local
1793c609719bSwdenk		variable later on, you have write `$name' or
17943b57fe0aSwdenk		`${name}'; to execute the contents of a variable
17953b57fe0aSwdenk		directly type `$name' at the command prompt.
1796c609719bSwdenk
1797c609719bSwdenk		Global environment variables are those you use
1798c609719bSwdenk		setenv/printenv to work with. To run a command stored
1799c609719bSwdenk		in such a variable, you need to use the run command,
1800c609719bSwdenk		and you must not use the '$' sign to access them.
1801c609719bSwdenk
1802c609719bSwdenk		To store commands and special characters in a
1803c609719bSwdenk		variable, please use double quotation marks
1804c609719bSwdenk		surrounding the whole text of the variable, instead
1805c609719bSwdenk		of the backslashes before semicolons and special
1806c609719bSwdenk		symbols.
1807c609719bSwdenk
1808aa0c71acSWolfgang Denk- Commandline Editing and History:
1809aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1810aa0c71acSWolfgang Denk
181111ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1812aa0c71acSWolfgang Denk		commandline input operations
1813aa0c71acSWolfgang Denk
1814a8c7c708Swdenk- Default Environment:
1815c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1816c609719bSwdenk
1817c609719bSwdenk		Define this to contain any number of null terminated
1818c609719bSwdenk		strings (variable = value pairs) that will be part of
18197152b1d0Swdenk		the default environment compiled into the boot image.
18202262cfeeSwdenk
1821c609719bSwdenk		For example, place something like this in your
1822c609719bSwdenk		board's config file:
1823c609719bSwdenk
1824c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1825c609719bSwdenk			"myvar1=value1\0" \
1826c609719bSwdenk			"myvar2=value2\0"
1827c609719bSwdenk
1828c609719bSwdenk		Warning: This method is based on knowledge about the
1829c609719bSwdenk		internal format how the environment is stored by the
18302262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1831c609719bSwdenk		interface! Although it is unlikely that this format
18327152b1d0Swdenk		will change soon, there is no guarantee either.
1833c609719bSwdenk		You better know what you are doing here.
1834c609719bSwdenk
1835c609719bSwdenk		Note: overly (ab)use of the default environment is
1836c609719bSwdenk		discouraged. Make sure to check other ways to preset
183774de7aefSWolfgang Denk		the environment like the "source" command or the
1838c609719bSwdenk		boot command first.
1839c609719bSwdenk
1840a8c7c708Swdenk- DataFlash Support:
18412abbe075Swdenk		CONFIG_HAS_DATAFLASH
18422abbe075Swdenk
18432abbe075Swdenk		Defining this option enables DataFlash features and
18442abbe075Swdenk		allows to read/write in Dataflash via the standard
18452abbe075Swdenk		commands cp, md...
18462abbe075Swdenk
18473f85ce27Swdenk- SystemACE Support:
18483f85ce27Swdenk		CONFIG_SYSTEMACE
18493f85ce27Swdenk
18503f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
18513f85ce27Swdenk		chips attached via some sort of local bus. The address
185211ccc33fSMarcel Ziswiler		of the chip must also be defined in the
18536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
18543f85ce27Swdenk
18553f85ce27Swdenk		#define CONFIG_SYSTEMACE
18566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
18573f85ce27Swdenk
18583f85ce27Swdenk		When SystemACE support is added, the "ace" device type
18593f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
18603f85ce27Swdenk
1861ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1862ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1863ecb0ccd9SWolfgang Denk
186428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1865ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
186628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1867ecb0ccd9SWolfgang Denk		number generator is used.
1868ecb0ccd9SWolfgang Denk
186928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
187028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
187128cb9375SWolfgang Denk		defined, the normal port 69 is used.
187228cb9375SWolfgang Denk
187328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1874ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1875ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1876ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1877ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1878ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1879ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1880ecb0ccd9SWolfgang Denk
1881a8c7c708Swdenk- Show boot progress:
1882c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1883c609719bSwdenk
1884c609719bSwdenk		Defining this option allows to add some board-
1885c609719bSwdenk		specific code (calling a user-provided function
1886c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1887c609719bSwdenk		the system's boot progress on some display (for
1888c609719bSwdenk		example, some LED's) on your board. At the moment,
1889c609719bSwdenk		the following checkpoints are implemented:
1890c609719bSwdenk
18914bae9090SBartlomiej Sieka- Automatic software updates via TFTP server
18924bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP
18934bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_CNT_MAX
18944bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_MSEC_MAX
18954bae9090SBartlomiej Sieka
18964bae9090SBartlomiej Sieka		These options enable and control the auto-update feature;
18974bae9090SBartlomiej Sieka		for a more detailed description refer to doc/README.update.
18984bae9090SBartlomiej Sieka
1899d558107cSStefan Roese- MTD Support (mtdparts command, UBI support)
1900d558107cSStefan Roese		CONFIG_MTD_DEVICE
1901d558107cSStefan Roese
1902d558107cSStefan Roese		Adds the MTD device infrastructure from the Linux kernel.
1903d558107cSStefan Roese		Needed for mtdparts command support.
1904d558107cSStefan Roese
1905d558107cSStefan Roese		CONFIG_MTD_PARTITIONS
1906d558107cSStefan Roese
1907d558107cSStefan Roese		Adds the MTD partitioning infrastructure from the Linux
1908d558107cSStefan Roese		kernel. Needed for UBI support.
1909d558107cSStefan Roese
19101372cce2SMarian BalakowiczLegacy uImage format:
19111372cce2SMarian Balakowicz
1912c609719bSwdenk  Arg	Where			When
1913c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1914c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1915c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1916c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1917c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1918c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1919c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1920c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1921c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19221372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1923c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1924c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1925c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1926c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19271372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1928c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19291372cce2SMarian Balakowicz
19301372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19311372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19321372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19331372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19341372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19351372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19361372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
193711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19381372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19391372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19401372cce2SMarian Balakowicz
19411372cce2SMarian Balakowicz   15	lib_<arch>/bootm.c	All preparation done, transferring control to OS
1942c609719bSwdenk
194363e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
194463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
194563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
194663e73c9aSwdenk
1947566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1948566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1949566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1950566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1951566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1952566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1953566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1954566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1955566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1956566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1957566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1958566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1959566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1960566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1961566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1962566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1963566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1964566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1965566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1966566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1967566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1968566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1969566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1970566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1971566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1972566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1973566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1974566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1975566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1976566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1977566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1978566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1979566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1980566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1981566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1982566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1983566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1984566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1985566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1986566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1987566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1988566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1989566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1990566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1991566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1992566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1993566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1994c609719bSwdenk
1995566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1996c609719bSwdenk
1997566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
1998566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
1999566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2000206c60cbSwdenk
2001566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2002566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
200311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
2004566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
2005566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2006566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
200774de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
200874de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2009566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2010c609719bSwdenk
20111372cce2SMarian BalakowiczFIT uImage format:
20121372cce2SMarian Balakowicz
20131372cce2SMarian Balakowicz  Arg	Where			When
20141372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20151372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20161372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20171372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20181372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20191372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2020f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20211372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20221372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20231372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20241372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20251372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
202611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
202711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20281372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20291372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20301372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20311372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20321372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20331372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20341372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20351372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20361372cce2SMarian Balakowicz
20371372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20381372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20391372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
204011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20411372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20421372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20431372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20441372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20451372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20461372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20471372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20481372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20491372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20501372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20511372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20521372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20531372cce2SMarian Balakowicz
205411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20551372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20561372cce2SMarian Balakowicz
205711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20581372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20591372cce2SMarian Balakowicz
206011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20611372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20621372cce2SMarian Balakowicz
20631372cce2SMarian Balakowicz
2064c609719bSwdenkModem Support:
2065c609719bSwdenk--------------
2066c609719bSwdenk
206785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2068c609719bSwdenk
206911ccc33fSMarcel Ziswiler- Modem support enable:
2070c609719bSwdenk		CONFIG_MODEM_SUPPORT
2071c609719bSwdenk
2072c609719bSwdenk- RTS/CTS Flow control enable:
2073c609719bSwdenk		CONFIG_HWFLOW
2074c609719bSwdenk
2075c609719bSwdenk- Modem debug support:
2076c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2077c609719bSwdenk
2078c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2079c609719bSwdenk		for modem support. Useful only with BDI2000.
2080c609719bSwdenk
2081a8c7c708Swdenk- Interrupt support (PPC):
2082a8c7c708Swdenk
2083a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2084a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
208511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2086a8c7c708Swdenk		should set decrementer_count to appropriate value. If
208711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2088a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
208911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2090a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2091a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2092a8c7c708Swdenk		general timer_interrupt().
2093a8c7c708Swdenk
2094c609719bSwdenk- General:
2095c609719bSwdenk
2096c609719bSwdenk		In the target system modem support is enabled when a
2097c609719bSwdenk		specific key (key combination) is pressed during
2098c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
209911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2100c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2101c609719bSwdenk		function, returning 1 and thus enabling modem
2102c609719bSwdenk		initialization.
2103c609719bSwdenk
2104c609719bSwdenk		If there are no modem init strings in the
2105c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2106c609719bSwdenk		previous output (banner, info printfs) will be
210711ccc33fSMarcel Ziswiler		suppressed, though.
2108c609719bSwdenk
2109c609719bSwdenk		See also: doc/README.Modem
2110c609719bSwdenk
2111c609719bSwdenk
2112c609719bSwdenkConfiguration Settings:
2113c609719bSwdenk-----------------------
2114c609719bSwdenk
21156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2116c609719bSwdenk		undefine this when you're short of memory.
2117c609719bSwdenk
21182fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21192fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21202fb2604dSPeter Tyser
21216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2122c609719bSwdenk		prompt for user input.
2123c609719bSwdenk
21246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2125c609719bSwdenk
21266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2127c609719bSwdenk
21286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2129c609719bSwdenk
21306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2131c609719bSwdenk		the application (usually a Linux kernel) when it is
2132c609719bSwdenk		booted
2133c609719bSwdenk
21346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2135c609719bSwdenk		List of legal baudrate settings for this board.
2136c609719bSwdenk
21376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2138c609719bSwdenk		Suppress display of console information at boot.
2139c609719bSwdenk
21406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2141c609719bSwdenk		If the board specific function
2142c609719bSwdenk			extern int overwrite_console (void);
2143c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2144c609719bSwdenk		serial port, else the settings in the environment are used.
2145c609719bSwdenk
21466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2147c609719bSwdenk		Enable the call to overwrite_console().
2148c609719bSwdenk
21496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2150c609719bSwdenk		Enable overwrite of previous console environment settings.
2151c609719bSwdenk
21526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2153c609719bSwdenk		Begin and End addresses of the area used by the
2154c609719bSwdenk		simple memory test.
2155c609719bSwdenk
21566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2157c609719bSwdenk		Enable an alternate, more extensive memory test.
2158c609719bSwdenk
21596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
21605f535fe1Swdenk		Scratch address used by the alternate memory test
21615f535fe1Swdenk		You only need to set this if address zero isn't writeable
21625f535fe1Swdenk
21636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
21646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
216514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
216611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
216714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
216814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
216914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
21705e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
217114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
21725e12e75dSStefan Roese		will have to get fixed in Linux additionally.
217314f73ca6SStefan Roese
217414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
217514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
217614f73ca6SStefan Roese		be touched.
217714f73ca6SStefan Roese
217814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
217914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
218014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
218114f73ca6SStefan Roese		non page size aligned address and this could cause major
218214f73ca6SStefan Roese		problems.
218314f73ca6SStefan Roese
21846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2185c609719bSwdenk		Default load address for network file downloads
2186c609719bSwdenk
21876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2188c609719bSwdenk		Enable temporary baudrate change while serial download
2189c609719bSwdenk
21906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2191c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2192c609719bSwdenk
21936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2194c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2195c609719bSwdenk		Cogent motherboard)
2196c609719bSwdenk
21976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2198c609719bSwdenk		Physical start address of Flash memory.
2199c609719bSwdenk
22006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2201c609719bSwdenk		Physical start address of boot monitor code (set by
2202c609719bSwdenk		make config files to be same as the text base address
2203c609719bSwdenk		(TEXT_BASE) used when linking) - same as
22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2205c609719bSwdenk
22066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
22073b57fe0aSwdenk		Size of memory reserved for monitor code, used to
22083b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22093b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22103b57fe0aSwdenk		flash sector.
2211c609719bSwdenk
22126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2213c609719bSwdenk		Size of DRAM reserved for malloc() use.
2214c609719bSwdenk
22156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
221615940c9aSStefan Roese		Normally compressed uImages are limited to an
221715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
221915940c9aSStefan Roese		to adjust this setting to your needs.
2220c609719bSwdenk
22216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2222c609719bSwdenk		Maximum size of memory mapped by the startup code of
2223c609719bSwdenk		the Linux kernel; all data that must be processed by
22247d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22257d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22267d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22277d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2229c609719bSwdenk
22306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2231c609719bSwdenk		Max number of Flash memory banks
2232c609719bSwdenk
22336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2234c609719bSwdenk		Max number of sectors on a Flash chip
2235c609719bSwdenk
22366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2237c609719bSwdenk		Timeout for Flash erase operations (in ms)
2238c609719bSwdenk
22396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2240c609719bSwdenk		Timeout for Flash write operations (in ms)
2241c609719bSwdenk
22426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
22438564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
22448564acf9Swdenk
22456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
22468564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
22478564acf9Swdenk
22486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
22498564acf9Swdenk		If defined, hardware flash sectors protection is used
22508564acf9Swdenk		instead of U-Boot software protection.
22518564acf9Swdenk
22526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2253c609719bSwdenk
2254c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2255c609719bSwdenk		without this option such a download has to be
2256c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2257c609719bSwdenk		copy from RAM to flash.
2258c609719bSwdenk
2259c609719bSwdenk		The two-step approach is usually more reliable, since
2260c609719bSwdenk		you can check if the download worked before you erase
226111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
226211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2263c609719bSwdenk		downloaded image) this option may be very useful.
2264c609719bSwdenk
22656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2266c609719bSwdenk		Define if the flash driver uses extra elements in the
22675653fc33Swdenk		common flash structure for storing flash geometry.
22685653fc33Swdenk
226900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
22705653fc33Swdenk		This option also enables the building of the cfi_flash driver
22715653fc33Swdenk		in the drivers directory
227253cf9435Sstroese
227391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
227491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
227591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
227691809ed5SPiotr Ziecik		to the MTD layer.
227791809ed5SPiotr Ziecik
22786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
227996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
228096ef831fSGuennadi Liakhovetski
228196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
228296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
228396ef831fSGuennadi Liakhovetski		write commands.
228496ef831fSGuennadi Liakhovetski
22856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
22865568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
22875568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
22885568e613SStefan Roese		is useful, if some of the configured banks are only
22895568e613SStefan Roese		optionally available.
22905568e613SStefan Roese
22919a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
22929a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
22939a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
22949a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
22959a042e9cSJerry Van Baren
22966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
229711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
229811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
229953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
230053cf9435Sstroese		buffers can be full shortly after enabling the interface
230111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
230253cf9435Sstroese		Defaults to 4 if not defined.
2303c609719bSwdenk
2304c609719bSwdenkThe following definitions that deal with the placement and management
2305c609719bSwdenkof environment data (variable area); in general, we support the
2306c609719bSwdenkfollowing configurations:
2307c609719bSwdenk
23085a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2309c609719bSwdenk
2310c609719bSwdenk	Define this if the environment is in flash memory.
2311c609719bSwdenk
2312c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2313c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2314c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2315c609719bSwdenk	   sector" type flash chips, which have several smaller
2316c609719bSwdenk	   sectors at the start or the end. For instance, such a
2317c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2318c609719bSwdenk	   such a case you would place the environment in one of the
2319c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2320c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2321c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2322c609719bSwdenk	   between U-Boot and the environment.
2323c609719bSwdenk
23240e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2325c609719bSwdenk
2326c609719bSwdenk	   Offset of environment data (variable area) to the
2327c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2328c609719bSwdenk	   type flash chips the second sector can be used: the offset
2329c609719bSwdenk	   for this sector is given here.
2330c609719bSwdenk
23316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2332c609719bSwdenk
23330e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2334c609719bSwdenk
2335c609719bSwdenk	   This is just another way to specify the start address of
2336c609719bSwdenk	   the flash sector containing the environment (instead of
23370e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2338c609719bSwdenk
23390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2340c609719bSwdenk
2341c609719bSwdenk	   Size of the sector containing the environment.
2342c609719bSwdenk
2343c609719bSwdenk
2344c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2345c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2346c609719bSwdenk	   the environment.
2347c609719bSwdenk
23480e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2349c609719bSwdenk
23505a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
23510e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2352c609719bSwdenk	   of this flash sector for the environment. This saves
2353c609719bSwdenk	   memory for the RAM copy of the environment.
2354c609719bSwdenk
2355c609719bSwdenk	   It may also save flash memory if you decide to use this
2356c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2357c609719bSwdenk	   since then the remainder of the flash sector could be used
2358c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2359c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2360c609719bSwdenk	   updating the environment in flash makes it always
2361c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2362c609719bSwdenk	   wrong before the contents has been restored from a copy in
2363c609719bSwdenk	   RAM, your target system will be dead.
2364c609719bSwdenk
23650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
23660e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2367c609719bSwdenk
2368c609719bSwdenk	   These settings describe a second storage area used to hold
236911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
23703e38691eSwdenk	   a valid backup copy in case there is a power failure during
2371c609719bSwdenk	   a "saveenv" operation.
2372c609719bSwdenk
2373c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2374c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2375c609719bSwdenkaccordingly!
2376c609719bSwdenk
2377c609719bSwdenk
23789314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2379c609719bSwdenk
2380c609719bSwdenk	Define this if you have some non-volatile memory device
2381c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2382c609719bSwdenk	environment.
2383c609719bSwdenk
23840e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
23850e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2386c609719bSwdenk
238711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2388c609719bSwdenk	  want to use for environment. It is assumed that this memory
2389c609719bSwdenk	  can just be read and written to, without any special
2390c609719bSwdenk	  provision.
2391c609719bSwdenk
2392c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2393c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
239411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2395c609719bSwdenkU-Boot will hang.
2396c609719bSwdenk
2397c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2398c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2399c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2400c609719bSwdenkto save the current settings.
2401c609719bSwdenk
2402c609719bSwdenk
2403bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2404c609719bSwdenk
2405c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2406c609719bSwdenk	device and a driver for it.
2407c609719bSwdenk
24080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24090e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2410c609719bSwdenk
2411c609719bSwdenk	  These two #defines specify the offset and size of the
2412c609719bSwdenk	  environment area within the total memory of your EEPROM.
2413c609719bSwdenk
24146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2415c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2416c609719bSwdenk	  The default address is zero.
2417c609719bSwdenk
24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2419c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2420c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2421c609719bSwdenk	  would require six bits.
2422c609719bSwdenk
24236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2424c609719bSwdenk	  If defined, the number of milliseconds to delay between
2425c609719bSwdenk	  page writes.	The default is zero milliseconds.
2426c609719bSwdenk
24276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2428c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2429c609719bSwdenk	  that this is NOT the chip address length!
2430c609719bSwdenk
24316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
24325cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
24335cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
24345cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
24355cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
24365cf91d6bSwdenk	  byte chips.
24375cf91d6bSwdenk
24385cf91d6bSwdenk	  Note that we consider the length of the address field to
24395cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
24405cf91d6bSwdenk	  in the chip address.
24415cf91d6bSwdenk
24426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2443c609719bSwdenk	  The size in bytes of the EEPROM device.
2444c609719bSwdenk
2445c609719bSwdenk
2446057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
24475779d8d9Swdenk
24485779d8d9Swdenk	Define this if you have a DataFlash memory device which you
24495779d8d9Swdenk	want to use for the environment.
24505779d8d9Swdenk
24510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24520e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24530e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
24545779d8d9Swdenk
24555779d8d9Swdenk	  These three #defines specify the offset and size of the
24565779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
24575779d8d9Swdenk	  at the specified address.
24585779d8d9Swdenk
245951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
246013a5695bSwdenk
246113a5695bSwdenk	Define this if you have a NAND device which you want to use
246213a5695bSwdenk	for the environment.
246313a5695bSwdenk
24640e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24650e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
246613a5695bSwdenk
246713a5695bSwdenk	  These two #defines specify the offset and size of the environment
246813a5695bSwdenk	  area within the first NAND device.
24695779d8d9Swdenk
24700e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2471e443c944SMarkus Klotzbuecher
24720e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2473e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2474e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2475e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2476e443c944SMarkus Klotzbuecher
24770e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
24780e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2479e443c944SMarkus Klotzbuecher	the NAND devices block size.
2480e443c944SMarkus Klotzbuecher
2481b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2482b74ab737SGuennadi Liakhovetski
2483b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2484b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2485b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2486b74ab737SGuennadi Liakhovetski
24876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2488c609719bSwdenk
2489c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2490c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2491c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2492c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2493c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2494c609719bSwdenk	to be a good choice since it makes it far enough from the
2495c609719bSwdenk	start of the data area as well as from the stack pointer.
2496c609719bSwdenk
2497e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2498c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2499c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2500c609719bSwdenkuntil then to read environment variables.
2501c609719bSwdenk
250285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
250385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
250485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
250585ec0bccSwdenknecessary, because the first environment variable we need is the
250685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
250785ec0bccSwdenkhave any device yet where we could complain.]
2508c609719bSwdenk
2509c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2510c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
251185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2512c609719bSwdenk
25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2514fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2515fc3e2165Swdenk
25166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2517fc3e2165Swdenk		      also needs to be defined.
2518fc3e2165Swdenk
25196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2520fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2521c609719bSwdenk
25226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_VSPRINTF:
2523c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2524c40b2956Swdenk		of 64bit values by using the L quantifier
2525c40b2956Swdenk
25266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_STRTOUL:
2527c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2528c40b2956Swdenk
2529f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2530f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2531f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2532f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2533f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2534f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2535f5675aa5SRon Madrid
2536c609719bSwdenkLow Level (hardware related) configuration options:
2537dc7c9a1aSwdenk---------------------------------------------------
2538c609719bSwdenk
25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2540c609719bSwdenk		Cache Line Size of the CPU.
2541c609719bSwdenk
25426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2543c609719bSwdenk		Default address of the IMMR after system reset.
25442535d602Swdenk
25452535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
25462535d602Swdenk		and RPXsuper) to be able to adjust the position of
25472535d602Swdenk		the IMMR register after a reset.
2548c609719bSwdenk
25497f6c2cbcSwdenk- Floppy Disk Support:
25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
25517f6c2cbcSwdenk
25527f6c2cbcSwdenk		the default drive number (default value 0)
25537f6c2cbcSwdenk
25546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
25557f6c2cbcSwdenk
255611ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
25577f6c2cbcSwdenk		(default value 1)
25587f6c2cbcSwdenk
25596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
25607f6c2cbcSwdenk
25617f6c2cbcSwdenk		defines the offset of register from address. It
25627f6c2cbcSwdenk		depends on which part of the data bus is connected to
256311ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
25647f6c2cbcSwdenk
25656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
25677f6c2cbcSwdenk		default value.
25687f6c2cbcSwdenk
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
25707f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
25717f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
25727f6c2cbcSwdenk		source code. It is used to make hardware dependant
25737f6c2cbcSwdenk		initializations.
25747f6c2cbcSwdenk
25756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
257625d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
257725d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2578c609719bSwdenk
25796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2580c609719bSwdenk
25817152b1d0Swdenk		Start address of memory area that can be used for
2582c609719bSwdenk		initial data and stack; please note that this must be
2583c609719bSwdenk		writable memory that is working WITHOUT special
2584c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2585c609719bSwdenk		will become available only after programming the
2586c609719bSwdenk		memory controller and running certain initialization
2587c609719bSwdenk		sequences.
2588c609719bSwdenk
2589c609719bSwdenk		U-Boot uses the following memory types:
2590c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2591c609719bSwdenk		- MPC824X: data cache
2592c609719bSwdenk		- PPC4xx:  data cache
2593c609719bSwdenk
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2595c609719bSwdenk
2596c609719bSwdenk		Offset of the initial data structure in the memory
25976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
25986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2599c609719bSwdenk		data is located at the end of the available space
26006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
26016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
26026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
26036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2604c609719bSwdenk
2605c609719bSwdenk	Note:
2606c609719bSwdenk		On the MPC824X (or other systems that use the data
2607c609719bSwdenk		cache for initial memory) the address chosen for
26086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2609c609719bSwdenk		point to an otherwise UNUSED address space between
2610c609719bSwdenk		the top of RAM and the start of the PCI space.
2611c609719bSwdenk
26126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2613c609719bSwdenk
26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2615c609719bSwdenk
26166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2617c609719bSwdenk
26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2619c609719bSwdenk
26206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2621c609719bSwdenk
26226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2623c609719bSwdenk
26246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2625c609719bSwdenk		SDRAM timing
2626c609719bSwdenk
26276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2628c609719bSwdenk		periodic timer for refresh
2629c609719bSwdenk
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2631c609719bSwdenk
26326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
26336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2636c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2637c609719bSwdenk
2638c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
26396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
26406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2641c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2642c609719bSwdenk
26436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
26446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2645c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2646c609719bSwdenk		Prescaler definitions (SDRAM timing)
2647c609719bSwdenk
26486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2649c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2650c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2651c609719bSwdenk
26526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2653b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2654b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2655b423d055SHeiko Schocher
26566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2657c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2658c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2659c609719bSwdenk
26606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2661c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2662c609719bSwdenk		wrong setting might damage your board. Read
2663c609719bSwdenk		doc/README.MBX before setting this variable!
2664c609719bSwdenk
26656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2666ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2667ea909b76Swdenk		(Power On Self Tests). This definition overrides
2668ea909b76Swdenk		#define'd default value in commproc.h resp.
2669ea909b76Swdenk		cpm_8260.h.
2670ea909b76Swdenk
26716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
26726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
26736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
26746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
26756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
26766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
26776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
26786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
26795d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
26805d232d0eSwdenk
26819cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
26829cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
26839cacf4fcSDirk Eibach		required.
26849cacf4fcSDirk Eibach
2685bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2686218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2687218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2688218ca724SWolfgang Denk
2689bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2690bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2691bb99ad6dSBen Warren
26926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2693218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2694218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2695218ca724SWolfgang Denk		to something your driver can deal with.
2696bb99ad6dSBen Warren
26976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2698218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2699218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
27002ad6b513STimur Tabi
2701c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2702c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2703c26e454dSwdenk
2704c26e454dSwdenk- CONFIG_FEC[12]_PHY
2705c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
27066e592385Swdenk		to the given FEC; i. e.
2707c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2708c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2709c26e454dSwdenk
2710c26e454dSwdenk		When set to -1, means to probe for first available.
2711c26e454dSwdenk
2712c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2713c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2714c26e454dSwdenk		(so program the FEC to ignore it).
2715c26e454dSwdenk
2716c26e454dSwdenk- CONFIG_RMII
2717c26e454dSwdenk		Enable RMII mode for all FECs.
2718c26e454dSwdenk		Note that this is a global option, we can't
2719c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2720c26e454dSwdenk
27215cf91d6bSwdenk- CONFIG_CRC32_VERIFY
27225cf91d6bSwdenk		Add a verify option to the crc32 command.
27235cf91d6bSwdenk		The syntax is:
27245cf91d6bSwdenk
27255cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
27265cf91d6bSwdenk
27275cf91d6bSwdenk		Where address/count indicate a memory area
27285cf91d6bSwdenk		and crc32 is the correct crc32 which the
27295cf91d6bSwdenk		area should have.
27305cf91d6bSwdenk
273156523f12Swdenk- CONFIG_LOOPW
273256523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2733602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
273456523f12Swdenk
27357b466641Sstroese- CONFIG_MX_CYCLIC
27367b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
27377b466641Sstroese		"md/mw" commands.
27387b466641Sstroese		Examples:
27397b466641Sstroese
27407b466641Sstroese		=> mdc.b 10 4 500
27417b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
27427b466641Sstroese
27437b466641Sstroese		=> mwc.l 100 12345678 10
27447b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
27457b466641Sstroese
27467b466641Sstroese		This only takes effect if the memory commands are activated
2747602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
27487b466641Sstroese
27498aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
27508aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
27518aa1a2d1Swdenk
27528aa1a2d1Swdenk		[ARM only] If these variables are defined, then
27538aa1a2d1Swdenk		certain low level initializations (like setting up
27548aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
27558aa1a2d1Swdenk		not relocate itself into RAM.
27568aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
27578aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
27588aa1a2d1Swdenk		some other boot loader or by a debugger which
275911ccc33fSMarcel Ziswiler		performs these initializations itself.
27608aa1a2d1Swdenk
2761df81238bSMagnus Lilja- CONFIG_PRELOADER
2762df81238bSMagnus Lilja
2763df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2764df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2765df81238bSMagnus Lilja		compiling a NAND SPL.
2766400558b5Swdenk
2767c609719bSwdenkBuilding the Software:
2768c609719bSwdenk======================
2769c609719bSwdenk
2770218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2771218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2772218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2773218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2774218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2775218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2776c609719bSwdenk
2777218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2778218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2779218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2780218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2781218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2782c609719bSwdenk
2783218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2784218ca724SWolfgang Denk	$ export CROSS_COMPILE
2785c609719bSwdenk
27862f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
27872f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
27882f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
27892f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
27902f8d396bSPeter Tyser
27912f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
27922f8d396bSPeter Tyser
27932f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
27942f8d396bSPeter Tyser      be executed on computers running Windows.
27952f8d396bSPeter Tyser
2796c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2797c609719bSwdenksources you must configure U-Boot for one specific board type. This
2798c609719bSwdenkis done by typing:
2799c609719bSwdenk
2800c609719bSwdenk	make NAME_config
2801c609719bSwdenk
2802218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2803218ca724SWolfgang Denkrations; see the main Makefile for supported names.
280454387ac9Swdenk
2805c609719bSwdenkNote: for some board special configuration names may exist; check if
2806c609719bSwdenk      additional information is available from the board vendor; for
28072729af9dSwdenk      instance, the TQM823L systems are available without (standard)
28082729af9dSwdenk      or with LCD support. You can select such additional "features"
280911ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2810c609719bSwdenk
28112729af9dSwdenk      make TQM823L_config
28122729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2813c609719bSwdenk
2814c609719bSwdenk      make TQM823L_LCD_config
2815c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2816c609719bSwdenk
2817c609719bSwdenk      etc.
2818c609719bSwdenk
2819c609719bSwdenk
2820c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
28217152b1d0Swdenkimages ready for download to / installation on your system:
2822c609719bSwdenk
2823c609719bSwdenk- "u-boot.bin" is a raw binary image
2824c609719bSwdenk- "u-boot" is an image in ELF binary format
2825c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2826c609719bSwdenk
2827baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2828baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2829baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2830baf31249SMarian Balakowicz
2831baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2832baf31249SMarian Balakowicz
2833baf31249SMarian Balakowicz	make O=/tmp/build distclean
2834baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2835baf31249SMarian Balakowicz	make O=/tmp/build all
2836baf31249SMarian Balakowicz
2837baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2838baf31249SMarian Balakowicz
2839baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2840baf31249SMarian Balakowicz	make distclean
2841baf31249SMarian Balakowicz	make NAME_config
2842baf31249SMarian Balakowicz	make all
2843baf31249SMarian Balakowicz
2844baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2845baf31249SMarian Balakowiczvariable.
2846baf31249SMarian Balakowicz
2847c609719bSwdenk
2848c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2849c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2850c609719bSwdenknative "make".
2851c609719bSwdenk
2852c609719bSwdenk
2853c609719bSwdenkIf the system board that you have is not listed, then you will need
2854c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2855c609719bSwdenksteps:
2856c609719bSwdenk
2857c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
285885ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
285985ec0bccSwdenk    entries as examples. Note that here and at many other places
28607152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
286185ec0bccSwdenk    keep this order.
2862c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
286385ec0bccSwdenk    files you need. In your board directory, you will need at least
286485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
286585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
286685ec0bccSwdenk    your board
2867c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2868c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
286985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2870c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2871c609719bSwdenk    to be installed on your target system.
287285ec0bccSwdenk6.  Debug and solve any problems that might arise.
2873c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2874c609719bSwdenk
2875c609719bSwdenk
2876c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2877c609719bSwdenk==============================================================
2878c609719bSwdenk
2879c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2880c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2881c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2882c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2883218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2884c609719bSwdenk
2885c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2886c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2887c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2888c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2889c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
28907152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2891218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2892218ca724SWolfgang Denkyou can type
2893c609719bSwdenk
2894c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2895c609719bSwdenk
2896c609719bSwdenkor to build on a native PowerPC system you can type
2897c609719bSwdenk
2898c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2899c609719bSwdenk
2900218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2901218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2902218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2903218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2904218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2905218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2906218ca724SWolfgang Denkvariable. For example:
2907baf31249SMarian Balakowicz
2908baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2909baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2910baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2911baf31249SMarian Balakowicz
2912218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2913218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2914218ca724SWolfgang Denkduring the whole build process.
2915baf31249SMarian Balakowicz
2916baf31249SMarian Balakowicz
2917c609719bSwdenkSee also "U-Boot Porting Guide" below.
2918c609719bSwdenk
2919c609719bSwdenk
2920c609719bSwdenkMonitor Commands - Overview:
2921c609719bSwdenk============================
2922c609719bSwdenk
2923c609719bSwdenkgo	- start application at address 'addr'
2924c609719bSwdenkrun	- run commands in an environment variable
2925c609719bSwdenkbootm	- boot application image from memory
2926c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2927c609719bSwdenktftpboot- boot image via network using TFTP protocol
2928c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2929c609719bSwdenk	       (and eventually "gatewayip")
2930c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2931c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2932c609719bSwdenkloads	- load S-Record file over serial line
2933c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2934c609719bSwdenkmd	- memory display
2935c609719bSwdenkmm	- memory modify (auto-incrementing)
2936c609719bSwdenknm	- memory modify (constant address)
2937c609719bSwdenkmw	- memory write (fill)
2938c609719bSwdenkcp	- memory copy
2939c609719bSwdenkcmp	- memory compare
2940c609719bSwdenkcrc32	- checksum calculation
29410f89c54bSPeter Tyseri2c	- I2C sub-system
2942c609719bSwdenksspi	- SPI utility commands
2943c609719bSwdenkbase	- print or set address offset
2944c609719bSwdenkprintenv- print environment variables
2945c609719bSwdenksetenv	- set environment variables
2946c609719bSwdenksaveenv - save environment variables to persistent storage
2947c609719bSwdenkprotect - enable or disable FLASH write protection
2948c609719bSwdenkerase	- erase FLASH memory
2949c609719bSwdenkflinfo	- print FLASH memory information
2950c609719bSwdenkbdinfo	- print Board Info structure
2951c609719bSwdenkiminfo	- print header information for application image
2952c609719bSwdenkconinfo - print console devices and informations
2953c609719bSwdenkide	- IDE sub-system
2954c609719bSwdenkloop	- infinite loop on address range
295556523f12Swdenkloopw	- infinite write loop on address range
2956c609719bSwdenkmtest	- simple RAM test
2957c609719bSwdenkicache	- enable or disable instruction cache
2958c609719bSwdenkdcache	- enable or disable data cache
2959c609719bSwdenkreset	- Perform RESET of the CPU
2960c609719bSwdenkecho	- echo args to console
2961c609719bSwdenkversion - print monitor version
2962c609719bSwdenkhelp	- print online help
2963c609719bSwdenk?	- alias for 'help'
2964c609719bSwdenk
2965c609719bSwdenk
2966c609719bSwdenkMonitor Commands - Detailed Description:
2967c609719bSwdenk========================================
2968c609719bSwdenk
2969c609719bSwdenkTODO.
2970c609719bSwdenk
2971c609719bSwdenkFor now: just type "help <command>".
2972c609719bSwdenk
2973c609719bSwdenk
2974c609719bSwdenkEnvironment Variables:
2975c609719bSwdenk======================
2976c609719bSwdenk
2977c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2978c609719bSwdenkcan be made persistent by saving to Flash memory.
2979c609719bSwdenk
2980c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2981c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2982c609719bSwdenkwithout a value can be used to delete a variable from the
2983c609719bSwdenkenvironment. As long as you don't save the environment you are
2984c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2985c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2986c609719bSwdenk
2987c609719bSwdenkSome configuration options can be set using Environment Variables:
2988c609719bSwdenk
2989c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2990c609719bSwdenk
2991c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2992c609719bSwdenk
2993c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2994c609719bSwdenk
2995c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2996c609719bSwdenk
2997c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2998c609719bSwdenk
29997d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
30007d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30017d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
30027d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
30037d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
30047d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
30056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
30067d721e34SBartlomiej Sieka
30077d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
30087d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30097d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
30107d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
30117d721e34SBartlomiej Sieka		  environment variable.
30127d721e34SBartlomiej Sieka
30134bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
30144bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
30154bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
30164bae9090SBartlomiej Sieka
3017c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3018c609719bSwdenk		  "bootp" will just load perform a lookup of the
3019c609719bSwdenk		  configuration from the BOOTP server, but not try to
3020c609719bSwdenk		  load any image using TFTP
3021c609719bSwdenk
3022c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3023c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3024c609719bSwdenk		  be automatically started (by internally calling
3025c609719bSwdenk		  "bootm")
3026c609719bSwdenk
30274a6fd34bSwdenk		  If set to "no", a standalone image passed to the
30284a6fd34bSwdenk		  "bootm" command will be copied to the load address
30294a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
30304a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
30314a6fd34bSwdenk		  data.
30324a6fd34bSwdenk
303317ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
303417ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
303517ea1177Swdenk		  mode (400kHZ). This environment variable is used in
303617ea1177Swdenk		  initialization code. So, for changes to be effective
303717ea1177Swdenk		  it must be saved and board must be reset.
303817ea1177Swdenk
3039c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3040c609719bSwdenk		  If this variable is not set, initrd images will be
3041c609719bSwdenk		  copied to the highest possible address in RAM; this
3042c609719bSwdenk		  is usually what you want since it allows for
3043c609719bSwdenk		  maximum initrd size. If for some reason you want to
3044c609719bSwdenk		  make sure that the initrd image is loaded below the
30456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3046c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3047c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3048c609719bSwdenk		  address to use (U-Boot will still check that it
3049c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3050c609719bSwdenk
3051c609719bSwdenk		  For instance, when you have a system with 16 MB
30527152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3053c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3054c609719bSwdenk		  the "bootargs" variable. However, now you must make
30557152b1d0Swdenk		  sure that the initrd image is placed in the first
3056c609719bSwdenk		  12 MB as well - this can be done with
3057c609719bSwdenk
3058c609719bSwdenk		  setenv initrd_high 00c00000
3059c609719bSwdenk
306038b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
306138b99261Swdenk		  indication to U-Boot that all addresses are legal
306238b99261Swdenk		  for the Linux kernel, including addresses in flash
306338b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
306438b99261Swdenk		  ramdisk at all. This may be useful to reduce the
306538b99261Swdenk		  boot time on your system, but requires that this
306638b99261Swdenk		  feature is supported by your Linux kernel.
306738b99261Swdenk
3068c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3069c609719bSwdenk
3070c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3071dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3072c609719bSwdenk
3073c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3074c609719bSwdenk
3075c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3076c609719bSwdenk
3077c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3078c609719bSwdenk
3079c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3080c609719bSwdenk
3081c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3082c609719bSwdenk
3083a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3084a3d991bdSwdenk		  interface is used first.
3085a3d991bdSwdenk
3086a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3087a3d991bdSwdenk		  interface is currently active. For example you
3088a3d991bdSwdenk		  can do the following
3089a3d991bdSwdenk
3090a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3091a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3092a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3093a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3094a3d991bdSwdenk
3095e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3096e1692577SMatthias Fuchs		  available network interfaces.
3097e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3098e1692577SMatthias Fuchs
3099a3d991bdSwdenk   netretry	- When set to "no" each network operation will
3100a3d991bdSwdenk		  either succeed or fail without retrying.
31016e592385Swdenk		  When set to "once" the network operation will
31026e592385Swdenk		  fail when all the available network interfaces
31036e592385Swdenk		  are tried once without success.
3104a3d991bdSwdenk		  Useful on scripts which control the retry operation
3105a3d991bdSwdenk		  themselves.
3106a3d991bdSwdenk
3107b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3108a1cf027aSJean-Christophe PLAGNIOL-VILLARD
310928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3110ecb0ccd9SWolfgang Denk		  UDP source port.
3111ecb0ccd9SWolfgang Denk
311228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
311328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
311428cb9375SWolfgang Denk
3115a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
311611ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3117a3d991bdSwdenk		  VLAN tagged frames.
3118c609719bSwdenk
3119c609719bSwdenkThe following environment variables may be used and automatically
3120c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3121c609719bSwdenkdepending the information provided by your boot server:
3122c609719bSwdenk
3123c609719bSwdenk  bootfile	- see above
3124c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3125fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3126c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3127c609719bSwdenk  hostname	- Target hostname
3128c609719bSwdenk  ipaddr	- see above
3129c609719bSwdenk  netmask	- Subnet Mask
3130c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3131c609719bSwdenk  serverip	- see above
3132c609719bSwdenk
3133c609719bSwdenk
3134c609719bSwdenkThere are two special Environment Variables:
3135c609719bSwdenk
3136c609719bSwdenk  serial#	- contains hardware identification information such
3137c609719bSwdenk		  as type string and/or serial number
3138c609719bSwdenk  ethaddr	- Ethernet address
3139c609719bSwdenk
3140c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3141c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3142c609719bSwdenkonce they have been set once.
3143c609719bSwdenk
3144c609719bSwdenk
3145c1551ea8SstroeseFurther special Environment Variables:
3146c1551ea8Sstroese
3147c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3148c1551ea8Sstroese		  with the "version" command. This variable is
3149c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3150c1551ea8Sstroese
3151c1551ea8Sstroese
3152c609719bSwdenkPlease note that changes to some configuration parameters may take
3153c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3154c609719bSwdenk
3155c609719bSwdenk
3156f07771ccSwdenkCommand Line Parsing:
3157f07771ccSwdenk=====================
3158f07771ccSwdenk
3159f07771ccSwdenkThere are two different command line parsers available with U-Boot:
31607152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3161f07771ccSwdenk
3162f07771ccSwdenkOld, simple command line parser:
3163f07771ccSwdenk--------------------------------
3164f07771ccSwdenk
3165f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3166f07771ccSwdenk- several commands on one line, separated by ';'
3167fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3168f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3169f07771ccSwdenk  for example:
3170fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3171f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3172f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3173f07771ccSwdenk
3174f07771ccSwdenkHush shell:
3175f07771ccSwdenk-----------
3176f07771ccSwdenk
3177f07771ccSwdenk- similar to Bourne shell, with control structures like
3178f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3179f07771ccSwdenk  until...do...done, ...
3180f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3181f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3182f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3183f07771ccSwdenk  command
3184f07771ccSwdenk
3185f07771ccSwdenkGeneral rules:
3186f07771ccSwdenk--------------
3187f07771ccSwdenk
3188f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3189f07771ccSwdenk    command) contains several commands separated by semicolon, and
3190f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3191f07771ccSwdenk    executed anyway.
3192f07771ccSwdenk
3193f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
319411ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3195f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3196f07771ccSwdenk    variables are not executed.
3197f07771ccSwdenk
3198c609719bSwdenkNote for Redundant Ethernet Interfaces:
3199c609719bSwdenk=======================================
3200c609719bSwdenk
320111ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3202c609719bSwdenksuch configurations and is capable of automatic selection of a
32037152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3204c609719bSwdenk
3205c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3206c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3207c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3208c609719bSwdenk
3209c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3210c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3211c609719bSwdenkding setting in the environment; if the corresponding environment
3212c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3213c609719bSwdenk
3214c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3215c609719bSwdenk  environment, the SROM's address is used.
3216c609719bSwdenk
3217c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3218c609719bSwdenk  environment exists, then the value from the environment variable is
3219c609719bSwdenk  used.
3220c609719bSwdenk
3221c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3222c609719bSwdenk  both addresses are the same, this MAC address is used.
3223c609719bSwdenk
3224c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3225c609719bSwdenk  addresses differ, the value from the environment is used and a
3226c609719bSwdenk  warning is printed.
3227c609719bSwdenk
3228c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3229c609719bSwdenk  is raised.
3230c609719bSwdenk
3231c609719bSwdenk
3232c609719bSwdenkImage Formats:
3233c609719bSwdenk==============
3234c609719bSwdenk
32353310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
32363310c549SMarian Balakowiczimages in two formats:
32373310c549SMarian Balakowicz
32383310c549SMarian BalakowiczNew uImage format (FIT)
32393310c549SMarian Balakowicz-----------------------
32403310c549SMarian Balakowicz
32413310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
32423310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
32433310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
32443310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
32453310c549SMarian Balakowicz
32463310c549SMarian Balakowicz
32473310c549SMarian BalakowiczOld uImage format
32483310c549SMarian Balakowicz-----------------
32493310c549SMarian Balakowicz
32503310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
32513310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
32523310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3253c609719bSwdenk
3254c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3255c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3256f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3257f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3258f5ed9e39SPeter Tyser  INTEGRITY).
32597b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
32603d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
32617b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3262c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3263c609719bSwdenk* Load Address
3264c609719bSwdenk* Entry Point
3265c609719bSwdenk* Image Name
3266c609719bSwdenk* Image Timestamp
3267c609719bSwdenk
3268c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3269c609719bSwdenkand the data portions of the image are secured against corruption by
3270c609719bSwdenkCRC32 checksums.
3271c609719bSwdenk
3272c609719bSwdenk
3273c609719bSwdenkLinux Support:
3274c609719bSwdenk==============
3275c609719bSwdenk
3276c609719bSwdenkAlthough U-Boot should support any OS or standalone application
32777152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3278c609719bSwdenkU-Boot.
3279c609719bSwdenk
3280c609719bSwdenkU-Boot includes many features that so far have been part of some
3281c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3282c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3283c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
32847152b1d0Swdenkserves several purposes:
3285c609719bSwdenk
3286c609719bSwdenk- the same features can be used for other OS or standalone
3287c609719bSwdenk  applications (for instance: using compressed images to reduce the
3288c609719bSwdenk  Flash memory footprint)
3289c609719bSwdenk
3290c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
32917152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3292c609719bSwdenk
3293c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3294c609719bSwdenk  images; of course this also means that different kernel images can
3295c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3296c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3297c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3298c609719bSwdenk  software is easier now.
3299c609719bSwdenk
3300c609719bSwdenk
3301c609719bSwdenkLinux HOWTO:
3302c609719bSwdenk============
3303c609719bSwdenk
3304c609719bSwdenkPorting Linux to U-Boot based systems:
3305c609719bSwdenk---------------------------------------
3306c609719bSwdenk
3307c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3308c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3309c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3310c609719bSwdenkLinux :-).
3311c609719bSwdenk
3312c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
3313c609719bSwdenk
3314c609719bSwdenkJust make sure your machine specific header file (for instance
3315c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
33161dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
33171dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
33186d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3319c609719bSwdenk
3320c609719bSwdenk
3321c609719bSwdenkConfiguring the Linux kernel:
3322c609719bSwdenk-----------------------------
3323c609719bSwdenk
3324c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3325c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3326c609719bSwdenk
3327c609719bSwdenk
3328c609719bSwdenkBuilding a Linux Image:
3329c609719bSwdenk-----------------------
3330c609719bSwdenk
333124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
333224ee89b9Swdenknot used. If you use recent kernel source, a new build target
333324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
333424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
333524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
333624ee89b9Swdenk100% compatible format.
3337c609719bSwdenk
3338c609719bSwdenkExample:
3339c609719bSwdenk
3340c609719bSwdenk	make TQM850L_config
3341c609719bSwdenk	make oldconfig
3342c609719bSwdenk	make dep
334324ee89b9Swdenk	make uImage
3344c609719bSwdenk
334524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
334624ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
334724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3348c609719bSwdenk
334924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
335024ee89b9Swdenk
335124ee89b9Swdenk* convert the kernel into a raw binary image:
335224ee89b9Swdenk
335324ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
335424ee89b9Swdenk				 -R .note -R .comment \
335524ee89b9Swdenk				 -S vmlinux linux.bin
335624ee89b9Swdenk
335724ee89b9Swdenk* compress the binary image:
335824ee89b9Swdenk
335924ee89b9Swdenk	gzip -9 linux.bin
336024ee89b9Swdenk
336124ee89b9Swdenk* package compressed binary image for U-Boot:
336224ee89b9Swdenk
336324ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
336424ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
336524ee89b9Swdenk		-d linux.bin.gz uImage
336624ee89b9Swdenk
336724ee89b9Swdenk
336824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
336924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
337024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
337124ee89b9Swdenkbyte header containing information about target architecture,
337224ee89b9Swdenkoperating system, image type, compression method, entry points, time
337324ee89b9Swdenkstamp, CRC32 checksums, etc.
337424ee89b9Swdenk
337524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
337624ee89b9Swdenkprint the header information, or to build new images.
3377c609719bSwdenk
3378c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3379c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3380c609719bSwdenkchecksum verification:
3381c609719bSwdenk
3382c609719bSwdenk	tools/mkimage -l image
3383c609719bSwdenk	  -l ==> list image header information
3384c609719bSwdenk
3385c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3386c609719bSwdenkfrom a "data file" which is used as image payload:
3387c609719bSwdenk
3388c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3389c609719bSwdenk		      -n name -d data_file image
3390c609719bSwdenk	  -A ==> set architecture to 'arch'
3391c609719bSwdenk	  -O ==> set operating system to 'os'
3392c609719bSwdenk	  -T ==> set image type to 'type'
3393c609719bSwdenk	  -C ==> set compression type 'comp'
3394c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3395c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3396c609719bSwdenk	  -n ==> set image name to 'name'
3397c609719bSwdenk	  -d ==> use image data from 'datafile'
3398c609719bSwdenk
339969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
340069459791Swdenkaddress (0x00000000), but the entry point address depends on the
340169459791Swdenkkernel version:
3402c609719bSwdenk
3403c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
340424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3405c609719bSwdenk
3406c609719bSwdenkSo a typical call to build a U-Boot image would read:
3407c609719bSwdenk
340824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
340924ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
341024ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
341124ee89b9Swdenk	> examples/uImage.TQM850L
341224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3413c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3414c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3415c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3416c609719bSwdenk	Load Address: 0x00000000
341724ee89b9Swdenk	Entry Point:  0x00000000
3418c609719bSwdenk
3419c609719bSwdenkTo verify the contents of the image (or check for corruption):
3420c609719bSwdenk
342124ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
342224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3423c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3424c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3425c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3426c609719bSwdenk	Load Address: 0x00000000
342724ee89b9Swdenk	Entry Point:  0x00000000
3428c609719bSwdenk
3429c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3430c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3431c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3432c609719bSwdenkneed to be uncompressed:
3433c609719bSwdenk
343424ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
343524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
343624ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
343724ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
343824ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
343924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3440c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3441c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3442c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3443c609719bSwdenk	Load Address: 0x00000000
344424ee89b9Swdenk	Entry Point:  0x00000000
3445c609719bSwdenk
3446c609719bSwdenk
3447c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3448c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3449c609719bSwdenk
3450c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3451c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3452c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3453c609719bSwdenk	Image Name:   Simple Ramdisk Image
3454c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3455c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3456c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3457c609719bSwdenk	Load Address: 0x00000000
3458c609719bSwdenk	Entry Point:  0x00000000
3459c609719bSwdenk
3460c609719bSwdenk
3461c609719bSwdenkInstalling a Linux Image:
3462c609719bSwdenk-------------------------
3463c609719bSwdenk
3464c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3465c609719bSwdenkyou must convert the image to S-Record format:
3466c609719bSwdenk
3467c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3468c609719bSwdenk
3469c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3470c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3471c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3472c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3473c609719bSwdenkcommand.
3474c609719bSwdenk
3475c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3476c609719bSwdenkTQM8xxL is in the first Flash bank):
3477c609719bSwdenk
3478c609719bSwdenk	=> erase 40100000 401FFFFF
3479c609719bSwdenk
3480c609719bSwdenk	.......... done
3481c609719bSwdenk	Erased 8 sectors
3482c609719bSwdenk
3483c609719bSwdenk	=> loads 40100000
3484c609719bSwdenk	## Ready for S-Record download ...
3485c609719bSwdenk	~>examples/image.srec
3486c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3487c609719bSwdenk	...
3488c609719bSwdenk	15989 15990 15991 15992
3489c609719bSwdenk	[file transfer complete]
3490c609719bSwdenk	[connected]
3491c609719bSwdenk	## Start Addr = 0x00000000
3492c609719bSwdenk
3493c609719bSwdenk
3494c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3495c609719bSwdenkthis includes a checksum verification so you can be sure no data
3496c609719bSwdenkcorruption happened:
3497c609719bSwdenk
3498c609719bSwdenk	=> imi 40100000
3499c609719bSwdenk
3500c609719bSwdenk	## Checking Image at 40100000 ...
3501c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3502c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3503c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3504c609719bSwdenk	   Load Address: 00000000
3505c609719bSwdenk	   Entry Point:	 0000000c
3506c609719bSwdenk	   Verifying Checksum ... OK
3507c609719bSwdenk
3508c609719bSwdenk
3509c609719bSwdenkBoot Linux:
3510c609719bSwdenk-----------
3511c609719bSwdenk
3512c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3513c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3514c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3515c609719bSwdenkparameters. You can check and modify this variable using the
3516c609719bSwdenk"printenv" and "setenv" commands:
3517c609719bSwdenk
3518c609719bSwdenk
3519c609719bSwdenk	=> printenv bootargs
3520c609719bSwdenk	bootargs=root=/dev/ram
3521c609719bSwdenk
3522c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3523c609719bSwdenk
3524c609719bSwdenk	=> printenv bootargs
3525c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3526c609719bSwdenk
3527c609719bSwdenk	=> bootm 40020000
3528c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3529c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3530c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3531c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3532c609719bSwdenk	   Load Address: 00000000
3533c609719bSwdenk	   Entry Point:	 0000000c
3534c609719bSwdenk	   Verifying Checksum ... OK
3535c609719bSwdenk	   Uncompressing Kernel Image ... OK
3536c609719bSwdenk	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
3537c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3538c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3539c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3540c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3541c609719bSwdenk	...
3542c609719bSwdenk
354311ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
35447152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3545c609719bSwdenkformat!) to the "bootm" command:
3546c609719bSwdenk
3547c609719bSwdenk	=> imi 40100000 40200000
3548c609719bSwdenk
3549c609719bSwdenk	## Checking Image at 40100000 ...
3550c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3551c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3552c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3553c609719bSwdenk	   Load Address: 00000000
3554c609719bSwdenk	   Entry Point:	 0000000c
3555c609719bSwdenk	   Verifying Checksum ... OK
3556c609719bSwdenk
3557c609719bSwdenk	## Checking Image at 40200000 ...
3558c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3559c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3560c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3561c609719bSwdenk	   Load Address: 00000000
3562c609719bSwdenk	   Entry Point:	 00000000
3563c609719bSwdenk	   Verifying Checksum ... OK
3564c609719bSwdenk
3565c609719bSwdenk	=> bootm 40100000 40200000
3566c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3567c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3568c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3569c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3570c609719bSwdenk	   Load Address: 00000000
3571c609719bSwdenk	   Entry Point:	 0000000c
3572c609719bSwdenk	   Verifying Checksum ... OK
3573c609719bSwdenk	   Uncompressing Kernel Image ... OK
3574c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3575c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3576c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3577c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3578c609719bSwdenk	   Load Address: 00000000
3579c609719bSwdenk	   Entry Point:	 00000000
3580c609719bSwdenk	   Verifying Checksum ... OK
3581c609719bSwdenk	   Loading Ramdisk ... OK
3582c609719bSwdenk	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
3583c609719bSwdenk	Boot arguments: root=/dev/ram
3584c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3585c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3586c609719bSwdenk	...
3587c609719bSwdenk	RAMDISK: Compressed image found at block 0
3588c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3589c609719bSwdenk
3590c609719bSwdenk	bash#
3591c609719bSwdenk
35920267768eSMatthew McClintockBoot Linux and pass a flat device tree:
35930267768eSMatthew McClintock-----------
35940267768eSMatthew McClintock
35950267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
35960267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
35970267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
35980267768eSMatthew McClintockflat device tree:
35990267768eSMatthew McClintock
36000267768eSMatthew McClintock=> print oftaddr
36010267768eSMatthew McClintockoftaddr=0x300000
36020267768eSMatthew McClintock=> print oft
36030267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
36040267768eSMatthew McClintock=> tftp $oftaddr $oft
36050267768eSMatthew McClintockSpeed: 1000, full duplex
36060267768eSMatthew McClintockUsing TSEC0 device
36070267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
36080267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
36090267768eSMatthew McClintockLoad address: 0x300000
36100267768eSMatthew McClintockLoading: #
36110267768eSMatthew McClintockdone
36120267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
36130267768eSMatthew McClintock=> tftp $loadaddr $bootfile
36140267768eSMatthew McClintockSpeed: 1000, full duplex
36150267768eSMatthew McClintockUsing TSEC0 device
36160267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
36170267768eSMatthew McClintockFilename 'uImage'.
36180267768eSMatthew McClintockLoad address: 0x200000
36190267768eSMatthew McClintockLoading:############
36200267768eSMatthew McClintockdone
36210267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
36220267768eSMatthew McClintock=> print loadaddr
36230267768eSMatthew McClintockloadaddr=200000
36240267768eSMatthew McClintock=> print oftaddr
36250267768eSMatthew McClintockoftaddr=0x300000
36260267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
36270267768eSMatthew McClintock## Booting image at 00200000 ...
36280267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
36290267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
36300267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
36310267768eSMatthew McClintock   Load Address: 00000000
36320267768eSMatthew McClintock   Entry Point:	 00000000
36330267768eSMatthew McClintock   Verifying Checksum ... OK
36340267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
36350267768eSMatthew McClintockBooting using flat device tree at 0x300000
36360267768eSMatthew McClintockUsing MPC85xx ADS machine description
36370267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
36380267768eSMatthew McClintock[snip]
36390267768eSMatthew McClintock
36400267768eSMatthew McClintock
36416069ff26SwdenkMore About U-Boot Image Types:
36426069ff26Swdenk------------------------------
36436069ff26Swdenk
36446069ff26SwdenkU-Boot supports the following image types:
36456069ff26Swdenk
36466069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
36476069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
36486069ff26Swdenk	well) you can continue to work in U-Boot after return from
36496069ff26Swdenk	the Standalone Program.
36506069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
36516069ff26Swdenk	will take over control completely. Usually these programs
36526069ff26Swdenk	will install their own set of exception handlers, device
36536069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
36546069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
36556069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
36566069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
36576069ff26Swdenk	being started.
36586069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
36596069ff26Swdenk	(Linux) kernel image and one or more data images like
36606069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
36616069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
36626069ff26Swdenk	server provides just a single image file, but you want to get
36636069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
36646069ff26Swdenk
36656069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
36666069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
36676069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
36686069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
36696069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
36706069ff26Swdenk	a multiple of 4 bytes).
36716069ff26Swdenk
36726069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
36736069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
36746069ff26Swdenk	flash memory.
36756069ff26Swdenk
36766069ff26Swdenk   "Script files" are command sequences that will be executed by
36776069ff26Swdenk	U-Boot's command interpreter; this feature is especially
36786069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
36796069ff26Swdenk	as command interpreter.
36806069ff26Swdenk
3681c609719bSwdenk
3682c609719bSwdenkStandalone HOWTO:
3683c609719bSwdenk=================
3684c609719bSwdenk
3685c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3686c609719bSwdenkrun "standalone" applications, which can use some resources of
3687c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3688c609719bSwdenk
3689c609719bSwdenkTwo simple examples are included with the sources:
3690c609719bSwdenk
3691c609719bSwdenk"Hello World" Demo:
3692c609719bSwdenk-------------------
3693c609719bSwdenk
3694c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3695c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3696c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3697c609719bSwdenklike that:
3698c609719bSwdenk
3699c609719bSwdenk	=> loads
3700c609719bSwdenk	## Ready for S-Record download ...
3701c609719bSwdenk	~>examples/hello_world.srec
3702c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3703c609719bSwdenk	[file transfer complete]
3704c609719bSwdenk	[connected]
3705c609719bSwdenk	## Start Addr = 0x00040004
3706c609719bSwdenk
3707c609719bSwdenk	=> go 40004 Hello World! This is a test.
3708c609719bSwdenk	## Starting application at 0x00040004 ...
3709c609719bSwdenk	Hello World
3710c609719bSwdenk	argc = 7
3711c609719bSwdenk	argv[0] = "40004"
3712c609719bSwdenk	argv[1] = "Hello"
3713c609719bSwdenk	argv[2] = "World!"
3714c609719bSwdenk	argv[3] = "This"
3715c609719bSwdenk	argv[4] = "is"
3716c609719bSwdenk	argv[5] = "a"
3717c609719bSwdenk	argv[6] = "test."
3718c609719bSwdenk	argv[7] = "<NULL>"
3719c609719bSwdenk	Hit any key to exit ...
3720c609719bSwdenk
3721c609719bSwdenk	## Application terminated, rc = 0x0
3722c609719bSwdenk
3723c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3724c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3725c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3726c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3727c609719bSwdenkcharacter, but this is just a demo program. The application can be
3728c609719bSwdenkcontrolled by the following keys:
3729c609719bSwdenk
3730c609719bSwdenk	? - print current values og the CPM Timer registers
3731c609719bSwdenk	b - enable interrupts and start timer
3732c609719bSwdenk	e - stop timer and disable interrupts
3733c609719bSwdenk	q - quit application
3734c609719bSwdenk
3735c609719bSwdenk	=> loads
3736c609719bSwdenk	## Ready for S-Record download ...
3737c609719bSwdenk	~>examples/timer.srec
3738c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3739c609719bSwdenk	[file transfer complete]
3740c609719bSwdenk	[connected]
3741c609719bSwdenk	## Start Addr = 0x00040004
3742c609719bSwdenk
3743c609719bSwdenk	=> go 40004
3744c609719bSwdenk	## Starting application at 0x00040004 ...
3745c609719bSwdenk	TIMERS=0xfff00980
3746c609719bSwdenk	Using timer 1
3747c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3748c609719bSwdenk
3749c609719bSwdenkHit 'b':
3750c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3751c609719bSwdenk	Enabling timer
3752c609719bSwdenkHit '?':
3753c609719bSwdenk	[q, b, e, ?] ........
3754c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3755c609719bSwdenkHit '?':
3756c609719bSwdenk	[q, b, e, ?] .
3757c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3758c609719bSwdenkHit '?':
3759c609719bSwdenk	[q, b, e, ?] .
3760c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3761c609719bSwdenkHit '?':
3762c609719bSwdenk	[q, b, e, ?] .
3763c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3764c609719bSwdenkHit 'e':
3765c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3766c609719bSwdenkHit 'q':
3767c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3768c609719bSwdenk
3769c609719bSwdenk
377085ec0bccSwdenkMinicom warning:
377185ec0bccSwdenk================
377285ec0bccSwdenk
37737152b1d0SwdenkOver time, many people have reported problems when trying to use the
377485ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
377585ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3776f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
377785ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
377885ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
377985ec0bccSwdenk
378052f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
378152f52c14Swdenkconfiguration to your "File transfer protocols" section:
378252f52c14Swdenk
378352f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
378452f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
378552f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
378652f52c14Swdenk
378752f52c14Swdenk
3788c609719bSwdenkNetBSD Notes:
3789c609719bSwdenk=============
3790c609719bSwdenk
3791c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3792c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3793c609719bSwdenk
3794c609719bSwdenkBuilding requires a cross environment; it is known to work on
3795c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3796c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3797c609719bSwdenkNote that the cross-powerpc package does not install include files;
3798c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3799c609719bSwdenkmissing.  This file has to be installed and patched manually:
3800c609719bSwdenk
3801c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3802c609719bSwdenk	# mkdir powerpc
3803c609719bSwdenk	# ln -s powerpc machine
3804c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3805c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3806c609719bSwdenk
3807c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3808c609719bSwdenkand U-Boot include files.
3809c609719bSwdenk
3810c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3811c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3812c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3813c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
38142a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3815c609719bSwdenk
3816c609719bSwdenk
3817c609719bSwdenkImplementation Internals:
3818c609719bSwdenk=========================
3819c609719bSwdenk
3820c609719bSwdenkThe following is not intended to be a complete description of every
3821c609719bSwdenkimplementation detail. However, it should help to understand the
3822c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3823c609719bSwdenkhardware.
3824c609719bSwdenk
3825c609719bSwdenk
3826c609719bSwdenkInitial Stack, Global Data:
3827c609719bSwdenk---------------------------
3828c609719bSwdenk
3829c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3830c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3831c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3832c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3833c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3834c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3835c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3836c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3837c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3838c609719bSwdenklocked as (mis-) used as memory, etc.
3839c609719bSwdenk
38407152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
38410668236bSWolfgang Denk	U-Boot mailing list:
384243d9616cSwdenk
384343d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
384443d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
384543d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
384643d9616cSwdenk	...
384743d9616cSwdenk
384843d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
384943d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
385043d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
385143d9616cSwdenk	is that the cache is being used as a temporary supply of
385243d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
385311ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
385443d9616cSwdenk	can see how this works by studying the cache architecture and
385543d9616cSwdenk	operation in the architecture and processor-specific manuals.
385643d9616cSwdenk
385743d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
385843d9616cSwdenk	is another option for the system designer to use as an
385911ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
386043d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
386143d9616cSwdenk	board designers haven't used it for something that would
386243d9616cSwdenk	cause you grief during the initial boot! It is frequently not
386343d9616cSwdenk	used.
386443d9616cSwdenk
38656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
386643d9616cSwdenk	with your processor/board/system design. The default value
386743d9616cSwdenk	you will find in any recent u-boot distribution in
38688a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
386943d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
387043d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
387143d9616cSwdenk	that are supposed to respond to that address! That code in
387243d9616cSwdenk	start.S has been around a while and should work as is when
387343d9616cSwdenk	you get the config right.
387443d9616cSwdenk
387543d9616cSwdenk	-Chris Hallinan
387643d9616cSwdenk	DS4.COM, Inc.
387743d9616cSwdenk
3878c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3879c609719bSwdenkcode for the initialization procedures:
3880c609719bSwdenk
3881c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3882c609719bSwdenk  to write it.
3883c609719bSwdenk
388411ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3885c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
38867152b1d0Swdenk  zation is performed later (when relocating to RAM).
3887c609719bSwdenk
3888c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3889c609719bSwdenk  that.
3890c609719bSwdenk
3891c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3892c609719bSwdenknormal global data to share information beween the code. But it
3893c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3894c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3895c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3896c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3897c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3898c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3899c609719bSwdenkreserve for this purpose.
3900c609719bSwdenk
39017152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3902c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3903c609719bSwdenkGCC's implementation.
3904c609719bSwdenk
3905c609719bSwdenkFor PowerPC, the following registers have specific use:
3906c609719bSwdenk	R1:	stack pointer
3907e7670f6cSWolfgang Denk	R2:	reserved for system use
3908c609719bSwdenk	R3-R4:	parameter passing and return values
3909c609719bSwdenk	R5-R10: parameter passing
3910c609719bSwdenk	R13:	small data area pointer
3911c609719bSwdenk	R30:	GOT pointer
3912c609719bSwdenk	R31:	frame pointer
3913c609719bSwdenk
3914c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3915c609719bSwdenk
3916e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3917c609719bSwdenk
3918c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3919c609719bSwdenk    address of the global data structure is known at compile time),
3920c609719bSwdenk    but it turned out that reserving a register results in somewhat
3921c609719bSwdenk    smaller code - although the code savings are not that big (on
3922c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3923c609719bSwdenk    624 text + 127 data).
3924c609719bSwdenk
3925c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
39264c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
39274c58eb55SMike Frysinger
3928c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
39294c58eb55SMike Frysinger
3930c609719bSwdenkOn ARM, the following registers are used:
3931c609719bSwdenk
3932c609719bSwdenk	R0:	function argument word/integer result
3933c609719bSwdenk	R1-R3:	function argument word
3934c609719bSwdenk	R9:	GOT pointer
3935c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3936c609719bSwdenk	R11:	argument (frame) pointer
3937c609719bSwdenk	R12:	temporary workspace
3938c609719bSwdenk	R13:	stack pointer
3939c609719bSwdenk	R14:	link register
3940c609719bSwdenk	R15:	program counter
3941c609719bSwdenk
3942c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3943c609719bSwdenk
3944d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3945d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3946c609719bSwdenk
3947c609719bSwdenkMemory Management:
3948c609719bSwdenk------------------
3949c609719bSwdenk
3950c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3951c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3952c609719bSwdenk
3953c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3954c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3955c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3956c609719bSwdenkphysical memory banks.
3957c609719bSwdenk
3958c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3959c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3960c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3961c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
39626d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
3963c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3964c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3965c609719bSwdenk
3966c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3967c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3968c609719bSwdenk
3969c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3970c609719bSwdenkthis:
3971c609719bSwdenk
3972c609719bSwdenk	0x0000 0000	Exception Vector code
3973c609719bSwdenk	      :
3974c609719bSwdenk	0x0000 1FFF
3975c609719bSwdenk	0x0000 2000	Free for Application Use
3976c609719bSwdenk	      :
3977c609719bSwdenk	      :
3978c609719bSwdenk
3979c609719bSwdenk	      :
3980c609719bSwdenk	      :
3981c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3982c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3983c609719bSwdenk	0x00FC 0000	Malloc Arena
3984c609719bSwdenk	      :
3985c609719bSwdenk	0x00FD FFFF
3986c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3987c609719bSwdenk	...		eventually: LCD or video framebuffer
3988c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3989c609719bSwdenk	0x00FF FFFF	[End of RAM]
3990c609719bSwdenk
3991c609719bSwdenk
3992c609719bSwdenkSystem Initialization:
3993c609719bSwdenk----------------------
3994c609719bSwdenk
3995c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
399611ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
3997c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
39987152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3999c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
4000c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4001c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4002c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4003c609719bSwdenkthe caches and the SIU.
4004c609719bSwdenk
4005c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4006c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4007c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4008c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4009c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4010c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4011c609719bSwdenkbanks.
4012c609719bSwdenk
4013c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
40147152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4015c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4016c609719bSwdenk0x00000000, with any additional banks following immediately to create
4017c609719bSwdenkcontiguous memory starting from 0.
4018c609719bSwdenk
4019c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4020c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4021c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4022c609719bSwdenkpages, and the final stack is set up.
4023c609719bSwdenk
4024c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4025c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4026c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4027c609719bSwdenknew address in RAM.
4028c609719bSwdenk
4029c609719bSwdenk
4030c609719bSwdenkU-Boot Porting Guide:
4031c609719bSwdenk----------------------
4032c609719bSwdenk
4033c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
40346aff3115Swdenklist, October 2002]
4035c609719bSwdenk
4036c609719bSwdenk
4037c609719bSwdenkint main(int argc, char *argv[])
4038c609719bSwdenk{
4039c609719bSwdenk	sighandler_t no_more_time;
4040c609719bSwdenk
4041c609719bSwdenk	signal(SIGALRM, no_more_time);
4042c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4043c609719bSwdenk
4044c609719bSwdenk	if (available_money > available_manpower) {
40456c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4046c609719bSwdenk		return 0;
4047c609719bSwdenk	}
4048c609719bSwdenk
4049c609719bSwdenk	Download latest U-Boot source;
4050c609719bSwdenk
40510668236bSWolfgang Denk	Subscribe to u-boot mailing list;
40526aff3115Swdenk
40536c3fef28SJerry Van Baren	if (clueless)
4054c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4055c609719bSwdenk
4056c609719bSwdenk	while (learning) {
4057c609719bSwdenk		Read the README file in the top level directory;
40587cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
40596c3fef28SJerry Van Baren		Read applicable doc/*.README;
4060c609719bSwdenk		Read the source, Luke;
40616c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4062c609719bSwdenk	}
4063c609719bSwdenk
40646c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
40656c3fef28SJerry Van Baren		Buy a BDI3000;
40666c3fef28SJerry Van Baren	else
4067c609719bSwdenk		Add a lot of aggravation and time;
4068c609719bSwdenk
40696c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
40706c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
40716c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
40726c3fef28SJerry Van Baren	} else {
4073c609719bSwdenk		Create your own board support subdirectory;
40746c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
40756c3fef28SJerry Van Baren	}
40766c3fef28SJerry Van Baren	Edit new board/<myboard> files
40776c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4078c609719bSwdenk
40796c3fef28SJerry Van Baren	while (!accepted) {
4080c609719bSwdenk		while (!running) {
4081c609719bSwdenk			do {
4082c609719bSwdenk				Add / modify source code;
4083c609719bSwdenk			} until (compiles);
4084c609719bSwdenk			Debug;
4085c609719bSwdenk			if (clueless)
4086c609719bSwdenk				email("Hi, I am having problems...");
4087c609719bSwdenk		}
40886c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
40896c3fef28SJerry Van Baren		if (reasonable critiques)
40906c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
40916c3fef28SJerry Van Baren		else
40926c3fef28SJerry Van Baren			Defend code as written;
40936c3fef28SJerry Van Baren	}
4094c609719bSwdenk
4095c609719bSwdenk	return 0;
4096c609719bSwdenk}
4097c609719bSwdenk
4098c609719bSwdenkvoid no_more_time (int sig)
4099c609719bSwdenk{
4100c609719bSwdenk      hire_a_guru();
4101c609719bSwdenk}
4102c609719bSwdenk
4103c609719bSwdenk
4104c609719bSwdenkCoding Standards:
4105c609719bSwdenk-----------------
4106c609719bSwdenk
4107c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
41082c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
41092c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
41102c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
41112c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4112c609719bSwdenk
41132c051651SDetlev ZundelSource files originating from a different project (for example the
41142c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
41152c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
41162c051651SDetlev Zundelsources.
41172c051651SDetlev Zundel
41182c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
41192c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
41202c051651SDetlev Zundelin your code.
4121c609719bSwdenk
4122c178d3daSwdenkPlease also stick to the following formatting rules:
4123180d3f74Swdenk- remove any trailing white space
4124180d3f74Swdenk- use TAB characters for indentation, not spaces
4125180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4126180d3f74Swdenk- do not add more than 2 empty lines to source files
4127180d3f74Swdenk- do not add trailing empty lines to source files
4128180d3f74Swdenk
4129c609719bSwdenkSubmissions which do not conform to the standards may be returned
4130c609719bSwdenkwith a request to reformat the changes.
4131c609719bSwdenk
4132c609719bSwdenk
4133c609719bSwdenkSubmitting Patches:
4134c609719bSwdenk-------------------
4135c609719bSwdenk
4136c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4137c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4138c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4139c609719bSwdenk
41400d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4141218ca724SWolfgang Denk
41420668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
41430668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
41440668236bSWolfgang Denk
4145c609719bSwdenkWhen you send a patch, please include the following information with
4146c609719bSwdenkit:
4147c609719bSwdenk
4148c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4149c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4150c609719bSwdenk  patch actually fixes something.
4151c609719bSwdenk
4152c609719bSwdenk* For new features: a description of the feature and your
4153c609719bSwdenk  implementation.
4154c609719bSwdenk
4155c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4156c609719bSwdenk
4157c609719bSwdenk* For major contributions, your entry to the CREDITS file
4158c609719bSwdenk
4159c609719bSwdenk* When you add support for a new board, don't forget to add this
4160c609719bSwdenk  board to the MAKEALL script, too.
4161c609719bSwdenk
4162c609719bSwdenk* If your patch adds new configuration options, don't forget to
4163c609719bSwdenk  document these in the README file.
4164c609719bSwdenk
4165218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4166218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4167218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4168218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4169218ca724SWolfgang Denk  with some other mail clients.
4170c609719bSwdenk
4171218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4172218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4173218ca724SWolfgang Denk  GNU diff.
41746dff5529Swdenk
4175218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4176218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4177218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4178218ca724SWolfgang Denk  affected files).
4179218ca724SWolfgang Denk
4180218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4181218ca724SWolfgang Denk  and compressed attachments must not be used.
4182c609719bSwdenk
418352f52c14Swdenk* If one logical set of modifications affects or creates several
418452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
418552f52c14Swdenk
418652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
418752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
418852f52c14Swdenk
418952f52c14Swdenk
4190c609719bSwdenkNotes:
4191c609719bSwdenk
4192c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4193c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4194c609719bSwdenk  for any of the boards.
4195c609719bSwdenk
4196c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4197c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4198c609719bSwdenk  returned with a request to re-formatting / split it.
4199c609719bSwdenk
4200c609719bSwdenk* If you modify existing code, make sure that your new code does not
4201c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4202c609719bSwdenk  When adding new features, these should compile conditionally only
4203c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4204c609719bSwdenk  disabled must not need more memory than the old code without your
4205c609719bSwdenk  modification.
420690dc6704Swdenk
42070668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
42080668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
42090668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
42100668236bSWolfgang Denk  bigger than the size limit should be avoided.
4211