xref: /openbmc/u-boot/README (revision b55ae40249545eabb9d6bfb850b1400a32561b1f)
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
371*b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
372*b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
373*b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
374*b55ae402SMarcel 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
3910b2f4ecaSNiklaus Giger- vxWorks boot parameters:
3920b2f4ecaSNiklaus Giger
3930b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
3940b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
3950b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
3960b2f4ecaSNiklaus Giger
3970b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
3980b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
3990b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
4000b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
4010b2f4ecaSNiklaus Giger
4020b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
4030b2f4ecaSNiklaus Giger
4040b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
4050b2f4ecaSNiklaus Giger
4060b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4070b2f4ecaSNiklaus Giger		the defaults discussed just above.
4080b2f4ecaSNiklaus Giger
4096705d81eSwdenk- Serial Ports:
41048d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4116705d81eSwdenk
4126705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4136705d81eSwdenk
41448d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4156705d81eSwdenk
4166705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4176705d81eSwdenk
4186705d81eSwdenk		CONFIG_PL011_CLOCK
4196705d81eSwdenk
4206705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4216705d81eSwdenk		the clock speed of the UARTs.
4226705d81eSwdenk
4236705d81eSwdenk		CONFIG_PL01x_PORTS
4246705d81eSwdenk
4256705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4266705d81eSwdenk		define this to a list of base addresses for each (supported)
4276705d81eSwdenk		port. See e.g. include/configs/versatile.h
4286705d81eSwdenk
4296705d81eSwdenk
430c609719bSwdenk- Console Interface:
431c609719bSwdenk		Depending on board, define exactly one serial port
432c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
433c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
434c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
435c609719bSwdenk
436c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
437c609719bSwdenk		port routines must be defined elsewhere
438c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
439c609719bSwdenk
440c609719bSwdenk		CONFIG_CFB_CONSOLE
441c609719bSwdenk		Enables console device for a color framebuffer. Needs following
442c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
443c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
444c609719bSwdenk						(default big endian)
445c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
446c609719bSwdenk						rectangle fill
447c609719bSwdenk						(cf. smiLynxEM)
448c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
449c609719bSwdenk						bit-blit (cf. smiLynxEM)
450c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
451c609719bSwdenk						(cols=pitch)
452c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
453c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
454c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
455c609719bSwdenk						(0-5, cf. cfb_console.c)
456c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
457c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
458c609719bSwdenk						(i.e. i8042_kbd_init())
459c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
460c609719bSwdenk						(i.e. i8042_tstc)
461c609719bSwdenk			VIDEO_GETC_FCT		get char fct
462c609719bSwdenk						(i.e. i8042_getc)
463c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
464c609719bSwdenk						(requires blink timer
465c609719bSwdenk						cf. i8042.c)
4666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
467c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
468c609719bSwdenk						upper right corner
469602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
470c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
471c609719bSwdenk						upper left corner
472a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
473a6c7ad2fSwdenk						linux_logo.h for logo.
474a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
475c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
47611ccc33fSMarcel Ziswiler						additional board info beside
477c609719bSwdenk						the logo
478c609719bSwdenk
479c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
480c609719bSwdenk		default i/o. Serial console can be forced with
481c609719bSwdenk		environment 'console=serial'.
482c609719bSwdenk
483a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
484a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
485a3ad8e26Swdenk		the "silent" environment variable. See
486a3ad8e26Swdenk		doc/README.silent for more information.
487a3ad8e26Swdenk
488c609719bSwdenk- Console Baudrate:
489c609719bSwdenk		CONFIG_BAUDRATE - in bps
490c609719bSwdenk		Select one of the baudrates listed in
4916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
4926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
493c609719bSwdenk
494c92fac91SHeiko Schocher- Console Rx buffer length
495c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
496c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
4972b3f12c2SHeiko Schocher		This option is actual only for 82xx and 8xx possible.
498c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
499c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
500c92fac91SHeiko Schocher		the SMC.
501c92fac91SHeiko Schocher
502c609719bSwdenk- Interrupt driven serial port input:
503c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
504c609719bSwdenk
505c609719bSwdenk		PPC405GP only.
506c609719bSwdenk		Use an interrupt handler for receiving data on the
507c609719bSwdenk		serial port. It also enables using hardware handshake
508c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
509c609719bSwdenk		bytes the interrupt driven input buffer should have.
510c609719bSwdenk
511109c0e3aSwdenk		Leave undefined to disable this feature, including
512109c0e3aSwdenk		disable the buffer and hardware handshake.
513c609719bSwdenk
5141d49b1f3Sstroese- Console UART Number:
5151d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5161d49b1f3Sstroese
5170c8721a4SWolfgang Denk		AMCC PPC4xx only.
5181d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5191d49b1f3Sstroese		as default U-Boot console.
5201d49b1f3Sstroese
521c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
522c609719bSwdenk		Delay before automatically booting the default image;
523c609719bSwdenk		set to -1 to disable autoboot.
524c609719bSwdenk
525c609719bSwdenk		See doc/README.autoboot for these options that
526c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
527c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
528c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
529c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
530c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
531c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
532c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
533c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
534c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
535c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
536c609719bSwdenk		CONFIG_RESET_TO_RETRY
537c609719bSwdenk
538c609719bSwdenk- Autoboot Command:
539c609719bSwdenk		CONFIG_BOOTCOMMAND
540c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
541c609719bSwdenk		define a command string that is automatically executed
542c609719bSwdenk		when no character is read on the console interface
543c609719bSwdenk		within "Boot Delay" after reset.
544c609719bSwdenk
545c609719bSwdenk		CONFIG_BOOTARGS
546c609719bSwdenk		This can be used to pass arguments to the bootm
547c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
548c609719bSwdenk		environment value "bootargs".
549c609719bSwdenk
550c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
551c609719bSwdenk		The value of these goes into the environment as
552c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
553c609719bSwdenk		as a convenience, when switching between booting from
55411ccc33fSMarcel Ziswiler		RAM and NFS.
555c609719bSwdenk
556c609719bSwdenk- Pre-Boot Commands:
557c609719bSwdenk		CONFIG_PREBOOT
558c609719bSwdenk
559c609719bSwdenk		When this option is #defined, the existence of the
560c609719bSwdenk		environment variable "preboot" will be checked
561c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
562c609719bSwdenk		countdown and/or running the auto-boot command resp.
563c609719bSwdenk		entering interactive mode.
564c609719bSwdenk
565c609719bSwdenk		This feature is especially useful when "preboot" is
566c609719bSwdenk		automatically generated or modified. For an example
567c609719bSwdenk		see the LWMON board specific code: here "preboot" is
568c609719bSwdenk		modified when the user holds down a certain
569c609719bSwdenk		combination of keys on the (special) keyboard when
570c609719bSwdenk		booting the systems
571c609719bSwdenk
572c609719bSwdenk- Serial Download Echo Mode:
573c609719bSwdenk		CONFIG_LOADS_ECHO
574c609719bSwdenk		If defined to 1, all characters received during a
575c609719bSwdenk		serial download (using the "loads" command) are
576c609719bSwdenk		echoed back. This might be needed by some terminal
577c609719bSwdenk		emulations (like "cu"), but may as well just take
578c609719bSwdenk		time on others. This setting #define's the initial
579c609719bSwdenk		value of the "loads_echo" environment variable.
580c609719bSwdenk
581602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
582c609719bSwdenk		CONFIG_KGDB_BAUDRATE
583c609719bSwdenk		Select one of the baudrates listed in
5846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
585c609719bSwdenk
586c609719bSwdenk- Monitor Functions:
587602ad3b3SJon Loeliger		Monitor commands can be included or excluded
588602ad3b3SJon Loeliger		from the build by using the #include files
589602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
590602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
591602ad3b3SJon Loeliger		and augmenting with additional #define's
592602ad3b3SJon Loeliger		for wanted commands.
593c609719bSwdenk
594602ad3b3SJon Loeliger		The default command configuration includes all commands
595602ad3b3SJon Loeliger		except those marked below with a "*".
596602ad3b3SJon Loeliger
597602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
598602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
599602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
600602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
601602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
602602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
603602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
604602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
605602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
606602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
607602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
608a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
609a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
610a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
611a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
612602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
613602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
614602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
615602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
616bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
617602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
618602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
619602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
620602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
621602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
622602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
623602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
624602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
625602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
626602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
627602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
628602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
629602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
630602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
631602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
632602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
633602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
63402c9aa1dSRobin Getz		CONFIG_CMD_MD5SUM	  print md5 message digest
63502c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
636602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
63756523f12Swdenk					  loop, loopw, mtest
638602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
639602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
640602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
64168d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
642602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
643602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
644e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
645e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
646602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
647602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
648602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
649602ad3b3SJon Loeliger					  host
650602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
651602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
652602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
653602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
654602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
655602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
656602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
657602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
658602ad3b3SJon Loeliger					  (4xx only)
65902c9aa1dSRobin Getz		CONFIG_CMD_SHA1		  print sha1 memory digest
66002c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY)
66174de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
662602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
663602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
664602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
665602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
666602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
667c609719bSwdenk
668c609719bSwdenk
669c609719bSwdenk		EXAMPLE: If you want all functions except of network
670c609719bSwdenk		support you can write:
671c609719bSwdenk
672602ad3b3SJon Loeliger		#include "config_cmd_all.h"
673602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
674c609719bSwdenk
675213bf8c8SGerald Van Baren	Other Commands:
676213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
677c609719bSwdenk
678c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
679602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
680c609719bSwdenk		what you (and your U-Boot users) are doing. Data
681c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
682c609719bSwdenk		8260 (where accesses to the IMMR region must be
683c609719bSwdenk		uncached), and it cannot be disabled on all other
684c609719bSwdenk		systems where we (mis-) use the data cache to hold an
685c609719bSwdenk		initial stack and some data.
686c609719bSwdenk
687c609719bSwdenk
688c609719bSwdenk		XXX - this list needs to get updated!
689c609719bSwdenk
690c609719bSwdenk- Watchdog:
691c609719bSwdenk		CONFIG_WATCHDOG
692c609719bSwdenk		If this variable is defined, it enables watchdog
6937152b1d0Swdenk		support. There must be support in the platform specific
694c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
695c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
696c609719bSwdenk		register.
697c609719bSwdenk
698c1551ea8Sstroese- U-Boot Version:
699c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
700c1551ea8Sstroese		If this variable is defined, an environment variable
701c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
702c1551ea8Sstroese		version as printed by the "version" command.
703c1551ea8Sstroese		This variable is readonly.
704c1551ea8Sstroese
705c609719bSwdenk- Real-Time Clock:
706c609719bSwdenk
707602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
708c609719bSwdenk		has to be selected, too. Define exactly one of the
709c609719bSwdenk		following options:
710c609719bSwdenk
711c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
712c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
7137ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
714c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7151cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
716c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7177f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7183bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7199536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7204c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
722c609719bSwdenk
723b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
724b37c7e5eSwdenk		must also be configured. See I2C Support, below.
725b37c7e5eSwdenk
726e92739d3SPeter Tyser- GPIO Support:
727e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
728e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
729e92739d3SPeter Tyser
730e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
731e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
732e92739d3SPeter Tyser
733c609719bSwdenk- Timestamp Support:
734c609719bSwdenk
735c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
736c609719bSwdenk		(date and time) of an image is printed by image
737c609719bSwdenk		commands like bootm or iminfo. This option is
738602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
739c609719bSwdenk
740c609719bSwdenk- Partition Support:
741c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
74207f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
743c609719bSwdenk
744602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
745218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
746218ca724SWolfgang Denk		least one partition type as well.
747c609719bSwdenk
748c609719bSwdenk- IDE Reset method:
7494d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7504d13cbadSwdenk		board configurations files but used nowhere!
751c609719bSwdenk
7524d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7534d13cbadSwdenk		be performed by calling the function
7544d13cbadSwdenk			ide_set_reset(int reset)
7554d13cbadSwdenk		which has to be defined in a board specific file
756c609719bSwdenk
757c609719bSwdenk- ATAPI Support:
758c609719bSwdenk		CONFIG_ATAPI
759c609719bSwdenk
760c609719bSwdenk		Set this to enable ATAPI support.
761c609719bSwdenk
762c40b2956Swdenk- LBA48 Support
763c40b2956Swdenk		CONFIG_LBA48
764c40b2956Swdenk
765c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
767c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
768c40b2956Swdenk		support disks up to 2.1TB.
769c40b2956Swdenk
7706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
771c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
772c40b2956Swdenk			Default is 32bit.
773c40b2956Swdenk
774c609719bSwdenk- SCSI Support:
775c609719bSwdenk		At the moment only there is only support for the
776c609719bSwdenk		SYM53C8XX SCSI controller; define
777c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
778c609719bSwdenk
7796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
7806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
7816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
782c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
783c609719bSwdenk		devices.
7846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
785c609719bSwdenk
786c609719bSwdenk- NETWORK Support (PCI):
787682011ffSwdenk		CONFIG_E1000
788682011ffSwdenk		Support for Intel 8254x gigabit chips.
789682011ffSwdenk
790ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
79111ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
792ac3315c2SAndre Schwarz
793c609719bSwdenk		CONFIG_EEPRO100
794c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
79511ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
796c609719bSwdenk		write routine for first time initialisation.
797c609719bSwdenk
798c609719bSwdenk		CONFIG_TULIP
799c609719bSwdenk		Support for Digital 2114x chips.
800c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
801c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
802c609719bSwdenk
803c609719bSwdenk		CONFIG_NATSEMI
804c609719bSwdenk		Support for National dp83815 chips.
805c609719bSwdenk
806c609719bSwdenk		CONFIG_NS8382X
807c609719bSwdenk		Support for National dp8382[01] gigabit chips.
808c609719bSwdenk
80945219c46Swdenk- NETWORK Support (other):
81045219c46Swdenk
81145219c46Swdenk		CONFIG_DRIVER_LAN91C96
81245219c46Swdenk		Support for SMSC's LAN91C96 chips.
81345219c46Swdenk
81445219c46Swdenk			CONFIG_LAN91C96_BASE
81545219c46Swdenk			Define this to hold the physical address
81645219c46Swdenk			of the LAN91C96's I/O space
81745219c46Swdenk
81845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
81945219c46Swdenk			Define this to enable 32 bit addressing
82045219c46Swdenk
821f39748aeSwdenk		CONFIG_DRIVER_SMC91111
822f39748aeSwdenk		Support for SMSC's LAN91C111 chip
823f39748aeSwdenk
824f39748aeSwdenk			CONFIG_SMC91111_BASE
825f39748aeSwdenk			Define this to hold the physical address
826f39748aeSwdenk			of the device (I/O space)
827f39748aeSwdenk
828f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
829f39748aeSwdenk			Define this if data bus is 32 bits
830f39748aeSwdenk
831f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
832f39748aeSwdenk			Define this to use i/o functions instead of macros
833f39748aeSwdenk			(some hardware wont work with macros)
834f39748aeSwdenk
835557b377dSJens Gehrlein		CONFIG_DRIVER_SMC911X
836557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
837557b377dSJens Gehrlein
838557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_BASE
839557b377dSJens Gehrlein			Define this to hold the physical address
840557b377dSJens Gehrlein			of the device (I/O space)
841557b377dSJens Gehrlein
842557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_32_BIT
843557b377dSJens Gehrlein			Define this if data bus is 32 bits
844557b377dSJens Gehrlein
845557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_16_BIT
846557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
847557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
848557b377dSJens Gehrlein			words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
849557b377dSJens Gehrlein
850c609719bSwdenk- USB Support:
851c609719bSwdenk		At the moment only the UHCI host controller is
8524d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
853c609719bSwdenk		CONFIG_USB_UHCI to enable it.
854c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
85530d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
856c609719bSwdenk		storage devices.
857c609719bSwdenk		Note:
858c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
859c609719bSwdenk		(TEAC FD-05PUB).
8604d13cbadSwdenk		MPC5200 USB requires additional defines:
8614d13cbadSwdenk			CONFIG_USB_CLOCK
8624d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
863307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
864307ecb6dSEric Millbrandt				for USB on PSC3
8654d13cbadSwdenk			CONFIG_USB_CONFIG
8664d13cbadSwdenk				for differential drivers: 0x00001000
8674d13cbadSwdenk				for single ended drivers: 0x00005000
868307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
869307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
8706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
871fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
872fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
8734d13cbadSwdenk
87416c8d5e7SWolfgang Denk- USB Device:
87516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
87616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
87716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
87811ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
87916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
88016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
88116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
88216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
88316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
88416c8d5e7SWolfgang Denk		a Linux host by
88516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
88616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
88716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
88816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
88916c8d5e7SWolfgang Denk
89016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
89116c8d5e7SWolfgang Denk			Define this to build a UDC device
89216c8d5e7SWolfgang Denk
89316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
89416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
89516c8d5e7SWolfgang Denk			talk to the UDC device
89616c8d5e7SWolfgang Denk
8976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
89816c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
89916c8d5e7SWolfgang Denk			be set to usbtty.
90016c8d5e7SWolfgang Denk
90116c8d5e7SWolfgang Denk			mpc8xx:
9026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
90316c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
9046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
90516c8d5e7SWolfgang Denk
9066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
90716c8d5e7SWolfgang Denk				Derive USB clock from brgclk
9086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
90916c8d5e7SWolfgang Denk
91016c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
91116c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
91216c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
91316c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
91416c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
91516c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
91616c8d5e7SWolfgang Denk
91716c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
91816c8d5e7SWolfgang Denk			Define this string as the name of your company for
91916c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
92016c8d5e7SWolfgang Denk
92116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
92216c8d5e7SWolfgang Denk			Define this string as the name of your product
92316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
92416c8d5e7SWolfgang Denk
92516c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
92616c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
92716c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
92816c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
92916c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
93016c8d5e7SWolfgang Denk
93116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
93216c8d5e7SWolfgang Denk			Define this as the unique Product ID
93316c8d5e7SWolfgang Denk			for your device
93416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
935c609719bSwdenk
936c609719bSwdenk
937c609719bSwdenk- MMC Support:
938c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
939c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
940c609719bSwdenk		accessed from the boot prompt by mapping the device
941c609719bSwdenk		to physical memory similar to flash. Command line is
942602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
943602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
944c609719bSwdenk
9456705d81eSwdenk- Journaling Flash filesystem support:
9466705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9476705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9486705d81eSwdenk		Define these for a default partition on a NAND device
9496705d81eSwdenk
9506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9526705d81eSwdenk		Define these for a default partition on a NOR device
9536705d81eSwdenk
9546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9556705d81eSwdenk		Define this to create an own partition. You have to provide a
9566705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9576705d81eSwdenk
9586705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
9606705d81eSwdenk		to disable the command chpart. This is the default when you
9616705d81eSwdenk		have not defined a custom partition
9626705d81eSwdenk
963c609719bSwdenk- Keyboard Support:
964c609719bSwdenk		CONFIG_ISA_KEYBOARD
965c609719bSwdenk
966c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
967c609719bSwdenk		support
968c609719bSwdenk
969c609719bSwdenk		CONFIG_I8042_KBD
970c609719bSwdenk		Standard PC keyboard driver with US (is default) and
971c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
972c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
973c609719bSwdenk		for cfb_console. Supports cursor blinking.
974c609719bSwdenk
975c609719bSwdenk- Video support:
976c609719bSwdenk		CONFIG_VIDEO
977c609719bSwdenk
978c609719bSwdenk		Define this to enable video support (for output to
979c609719bSwdenk		video).
980c609719bSwdenk
981c609719bSwdenk		CONFIG_VIDEO_CT69000
982c609719bSwdenk
983c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
984c609719bSwdenk
985c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
986eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
987eeb1b77bSwdenk		video output is selected via environment 'videoout'
988eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
989eeb1b77bSwdenk		assumed.
990c609719bSwdenk
991eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
99211ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
993eeb1b77bSwdenk		are possible:
994eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
995eeb1b77bSwdenk		Following standard modes are supported	(* is default):
996eeb1b77bSwdenk
997eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
998eeb1b77bSwdenk		-------------+---------------------------------------------
999eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1000eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1001eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1002eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1003eeb1b77bSwdenk		-------------+---------------------------------------------
1004c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1005c609719bSwdenk
1006eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
10077817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
1008eeb1b77bSwdenk
1009eeb1b77bSwdenk
1010a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1011a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1012a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1013a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1014a6c7ad2fSwdenk
1015682011ffSwdenk- Keyboard Support:
1016682011ffSwdenk		CONFIG_KEYBOARD
1017682011ffSwdenk
1018682011ffSwdenk		Define this to enable a custom keyboard support.
1019682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1020682011ffSwdenk		defined in your board-specific files.
1021682011ffSwdenk		The only board using this so far is RBC823.
1022a6c7ad2fSwdenk
1023c609719bSwdenk- LCD Support:	CONFIG_LCD
1024c609719bSwdenk
1025c609719bSwdenk		Define this to enable LCD support (for output to LCD
1026c609719bSwdenk		display); also select one of the supported displays
1027c609719bSwdenk		by defining one of these:
1028c609719bSwdenk
102939cf4804SStelian Pop		CONFIG_ATMEL_LCD:
103039cf4804SStelian Pop
103139cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
103239cf4804SStelian Pop
1033fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1034c609719bSwdenk
1035fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1036c609719bSwdenk
1037fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1038c609719bSwdenk
1039fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1040fd3103bbSwdenk			Active, color, single scan.
1041fd3103bbSwdenk
1042fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1043fd3103bbSwdenk
1044fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1045c609719bSwdenk			Active, color, single scan.
1046c609719bSwdenk
1047c609719bSwdenk		CONFIG_SHARP_16x9
1048c609719bSwdenk
1049c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1050c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1051c609719bSwdenk
1052c609719bSwdenk		CONFIG_SHARP_LQ64D341
1053c609719bSwdenk
1054c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1055c609719bSwdenk			Active, color, single scan.
1056c609719bSwdenk
1057c609719bSwdenk		CONFIG_HLD1045
1058c609719bSwdenk
1059c609719bSwdenk			HLD1045 display, 640x480.
1060c609719bSwdenk			Active, color, single scan.
1061c609719bSwdenk
1062c609719bSwdenk		CONFIG_OPTREX_BW
1063c609719bSwdenk
1064c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1065c609719bSwdenk			or
1066c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1067c609719bSwdenk			or
1068c609719bSwdenk			Hitachi	 SP14Q002
1069c609719bSwdenk
1070c609719bSwdenk			320x240. Black & white.
1071c609719bSwdenk
1072c609719bSwdenk		Normally display is black on white background; define
10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1074c609719bSwdenk
10757152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1076d791b1dcSwdenk
1077d791b1dcSwdenk		If this option is set, the environment is checked for
1078d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1079d791b1dcSwdenk		of logo, copyright and system information on the LCD
1080e94d2cd9Swdenk		is suppressed and the BMP image at the address
1081d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1082d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1083d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1084d791b1dcSwdenk		loaded very quickly after power-on.
1085d791b1dcSwdenk
10861ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
10871ca298ceSMatthias Weisser
10881ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
10891ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
10901ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
10911ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
10921ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
10931ca298ceSMatthias Weisser		specify 'm' for centering the image.
10941ca298ceSMatthias Weisser
10951ca298ceSMatthias Weisser		Example:
10961ca298ceSMatthias Weisser		setenv splashpos m,m
10971ca298ceSMatthias Weisser			=> image at center of screen
10981ca298ceSMatthias Weisser
10991ca298ceSMatthias Weisser		setenv splashpos 30,20
11001ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
11011ca298ceSMatthias Weisser
11021ca298ceSMatthias Weisser		setenv splashpos -10,m
11031ca298ceSMatthias Weisser			=> vertically centered image
11041ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
11051ca298ceSMatthias Weisser
110698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
110798f4a3dfSStefan Roese
110898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
110998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
111098f4a3dfSStefan Roese		splashscreen support or the bmp command.
111198f4a3dfSStefan Roese
1112c29fdfc1Swdenk- Compression support:
1113c29fdfc1Swdenk		CONFIG_BZIP2
1114c29fdfc1Swdenk
1115c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1116c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1117c29fdfc1Swdenk		compressed images are supported.
1118c29fdfc1Swdenk
1119c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
11206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1121c29fdfc1Swdenk		be at least 4MB.
1122d791b1dcSwdenk
1123fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1124fc9c1727SLuigi 'Comio' Mantellini
1125fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1126fc9c1727SLuigi 'Comio' Mantellini		images is included.
1127fc9c1727SLuigi 'Comio' Mantellini
1128fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1129fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1130fc9c1727SLuigi 'Comio' Mantellini		formula:
1131fc9c1727SLuigi 'Comio' Mantellini
1132fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1133fc9c1727SLuigi 'Comio' Mantellini
1134fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1135fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1136fc9c1727SLuigi 'Comio' Mantellini
1137fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1138fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1139fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1140fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1141fc9c1727SLuigi 'Comio' Mantellini
1142fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1143fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1145fc9c1727SLuigi 'Comio' Mantellini
114617ea1177Swdenk- MII/PHY support:
114717ea1177Swdenk		CONFIG_PHY_ADDR
114817ea1177Swdenk
114917ea1177Swdenk		The address of PHY on MII bus.
115017ea1177Swdenk
115117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
115217ea1177Swdenk
115317ea1177Swdenk		The clock frequency of the MII bus
115417ea1177Swdenk
115517ea1177Swdenk		CONFIG_PHY_GIGE
115617ea1177Swdenk
115717ea1177Swdenk		If this option is set, support for speed/duplex
115811ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
115917ea1177Swdenk
116017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
116117ea1177Swdenk
116217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
116317ea1177Swdenk		reset before any MII register access is possible.
116417ea1177Swdenk		For such PHY, set this option to the usec delay
116517ea1177Swdenk		required. (minimum 300usec for LXT971A)
116617ea1177Swdenk
116717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
116817ea1177Swdenk
116917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
117017ea1177Swdenk		command issued before MII status register can be read
117117ea1177Swdenk
1172c609719bSwdenk- Ethernet address:
1173c609719bSwdenk		CONFIG_ETHADDR
1174c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1175c609719bSwdenk		CONFIG_ETH2ADDR
1176c609719bSwdenk		CONFIG_ETH3ADDR
1177c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1178c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1179c609719bSwdenk
118011ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
118111ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1182c609719bSwdenk		is not determined automatically.
1183c609719bSwdenk
1184c609719bSwdenk- IP address:
1185c609719bSwdenk		CONFIG_IPADDR
1186c609719bSwdenk
1187c609719bSwdenk		Define a default value for the IP address to use for
118811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1189c609719bSwdenk		determined through e.g. bootp.
1190c609719bSwdenk
1191c609719bSwdenk- Server IP address:
1192c609719bSwdenk		CONFIG_SERVERIP
1193c609719bSwdenk
1194c609719bSwdenk		Defines a default value for the IP address of a TFTP
1195c609719bSwdenk		server to contact when using the "tftboot" command.
1196c609719bSwdenk
119797cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
119897cfe861SRobin Getz
119997cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
120097cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
120197cfe861SRobin Getz
120253a5c424SDavid Updegraff- Multicast TFTP Mode:
120353a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
120453a5c424SDavid Updegraff
120553a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
120653a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
120711ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
120853a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
120953a5c424SDavid Updegraff		multicast group.
121053a5c424SDavid Updegraff
121153a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1212c609719bSwdenk- BOOTP Recovery Mode:
1213c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1214c609719bSwdenk
1215c609719bSwdenk		If you have many targets in a network that try to
1216c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1217c609719bSwdenk		systems send out BOOTP requests at precisely the same
1218c609719bSwdenk		moment (which would happen for instance at recovery
1219c609719bSwdenk		from a power failure, when all systems will try to
1220c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1221c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1222c609719bSwdenk		inserted before sending out BOOTP requests. The
12236c33c785SWolfgang Denk		following delays are inserted then:
1224c609719bSwdenk
1225c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1226c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1227c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1228c609719bSwdenk		4th and following
1229c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1230c609719bSwdenk
1231fe389a82Sstroese- DHCP Advanced Options:
12321fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
12331fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1234fe389a82Sstroese
12351fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
12361fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
12371fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
12381fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
12391fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
12401fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
12411fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
12421fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
12431fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
12441fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
12451fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
12461fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1247fe389a82Sstroese
12485d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12495d110f0aSWilson Callan		environment variable, not the BOOTP server.
1250fe389a82Sstroese
1251fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1252fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1253fe389a82Sstroese		than one DNS serverip is offered to the client.
1254fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1255fe389a82Sstroese		serverip will be stored in the additional environment
1256fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1257fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
12581fe80d79SJon Loeliger		is defined.
1259fe389a82Sstroese
1260fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1261fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1262fe389a82Sstroese		need the hostname of the DHCP requester.
12635d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
12641fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
12651fe80d79SJon Loeliger		option 12 to the DHCP server.
1266fe389a82Sstroese
1267d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1268d9a2f416SAras Vaichas
1269d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1270d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1271d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1272d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1273d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1274d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1275d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1276d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1277d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1278d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1279d9a2f416SAras Vaichas		this delay.
1280d9a2f416SAras Vaichas
1281a3d991bdSwdenk - CDP Options:
1282a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1283a3d991bdSwdenk
1284a3d991bdSwdenk		The device id used in CDP trigger frames.
1285a3d991bdSwdenk
1286a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1287a3d991bdSwdenk
1288a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1289a3d991bdSwdenk		of the device.
1290a3d991bdSwdenk
1291a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1292a3d991bdSwdenk
1293a3d991bdSwdenk		A printf format string which contains the ascii name of
1294a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
129511ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1296a3d991bdSwdenk
1297a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1298a3d991bdSwdenk
1299a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1300a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1301a3d991bdSwdenk
1302a3d991bdSwdenk		CONFIG_CDP_VERSION
1303a3d991bdSwdenk
1304a3d991bdSwdenk		An ascii string containing the version of the software.
1305a3d991bdSwdenk
1306a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1307a3d991bdSwdenk
1308a3d991bdSwdenk		An ascii string containing the name of the platform.
1309a3d991bdSwdenk
1310a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1311a3d991bdSwdenk
1312a3d991bdSwdenk		A 32bit integer sent on the trigger.
1313a3d991bdSwdenk
1314a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1315a3d991bdSwdenk
1316a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1317a3d991bdSwdenk		device in .1 of milliwatts.
1318a3d991bdSwdenk
1319a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1320a3d991bdSwdenk
1321a3d991bdSwdenk		A byte containing the id of the VLAN.
1322a3d991bdSwdenk
1323c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1324c609719bSwdenk
1325c609719bSwdenk		Several configurations allow to display the current
1326c609719bSwdenk		status using a LED. For instance, the LED will blink
1327c609719bSwdenk		fast while running U-Boot code, stop blinking as
1328c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1329c609719bSwdenk		start blinking slow once the Linux kernel is running
1330c609719bSwdenk		(supported by a status LED driver in the Linux
1331c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1332c609719bSwdenk		feature in U-Boot.
1333c609719bSwdenk
1334c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1335c609719bSwdenk
1336c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1337c609719bSwdenk		on those systems that support this (optional)
1338c609719bSwdenk		feature, like the TQM8xxL modules.
1339c609719bSwdenk
1340c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1341c609719bSwdenk
1342b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1343b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
134411ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1345c609719bSwdenk
1346b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1347602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1348b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1349b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1350c609719bSwdenk		command line interface.
1351c609719bSwdenk
1352bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1353c609719bSwdenk
1354b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1355b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1356b37c7e5eSwdenk		support for I2C.
1357c609719bSwdenk
1358b37c7e5eSwdenk		There are several other quantities that must also be
1359b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1360c609719bSwdenk
13616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1362b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
13636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
136411ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1365c609719bSwdenk
1366b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
136711ccc33fSMarcel Ziswiler		sets the CPU up as a master node and so its address should
1368b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
13696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
1370b37c7e5eSwdenk
13715da71efaSEric Millbrandt		CONFIG_SYS_I2C_INIT_MPC5XXX
13725da71efaSEric Millbrandt
13735da71efaSEric Millbrandt		When a board is reset during an i2c bus transfer
13745da71efaSEric Millbrandt		chips might think that the current transfer is still
13755da71efaSEric Millbrandt		in progress.  Reset the slave devices by sending start
13765da71efaSEric Millbrandt		commands until the slave device responds.
13775da71efaSEric Millbrandt
1378b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1379b37c7e5eSwdenk
1380b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1381b37c7e5eSwdenk		then the following macros need to be defined (examples are
1382b37c7e5eSwdenk		from include/configs/lwmon.h):
1383c609719bSwdenk
1384c609719bSwdenk		I2C_INIT
1385c609719bSwdenk
1386b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1387c609719bSwdenk		controller or configure ports.
1388c609719bSwdenk
1389b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1390b37c7e5eSwdenk
1391c609719bSwdenk		I2C_PORT
1392c609719bSwdenk
1393c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1394c609719bSwdenk		assumes both bits are on the same port). Valid values
1395c609719bSwdenk		are 0..3 for ports A..D.
1396c609719bSwdenk
1397c609719bSwdenk		I2C_ACTIVE
1398c609719bSwdenk
1399c609719bSwdenk		The code necessary to make the I2C data line active
1400c609719bSwdenk		(driven).  If the data line is open collector, this
1401c609719bSwdenk		define can be null.
1402c609719bSwdenk
1403b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1404b37c7e5eSwdenk
1405c609719bSwdenk		I2C_TRISTATE
1406c609719bSwdenk
1407c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1408c609719bSwdenk		(inactive).  If the data line is open collector, this
1409c609719bSwdenk		define can be null.
1410c609719bSwdenk
1411b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1412b37c7e5eSwdenk
1413c609719bSwdenk		I2C_READ
1414c609719bSwdenk
1415c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1416c609719bSwdenk		FALSE if it is low.
1417c609719bSwdenk
1418b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1419b37c7e5eSwdenk
1420c609719bSwdenk		I2C_SDA(bit)
1421c609719bSwdenk
1422c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1423c609719bSwdenk		is FALSE, it clears it (low).
1424c609719bSwdenk
1425b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1426b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1427b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1428b37c7e5eSwdenk
1429c609719bSwdenk		I2C_SCL(bit)
1430c609719bSwdenk
1431c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1432c609719bSwdenk		is FALSE, it clears it (low).
1433c609719bSwdenk
1434b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1435b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1436b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1437b37c7e5eSwdenk
1438c609719bSwdenk		I2C_DELAY
1439c609719bSwdenk
1440c609719bSwdenk		This delay is invoked four times per clock cycle so this
1441c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1442b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1443b37c7e5eSwdenk		like:
1444b37c7e5eSwdenk
1445b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1446c609719bSwdenk
14476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
144847cd00faSwdenk
144947cd00faSwdenk		When a board is reset during an i2c bus transfer
145047cd00faSwdenk		chips might think that the current transfer is still
145147cd00faSwdenk		in progress. On some boards it is possible to access
145247cd00faSwdenk		the i2c SCLK line directly, either by using the
145347cd00faSwdenk		processor pin as a GPIO or by having a second pin
145447cd00faSwdenk		connected to the bus. If this option is defined a
145547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
145647cd00faSwdenk		is run early in the boot sequence.
145747cd00faSwdenk
145817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
145917ea1177Swdenk
146017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
146117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
146217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
146317ea1177Swdenk
1464bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1465bb99ad6dSBen Warren
1466bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1467bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1468bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1469bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1470bb99ad6dSBen Warren
14716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1472bb99ad6dSBen Warren
1473bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
14740f89c54bSPeter Tyser		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
14750f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
14760f89c54bSPeter Tyser		a 1D array of device addresses
1477bb99ad6dSBen Warren
1478bb99ad6dSBen Warren		e.g.
1479bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
14806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1481bb99ad6dSBen Warren
1482bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1483bb99ad6dSBen Warren
1484bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
14856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1486bb99ad6dSBen Warren
1487bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1488bb99ad6dSBen Warren
14896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1490be5e6181STimur Tabi
1491be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1492be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1493be5e6181STimur Tabi
14946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
14950dc018ecSStefan Roese
14960dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
14970dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
14980dc018ecSStefan Roese
14996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
15000dc018ecSStefan Roese
15010dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
15020dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
15030dc018ecSStefan Roese
15046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
15059ebbb54fSVictor Gallardo
15069ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
15079ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
15089ebbb54fSVictor Gallardo		specified DTT device.
15099ebbb54fSVictor Gallardo
1510be5e6181STimur Tabi		CONFIG_FSL_I2C
1511be5e6181STimur Tabi
1512be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
15137817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1514be5e6181STimur Tabi
151567b23a32SHeiko Schocher		CONFIG_I2C_MUX
151667b23a32SHeiko Schocher
151767b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
151867b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
151967b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
152067b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
152167b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
152267b23a32SHeiko Schocher		the muxes to activate this new "bus".
152367b23a32SHeiko Schocher
152467b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
152567b23a32SHeiko Schocher		feature!
152667b23a32SHeiko Schocher
152767b23a32SHeiko Schocher		Example:
152867b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
152967b23a32SHeiko Schocher			The First mux with address 70 and channel 6
153067b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
153167b23a32SHeiko Schocher
153267b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
153367b23a32SHeiko Schocher
153467b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
153567b23a32SHeiko Schocher		of I2C Busses with muxes:
153667b23a32SHeiko Schocher
153767b23a32SHeiko Schocher		=> i2c bus
153867b23a32SHeiko Schocher		Busses reached over muxes:
153967b23a32SHeiko Schocher		Bus ID: 2
154067b23a32SHeiko Schocher		  reached over Mux(es):
154167b23a32SHeiko Schocher		    pca9544a@70 ch: 4
154267b23a32SHeiko Schocher		Bus ID: 3
154367b23a32SHeiko Schocher		  reached over Mux(es):
154467b23a32SHeiko Schocher		    pca9544a@70 ch: 6
154567b23a32SHeiko Schocher		    pca9544a@71 ch: 4
154667b23a32SHeiko Schocher		=>
154767b23a32SHeiko Schocher
154867b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
154967b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
155067b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
155167b23a32SHeiko Schocher		the channel 4.
155267b23a32SHeiko Schocher
155367b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
155467b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
155567b23a32SHeiko Schocher		the 2 muxes.
155667b23a32SHeiko Schocher
155767b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
155867b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
155967b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
156067b23a32SHeiko Schocher		to add this option to other architectures.
156167b23a32SHeiko Schocher
15622ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
15632ac6985aSAndrew Dyer
15642ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
15652ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
15662ac6985aSAndrew Dyer		between writing the address pointer and reading the
15672ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
15682ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
15692ac6985aSAndrew Dyer		devices can use either method, but some require one or
15702ac6985aSAndrew Dyer		the other.
1571be5e6181STimur Tabi
1572c609719bSwdenk- SPI Support:	CONFIG_SPI
1573c609719bSwdenk
1574c609719bSwdenk		Enables SPI driver (so far only tested with
1575c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1576c609719bSwdenk		D/As on the SACSng board)
1577c609719bSwdenk
1578c609719bSwdenk		CONFIG_SPI_X
1579c609719bSwdenk
1580c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1581c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1582c609719bSwdenk
1583c609719bSwdenk		CONFIG_SOFT_SPI
1584c609719bSwdenk
1585c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1586c609719bSwdenk		using hardware support. This is a general purpose
1587c609719bSwdenk		driver that only requires three general I/O port pins
1588c609719bSwdenk		(two outputs, one input) to function. If this is
1589c609719bSwdenk		defined, the board configuration must define several
1590c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1591c609719bSwdenk		an example, see include/configs/sacsng.h.
1592c609719bSwdenk
159304a9e118SBen Warren		CONFIG_HARD_SPI
159404a9e118SBen Warren
159504a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
159604a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
159704a9e118SBen Warren		must define a list of chip-select function pointers.
159804a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
159904a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
160004a9e118SBen Warren
160138254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
160238254f45SGuennadi Liakhovetski
160338254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
160438254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
160538254f45SGuennadi Liakhovetski
16060133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
16070133502eSMatthias Fuchs
16080133502eSMatthias Fuchs		Enables FPGA subsystem.
16090133502eSMatthias Fuchs
16100133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
16110133502eSMatthias Fuchs
16120133502eSMatthias Fuchs		Enables support for specific chip vendors.
16130133502eSMatthias Fuchs		(ALTERA, XILINX)
16140133502eSMatthias Fuchs
16150133502eSMatthias Fuchs		CONFIG_FPGA_<family>
16160133502eSMatthias Fuchs
16170133502eSMatthias Fuchs		Enables support for FPGA family.
16180133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
16190133502eSMatthias Fuchs
16200133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1621c609719bSwdenk
1622c609719bSwdenk		Specify the number of FPGA devices to support.
1623c609719bSwdenk
16246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1625c609719bSwdenk
1626c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1627c609719bSwdenk
16286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1629c609719bSwdenk
1630c609719bSwdenk		Enable checks on FPGA configuration interface busy
1631c609719bSwdenk		status by the configuration function. This option
1632c609719bSwdenk		will require a board or device specific function to
1633c609719bSwdenk		be written.
1634c609719bSwdenk
1635c609719bSwdenk		CONFIG_FPGA_DELAY
1636c609719bSwdenk
1637c609719bSwdenk		If defined, a function that provides delays in the FPGA
1638c609719bSwdenk		configuration driver.
1639c609719bSwdenk
16406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1641c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1642c609719bSwdenk
16436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1644c609719bSwdenk
1645c609719bSwdenk		Check for configuration errors during FPGA bitfile
1646c609719bSwdenk		loading. For example, abort during Virtex II
1647c609719bSwdenk		configuration if the INIT_B line goes low (which
1648c609719bSwdenk		indicated a CRC error).
1649c609719bSwdenk
16506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1651c609719bSwdenk
1652c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1653c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1654c609719bSwdenk		FPGA configuration sequence. The default time is 500
165511ccc33fSMarcel Ziswiler		ms.
1656c609719bSwdenk
16576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1658c609719bSwdenk
1659c609719bSwdenk		Maximum time to wait for BUSY to deassert during
166011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1661c609719bSwdenk
16626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1663c609719bSwdenk
1664c609719bSwdenk		Time to wait after FPGA configuration. The default is
166511ccc33fSMarcel Ziswiler		200 ms.
1666c609719bSwdenk
1667c609719bSwdenk- Configuration Management:
1668c609719bSwdenk		CONFIG_IDENT_STRING
1669c609719bSwdenk
1670c609719bSwdenk		If defined, this string will be added to the U-Boot
1671c609719bSwdenk		version information (U_BOOT_VERSION)
1672c609719bSwdenk
1673c609719bSwdenk- Vendor Parameter Protection:
1674c609719bSwdenk
1675c609719bSwdenk		U-Boot considers the values of the environment
1676c609719bSwdenk		variables "serial#" (Board Serial Number) and
16777152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1678c609719bSwdenk		are set once by the board vendor / manufacturer, and
1679c609719bSwdenk		protects these variables from casual modification by
1680c609719bSwdenk		the user. Once set, these variables are read-only,
1681c609719bSwdenk		and write or delete attempts are rejected. You can
168211ccc33fSMarcel Ziswiler		change this behaviour:
1683c609719bSwdenk
1684c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1685c609719bSwdenk		file, the write protection for vendor parameters is
168647cd00faSwdenk		completely disabled. Anybody can change or delete
1687c609719bSwdenk		these parameters.
1688c609719bSwdenk
1689c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1690c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
169111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1692c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1693c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1694c609719bSwdenk		read-only.]
1695c609719bSwdenk
1696c609719bSwdenk- Protected RAM:
1697c609719bSwdenk		CONFIG_PRAM
1698c609719bSwdenk
1699c609719bSwdenk		Define this variable to enable the reservation of
1700c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1701c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1702c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1703c609719bSwdenk		this default value by defining an environment
1704c609719bSwdenk		variable "pram" to the number of kB you want to
1705c609719bSwdenk		reserve. Note that the board info structure will
1706c609719bSwdenk		still show the full amount of RAM. If pRAM is
1707c609719bSwdenk		reserved, a new environment variable "mem" will
1708c609719bSwdenk		automatically be defined to hold the amount of
1709c609719bSwdenk		remaining RAM in a form that can be passed as boot
1710c609719bSwdenk		argument to Linux, for instance like that:
1711c609719bSwdenk
1712fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1713c609719bSwdenk			saveenv
1714c609719bSwdenk
1715c609719bSwdenk		This way you can tell Linux not to use this memory,
1716c609719bSwdenk		either, which results in a memory region that will
1717c609719bSwdenk		not be affected by reboots.
1718c609719bSwdenk
1719c609719bSwdenk		*WARNING* If your board configuration uses automatic
1720c609719bSwdenk		detection of the RAM size, you must make sure that
1721c609719bSwdenk		this memory test is non-destructive. So far, the
1722c609719bSwdenk		following board configurations are known to be
1723c609719bSwdenk		"pRAM-clean":
1724c609719bSwdenk
1725c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1726c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1727c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1728c609719bSwdenk
1729c609719bSwdenk- Error Recovery:
1730c609719bSwdenk		CONFIG_PANIC_HANG
1731c609719bSwdenk
1732c609719bSwdenk		Define this variable to stop the system in case of a
1733c609719bSwdenk		fatal error, so that you have to reset it manually.
1734c609719bSwdenk		This is probably NOT a good idea for an embedded
173511ccc33fSMarcel Ziswiler		system where you want the system to reboot
1736c609719bSwdenk		automatically as fast as possible, but it may be
1737c609719bSwdenk		useful during development since you can try to debug
1738c609719bSwdenk		the conditions that lead to the situation.
1739c609719bSwdenk
1740c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1741c609719bSwdenk
1742c609719bSwdenk		This variable defines the number of retries for
1743c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1744c609719bSwdenk		before giving up the operation. If not defined, a
1745c609719bSwdenk		default value of 5 is used.
1746c609719bSwdenk
174740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
174840cb90eeSGuennadi Liakhovetski
174940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
175040cb90eeSGuennadi Liakhovetski
1751c609719bSwdenk- Command Interpreter:
17528078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
175304a85b3bSwdenk
175404a85b3bSwdenk		Enable auto completion of commands using TAB.
175504a85b3bSwdenk
17568078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
17578078f1a5SWolfgang Denk		for the "hush" shell.
17588078f1a5SWolfgang Denk
17598078f1a5SWolfgang Denk
17606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1761c609719bSwdenk
1762c609719bSwdenk		Define this variable to enable the "hush" shell (from
1763c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1764c609719bSwdenk		powerful command line syntax like
1765c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1766c609719bSwdenk		constructs ("shell scripts").
1767c609719bSwdenk
1768c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1769c609719bSwdenk		with a somewhat smaller memory footprint.
1770c609719bSwdenk
1771c609719bSwdenk
17726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1773c609719bSwdenk
1774c609719bSwdenk		This defines the secondary prompt string, which is
1775c609719bSwdenk		printed when the command interpreter needs more input
1776c609719bSwdenk		to complete a command. Usually "> ".
1777c609719bSwdenk
1778c609719bSwdenk	Note:
1779c609719bSwdenk
1780c609719bSwdenk		In the current implementation, the local variables
1781c609719bSwdenk		space and global environment variables space are
1782c609719bSwdenk		separated. Local variables are those you define by
17833b57fe0aSwdenk		simply typing `name=value'. To access a local
1784c609719bSwdenk		variable later on, you have write `$name' or
17853b57fe0aSwdenk		`${name}'; to execute the contents of a variable
17863b57fe0aSwdenk		directly type `$name' at the command prompt.
1787c609719bSwdenk
1788c609719bSwdenk		Global environment variables are those you use
1789c609719bSwdenk		setenv/printenv to work with. To run a command stored
1790c609719bSwdenk		in such a variable, you need to use the run command,
1791c609719bSwdenk		and you must not use the '$' sign to access them.
1792c609719bSwdenk
1793c609719bSwdenk		To store commands and special characters in a
1794c609719bSwdenk		variable, please use double quotation marks
1795c609719bSwdenk		surrounding the whole text of the variable, instead
1796c609719bSwdenk		of the backslashes before semicolons and special
1797c609719bSwdenk		symbols.
1798c609719bSwdenk
1799aa0c71acSWolfgang Denk- Commandline Editing and History:
1800aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1801aa0c71acSWolfgang Denk
180211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1803aa0c71acSWolfgang Denk		commandline input operations
1804aa0c71acSWolfgang Denk
1805a8c7c708Swdenk- Default Environment:
1806c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1807c609719bSwdenk
1808c609719bSwdenk		Define this to contain any number of null terminated
1809c609719bSwdenk		strings (variable = value pairs) that will be part of
18107152b1d0Swdenk		the default environment compiled into the boot image.
18112262cfeeSwdenk
1812c609719bSwdenk		For example, place something like this in your
1813c609719bSwdenk		board's config file:
1814c609719bSwdenk
1815c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1816c609719bSwdenk			"myvar1=value1\0" \
1817c609719bSwdenk			"myvar2=value2\0"
1818c609719bSwdenk
1819c609719bSwdenk		Warning: This method is based on knowledge about the
1820c609719bSwdenk		internal format how the environment is stored by the
18212262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1822c609719bSwdenk		interface! Although it is unlikely that this format
18237152b1d0Swdenk		will change soon, there is no guarantee either.
1824c609719bSwdenk		You better know what you are doing here.
1825c609719bSwdenk
1826c609719bSwdenk		Note: overly (ab)use of the default environment is
1827c609719bSwdenk		discouraged. Make sure to check other ways to preset
182874de7aefSWolfgang Denk		the environment like the "source" command or the
1829c609719bSwdenk		boot command first.
1830c609719bSwdenk
1831a8c7c708Swdenk- DataFlash Support:
18322abbe075Swdenk		CONFIG_HAS_DATAFLASH
18332abbe075Swdenk
18342abbe075Swdenk		Defining this option enables DataFlash features and
18352abbe075Swdenk		allows to read/write in Dataflash via the standard
18362abbe075Swdenk		commands cp, md...
18372abbe075Swdenk
18383f85ce27Swdenk- SystemACE Support:
18393f85ce27Swdenk		CONFIG_SYSTEMACE
18403f85ce27Swdenk
18413f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
18423f85ce27Swdenk		chips attached via some sort of local bus. The address
184311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
18446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
18453f85ce27Swdenk
18463f85ce27Swdenk		#define CONFIG_SYSTEMACE
18476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
18483f85ce27Swdenk
18493f85ce27Swdenk		When SystemACE support is added, the "ace" device type
18503f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
18513f85ce27Swdenk
1852ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1853ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1854ecb0ccd9SWolfgang Denk
185528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1856ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
185728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1858ecb0ccd9SWolfgang Denk		number generator is used.
1859ecb0ccd9SWolfgang Denk
186028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
186128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
186228cb9375SWolfgang Denk		defined, the normal port 69 is used.
186328cb9375SWolfgang Denk
186428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1865ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1866ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1867ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1868ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1869ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1870ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1871ecb0ccd9SWolfgang Denk
1872a8c7c708Swdenk- Show boot progress:
1873c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1874c609719bSwdenk
1875c609719bSwdenk		Defining this option allows to add some board-
1876c609719bSwdenk		specific code (calling a user-provided function
1877c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1878c609719bSwdenk		the system's boot progress on some display (for
1879c609719bSwdenk		example, some LED's) on your board. At the moment,
1880c609719bSwdenk		the following checkpoints are implemented:
1881c609719bSwdenk
18824bae9090SBartlomiej Sieka- Automatic software updates via TFTP server
18834bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP
18844bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_CNT_MAX
18854bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_MSEC_MAX
18864bae9090SBartlomiej Sieka
18874bae9090SBartlomiej Sieka		These options enable and control the auto-update feature;
18884bae9090SBartlomiej Sieka		for a more detailed description refer to doc/README.update.
18894bae9090SBartlomiej Sieka
1890d558107cSStefan Roese- MTD Support (mtdparts command, UBI support)
1891d558107cSStefan Roese		CONFIG_MTD_DEVICE
1892d558107cSStefan Roese
1893d558107cSStefan Roese		Adds the MTD device infrastructure from the Linux kernel.
1894d558107cSStefan Roese		Needed for mtdparts command support.
1895d558107cSStefan Roese
1896d558107cSStefan Roese		CONFIG_MTD_PARTITIONS
1897d558107cSStefan Roese
1898d558107cSStefan Roese		Adds the MTD partitioning infrastructure from the Linux
1899d558107cSStefan Roese		kernel. Needed for UBI support.
1900d558107cSStefan Roese
19011372cce2SMarian BalakowiczLegacy uImage format:
19021372cce2SMarian Balakowicz
1903c609719bSwdenk  Arg	Where			When
1904c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1905c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1906c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1907c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1908c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1909c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1910c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1911c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1912c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
19131372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1914c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1915c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1916c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1917c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
19181372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1919c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
19201372cce2SMarian Balakowicz
19211372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
19221372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
19231372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
19241372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
19251372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
19261372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
19271372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
192811ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
19291372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
19301372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
19311372cce2SMarian Balakowicz
19321372cce2SMarian Balakowicz   15	lib_<arch>/bootm.c	All preparation done, transferring control to OS
1933c609719bSwdenk
193463e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
193563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
193663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
193763e73c9aSwdenk
1938566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1939566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1940566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1941566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1942566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1943566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1944566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1945566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1946566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1947566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1948566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1949566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1950566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1951566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1952566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1953566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1954566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1955566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1956566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1957566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1958566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1959566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1960566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1961566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1962566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1963566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1964566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1965566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1966566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1967566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1968566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1969566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1970566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1971566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1972566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1973566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1974566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1975566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1976566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1977566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1978566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1979566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1980566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1981566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1982566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1983566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1984566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1985c609719bSwdenk
1986566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1987c609719bSwdenk
1988566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
1989566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
1990566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
1991206c60cbSwdenk
1992566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
1993566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
199411ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
1995566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
1996566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
1997566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
199874de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
199974de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2000566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2001c609719bSwdenk
20021372cce2SMarian BalakowiczFIT uImage format:
20031372cce2SMarian Balakowicz
20041372cce2SMarian Balakowicz  Arg	Where			When
20051372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
20061372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
20071372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
20081372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
20091372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
20101372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2011f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
20121372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
20131372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
20141372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
20151372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
20161372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
201711ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
201811ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
20191372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
20201372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
20211372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
20221372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
20231372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
20241372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
20251372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
20261372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
20271372cce2SMarian Balakowicz
20281372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
20291372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
20301372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
203111ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
20321372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
20331372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
20341372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
20351372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
20361372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
20371372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
20381372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
20391372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
20401372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
20411372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
20421372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
20431372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
20441372cce2SMarian Balakowicz
204511ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
20461372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
20471372cce2SMarian Balakowicz
204811ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
20491372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
20501372cce2SMarian Balakowicz
205111ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
20521372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
20531372cce2SMarian Balakowicz
20541372cce2SMarian Balakowicz
2055c609719bSwdenkModem Support:
2056c609719bSwdenk--------------
2057c609719bSwdenk
205885ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
2059c609719bSwdenk
206011ccc33fSMarcel Ziswiler- Modem support enable:
2061c609719bSwdenk		CONFIG_MODEM_SUPPORT
2062c609719bSwdenk
2063c609719bSwdenk- RTS/CTS Flow control enable:
2064c609719bSwdenk		CONFIG_HWFLOW
2065c609719bSwdenk
2066c609719bSwdenk- Modem debug support:
2067c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2068c609719bSwdenk
2069c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2070c609719bSwdenk		for modem support. Useful only with BDI2000.
2071c609719bSwdenk
2072a8c7c708Swdenk- Interrupt support (PPC):
2073a8c7c708Swdenk
2074a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2075a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
207611ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2077a8c7c708Swdenk		should set decrementer_count to appropriate value. If
207811ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2079a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
208011ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2081a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2082a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2083a8c7c708Swdenk		general timer_interrupt().
2084a8c7c708Swdenk
2085c609719bSwdenk- General:
2086c609719bSwdenk
2087c609719bSwdenk		In the target system modem support is enabled when a
2088c609719bSwdenk		specific key (key combination) is pressed during
2089c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
209011ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2091c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2092c609719bSwdenk		function, returning 1 and thus enabling modem
2093c609719bSwdenk		initialization.
2094c609719bSwdenk
2095c609719bSwdenk		If there are no modem init strings in the
2096c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2097c609719bSwdenk		previous output (banner, info printfs) will be
209811ccc33fSMarcel Ziswiler		suppressed, though.
2099c609719bSwdenk
2100c609719bSwdenk		See also: doc/README.Modem
2101c609719bSwdenk
2102c609719bSwdenk
2103c609719bSwdenkConfiguration Settings:
2104c609719bSwdenk-----------------------
2105c609719bSwdenk
21066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2107c609719bSwdenk		undefine this when you're short of memory.
2108c609719bSwdenk
21092fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
21102fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
21112fb2604dSPeter Tyser
21126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2113c609719bSwdenk		prompt for user input.
2114c609719bSwdenk
21156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2116c609719bSwdenk
21176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2118c609719bSwdenk
21196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2120c609719bSwdenk
21216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2122c609719bSwdenk		the application (usually a Linux kernel) when it is
2123c609719bSwdenk		booted
2124c609719bSwdenk
21256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2126c609719bSwdenk		List of legal baudrate settings for this board.
2127c609719bSwdenk
21286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2129c609719bSwdenk		Suppress display of console information at boot.
2130c609719bSwdenk
21316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2132c609719bSwdenk		If the board specific function
2133c609719bSwdenk			extern int overwrite_console (void);
2134c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2135c609719bSwdenk		serial port, else the settings in the environment are used.
2136c609719bSwdenk
21376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2138c609719bSwdenk		Enable the call to overwrite_console().
2139c609719bSwdenk
21406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2141c609719bSwdenk		Enable overwrite of previous console environment settings.
2142c609719bSwdenk
21436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2144c609719bSwdenk		Begin and End addresses of the area used by the
2145c609719bSwdenk		simple memory test.
2146c609719bSwdenk
21476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2148c609719bSwdenk		Enable an alternate, more extensive memory test.
2149c609719bSwdenk
21506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
21515f535fe1Swdenk		Scratch address used by the alternate memory test
21525f535fe1Swdenk		You only need to set this if address zero isn't writeable
21535f535fe1Swdenk
21546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
21556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
215614f73ca6SStefan Roese		this specified memory area will get subtracted from the top
215711ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
215814f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
215914f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
216014f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
21615e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
216214f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
21635e12e75dSStefan Roese		will have to get fixed in Linux additionally.
216414f73ca6SStefan Roese
216514f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
216614f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
216714f73ca6SStefan Roese		be touched.
216814f73ca6SStefan Roese
216914f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
217014f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
217114f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
217214f73ca6SStefan Roese		non page size aligned address and this could cause major
217314f73ca6SStefan Roese		problems.
217414f73ca6SStefan Roese
21756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2176c609719bSwdenk		Default load address for network file downloads
2177c609719bSwdenk
21786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2179c609719bSwdenk		Enable temporary baudrate change while serial download
2180c609719bSwdenk
21816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2182c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2183c609719bSwdenk
21846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2185c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2186c609719bSwdenk		Cogent motherboard)
2187c609719bSwdenk
21886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2189c609719bSwdenk		Physical start address of Flash memory.
2190c609719bSwdenk
21916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2192c609719bSwdenk		Physical start address of boot monitor code (set by
2193c609719bSwdenk		make config files to be same as the text base address
2194c609719bSwdenk		(TEXT_BASE) used when linking) - same as
21956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2196c609719bSwdenk
21976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
21983b57fe0aSwdenk		Size of memory reserved for monitor code, used to
21993b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
22003b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
22013b57fe0aSwdenk		flash sector.
2202c609719bSwdenk
22036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2204c609719bSwdenk		Size of DRAM reserved for malloc() use.
2205c609719bSwdenk
22066d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
220715940c9aSStefan Roese		Normally compressed uImages are limited to an
220815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
22096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
221015940c9aSStefan Roese		to adjust this setting to your needs.
2211c609719bSwdenk
22126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2213c609719bSwdenk		Maximum size of memory mapped by the startup code of
2214c609719bSwdenk		the Linux kernel; all data that must be processed by
22157d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
22167d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
22177d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
22187d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
22196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2220c609719bSwdenk
22216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2222c609719bSwdenk		Max number of Flash memory banks
2223c609719bSwdenk
22246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2225c609719bSwdenk		Max number of sectors on a Flash chip
2226c609719bSwdenk
22276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2228c609719bSwdenk		Timeout for Flash erase operations (in ms)
2229c609719bSwdenk
22306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2231c609719bSwdenk		Timeout for Flash write operations (in ms)
2232c609719bSwdenk
22336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
22348564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
22358564acf9Swdenk
22366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
22378564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
22388564acf9Swdenk
22396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
22408564acf9Swdenk		If defined, hardware flash sectors protection is used
22418564acf9Swdenk		instead of U-Boot software protection.
22428564acf9Swdenk
22436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2244c609719bSwdenk
2245c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2246c609719bSwdenk		without this option such a download has to be
2247c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2248c609719bSwdenk		copy from RAM to flash.
2249c609719bSwdenk
2250c609719bSwdenk		The two-step approach is usually more reliable, since
2251c609719bSwdenk		you can check if the download worked before you erase
225211ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
225311ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2254c609719bSwdenk		downloaded image) this option may be very useful.
2255c609719bSwdenk
22566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2257c609719bSwdenk		Define if the flash driver uses extra elements in the
22585653fc33Swdenk		common flash structure for storing flash geometry.
22595653fc33Swdenk
226000b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
22615653fc33Swdenk		This option also enables the building of the cfi_flash driver
22625653fc33Swdenk		in the drivers directory
226353cf9435Sstroese
226491809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
226591809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
226691809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
226791809ed5SPiotr Ziecik		to the MTD layer.
226891809ed5SPiotr Ziecik
22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
227096ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
227196ef831fSGuennadi Liakhovetski
227296ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
227396ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
227496ef831fSGuennadi Liakhovetski		write commands.
227596ef831fSGuennadi Liakhovetski
22766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
22775568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
22785568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
22795568e613SStefan Roese		is useful, if some of the configured banks are only
22805568e613SStefan Roese		optionally available.
22815568e613SStefan Roese
22829a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
22839a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
22849a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
22859a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
22869a042e9cSJerry Van Baren
22876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
228811ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
228911ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
229053cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
229153cf9435Sstroese		buffers can be full shortly after enabling the interface
229211ccc33fSMarcel Ziswiler		on high Ethernet traffic.
229353cf9435Sstroese		Defaults to 4 if not defined.
2294c609719bSwdenk
2295c609719bSwdenkThe following definitions that deal with the placement and management
2296c609719bSwdenkof environment data (variable area); in general, we support the
2297c609719bSwdenkfollowing configurations:
2298c609719bSwdenk
22995a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2300c609719bSwdenk
2301c609719bSwdenk	Define this if the environment is in flash memory.
2302c609719bSwdenk
2303c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2304c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2305c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2306c609719bSwdenk	   sector" type flash chips, which have several smaller
2307c609719bSwdenk	   sectors at the start or the end. For instance, such a
2308c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2309c609719bSwdenk	   such a case you would place the environment in one of the
2310c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2311c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2312c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2313c609719bSwdenk	   between U-Boot and the environment.
2314c609719bSwdenk
23150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2316c609719bSwdenk
2317c609719bSwdenk	   Offset of environment data (variable area) to the
2318c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2319c609719bSwdenk	   type flash chips the second sector can be used: the offset
2320c609719bSwdenk	   for this sector is given here.
2321c609719bSwdenk
23226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2323c609719bSwdenk
23240e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2325c609719bSwdenk
2326c609719bSwdenk	   This is just another way to specify the start address of
2327c609719bSwdenk	   the flash sector containing the environment (instead of
23280e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2329c609719bSwdenk
23300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2331c609719bSwdenk
2332c609719bSwdenk	   Size of the sector containing the environment.
2333c609719bSwdenk
2334c609719bSwdenk
2335c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2336c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2337c609719bSwdenk	   the environment.
2338c609719bSwdenk
23390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2340c609719bSwdenk
23415a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
23420e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2343c609719bSwdenk	   of this flash sector for the environment. This saves
2344c609719bSwdenk	   memory for the RAM copy of the environment.
2345c609719bSwdenk
2346c609719bSwdenk	   It may also save flash memory if you decide to use this
2347c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2348c609719bSwdenk	   since then the remainder of the flash sector could be used
2349c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2350c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2351c609719bSwdenk	   updating the environment in flash makes it always
2352c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2353c609719bSwdenk	   wrong before the contents has been restored from a copy in
2354c609719bSwdenk	   RAM, your target system will be dead.
2355c609719bSwdenk
23560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
23570e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2358c609719bSwdenk
2359c609719bSwdenk	   These settings describe a second storage area used to hold
236011ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
23613e38691eSwdenk	   a valid backup copy in case there is a power failure during
2362c609719bSwdenk	   a "saveenv" operation.
2363c609719bSwdenk
2364c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2365c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2366c609719bSwdenkaccordingly!
2367c609719bSwdenk
2368c609719bSwdenk
23699314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2370c609719bSwdenk
2371c609719bSwdenk	Define this if you have some non-volatile memory device
2372c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2373c609719bSwdenk	environment.
2374c609719bSwdenk
23750e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
23760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2377c609719bSwdenk
237811ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2379c609719bSwdenk	  want to use for environment. It is assumed that this memory
2380c609719bSwdenk	  can just be read and written to, without any special
2381c609719bSwdenk	  provision.
2382c609719bSwdenk
2383c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2384c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
238511ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2386c609719bSwdenkU-Boot will hang.
2387c609719bSwdenk
2388c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2389c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2390c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2391c609719bSwdenkto save the current settings.
2392c609719bSwdenk
2393c609719bSwdenk
2394bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2395c609719bSwdenk
2396c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2397c609719bSwdenk	device and a driver for it.
2398c609719bSwdenk
23990e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24000e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2401c609719bSwdenk
2402c609719bSwdenk	  These two #defines specify the offset and size of the
2403c609719bSwdenk	  environment area within the total memory of your EEPROM.
2404c609719bSwdenk
24056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2406c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2407c609719bSwdenk	  The default address is zero.
2408c609719bSwdenk
24096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2410c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2411c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2412c609719bSwdenk	  would require six bits.
2413c609719bSwdenk
24146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2415c609719bSwdenk	  If defined, the number of milliseconds to delay between
2416c609719bSwdenk	  page writes.	The default is zero milliseconds.
2417c609719bSwdenk
24186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2419c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2420c609719bSwdenk	  that this is NOT the chip address length!
2421c609719bSwdenk
24226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
24235cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
24245cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
24255cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
24265cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
24275cf91d6bSwdenk	  byte chips.
24285cf91d6bSwdenk
24295cf91d6bSwdenk	  Note that we consider the length of the address field to
24305cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
24315cf91d6bSwdenk	  in the chip address.
24325cf91d6bSwdenk
24336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2434c609719bSwdenk	  The size in bytes of the EEPROM device.
2435c609719bSwdenk
2436c609719bSwdenk
2437057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
24385779d8d9Swdenk
24395779d8d9Swdenk	Define this if you have a DataFlash memory device which you
24405779d8d9Swdenk	want to use for the environment.
24415779d8d9Swdenk
24420e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24430e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
24440e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
24455779d8d9Swdenk
24465779d8d9Swdenk	  These three #defines specify the offset and size of the
24475779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
24485779d8d9Swdenk	  at the specified address.
24495779d8d9Swdenk
245051bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
245113a5695bSwdenk
245213a5695bSwdenk	Define this if you have a NAND device which you want to use
245313a5695bSwdenk	for the environment.
245413a5695bSwdenk
24550e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
24560e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
245713a5695bSwdenk
245813a5695bSwdenk	  These two #defines specify the offset and size of the environment
245913a5695bSwdenk	  area within the first NAND device.
24605779d8d9Swdenk
24610e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2462e443c944SMarkus Klotzbuecher
24630e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2464e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2465e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2466e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2467e443c944SMarkus Klotzbuecher
24680e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
24690e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2470e443c944SMarkus Klotzbuecher	the NAND devices block size.
2471e443c944SMarkus Klotzbuecher
2472b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
2473b74ab737SGuennadi Liakhovetski
2474b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
2475b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
2476b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
2477b74ab737SGuennadi Liakhovetski
24786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2479c609719bSwdenk
2480c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2481c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2482c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2483c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2484c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2485c609719bSwdenk	to be a good choice since it makes it far enough from the
2486c609719bSwdenk	start of the data area as well as from the stack pointer.
2487c609719bSwdenk
2488e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2489c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2490c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2491c609719bSwdenkuntil then to read environment variables.
2492c609719bSwdenk
249385ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
249485ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
249585ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
249685ec0bccSwdenknecessary, because the first environment variable we need is the
249785ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
249885ec0bccSwdenkhave any device yet where we could complain.]
2499c609719bSwdenk
2500c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2501c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
250285ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2503c609719bSwdenk
25046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2505fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2506fc3e2165Swdenk
25076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2508fc3e2165Swdenk		      also needs to be defined.
2509fc3e2165Swdenk
25106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2511fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2512c609719bSwdenk
25136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_VSPRINTF:
2514c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2515c40b2956Swdenk		of 64bit values by using the L quantifier
2516c40b2956Swdenk
25176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_STRTOUL:
2518c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2519c40b2956Swdenk
2520f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
2521f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
2522f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
2523f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
2524f5675aa5SRon Madrid		space for already greatly restricted images, including but not
2525f5675aa5SRon Madrid		limited to NAND_SPL configurations.
2526f5675aa5SRon Madrid
2527c609719bSwdenkLow Level (hardware related) configuration options:
2528dc7c9a1aSwdenk---------------------------------------------------
2529c609719bSwdenk
25306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2531c609719bSwdenk		Cache Line Size of the CPU.
2532c609719bSwdenk
25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2534c609719bSwdenk		Default address of the IMMR after system reset.
25352535d602Swdenk
25362535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
25372535d602Swdenk		and RPXsuper) to be able to adjust the position of
25382535d602Swdenk		the IMMR register after a reset.
2539c609719bSwdenk
25407f6c2cbcSwdenk- Floppy Disk Support:
25416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
25427f6c2cbcSwdenk
25437f6c2cbcSwdenk		the default drive number (default value 0)
25447f6c2cbcSwdenk
25456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
25467f6c2cbcSwdenk
254711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
25487f6c2cbcSwdenk		(default value 1)
25497f6c2cbcSwdenk
25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
25517f6c2cbcSwdenk
25527f6c2cbcSwdenk		defines the offset of register from address. It
25537f6c2cbcSwdenk		depends on which part of the data bus is connected to
255411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
25557f6c2cbcSwdenk
25566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
25576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
25587f6c2cbcSwdenk		default value.
25597f6c2cbcSwdenk
25606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
25617f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
25627f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
25637f6c2cbcSwdenk		source code. It is used to make hardware dependant
25647f6c2cbcSwdenk		initializations.
25657f6c2cbcSwdenk
25666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
256725d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
256825d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2569c609719bSwdenk
25706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2571c609719bSwdenk
25727152b1d0Swdenk		Start address of memory area that can be used for
2573c609719bSwdenk		initial data and stack; please note that this must be
2574c609719bSwdenk		writable memory that is working WITHOUT special
2575c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2576c609719bSwdenk		will become available only after programming the
2577c609719bSwdenk		memory controller and running certain initialization
2578c609719bSwdenk		sequences.
2579c609719bSwdenk
2580c609719bSwdenk		U-Boot uses the following memory types:
2581c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2582c609719bSwdenk		- MPC824X: data cache
2583c609719bSwdenk		- PPC4xx:  data cache
2584c609719bSwdenk
25856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2586c609719bSwdenk
2587c609719bSwdenk		Offset of the initial data structure in the memory
25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
25896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2590c609719bSwdenk		data is located at the end of the available space
25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
25936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2595c609719bSwdenk
2596c609719bSwdenk	Note:
2597c609719bSwdenk		On the MPC824X (or other systems that use the data
2598c609719bSwdenk		cache for initial memory) the address chosen for
25996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2600c609719bSwdenk		point to an otherwise UNUSED address space between
2601c609719bSwdenk		the top of RAM and the start of the PCI space.
2602c609719bSwdenk
26036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2604c609719bSwdenk
26056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2606c609719bSwdenk
26076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2608c609719bSwdenk
26096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2610c609719bSwdenk
26116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2612c609719bSwdenk
26136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2614c609719bSwdenk
26156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2616c609719bSwdenk		SDRAM timing
2617c609719bSwdenk
26186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2619c609719bSwdenk		periodic timer for refresh
2620c609719bSwdenk
26216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2622c609719bSwdenk
26236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
26246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
26256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
26266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2627c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2628c609719bSwdenk
2629c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
26306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
26316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2632c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2633c609719bSwdenk
26346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
26356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2636c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2637c609719bSwdenk		Prescaler definitions (SDRAM timing)
2638c609719bSwdenk
26396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2640c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2641c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2642c609719bSwdenk
26436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2644b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2645b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2646b423d055SHeiko Schocher
26476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2648c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2649c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2650c609719bSwdenk
26516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2652c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2653c609719bSwdenk		wrong setting might damage your board. Read
2654c609719bSwdenk		doc/README.MBX before setting this variable!
2655c609719bSwdenk
26566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2657ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2658ea909b76Swdenk		(Power On Self Tests). This definition overrides
2659ea909b76Swdenk		#define'd default value in commproc.h resp.
2660ea909b76Swdenk		cpm_8260.h.
2661ea909b76Swdenk
26626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
26636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
26646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
26656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
26666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
26676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
26686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
26696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
26705d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
26715d232d0eSwdenk
26729cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
26739cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
26749cacf4fcSDirk Eibach		required.
26759cacf4fcSDirk Eibach
2676bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2677218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2678218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2679218ca724SWolfgang Denk
2680bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2681bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2682bb99ad6dSBen Warren
26836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2684218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2685218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2686218ca724SWolfgang Denk		to something your driver can deal with.
2687bb99ad6dSBen Warren
26886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2689218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2690218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
26912ad6b513STimur Tabi
2692c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2693c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2694c26e454dSwdenk
2695c26e454dSwdenk- CONFIG_FEC[12]_PHY
2696c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
26976e592385Swdenk		to the given FEC; i. e.
2698c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2699c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2700c26e454dSwdenk
2701c26e454dSwdenk		When set to -1, means to probe for first available.
2702c26e454dSwdenk
2703c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2704c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2705c26e454dSwdenk		(so program the FEC to ignore it).
2706c26e454dSwdenk
2707c26e454dSwdenk- CONFIG_RMII
2708c26e454dSwdenk		Enable RMII mode for all FECs.
2709c26e454dSwdenk		Note that this is a global option, we can't
2710c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2711c26e454dSwdenk
27125cf91d6bSwdenk- CONFIG_CRC32_VERIFY
27135cf91d6bSwdenk		Add a verify option to the crc32 command.
27145cf91d6bSwdenk		The syntax is:
27155cf91d6bSwdenk
27165cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
27175cf91d6bSwdenk
27185cf91d6bSwdenk		Where address/count indicate a memory area
27195cf91d6bSwdenk		and crc32 is the correct crc32 which the
27205cf91d6bSwdenk		area should have.
27215cf91d6bSwdenk
272256523f12Swdenk- CONFIG_LOOPW
272356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2724602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
272556523f12Swdenk
27267b466641Sstroese- CONFIG_MX_CYCLIC
27277b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
27287b466641Sstroese		"md/mw" commands.
27297b466641Sstroese		Examples:
27307b466641Sstroese
27317b466641Sstroese		=> mdc.b 10 4 500
27327b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
27337b466641Sstroese
27347b466641Sstroese		=> mwc.l 100 12345678 10
27357b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
27367b466641Sstroese
27377b466641Sstroese		This only takes effect if the memory commands are activated
2738602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
27397b466641Sstroese
27408aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
27418aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
27428aa1a2d1Swdenk
27438aa1a2d1Swdenk		[ARM only] If these variables are defined, then
27448aa1a2d1Swdenk		certain low level initializations (like setting up
27458aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
27468aa1a2d1Swdenk		not relocate itself into RAM.
27478aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
27488aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
27498aa1a2d1Swdenk		some other boot loader or by a debugger which
275011ccc33fSMarcel Ziswiler		performs these initializations itself.
27518aa1a2d1Swdenk
2752df81238bSMagnus Lilja- CONFIG_PRELOADER
2753df81238bSMagnus Lilja
2754df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
2755df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
2756df81238bSMagnus Lilja		compiling a NAND SPL.
2757400558b5Swdenk
2758c609719bSwdenkBuilding the Software:
2759c609719bSwdenk======================
2760c609719bSwdenk
2761218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2762218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2763218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2764218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2765218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2766218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2767c609719bSwdenk
2768218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2769218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2770218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2771218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2772218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2773c609719bSwdenk
2774218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2775218ca724SWolfgang Denk	$ export CROSS_COMPILE
2776c609719bSwdenk
27772f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
27782f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
27792f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
27802f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
27812f8d396bSPeter Tyser
27822f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
27832f8d396bSPeter Tyser
27842f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
27852f8d396bSPeter Tyser      be executed on computers running Windows.
27862f8d396bSPeter Tyser
2787c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2788c609719bSwdenksources you must configure U-Boot for one specific board type. This
2789c609719bSwdenkis done by typing:
2790c609719bSwdenk
2791c609719bSwdenk	make NAME_config
2792c609719bSwdenk
2793218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2794218ca724SWolfgang Denkrations; see the main Makefile for supported names.
279554387ac9Swdenk
2796c609719bSwdenkNote: for some board special configuration names may exist; check if
2797c609719bSwdenk      additional information is available from the board vendor; for
27982729af9dSwdenk      instance, the TQM823L systems are available without (standard)
27992729af9dSwdenk      or with LCD support. You can select such additional "features"
280011ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2801c609719bSwdenk
28022729af9dSwdenk      make TQM823L_config
28032729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2804c609719bSwdenk
2805c609719bSwdenk      make TQM823L_LCD_config
2806c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2807c609719bSwdenk
2808c609719bSwdenk      etc.
2809c609719bSwdenk
2810c609719bSwdenk
2811c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
28127152b1d0Swdenkimages ready for download to / installation on your system:
2813c609719bSwdenk
2814c609719bSwdenk- "u-boot.bin" is a raw binary image
2815c609719bSwdenk- "u-boot" is an image in ELF binary format
2816c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2817c609719bSwdenk
2818baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2819baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2820baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2821baf31249SMarian Balakowicz
2822baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2823baf31249SMarian Balakowicz
2824baf31249SMarian Balakowicz	make O=/tmp/build distclean
2825baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2826baf31249SMarian Balakowicz	make O=/tmp/build all
2827baf31249SMarian Balakowicz
2828baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2829baf31249SMarian Balakowicz
2830baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2831baf31249SMarian Balakowicz	make distclean
2832baf31249SMarian Balakowicz	make NAME_config
2833baf31249SMarian Balakowicz	make all
2834baf31249SMarian Balakowicz
2835baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2836baf31249SMarian Balakowiczvariable.
2837baf31249SMarian Balakowicz
2838c609719bSwdenk
2839c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2840c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2841c609719bSwdenknative "make".
2842c609719bSwdenk
2843c609719bSwdenk
2844c609719bSwdenkIf the system board that you have is not listed, then you will need
2845c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2846c609719bSwdenksteps:
2847c609719bSwdenk
2848c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
284985ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
285085ec0bccSwdenk    entries as examples. Note that here and at many other places
28517152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
285285ec0bccSwdenk    keep this order.
2853c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
285485ec0bccSwdenk    files you need. In your board directory, you will need at least
285585ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
285685ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
285785ec0bccSwdenk    your board
2858c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2859c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
286085ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2861c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2862c609719bSwdenk    to be installed on your target system.
286385ec0bccSwdenk6.  Debug and solve any problems that might arise.
2864c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2865c609719bSwdenk
2866c609719bSwdenk
2867c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2868c609719bSwdenk==============================================================
2869c609719bSwdenk
2870c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2871c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2872c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2873c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2874218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2875c609719bSwdenk
2876c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2877c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2878c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2879c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2880c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
28817152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2882218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2883218ca724SWolfgang Denkyou can type
2884c609719bSwdenk
2885c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2886c609719bSwdenk
2887c609719bSwdenkor to build on a native PowerPC system you can type
2888c609719bSwdenk
2889c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2890c609719bSwdenk
2891218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2892218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2893218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2894218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2895218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2896218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2897218ca724SWolfgang Denkvariable. For example:
2898baf31249SMarian Balakowicz
2899baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2900baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2901baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2902baf31249SMarian Balakowicz
2903218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2904218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2905218ca724SWolfgang Denkduring the whole build process.
2906baf31249SMarian Balakowicz
2907baf31249SMarian Balakowicz
2908c609719bSwdenkSee also "U-Boot Porting Guide" below.
2909c609719bSwdenk
2910c609719bSwdenk
2911c609719bSwdenkMonitor Commands - Overview:
2912c609719bSwdenk============================
2913c609719bSwdenk
2914c609719bSwdenkgo	- start application at address 'addr'
2915c609719bSwdenkrun	- run commands in an environment variable
2916c609719bSwdenkbootm	- boot application image from memory
2917c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2918c609719bSwdenktftpboot- boot image via network using TFTP protocol
2919c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2920c609719bSwdenk	       (and eventually "gatewayip")
2921c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2922c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2923c609719bSwdenkloads	- load S-Record file over serial line
2924c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2925c609719bSwdenkmd	- memory display
2926c609719bSwdenkmm	- memory modify (auto-incrementing)
2927c609719bSwdenknm	- memory modify (constant address)
2928c609719bSwdenkmw	- memory write (fill)
2929c609719bSwdenkcp	- memory copy
2930c609719bSwdenkcmp	- memory compare
2931c609719bSwdenkcrc32	- checksum calculation
29320f89c54bSPeter Tyseri2c	- I2C sub-system
2933c609719bSwdenksspi	- SPI utility commands
2934c609719bSwdenkbase	- print or set address offset
2935c609719bSwdenkprintenv- print environment variables
2936c609719bSwdenksetenv	- set environment variables
2937c609719bSwdenksaveenv - save environment variables to persistent storage
2938c609719bSwdenkprotect - enable or disable FLASH write protection
2939c609719bSwdenkerase	- erase FLASH memory
2940c609719bSwdenkflinfo	- print FLASH memory information
2941c609719bSwdenkbdinfo	- print Board Info structure
2942c609719bSwdenkiminfo	- print header information for application image
2943c609719bSwdenkconinfo - print console devices and informations
2944c609719bSwdenkide	- IDE sub-system
2945c609719bSwdenkloop	- infinite loop on address range
294656523f12Swdenkloopw	- infinite write loop on address range
2947c609719bSwdenkmtest	- simple RAM test
2948c609719bSwdenkicache	- enable or disable instruction cache
2949c609719bSwdenkdcache	- enable or disable data cache
2950c609719bSwdenkreset	- Perform RESET of the CPU
2951c609719bSwdenkecho	- echo args to console
2952c609719bSwdenkversion - print monitor version
2953c609719bSwdenkhelp	- print online help
2954c609719bSwdenk?	- alias for 'help'
2955c609719bSwdenk
2956c609719bSwdenk
2957c609719bSwdenkMonitor Commands - Detailed Description:
2958c609719bSwdenk========================================
2959c609719bSwdenk
2960c609719bSwdenkTODO.
2961c609719bSwdenk
2962c609719bSwdenkFor now: just type "help <command>".
2963c609719bSwdenk
2964c609719bSwdenk
2965c609719bSwdenkEnvironment Variables:
2966c609719bSwdenk======================
2967c609719bSwdenk
2968c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2969c609719bSwdenkcan be made persistent by saving to Flash memory.
2970c609719bSwdenk
2971c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2972c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2973c609719bSwdenkwithout a value can be used to delete a variable from the
2974c609719bSwdenkenvironment. As long as you don't save the environment you are
2975c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2976c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2977c609719bSwdenk
2978c609719bSwdenkSome configuration options can be set using Environment Variables:
2979c609719bSwdenk
2980c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2981c609719bSwdenk
2982c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2983c609719bSwdenk
2984c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2985c609719bSwdenk
2986c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2987c609719bSwdenk
2988c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2989c609719bSwdenk
29907d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
29917d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
29927d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
29937d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
29947d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
29957d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
29966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
29977d721e34SBartlomiej Sieka
29987d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
29997d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
30007d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
30017d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
30027d721e34SBartlomiej Sieka		  environment variable.
30037d721e34SBartlomiej Sieka
30044bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
30054bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
30064bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
30074bae9090SBartlomiej Sieka
3008c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
3009c609719bSwdenk		  "bootp" will just load perform a lookup of the
3010c609719bSwdenk		  configuration from the BOOTP server, but not try to
3011c609719bSwdenk		  load any image using TFTP
3012c609719bSwdenk
30133310c549SMarian Balakowicz  autoscript	- if set to "yes" commands like "loadb", "loady",
30143310c549SMarian Balakowicz		  "bootp", "tftpb", "rarpboot" and "nfs" will attempt
30153310c549SMarian Balakowicz		  to automatically run script images (by internally
301674de7aefSWolfgang Denk		  calling "source").
30173310c549SMarian Balakowicz
30183310c549SMarian Balakowicz  autoscript_uname - if script image is in a format (FIT) this
30193310c549SMarian Balakowicz		     variable is used to get script subimage unit name.
30203310c549SMarian Balakowicz
3021c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
3022c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
3023c609719bSwdenk		  be automatically started (by internally calling
3024c609719bSwdenk		  "bootm")
3025c609719bSwdenk
30264a6fd34bSwdenk		  If set to "no", a standalone image passed to the
30274a6fd34bSwdenk		  "bootm" command will be copied to the load address
30284a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
30294a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
30304a6fd34bSwdenk		  data.
30314a6fd34bSwdenk
303217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
303317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
303417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
303517ea1177Swdenk		  initialization code. So, for changes to be effective
303617ea1177Swdenk		  it must be saved and board must be reset.
303717ea1177Swdenk
3038c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
3039c609719bSwdenk		  If this variable is not set, initrd images will be
3040c609719bSwdenk		  copied to the highest possible address in RAM; this
3041c609719bSwdenk		  is usually what you want since it allows for
3042c609719bSwdenk		  maximum initrd size. If for some reason you want to
3043c609719bSwdenk		  make sure that the initrd image is loaded below the
30446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
3045c609719bSwdenk		  variable to a value of "no" or "off" or "0".
3046c609719bSwdenk		  Alternatively, you can set it to a maximum upper
3047c609719bSwdenk		  address to use (U-Boot will still check that it
3048c609719bSwdenk		  does not overwrite the U-Boot stack and data).
3049c609719bSwdenk
3050c609719bSwdenk		  For instance, when you have a system with 16 MB
30517152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
3052c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
3053c609719bSwdenk		  the "bootargs" variable. However, now you must make
30547152b1d0Swdenk		  sure that the initrd image is placed in the first
3055c609719bSwdenk		  12 MB as well - this can be done with
3056c609719bSwdenk
3057c609719bSwdenk		  setenv initrd_high 00c00000
3058c609719bSwdenk
305938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
306038b99261Swdenk		  indication to U-Boot that all addresses are legal
306138b99261Swdenk		  for the Linux kernel, including addresses in flash
306238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
306338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
306438b99261Swdenk		  boot time on your system, but requires that this
306538b99261Swdenk		  feature is supported by your Linux kernel.
306638b99261Swdenk
3067c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
3068c609719bSwdenk
3069c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
3070dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
3071c609719bSwdenk
3072c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
3073c609719bSwdenk
3074c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
3075c609719bSwdenk
3076c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
3077c609719bSwdenk
3078c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3079c609719bSwdenk
3080c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
3081c609719bSwdenk
3082a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3083a3d991bdSwdenk		  interface is used first.
3084a3d991bdSwdenk
3085a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3086a3d991bdSwdenk		  interface is currently active. For example you
3087a3d991bdSwdenk		  can do the following
3088a3d991bdSwdenk
3089a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3090a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3091a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3092a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3093a3d991bdSwdenk
3094e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3095e1692577SMatthias Fuchs		  available network interfaces.
3096e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3097e1692577SMatthias Fuchs
3098a3d991bdSwdenk   netretry	- When set to "no" each network operation will
3099a3d991bdSwdenk		  either succeed or fail without retrying.
31006e592385Swdenk		  When set to "once" the network operation will
31016e592385Swdenk		  fail when all the available network interfaces
31026e592385Swdenk		  are tried once without success.
3103a3d991bdSwdenk		  Useful on scripts which control the retry operation
3104a3d991bdSwdenk		  themselves.
3105a3d991bdSwdenk
3106b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
3107a1cf027aSJean-Christophe PLAGNIOL-VILLARD
310828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3109ecb0ccd9SWolfgang Denk		  UDP source port.
3110ecb0ccd9SWolfgang Denk
311128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
311228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
311328cb9375SWolfgang Denk
3114a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
311511ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3116a3d991bdSwdenk		  VLAN tagged frames.
3117c609719bSwdenk
3118c609719bSwdenkThe following environment variables may be used and automatically
3119c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3120c609719bSwdenkdepending the information provided by your boot server:
3121c609719bSwdenk
3122c609719bSwdenk  bootfile	- see above
3123c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3124fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3125c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3126c609719bSwdenk  hostname	- Target hostname
3127c609719bSwdenk  ipaddr	- see above
3128c609719bSwdenk  netmask	- Subnet Mask
3129c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3130c609719bSwdenk  serverip	- see above
3131c609719bSwdenk
3132c609719bSwdenk
3133c609719bSwdenkThere are two special Environment Variables:
3134c609719bSwdenk
3135c609719bSwdenk  serial#	- contains hardware identification information such
3136c609719bSwdenk		  as type string and/or serial number
3137c609719bSwdenk  ethaddr	- Ethernet address
3138c609719bSwdenk
3139c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3140c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3141c609719bSwdenkonce they have been set once.
3142c609719bSwdenk
3143c609719bSwdenk
3144c1551ea8SstroeseFurther special Environment Variables:
3145c1551ea8Sstroese
3146c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3147c1551ea8Sstroese		  with the "version" command. This variable is
3148c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3149c1551ea8Sstroese
3150c1551ea8Sstroese
3151c609719bSwdenkPlease note that changes to some configuration parameters may take
3152c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3153c609719bSwdenk
3154c609719bSwdenk
3155f07771ccSwdenkCommand Line Parsing:
3156f07771ccSwdenk=====================
3157f07771ccSwdenk
3158f07771ccSwdenkThere are two different command line parsers available with U-Boot:
31597152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3160f07771ccSwdenk
3161f07771ccSwdenkOld, simple command line parser:
3162f07771ccSwdenk--------------------------------
3163f07771ccSwdenk
3164f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3165f07771ccSwdenk- several commands on one line, separated by ';'
3166fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3167f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3168f07771ccSwdenk  for example:
3169fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3170f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3171f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3172f07771ccSwdenk
3173f07771ccSwdenkHush shell:
3174f07771ccSwdenk-----------
3175f07771ccSwdenk
3176f07771ccSwdenk- similar to Bourne shell, with control structures like
3177f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3178f07771ccSwdenk  until...do...done, ...
3179f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3180f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3181f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3182f07771ccSwdenk  command
3183f07771ccSwdenk
3184f07771ccSwdenkGeneral rules:
3185f07771ccSwdenk--------------
3186f07771ccSwdenk
3187f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3188f07771ccSwdenk    command) contains several commands separated by semicolon, and
3189f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3190f07771ccSwdenk    executed anyway.
3191f07771ccSwdenk
3192f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
319311ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3194f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3195f07771ccSwdenk    variables are not executed.
3196f07771ccSwdenk
3197c609719bSwdenkNote for Redundant Ethernet Interfaces:
3198c609719bSwdenk=======================================
3199c609719bSwdenk
320011ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3201c609719bSwdenksuch configurations and is capable of automatic selection of a
32027152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3203c609719bSwdenk
3204c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3205c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3206c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3207c609719bSwdenk
3208c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3209c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3210c609719bSwdenkding setting in the environment; if the corresponding environment
3211c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3212c609719bSwdenk
3213c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3214c609719bSwdenk  environment, the SROM's address is used.
3215c609719bSwdenk
3216c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3217c609719bSwdenk  environment exists, then the value from the environment variable is
3218c609719bSwdenk  used.
3219c609719bSwdenk
3220c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3221c609719bSwdenk  both addresses are the same, this MAC address is used.
3222c609719bSwdenk
3223c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3224c609719bSwdenk  addresses differ, the value from the environment is used and a
3225c609719bSwdenk  warning is printed.
3226c609719bSwdenk
3227c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3228c609719bSwdenk  is raised.
3229c609719bSwdenk
3230c609719bSwdenk
3231c609719bSwdenkImage Formats:
3232c609719bSwdenk==============
3233c609719bSwdenk
32343310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
32353310c549SMarian Balakowiczimages in two formats:
32363310c549SMarian Balakowicz
32373310c549SMarian BalakowiczNew uImage format (FIT)
32383310c549SMarian Balakowicz-----------------------
32393310c549SMarian Balakowicz
32403310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
32413310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
32423310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
32433310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
32443310c549SMarian Balakowicz
32453310c549SMarian Balakowicz
32463310c549SMarian BalakowiczOld uImage format
32473310c549SMarian Balakowicz-----------------
32483310c549SMarian Balakowicz
32493310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
32503310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
32513310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3252c609719bSwdenk
3253c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3254c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3255f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3256f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3257f5ed9e39SPeter Tyser  INTEGRITY).
32587b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
32593d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
32607b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3261c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3262c609719bSwdenk* Load Address
3263c609719bSwdenk* Entry Point
3264c609719bSwdenk* Image Name
3265c609719bSwdenk* Image Timestamp
3266c609719bSwdenk
3267c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3268c609719bSwdenkand the data portions of the image are secured against corruption by
3269c609719bSwdenkCRC32 checksums.
3270c609719bSwdenk
3271c609719bSwdenk
3272c609719bSwdenkLinux Support:
3273c609719bSwdenk==============
3274c609719bSwdenk
3275c609719bSwdenkAlthough U-Boot should support any OS or standalone application
32767152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3277c609719bSwdenkU-Boot.
3278c609719bSwdenk
3279c609719bSwdenkU-Boot includes many features that so far have been part of some
3280c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3281c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3282c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
32837152b1d0Swdenkserves several purposes:
3284c609719bSwdenk
3285c609719bSwdenk- the same features can be used for other OS or standalone
3286c609719bSwdenk  applications (for instance: using compressed images to reduce the
3287c609719bSwdenk  Flash memory footprint)
3288c609719bSwdenk
3289c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
32907152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3291c609719bSwdenk
3292c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3293c609719bSwdenk  images; of course this also means that different kernel images can
3294c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3295c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3296c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3297c609719bSwdenk  software is easier now.
3298c609719bSwdenk
3299c609719bSwdenk
3300c609719bSwdenkLinux HOWTO:
3301c609719bSwdenk============
3302c609719bSwdenk
3303c609719bSwdenkPorting Linux to U-Boot based systems:
3304c609719bSwdenk---------------------------------------
3305c609719bSwdenk
3306c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3307c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3308c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3309c609719bSwdenkLinux :-).
3310c609719bSwdenk
3311c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
3312c609719bSwdenk
3313c609719bSwdenkJust make sure your machine specific header file (for instance
3314c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
33151dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
33161dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
33176d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3318c609719bSwdenk
3319c609719bSwdenk
3320c609719bSwdenkConfiguring the Linux kernel:
3321c609719bSwdenk-----------------------------
3322c609719bSwdenk
3323c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3324c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3325c609719bSwdenk
3326c609719bSwdenk
3327c609719bSwdenkBuilding a Linux Image:
3328c609719bSwdenk-----------------------
3329c609719bSwdenk
333024ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
333124ee89b9Swdenknot used. If you use recent kernel source, a new build target
333224ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
333324ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
333424ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
333524ee89b9Swdenk100% compatible format.
3336c609719bSwdenk
3337c609719bSwdenkExample:
3338c609719bSwdenk
3339c609719bSwdenk	make TQM850L_config
3340c609719bSwdenk	make oldconfig
3341c609719bSwdenk	make dep
334224ee89b9Swdenk	make uImage
3343c609719bSwdenk
334424ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
334524ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
334624ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3347c609719bSwdenk
334824ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
334924ee89b9Swdenk
335024ee89b9Swdenk* convert the kernel into a raw binary image:
335124ee89b9Swdenk
335224ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
335324ee89b9Swdenk				 -R .note -R .comment \
335424ee89b9Swdenk				 -S vmlinux linux.bin
335524ee89b9Swdenk
335624ee89b9Swdenk* compress the binary image:
335724ee89b9Swdenk
335824ee89b9Swdenk	gzip -9 linux.bin
335924ee89b9Swdenk
336024ee89b9Swdenk* package compressed binary image for U-Boot:
336124ee89b9Swdenk
336224ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
336324ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
336424ee89b9Swdenk		-d linux.bin.gz uImage
336524ee89b9Swdenk
336624ee89b9Swdenk
336724ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
336824ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
336924ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
337024ee89b9Swdenkbyte header containing information about target architecture,
337124ee89b9Swdenkoperating system, image type, compression method, entry points, time
337224ee89b9Swdenkstamp, CRC32 checksums, etc.
337324ee89b9Swdenk
337424ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
337524ee89b9Swdenkprint the header information, or to build new images.
3376c609719bSwdenk
3377c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3378c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3379c609719bSwdenkchecksum verification:
3380c609719bSwdenk
3381c609719bSwdenk	tools/mkimage -l image
3382c609719bSwdenk	  -l ==> list image header information
3383c609719bSwdenk
3384c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3385c609719bSwdenkfrom a "data file" which is used as image payload:
3386c609719bSwdenk
3387c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3388c609719bSwdenk		      -n name -d data_file image
3389c609719bSwdenk	  -A ==> set architecture to 'arch'
3390c609719bSwdenk	  -O ==> set operating system to 'os'
3391c609719bSwdenk	  -T ==> set image type to 'type'
3392c609719bSwdenk	  -C ==> set compression type 'comp'
3393c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3394c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3395c609719bSwdenk	  -n ==> set image name to 'name'
3396c609719bSwdenk	  -d ==> use image data from 'datafile'
3397c609719bSwdenk
339869459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
339969459791Swdenkaddress (0x00000000), but the entry point address depends on the
340069459791Swdenkkernel version:
3401c609719bSwdenk
3402c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
340324ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3404c609719bSwdenk
3405c609719bSwdenkSo a typical call to build a U-Boot image would read:
3406c609719bSwdenk
340724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
340824ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
340924ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
341024ee89b9Swdenk	> examples/uImage.TQM850L
341124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3412c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3413c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3414c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3415c609719bSwdenk	Load Address: 0x00000000
341624ee89b9Swdenk	Entry Point:  0x00000000
3417c609719bSwdenk
3418c609719bSwdenkTo verify the contents of the image (or check for corruption):
3419c609719bSwdenk
342024ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
342124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3422c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3423c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3424c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3425c609719bSwdenk	Load Address: 0x00000000
342624ee89b9Swdenk	Entry Point:  0x00000000
3427c609719bSwdenk
3428c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3429c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3430c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3431c609719bSwdenkneed to be uncompressed:
3432c609719bSwdenk
343324ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
343424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
343524ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
343624ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
343724ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
343824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3439c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3440c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3441c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3442c609719bSwdenk	Load Address: 0x00000000
344324ee89b9Swdenk	Entry Point:  0x00000000
3444c609719bSwdenk
3445c609719bSwdenk
3446c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3447c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3448c609719bSwdenk
3449c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3450c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3451c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3452c609719bSwdenk	Image Name:   Simple Ramdisk Image
3453c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3454c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3455c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3456c609719bSwdenk	Load Address: 0x00000000
3457c609719bSwdenk	Entry Point:  0x00000000
3458c609719bSwdenk
3459c609719bSwdenk
3460c609719bSwdenkInstalling a Linux Image:
3461c609719bSwdenk-------------------------
3462c609719bSwdenk
3463c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3464c609719bSwdenkyou must convert the image to S-Record format:
3465c609719bSwdenk
3466c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3467c609719bSwdenk
3468c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3469c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3470c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3471c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3472c609719bSwdenkcommand.
3473c609719bSwdenk
3474c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3475c609719bSwdenkTQM8xxL is in the first Flash bank):
3476c609719bSwdenk
3477c609719bSwdenk	=> erase 40100000 401FFFFF
3478c609719bSwdenk
3479c609719bSwdenk	.......... done
3480c609719bSwdenk	Erased 8 sectors
3481c609719bSwdenk
3482c609719bSwdenk	=> loads 40100000
3483c609719bSwdenk	## Ready for S-Record download ...
3484c609719bSwdenk	~>examples/image.srec
3485c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3486c609719bSwdenk	...
3487c609719bSwdenk	15989 15990 15991 15992
3488c609719bSwdenk	[file transfer complete]
3489c609719bSwdenk	[connected]
3490c609719bSwdenk	## Start Addr = 0x00000000
3491c609719bSwdenk
3492c609719bSwdenk
3493c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3494c609719bSwdenkthis includes a checksum verification so you can be sure no data
3495c609719bSwdenkcorruption happened:
3496c609719bSwdenk
3497c609719bSwdenk	=> imi 40100000
3498c609719bSwdenk
3499c609719bSwdenk	## Checking Image at 40100000 ...
3500c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3501c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3502c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3503c609719bSwdenk	   Load Address: 00000000
3504c609719bSwdenk	   Entry Point:	 0000000c
3505c609719bSwdenk	   Verifying Checksum ... OK
3506c609719bSwdenk
3507c609719bSwdenk
3508c609719bSwdenkBoot Linux:
3509c609719bSwdenk-----------
3510c609719bSwdenk
3511c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3512c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3513c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3514c609719bSwdenkparameters. You can check and modify this variable using the
3515c609719bSwdenk"printenv" and "setenv" commands:
3516c609719bSwdenk
3517c609719bSwdenk
3518c609719bSwdenk	=> printenv bootargs
3519c609719bSwdenk	bootargs=root=/dev/ram
3520c609719bSwdenk
3521c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3522c609719bSwdenk
3523c609719bSwdenk	=> printenv bootargs
3524c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3525c609719bSwdenk
3526c609719bSwdenk	=> bootm 40020000
3527c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3528c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3529c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3530c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3531c609719bSwdenk	   Load Address: 00000000
3532c609719bSwdenk	   Entry Point:	 0000000c
3533c609719bSwdenk	   Verifying Checksum ... OK
3534c609719bSwdenk	   Uncompressing Kernel Image ... OK
3535c609719bSwdenk	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
3536c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3537c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3538c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3539c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3540c609719bSwdenk	...
3541c609719bSwdenk
354211ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
35437152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3544c609719bSwdenkformat!) to the "bootm" command:
3545c609719bSwdenk
3546c609719bSwdenk	=> imi 40100000 40200000
3547c609719bSwdenk
3548c609719bSwdenk	## Checking Image at 40100000 ...
3549c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3550c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3551c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3552c609719bSwdenk	   Load Address: 00000000
3553c609719bSwdenk	   Entry Point:	 0000000c
3554c609719bSwdenk	   Verifying Checksum ... OK
3555c609719bSwdenk
3556c609719bSwdenk	## Checking Image at 40200000 ...
3557c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3558c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3559c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3560c609719bSwdenk	   Load Address: 00000000
3561c609719bSwdenk	   Entry Point:	 00000000
3562c609719bSwdenk	   Verifying Checksum ... OK
3563c609719bSwdenk
3564c609719bSwdenk	=> bootm 40100000 40200000
3565c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3566c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3567c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3568c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3569c609719bSwdenk	   Load Address: 00000000
3570c609719bSwdenk	   Entry Point:	 0000000c
3571c609719bSwdenk	   Verifying Checksum ... OK
3572c609719bSwdenk	   Uncompressing Kernel Image ... OK
3573c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3574c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3575c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3576c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3577c609719bSwdenk	   Load Address: 00000000
3578c609719bSwdenk	   Entry Point:	 00000000
3579c609719bSwdenk	   Verifying Checksum ... OK
3580c609719bSwdenk	   Loading Ramdisk ... OK
3581c609719bSwdenk	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
3582c609719bSwdenk	Boot arguments: root=/dev/ram
3583c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3584c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3585c609719bSwdenk	...
3586c609719bSwdenk	RAMDISK: Compressed image found at block 0
3587c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3588c609719bSwdenk
3589c609719bSwdenk	bash#
3590c609719bSwdenk
35910267768eSMatthew McClintockBoot Linux and pass a flat device tree:
35920267768eSMatthew McClintock-----------
35930267768eSMatthew McClintock
35940267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
35950267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
35960267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
35970267768eSMatthew McClintockflat device tree:
35980267768eSMatthew McClintock
35990267768eSMatthew McClintock=> print oftaddr
36000267768eSMatthew McClintockoftaddr=0x300000
36010267768eSMatthew McClintock=> print oft
36020267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
36030267768eSMatthew McClintock=> tftp $oftaddr $oft
36040267768eSMatthew McClintockSpeed: 1000, full duplex
36050267768eSMatthew McClintockUsing TSEC0 device
36060267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
36070267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
36080267768eSMatthew McClintockLoad address: 0x300000
36090267768eSMatthew McClintockLoading: #
36100267768eSMatthew McClintockdone
36110267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
36120267768eSMatthew McClintock=> tftp $loadaddr $bootfile
36130267768eSMatthew McClintockSpeed: 1000, full duplex
36140267768eSMatthew McClintockUsing TSEC0 device
36150267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
36160267768eSMatthew McClintockFilename 'uImage'.
36170267768eSMatthew McClintockLoad address: 0x200000
36180267768eSMatthew McClintockLoading:############
36190267768eSMatthew McClintockdone
36200267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
36210267768eSMatthew McClintock=> print loadaddr
36220267768eSMatthew McClintockloadaddr=200000
36230267768eSMatthew McClintock=> print oftaddr
36240267768eSMatthew McClintockoftaddr=0x300000
36250267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
36260267768eSMatthew McClintock## Booting image at 00200000 ...
36270267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
36280267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
36290267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
36300267768eSMatthew McClintock   Load Address: 00000000
36310267768eSMatthew McClintock   Entry Point:	 00000000
36320267768eSMatthew McClintock   Verifying Checksum ... OK
36330267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
36340267768eSMatthew McClintockBooting using flat device tree at 0x300000
36350267768eSMatthew McClintockUsing MPC85xx ADS machine description
36360267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
36370267768eSMatthew McClintock[snip]
36380267768eSMatthew McClintock
36390267768eSMatthew McClintock
36406069ff26SwdenkMore About U-Boot Image Types:
36416069ff26Swdenk------------------------------
36426069ff26Swdenk
36436069ff26SwdenkU-Boot supports the following image types:
36446069ff26Swdenk
36456069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
36466069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
36476069ff26Swdenk	well) you can continue to work in U-Boot after return from
36486069ff26Swdenk	the Standalone Program.
36496069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
36506069ff26Swdenk	will take over control completely. Usually these programs
36516069ff26Swdenk	will install their own set of exception handlers, device
36526069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
36536069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
36546069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
36556069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
36566069ff26Swdenk	being started.
36576069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
36586069ff26Swdenk	(Linux) kernel image and one or more data images like
36596069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
36606069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
36616069ff26Swdenk	server provides just a single image file, but you want to get
36626069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
36636069ff26Swdenk
36646069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
36656069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
36666069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
36676069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
36686069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
36696069ff26Swdenk	a multiple of 4 bytes).
36706069ff26Swdenk
36716069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
36726069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
36736069ff26Swdenk	flash memory.
36746069ff26Swdenk
36756069ff26Swdenk   "Script files" are command sequences that will be executed by
36766069ff26Swdenk	U-Boot's command interpreter; this feature is especially
36776069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
36786069ff26Swdenk	as command interpreter.
36796069ff26Swdenk
3680c609719bSwdenk
3681c609719bSwdenkStandalone HOWTO:
3682c609719bSwdenk=================
3683c609719bSwdenk
3684c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3685c609719bSwdenkrun "standalone" applications, which can use some resources of
3686c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3687c609719bSwdenk
3688c609719bSwdenkTwo simple examples are included with the sources:
3689c609719bSwdenk
3690c609719bSwdenk"Hello World" Demo:
3691c609719bSwdenk-------------------
3692c609719bSwdenk
3693c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3694c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3695c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3696c609719bSwdenklike that:
3697c609719bSwdenk
3698c609719bSwdenk	=> loads
3699c609719bSwdenk	## Ready for S-Record download ...
3700c609719bSwdenk	~>examples/hello_world.srec
3701c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3702c609719bSwdenk	[file transfer complete]
3703c609719bSwdenk	[connected]
3704c609719bSwdenk	## Start Addr = 0x00040004
3705c609719bSwdenk
3706c609719bSwdenk	=> go 40004 Hello World! This is a test.
3707c609719bSwdenk	## Starting application at 0x00040004 ...
3708c609719bSwdenk	Hello World
3709c609719bSwdenk	argc = 7
3710c609719bSwdenk	argv[0] = "40004"
3711c609719bSwdenk	argv[1] = "Hello"
3712c609719bSwdenk	argv[2] = "World!"
3713c609719bSwdenk	argv[3] = "This"
3714c609719bSwdenk	argv[4] = "is"
3715c609719bSwdenk	argv[5] = "a"
3716c609719bSwdenk	argv[6] = "test."
3717c609719bSwdenk	argv[7] = "<NULL>"
3718c609719bSwdenk	Hit any key to exit ...
3719c609719bSwdenk
3720c609719bSwdenk	## Application terminated, rc = 0x0
3721c609719bSwdenk
3722c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3723c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3724c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3725c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3726c609719bSwdenkcharacter, but this is just a demo program. The application can be
3727c609719bSwdenkcontrolled by the following keys:
3728c609719bSwdenk
3729c609719bSwdenk	? - print current values og the CPM Timer registers
3730c609719bSwdenk	b - enable interrupts and start timer
3731c609719bSwdenk	e - stop timer and disable interrupts
3732c609719bSwdenk	q - quit application
3733c609719bSwdenk
3734c609719bSwdenk	=> loads
3735c609719bSwdenk	## Ready for S-Record download ...
3736c609719bSwdenk	~>examples/timer.srec
3737c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3738c609719bSwdenk	[file transfer complete]
3739c609719bSwdenk	[connected]
3740c609719bSwdenk	## Start Addr = 0x00040004
3741c609719bSwdenk
3742c609719bSwdenk	=> go 40004
3743c609719bSwdenk	## Starting application at 0x00040004 ...
3744c609719bSwdenk	TIMERS=0xfff00980
3745c609719bSwdenk	Using timer 1
3746c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3747c609719bSwdenk
3748c609719bSwdenkHit 'b':
3749c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3750c609719bSwdenk	Enabling timer
3751c609719bSwdenkHit '?':
3752c609719bSwdenk	[q, b, e, ?] ........
3753c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3754c609719bSwdenkHit '?':
3755c609719bSwdenk	[q, b, e, ?] .
3756c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3757c609719bSwdenkHit '?':
3758c609719bSwdenk	[q, b, e, ?] .
3759c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3760c609719bSwdenkHit '?':
3761c609719bSwdenk	[q, b, e, ?] .
3762c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3763c609719bSwdenkHit 'e':
3764c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3765c609719bSwdenkHit 'q':
3766c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3767c609719bSwdenk
3768c609719bSwdenk
376985ec0bccSwdenkMinicom warning:
377085ec0bccSwdenk================
377185ec0bccSwdenk
37727152b1d0SwdenkOver time, many people have reported problems when trying to use the
377385ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
377485ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3775f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
377685ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
377785ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
377885ec0bccSwdenk
377952f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
378052f52c14Swdenkconfiguration to your "File transfer protocols" section:
378152f52c14Swdenk
378252f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
378352f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
378452f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
378552f52c14Swdenk
378652f52c14Swdenk
3787c609719bSwdenkNetBSD Notes:
3788c609719bSwdenk=============
3789c609719bSwdenk
3790c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3791c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3792c609719bSwdenk
3793c609719bSwdenkBuilding requires a cross environment; it is known to work on
3794c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3795c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3796c609719bSwdenkNote that the cross-powerpc package does not install include files;
3797c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3798c609719bSwdenkmissing.  This file has to be installed and patched manually:
3799c609719bSwdenk
3800c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3801c609719bSwdenk	# mkdir powerpc
3802c609719bSwdenk	# ln -s powerpc machine
3803c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3804c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3805c609719bSwdenk
3806c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3807c609719bSwdenkand U-Boot include files.
3808c609719bSwdenk
3809c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3810c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3811c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3812c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
38132a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3814c609719bSwdenk
3815c609719bSwdenk
3816c609719bSwdenkImplementation Internals:
3817c609719bSwdenk=========================
3818c609719bSwdenk
3819c609719bSwdenkThe following is not intended to be a complete description of every
3820c609719bSwdenkimplementation detail. However, it should help to understand the
3821c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3822c609719bSwdenkhardware.
3823c609719bSwdenk
3824c609719bSwdenk
3825c609719bSwdenkInitial Stack, Global Data:
3826c609719bSwdenk---------------------------
3827c609719bSwdenk
3828c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3829c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3830c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3831c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3832c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3833c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3834c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3835c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3836c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3837c609719bSwdenklocked as (mis-) used as memory, etc.
3838c609719bSwdenk
38397152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
38400668236bSWolfgang Denk	U-Boot mailing list:
384143d9616cSwdenk
384243d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
384343d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
384443d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
384543d9616cSwdenk	...
384643d9616cSwdenk
384743d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
384843d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
384943d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
385043d9616cSwdenk	is that the cache is being used as a temporary supply of
385143d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
385211ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
385343d9616cSwdenk	can see how this works by studying the cache architecture and
385443d9616cSwdenk	operation in the architecture and processor-specific manuals.
385543d9616cSwdenk
385643d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
385743d9616cSwdenk	is another option for the system designer to use as an
385811ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
385943d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
386043d9616cSwdenk	board designers haven't used it for something that would
386143d9616cSwdenk	cause you grief during the initial boot! It is frequently not
386243d9616cSwdenk	used.
386343d9616cSwdenk
38646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
386543d9616cSwdenk	with your processor/board/system design. The default value
386643d9616cSwdenk	you will find in any recent u-boot distribution in
38678a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
386843d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
386943d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
387043d9616cSwdenk	that are supposed to respond to that address! That code in
387143d9616cSwdenk	start.S has been around a while and should work as is when
387243d9616cSwdenk	you get the config right.
387343d9616cSwdenk
387443d9616cSwdenk	-Chris Hallinan
387543d9616cSwdenk	DS4.COM, Inc.
387643d9616cSwdenk
3877c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3878c609719bSwdenkcode for the initialization procedures:
3879c609719bSwdenk
3880c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3881c609719bSwdenk  to write it.
3882c609719bSwdenk
388311ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3884c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
38857152b1d0Swdenk  zation is performed later (when relocating to RAM).
3886c609719bSwdenk
3887c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3888c609719bSwdenk  that.
3889c609719bSwdenk
3890c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3891c609719bSwdenknormal global data to share information beween the code. But it
3892c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3893c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3894c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3895c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3896c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3897c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3898c609719bSwdenkreserve for this purpose.
3899c609719bSwdenk
39007152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3901c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3902c609719bSwdenkGCC's implementation.
3903c609719bSwdenk
3904c609719bSwdenkFor PowerPC, the following registers have specific use:
3905c609719bSwdenk	R1:	stack pointer
3906e7670f6cSWolfgang Denk	R2:	reserved for system use
3907c609719bSwdenk	R3-R4:	parameter passing and return values
3908c609719bSwdenk	R5-R10: parameter passing
3909c609719bSwdenk	R13:	small data area pointer
3910c609719bSwdenk	R30:	GOT pointer
3911c609719bSwdenk	R31:	frame pointer
3912c609719bSwdenk
3913c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3914c609719bSwdenk
3915e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3916c609719bSwdenk
3917c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3918c609719bSwdenk    address of the global data structure is known at compile time),
3919c609719bSwdenk    but it turned out that reserving a register results in somewhat
3920c609719bSwdenk    smaller code - although the code savings are not that big (on
3921c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3922c609719bSwdenk    624 text + 127 data).
3923c609719bSwdenk
3924c4db335cSRobin GetzOn Blackfin, the normal C ABI (except for P3) is followed as documented here:
39254c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
39264c58eb55SMike Frysinger
3927c4db335cSRobin Getz    ==> U-Boot will use P3 to hold a pointer to the global data
39284c58eb55SMike Frysinger
3929c609719bSwdenkOn ARM, the following registers are used:
3930c609719bSwdenk
3931c609719bSwdenk	R0:	function argument word/integer result
3932c609719bSwdenk	R1-R3:	function argument word
3933c609719bSwdenk	R9:	GOT pointer
3934c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3935c609719bSwdenk	R11:	argument (frame) pointer
3936c609719bSwdenk	R12:	temporary workspace
3937c609719bSwdenk	R13:	stack pointer
3938c609719bSwdenk	R14:	link register
3939c609719bSwdenk	R15:	program counter
3940c609719bSwdenk
3941c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3942c609719bSwdenk
3943d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3944d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3945c609719bSwdenk
3946c609719bSwdenkMemory Management:
3947c609719bSwdenk------------------
3948c609719bSwdenk
3949c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3950c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3951c609719bSwdenk
3952c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3953c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3954c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3955c609719bSwdenkphysical memory banks.
3956c609719bSwdenk
3957c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3958c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3959c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3960c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
39616d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
3962c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3963c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3964c609719bSwdenk
3965c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3966c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3967c609719bSwdenk
3968c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3969c609719bSwdenkthis:
3970c609719bSwdenk
3971c609719bSwdenk	0x0000 0000	Exception Vector code
3972c609719bSwdenk	      :
3973c609719bSwdenk	0x0000 1FFF
3974c609719bSwdenk	0x0000 2000	Free for Application Use
3975c609719bSwdenk	      :
3976c609719bSwdenk	      :
3977c609719bSwdenk
3978c609719bSwdenk	      :
3979c609719bSwdenk	      :
3980c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3981c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3982c609719bSwdenk	0x00FC 0000	Malloc Arena
3983c609719bSwdenk	      :
3984c609719bSwdenk	0x00FD FFFF
3985c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3986c609719bSwdenk	...		eventually: LCD or video framebuffer
3987c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3988c609719bSwdenk	0x00FF FFFF	[End of RAM]
3989c609719bSwdenk
3990c609719bSwdenk
3991c609719bSwdenkSystem Initialization:
3992c609719bSwdenk----------------------
3993c609719bSwdenk
3994c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
399511ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
3996c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
39977152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3998c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3999c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
4000c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
4001c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
4002c609719bSwdenkthe caches and the SIU.
4003c609719bSwdenk
4004c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
4005c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
4006c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
4007c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
4008c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
4009c609719bSwdenksimple memory test is run that determines the size of the SDRAM
4010c609719bSwdenkbanks.
4011c609719bSwdenk
4012c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
40137152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
4014c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
4015c609719bSwdenk0x00000000, with any additional banks following immediately to create
4016c609719bSwdenkcontiguous memory starting from 0.
4017c609719bSwdenk
4018c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
4019c609719bSwdenkand allocates memory for use by malloc() and for the global Board
4020c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
4021c609719bSwdenkpages, and the final stack is set up.
4022c609719bSwdenk
4023c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
4024c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
4025c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
4026c609719bSwdenknew address in RAM.
4027c609719bSwdenk
4028c609719bSwdenk
4029c609719bSwdenkU-Boot Porting Guide:
4030c609719bSwdenk----------------------
4031c609719bSwdenk
4032c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
40336aff3115Swdenklist, October 2002]
4034c609719bSwdenk
4035c609719bSwdenk
4036c609719bSwdenkint main(int argc, char *argv[])
4037c609719bSwdenk{
4038c609719bSwdenk	sighandler_t no_more_time;
4039c609719bSwdenk
4040c609719bSwdenk	signal(SIGALRM, no_more_time);
4041c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
4042c609719bSwdenk
4043c609719bSwdenk	if (available_money > available_manpower) {
40446c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
4045c609719bSwdenk		return 0;
4046c609719bSwdenk	}
4047c609719bSwdenk
4048c609719bSwdenk	Download latest U-Boot source;
4049c609719bSwdenk
40500668236bSWolfgang Denk	Subscribe to u-boot mailing list;
40516aff3115Swdenk
40526c3fef28SJerry Van Baren	if (clueless)
4053c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
4054c609719bSwdenk
4055c609719bSwdenk	while (learning) {
4056c609719bSwdenk		Read the README file in the top level directory;
40577cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
40586c3fef28SJerry Van Baren		Read applicable doc/*.README;
4059c609719bSwdenk		Read the source, Luke;
40606c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
4061c609719bSwdenk	}
4062c609719bSwdenk
40636c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
40646c3fef28SJerry Van Baren		Buy a BDI3000;
40656c3fef28SJerry Van Baren	else
4066c609719bSwdenk		Add a lot of aggravation and time;
4067c609719bSwdenk
40686c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
40696c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
40706c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
40716c3fef28SJerry Van Baren	} else {
4072c609719bSwdenk		Create your own board support subdirectory;
40736c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
40746c3fef28SJerry Van Baren	}
40756c3fef28SJerry Van Baren	Edit new board/<myboard> files
40766c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
4077c609719bSwdenk
40786c3fef28SJerry Van Baren	while (!accepted) {
4079c609719bSwdenk		while (!running) {
4080c609719bSwdenk			do {
4081c609719bSwdenk				Add / modify source code;
4082c609719bSwdenk			} until (compiles);
4083c609719bSwdenk			Debug;
4084c609719bSwdenk			if (clueless)
4085c609719bSwdenk				email("Hi, I am having problems...");
4086c609719bSwdenk		}
40876c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
40886c3fef28SJerry Van Baren		if (reasonable critiques)
40896c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
40906c3fef28SJerry Van Baren		else
40916c3fef28SJerry Van Baren			Defend code as written;
40926c3fef28SJerry Van Baren	}
4093c609719bSwdenk
4094c609719bSwdenk	return 0;
4095c609719bSwdenk}
4096c609719bSwdenk
4097c609719bSwdenkvoid no_more_time (int sig)
4098c609719bSwdenk{
4099c609719bSwdenk      hire_a_guru();
4100c609719bSwdenk}
4101c609719bSwdenk
4102c609719bSwdenk
4103c609719bSwdenkCoding Standards:
4104c609719bSwdenk-----------------
4105c609719bSwdenk
4106c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
41072c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
41082c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
41092c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
41102c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4111c609719bSwdenk
41122c051651SDetlev ZundelSource files originating from a different project (for example the
41132c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
41142c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
41152c051651SDetlev Zundelsources.
41162c051651SDetlev Zundel
41172c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
41182c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
41192c051651SDetlev Zundelin your code.
4120c609719bSwdenk
4121c178d3daSwdenkPlease also stick to the following formatting rules:
4122180d3f74Swdenk- remove any trailing white space
4123180d3f74Swdenk- use TAB characters for indentation, not spaces
4124180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4125180d3f74Swdenk- do not add more than 2 empty lines to source files
4126180d3f74Swdenk- do not add trailing empty lines to source files
4127180d3f74Swdenk
4128c609719bSwdenkSubmissions which do not conform to the standards may be returned
4129c609719bSwdenkwith a request to reformat the changes.
4130c609719bSwdenk
4131c609719bSwdenk
4132c609719bSwdenkSubmitting Patches:
4133c609719bSwdenk-------------------
4134c609719bSwdenk
4135c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4136c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4137c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4138c609719bSwdenk
41390d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4140218ca724SWolfgang Denk
41410668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
41420668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
41430668236bSWolfgang Denk
4144c609719bSwdenkWhen you send a patch, please include the following information with
4145c609719bSwdenkit:
4146c609719bSwdenk
4147c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4148c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4149c609719bSwdenk  patch actually fixes something.
4150c609719bSwdenk
4151c609719bSwdenk* For new features: a description of the feature and your
4152c609719bSwdenk  implementation.
4153c609719bSwdenk
4154c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4155c609719bSwdenk
4156c609719bSwdenk* For major contributions, your entry to the CREDITS file
4157c609719bSwdenk
4158c609719bSwdenk* When you add support for a new board, don't forget to add this
4159c609719bSwdenk  board to the MAKEALL script, too.
4160c609719bSwdenk
4161c609719bSwdenk* If your patch adds new configuration options, don't forget to
4162c609719bSwdenk  document these in the README file.
4163c609719bSwdenk
4164218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4165218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4166218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4167218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4168218ca724SWolfgang Denk  with some other mail clients.
4169c609719bSwdenk
4170218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4171218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4172218ca724SWolfgang Denk  GNU diff.
41736dff5529Swdenk
4174218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4175218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4176218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4177218ca724SWolfgang Denk  affected files).
4178218ca724SWolfgang Denk
4179218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4180218ca724SWolfgang Denk  and compressed attachments must not be used.
4181c609719bSwdenk
418252f52c14Swdenk* If one logical set of modifications affects or creates several
418352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
418452f52c14Swdenk
418552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
418652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
418752f52c14Swdenk
418852f52c14Swdenk
4189c609719bSwdenkNotes:
4190c609719bSwdenk
4191c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4192c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4193c609719bSwdenk  for any of the boards.
4194c609719bSwdenk
4195c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4196c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4197c609719bSwdenk  returned with a request to re-formatting / split it.
4198c609719bSwdenk
4199c609719bSwdenk* If you modify existing code, make sure that your new code does not
4200c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4201c609719bSwdenk  When adding new features, these should compile conditionally only
4202c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4203c609719bSwdenk  disabled must not need more memory than the old code without your
4204c609719bSwdenk  modification.
420590dc6704Swdenk
42060668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
42070668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
42080668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
42090668236bSWolfgang Denk  bigger than the size limit should be avoided.
4210