xref: /openbmc/u-boot/README (revision 7817cb2083d982923752fe0f12b67c0e7c09a027)
1c609719bSwdenk#
2151ab83aSwdenk# (C) Copyright 2000 - 2005
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
54c609719bSwdenkwho contributed the specific port.
55c609719bSwdenk
56c609719bSwdenk
57c609719bSwdenkWhere to get help:
58c609719bSwdenk==================
59c609719bSwdenk
60c609719bSwdenkIn case you have questions about, problems with or contributions for
61c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
62c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
63c609719bSwdenkprevious traffic on the mailing list - please search the archive
64c609719bSwdenkbefore asking FAQ's. Please see
65c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
66c609719bSwdenk
67c609719bSwdenk
68c609719bSwdenkWhere we come from:
69c609719bSwdenk===================
70c609719bSwdenk
71c609719bSwdenk- start from 8xxrom sources
7224ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73c609719bSwdenk- clean up code
74c609719bSwdenk- make it easier to add custom boards
75c609719bSwdenk- make it possible to add other [PowerPC] CPUs
76c609719bSwdenk- extend functions, especially:
77c609719bSwdenk  * Provide extended interface to Linux boot loader
78c609719bSwdenk  * S-Record download
79c609719bSwdenk  * network boot
80c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8124ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
82c609719bSwdenk- add other CPU families (starting with ARM)
8324ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8424ee89b9Swdenk
8524ee89b9Swdenk
8624ee89b9SwdenkNames and Spelling:
8724ee89b9Swdenk===================
8824ee89b9Swdenk
8924ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9024ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9124ee89b9Swdenkin source files etc.). Example:
9224ee89b9Swdenk
9324ee89b9Swdenk	This is the README file for the U-Boot project.
9424ee89b9Swdenk
9524ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9624ee89b9Swdenk
9724ee89b9Swdenk	include/asm-ppc/u-boot.h
9824ee89b9Swdenk
9924ee89b9Swdenk	#include <asm/u-boot.h>
10024ee89b9Swdenk
10124ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10224ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10324ee89b9Swdenk
10424ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10524ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
106c609719bSwdenk
107c609719bSwdenk
10893f19cc0SwdenkVersioning:
10993f19cc0Swdenk===========
11093f19cc0Swdenk
11193f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11293f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11393f19cc0Swdenksub-version "34", and patchlevel "4".
11493f19cc0Swdenk
11593f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11693f19cc0Swdenkbetween released versions, i. e. officially released versions of
11793f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11893f19cc0Swdenk
11993f19cc0Swdenk
120c609719bSwdenkDirectory Hierarchy:
121c609719bSwdenk====================
122c609719bSwdenk
1237152b1d0Swdenk- board		Board dependent files
1247152b1d0Swdenk- common	Misc architecture independent functions
125c609719bSwdenk- cpu		CPU specific files
126983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
12711dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12811dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
129a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1311d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
13211dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
13311dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1348ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
13572a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
13611dadd54Swdenk  - i386	Files specific to i386 CPUs
13711dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
138983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
1398e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
1408ae158cdSTsiChungLiew  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
14111dadd54Swdenk  - mips	Files specific to MIPS CPUs
142983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
143983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
144983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
145983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
146983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
147983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
148983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14911dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1505c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1510c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
15211dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15311dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15411dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
155c609719bSwdenk- disk		Code for disk drive partition handling
156c609719bSwdenk- doc		Documentation (don't expect too much)
1577152b1d0Swdenk- drivers	Commonly used device drivers
158c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
159c609719bSwdenk- examples	Example code for standalone applications, etc.
160c609719bSwdenk- include	Header Files
16111dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1627b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
16311dadd54Swdenk- lib_generic	Files generic to all	 architectures
16411dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16511dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16611dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16711dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16811dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
169213bf8c8SGerald Van Baren- libfdt 	Library files to support flattened device trees
170c609719bSwdenk- net		Networking code
171c609719bSwdenk- post		Power On Self Test
172c609719bSwdenk- rtc		Real Time Clock drivers
173c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
174c609719bSwdenk
175c609719bSwdenkSoftware Configuration:
176c609719bSwdenk=======================
177c609719bSwdenk
178c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
179c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
180c609719bSwdenk
181c609719bSwdenkThere are two classes of configuration variables:
182c609719bSwdenk
183c609719bSwdenk* Configuration _OPTIONS_:
184c609719bSwdenk  These are selectable by the user and have names beginning with
185c609719bSwdenk  "CONFIG_".
186c609719bSwdenk
187c609719bSwdenk* Configuration _SETTINGS_:
188c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
189c609719bSwdenk  you don't know what you're doing; they have names beginning with
190c609719bSwdenk  "CFG_".
191c609719bSwdenk
192c609719bSwdenkLater we will add a configuration tool - probably similar to or even
193c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
194c609719bSwdenkdo the configuration by hand, which means creating some symbolic
195c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
196c609719bSwdenkas an example here.
197c609719bSwdenk
198c609719bSwdenk
199c609719bSwdenkSelection of Processor Architecture and Board Type:
200c609719bSwdenk---------------------------------------------------
201c609719bSwdenk
202c609719bSwdenkFor all supported boards there are ready-to-use default
203c609719bSwdenkconfigurations available; just type "make <board_name>_config".
204c609719bSwdenk
205c609719bSwdenkExample: For a TQM823L module type:
206c609719bSwdenk
207c609719bSwdenk	cd u-boot
208c609719bSwdenk	make TQM823L_config
209c609719bSwdenk
210c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
211c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
212c609719bSwdenkdirectory according to the instructions in cogent/README.
213c609719bSwdenk
214c609719bSwdenk
215c609719bSwdenkConfiguration Options:
216c609719bSwdenk----------------------
217c609719bSwdenk
218c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
219c609719bSwdenksuch information is kept in a configuration file
220c609719bSwdenk"include/configs/<board_name>.h".
221c609719bSwdenk
222c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
223c609719bSwdenk"include/configs/TQM823L.h".
224c609719bSwdenk
225c609719bSwdenk
2267f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2277f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2287f6c2cbcSwdenkbuild a config tool - later.
2297f6c2cbcSwdenk
2307f6c2cbcSwdenk
231c609719bSwdenkThe following options need to be configured:
232c609719bSwdenk
2332628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
234c609719bSwdenk
2352628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2366ccec449SWolfgang Denk
2376ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
23809ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
239c609719bSwdenk
240c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
241c609719bSwdenk		Define exactly one of
242c609719bSwdenk		CONFIG_CMA286_60_OLD
243c609719bSwdenk--- FIXME --- not tested yet:
244c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
245c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
246c609719bSwdenk
247c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
248c609719bSwdenk		Define exactly one of
249c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
250c609719bSwdenk
251c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
252c609719bSwdenk		Define one or more of
253c609719bSwdenk		CONFIG_CMA302
254c609719bSwdenk
255c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
256c609719bSwdenk		Define one or more of
257c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
258c609719bSwdenk					  the lcd display every second with
259c609719bSwdenk					  a "rotator" |\-/|\-/
260c609719bSwdenk
2612535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
2622535d602Swdenk		CONFIG_ADSTYPE
2632535d602Swdenk		Possible values are:
2642535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
265180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
26654387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
26704a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
2682535d602Swdenk
269c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
270c609719bSwdenk		Define exactly one of
271c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
272c609719bSwdenk
27375d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
27466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
27566ca92a5Swdenk					  get_gclk_freq() cannot work
2765da627a4Swdenk					  e.g. if there is no 32KHz
2775da627a4Swdenk					  reference PIT/RTC clock
27866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
27966ca92a5Swdenk					  or XTAL/EXTAL)
280c609719bSwdenk
28166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
28266ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
28366ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
28466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
28575d1ea7fSwdenk			See doc/README.MPC866
28675d1ea7fSwdenk
28775d1ea7fSwdenk		CFG_MEASURE_CPUCLK
28875d1ea7fSwdenk
28975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
29075d1ea7fSwdenk		of relying on the correctness of the configured
29175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
29275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
29375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
29466ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
29575d1ea7fSwdenk
2960b953ffcSMarkus Klotzbuecher- Intel Monahans options:
2970b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
2980b953ffcSMarkus Klotzbuecher
2990b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3000b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3010b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3020b953ffcSMarkus Klotzbuecher
3030b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
3040b953ffcSMarkus Klotzbuecher
3050b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3060b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3070b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3080b953ffcSMarkus Klotzbuecher		by this value.
3090b953ffcSMarkus Klotzbuecher
3105da627a4Swdenk- Linux Kernel Interface:
311c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
312c609719bSwdenk
313c609719bSwdenk		U-Boot stores all clock information in Hz
314c609719bSwdenk		internally. For binary compatibility with older Linux
315c609719bSwdenk		kernels (which expect the clocks passed in the
316c609719bSwdenk		bd_info data to be in MHz) the environment variable
317c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
318c609719bSwdenk		converts clock data to MHZ before passing it to the
319c609719bSwdenk		Linux kernel.
320c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
321c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
322c609719bSwdenk		default environment.
323c609719bSwdenk
3245da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3255da627a4Swdenk
3265da627a4Swdenk		When transfering memsize parameter to linux, some versions
3275da627a4Swdenk		expect it to be in bytes, others in MB.
3285da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3295da627a4Swdenk
330213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
331f57f70aaSWolfgang Denk
332f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
333213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
334213bf8c8SGerald Van Baren		concepts).
335213bf8c8SGerald Van Baren
336213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
337213bf8c8SGerald Van Baren		 * New libfdt-based support
338213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3393bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
340213bf8c8SGerald Van Baren
341213bf8c8SGerald Van Baren		CONFIG_OF_FLAT_TREE
342213bf8c8SGerald Van Baren		 * Deprecated, see CONFIG_OF_LIBFDT
343213bf8c8SGerald Van Baren		 * Original ft_build.c-based support
344213bf8c8SGerald Van Baren		 * Automatically modifies the dft as part of the bootm command
345213bf8c8SGerald Van Baren		 * The environment variable "disable_of", when set,
346213bf8c8SGerald Van Baren		     disables this functionality.
347f57f70aaSWolfgang Denk
348f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
349c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
350f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
351c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
352f57f70aaSWolfgang Denk
3533bb342fcSKim Phillips		boards with QUICC Engines require OF_QE to set UCC mac addresses
3543bb342fcSKim Phillips
355e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
356e4f880edSKumar Gala
357213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
358213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
359213bf8c8SGerald Van Baren		     will have a copy of the bd_t.  Space should be
360213bf8c8SGerald Van Baren		     pre-allocated in the dts for the bd_t.
361e4f880edSKumar Gala
362e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
363e4f880edSKumar Gala
3643bb342fcSKim Phillips		 * CONFIG_OF_LIBFDT - enables the "fdt env" command
365213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
366213bf8c8SGerald Van Baren		     will have a copy of u-boot's environment variables
367e4f880edSKumar Gala
3684e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
3694e253137SKumar Gala
3704e253137SKumar Gala		Board code has addition modification that it wants to make
3714e253137SKumar Gala		to the flat device tree before handing it off to the kernel
3726705d81eSwdenk
3730267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
3740267768eSMatthew McClintock
3750267768eSMatthew McClintock		This define fills in the correct boot cpu in the boot
3760267768eSMatthew McClintock		param header, the default value is zero if undefined.
3770267768eSMatthew McClintock
3786705d81eSwdenk- Serial Ports:
3796705d81eSwdenk		CFG_PL010_SERIAL
3806705d81eSwdenk
3816705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
3826705d81eSwdenk
3836705d81eSwdenk		CFG_PL011_SERIAL
3846705d81eSwdenk
3856705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
3866705d81eSwdenk
3876705d81eSwdenk		CONFIG_PL011_CLOCK
3886705d81eSwdenk
3896705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
3906705d81eSwdenk		the clock speed of the UARTs.
3916705d81eSwdenk
3926705d81eSwdenk		CONFIG_PL01x_PORTS
3936705d81eSwdenk
3946705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
3956705d81eSwdenk		define this to a list of base addresses for each (supported)
3966705d81eSwdenk		port. See e.g. include/configs/versatile.h
3976705d81eSwdenk
3986705d81eSwdenk
399c609719bSwdenk- Console Interface:
400c609719bSwdenk		Depending on board, define exactly one serial port
401c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
402c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
403c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
404c609719bSwdenk
405c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
406c609719bSwdenk		port routines must be defined elsewhere
407c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
408c609719bSwdenk
409c609719bSwdenk		CONFIG_CFB_CONSOLE
410c609719bSwdenk		Enables console device for a color framebuffer. Needs following
411c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
412c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
413c609719bSwdenk						(default big endian)
414c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
415c609719bSwdenk						rectangle fill
416c609719bSwdenk						(cf. smiLynxEM)
417c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
418c609719bSwdenk						bit-blit (cf. smiLynxEM)
419c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
420c609719bSwdenk						(cols=pitch)
421c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
422c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
423c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
424c609719bSwdenk						(0-5, cf. cfb_console.c)
425c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
426c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
427c609719bSwdenk						(i.e. i8042_kbd_init())
428c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
429c609719bSwdenk						(i.e. i8042_tstc)
430c609719bSwdenk			VIDEO_GETC_FCT		get char fct
431c609719bSwdenk						(i.e. i8042_getc)
432c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
433c609719bSwdenk						(requires blink timer
434c609719bSwdenk						cf. i8042.c)
435c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
436c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
437c609719bSwdenk						upper right corner
438602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
439c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
440c609719bSwdenk						upper left corner
441a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
442a6c7ad2fSwdenk						linux_logo.h for logo.
443a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
444c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
445c609719bSwdenk						addional board info beside
446c609719bSwdenk						the logo
447c609719bSwdenk
448c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
449c609719bSwdenk		default i/o. Serial console can be forced with
450c609719bSwdenk		environment 'console=serial'.
451c609719bSwdenk
452a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
453a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
454a3ad8e26Swdenk		the "silent" environment variable. See
455a3ad8e26Swdenk		doc/README.silent for more information.
456a3ad8e26Swdenk
457c609719bSwdenk- Console Baudrate:
458c609719bSwdenk		CONFIG_BAUDRATE - in bps
459c609719bSwdenk		Select one of the baudrates listed in
460c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
4613bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
462c609719bSwdenk
463c609719bSwdenk- Interrupt driven serial port input:
464c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
465c609719bSwdenk
466c609719bSwdenk		PPC405GP only.
467c609719bSwdenk		Use an interrupt handler for receiving data on the
468c609719bSwdenk		serial port. It also enables using hardware handshake
469c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
470c609719bSwdenk		bytes the interrupt driven input buffer should have.
471c609719bSwdenk
472109c0e3aSwdenk		Leave undefined to disable this feature, including
473109c0e3aSwdenk		disable the buffer and hardware handshake.
474c609719bSwdenk
4751d49b1f3Sstroese- Console UART Number:
4761d49b1f3Sstroese		CONFIG_UART1_CONSOLE
4771d49b1f3Sstroese
4780c8721a4SWolfgang Denk		AMCC PPC4xx only.
4791d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
4801d49b1f3Sstroese		as default U-Boot console.
4811d49b1f3Sstroese
482c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
483c609719bSwdenk		Delay before automatically booting the default image;
484c609719bSwdenk		set to -1 to disable autoboot.
485c609719bSwdenk
486c609719bSwdenk		See doc/README.autoboot for these options that
487c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
488c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
489c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
490c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
491c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
492c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
493c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
494c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
495c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
496c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
497c609719bSwdenk		CONFIG_RESET_TO_RETRY
498c609719bSwdenk
499c609719bSwdenk- Autoboot Command:
500c609719bSwdenk		CONFIG_BOOTCOMMAND
501c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
502c609719bSwdenk		define a command string that is automatically executed
503c609719bSwdenk		when no character is read on the console interface
504c609719bSwdenk		within "Boot Delay" after reset.
505c609719bSwdenk
506c609719bSwdenk		CONFIG_BOOTARGS
507c609719bSwdenk		This can be used to pass arguments to the bootm
508c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
509c609719bSwdenk		environment value "bootargs".
510c609719bSwdenk
511c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
512c609719bSwdenk		The value of these goes into the environment as
513c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
514c609719bSwdenk		as a convenience, when switching between booting from
515c609719bSwdenk		ram and nfs.
516c609719bSwdenk
517c609719bSwdenk- Pre-Boot Commands:
518c609719bSwdenk		CONFIG_PREBOOT
519c609719bSwdenk
520c609719bSwdenk		When this option is #defined, the existence of the
521c609719bSwdenk		environment variable "preboot" will be checked
522c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
523c609719bSwdenk		countdown and/or running the auto-boot command resp.
524c609719bSwdenk		entering interactive mode.
525c609719bSwdenk
526c609719bSwdenk		This feature is especially useful when "preboot" is
527c609719bSwdenk		automatically generated or modified. For an example
528c609719bSwdenk		see the LWMON board specific code: here "preboot" is
529c609719bSwdenk		modified when the user holds down a certain
530c609719bSwdenk		combination of keys on the (special) keyboard when
531c609719bSwdenk		booting the systems
532c609719bSwdenk
533c609719bSwdenk- Serial Download Echo Mode:
534c609719bSwdenk		CONFIG_LOADS_ECHO
535c609719bSwdenk		If defined to 1, all characters received during a
536c609719bSwdenk		serial download (using the "loads" command) are
537c609719bSwdenk		echoed back. This might be needed by some terminal
538c609719bSwdenk		emulations (like "cu"), but may as well just take
539c609719bSwdenk		time on others. This setting #define's the initial
540c609719bSwdenk		value of the "loads_echo" environment variable.
541c609719bSwdenk
542602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
543c609719bSwdenk		CONFIG_KGDB_BAUDRATE
544c609719bSwdenk		Select one of the baudrates listed in
545c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
546c609719bSwdenk
547c609719bSwdenk- Monitor Functions:
548602ad3b3SJon Loeliger		Monitor commands can be included or excluded
549602ad3b3SJon Loeliger		from the build by using the #include files
550602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
551602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
552602ad3b3SJon Loeliger		and augmenting with additional #define's
553602ad3b3SJon Loeliger		for wanted commands.
554c609719bSwdenk
555602ad3b3SJon Loeliger		The default command configuration includes all commands
556602ad3b3SJon Loeliger		except those marked below with a "*".
557602ad3b3SJon Loeliger
558602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
559602ad3b3SJon Loeliger		CONFIG_CMD_AUTOSCRIPT	  Autoscript Support
560602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
561602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
562602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
563602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
564602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
565602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
566602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
567602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
568602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
569602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
570602ad3b3SJon Loeliger		CONFIG_CMD_DOC		* Disk-On-Chip Support
571602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
572602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
573602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
574602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
575602ad3b3SJon Loeliger		CONFIG_CMD_ENV		  saveenv
576602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
577602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
578602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
579602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
580602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
581602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
582602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
583602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
584602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
585602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
586602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
587602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
588602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
589602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
590602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
591602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
592602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
593602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
59456523f12Swdenk					  loop, loopw, mtest
595602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
596602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
597602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
598602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
599602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
600602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
601602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
602602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
603602ad3b3SJon Loeliger					  host
604602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
605602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
606602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
607602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
608602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
609602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
610602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
611602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
612602ad3b3SJon Loeliger					  (4xx only)
613602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
614602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
615602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
616602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board SPecific functions
617602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
618602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
619c609719bSwdenk
620c609719bSwdenk
621c609719bSwdenk		EXAMPLE: If you want all functions except of network
622c609719bSwdenk		support you can write:
623c609719bSwdenk
624602ad3b3SJon Loeliger		#include "config_cmd_all.h"
625602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
626c609719bSwdenk
627213bf8c8SGerald Van Baren	Other Commands:
628213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
629c609719bSwdenk
630c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
631602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
632c609719bSwdenk		what you (and your U-Boot users) are doing. Data
633c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
634c609719bSwdenk		8260 (where accesses to the IMMR region must be
635c609719bSwdenk		uncached), and it cannot be disabled on all other
636c609719bSwdenk		systems where we (mis-) use the data cache to hold an
637c609719bSwdenk		initial stack and some data.
638c609719bSwdenk
639c609719bSwdenk
640c609719bSwdenk		XXX - this list needs to get updated!
641c609719bSwdenk
642c609719bSwdenk- Watchdog:
643c609719bSwdenk		CONFIG_WATCHDOG
644c609719bSwdenk		If this variable is defined, it enables watchdog
6457152b1d0Swdenk		support. There must be support in the platform specific
646c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
647c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
648c609719bSwdenk		register.
649c609719bSwdenk
650c1551ea8Sstroese- U-Boot Version:
651c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
652c1551ea8Sstroese		If this variable is defined, an environment variable
653c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
654c1551ea8Sstroese		version as printed by the "version" command.
655c1551ea8Sstroese		This variable is readonly.
656c1551ea8Sstroese
657c609719bSwdenk- Real-Time Clock:
658c609719bSwdenk
659602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
660c609719bSwdenk		has to be selected, too. Define exactly one of the
661c609719bSwdenk		following options:
662c609719bSwdenk
663c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
664c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
665c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
6661cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
667c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
6687f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
6693bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
6704c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
671c609719bSwdenk
672b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
673b37c7e5eSwdenk		must also be configured. See I2C Support, below.
674b37c7e5eSwdenk
675c609719bSwdenk- Timestamp Support:
676c609719bSwdenk
677c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
678c609719bSwdenk		(date and time) of an image is printed by image
679c609719bSwdenk		commands like bootm or iminfo. This option is
680602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
681c609719bSwdenk
682c609719bSwdenk- Partition Support:
683c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
684c609719bSwdenk		and/or CONFIG_ISO_PARTITION
685c609719bSwdenk
686602ad3b3SJon Loeliger		If IDE or SCSI support	is  enabled  (CONFIG_CMD_IDE or
687602ad3b3SJon Loeliger		CONFIG_CMD_SCSI) you must configure support for at least
688c609719bSwdenk		one partition type as well.
689c609719bSwdenk
690c609719bSwdenk- IDE Reset method:
6914d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
6924d13cbadSwdenk		board configurations files but used nowhere!
693c609719bSwdenk
6944d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
6954d13cbadSwdenk		be performed by calling the function
6964d13cbadSwdenk			ide_set_reset(int reset)
6974d13cbadSwdenk		which has to be defined in a board specific file
698c609719bSwdenk
699c609719bSwdenk- ATAPI Support:
700c609719bSwdenk		CONFIG_ATAPI
701c609719bSwdenk
702c609719bSwdenk		Set this to enable ATAPI support.
703c609719bSwdenk
704c40b2956Swdenk- LBA48 Support
705c40b2956Swdenk		CONFIG_LBA48
706c40b2956Swdenk
707c40b2956Swdenk		Set this to enable support for disks larger than 137GB
708c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
709c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
710c40b2956Swdenk		support disks up to 2.1TB.
711c40b2956Swdenk
712c40b2956Swdenk		CFG_64BIT_LBA:
713c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
714c40b2956Swdenk			Default is 32bit.
715c40b2956Swdenk
716c609719bSwdenk- SCSI Support:
717c609719bSwdenk		At the moment only there is only support for the
718c609719bSwdenk		SYM53C8XX SCSI controller; define
719c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
720c609719bSwdenk
721c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
722c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
723c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
724c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
725c609719bSwdenk		devices.
726c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
727c609719bSwdenk
728c609719bSwdenk- NETWORK Support (PCI):
729682011ffSwdenk		CONFIG_E1000
730682011ffSwdenk		Support for Intel 8254x gigabit chips.
731682011ffSwdenk
732c609719bSwdenk		CONFIG_EEPRO100
733c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
734c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
735c609719bSwdenk		write routine for first time initialisation.
736c609719bSwdenk
737c609719bSwdenk		CONFIG_TULIP
738c609719bSwdenk		Support for Digital 2114x chips.
739c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
740c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
741c609719bSwdenk
742c609719bSwdenk		CONFIG_NATSEMI
743c609719bSwdenk		Support for National dp83815 chips.
744c609719bSwdenk
745c609719bSwdenk		CONFIG_NS8382X
746c609719bSwdenk		Support for National dp8382[01] gigabit chips.
747c609719bSwdenk
74845219c46Swdenk- NETWORK Support (other):
74945219c46Swdenk
75045219c46Swdenk		CONFIG_DRIVER_LAN91C96
75145219c46Swdenk		Support for SMSC's LAN91C96 chips.
75245219c46Swdenk
75345219c46Swdenk			CONFIG_LAN91C96_BASE
75445219c46Swdenk			Define this to hold the physical address
75545219c46Swdenk			of the LAN91C96's I/O space
75645219c46Swdenk
75745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
75845219c46Swdenk			Define this to enable 32 bit addressing
75945219c46Swdenk
760f39748aeSwdenk		CONFIG_DRIVER_SMC91111
761f39748aeSwdenk		Support for SMSC's LAN91C111 chip
762f39748aeSwdenk
763f39748aeSwdenk			CONFIG_SMC91111_BASE
764f39748aeSwdenk			Define this to hold the physical address
765f39748aeSwdenk			of the device (I/O space)
766f39748aeSwdenk
767f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
768f39748aeSwdenk			Define this if data bus is 32 bits
769f39748aeSwdenk
770f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
771f39748aeSwdenk			Define this to use i/o functions instead of macros
772f39748aeSwdenk			(some hardware wont work with macros)
773f39748aeSwdenk
774c609719bSwdenk- USB Support:
775c609719bSwdenk		At the moment only the UHCI host controller is
7764d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
777c609719bSwdenk		CONFIG_USB_UHCI to enable it.
778c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
77930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
780c609719bSwdenk		storage devices.
781c609719bSwdenk		Note:
782c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
783c609719bSwdenk		(TEAC FD-05PUB).
7844d13cbadSwdenk		MPC5200 USB requires additional defines:
7854d13cbadSwdenk			CONFIG_USB_CLOCK
7864d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
7874d13cbadSwdenk			CONFIG_USB_CONFIG
7884d13cbadSwdenk				for differential drivers: 0x00001000
7894d13cbadSwdenk				for single ended drivers: 0x00005000
790fdcfaa1bSZhang Wei			CFG_USB_EVENT_POLL
791fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
792fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
7934d13cbadSwdenk
79416c8d5e7SWolfgang Denk- USB Device:
79516c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
79616c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
79716c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
79816c8d5e7SWolfgang Denk		attach your usb cable. The Unix command "dmesg" should print
79916c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
80016c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
80116c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
80216c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
80316c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
80416c8d5e7SWolfgang Denk		a Linux host by
80516c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
80616c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
80716c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
80816c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
80916c8d5e7SWolfgang Denk
81016c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
81116c8d5e7SWolfgang Denk			Define this to build a UDC device
81216c8d5e7SWolfgang Denk
81316c8d5e7SWolfgang Denk			CONFIG_USB_TTY
81416c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
81516c8d5e7SWolfgang Denk			talk to the UDC device
81616c8d5e7SWolfgang Denk
81716c8d5e7SWolfgang Denk			CFG_CONSOLE_IS_IN_ENV
81816c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
81916c8d5e7SWolfgang Denk			be set to usbtty.
82016c8d5e7SWolfgang Denk
82116c8d5e7SWolfgang Denk			mpc8xx:
82216c8d5e7SWolfgang Denk				CFG_USB_EXTC_CLK 0xBLAH
82316c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
82416c8d5e7SWolfgang Denk				- CFG_USB_EXTC_CLK 0x02
82516c8d5e7SWolfgang Denk
82616c8d5e7SWolfgang Denk				CFG_USB_BRG_CLK 0xBLAH
82716c8d5e7SWolfgang Denk				Derive USB clock from brgclk
82816c8d5e7SWolfgang Denk				- CFG_USB_BRG_CLK 0x04
82916c8d5e7SWolfgang Denk
83016c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
83116c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
83216c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
83316c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
83416c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
83516c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
83616c8d5e7SWolfgang Denk
83716c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
83816c8d5e7SWolfgang Denk			Define this string as the name of your company for
83916c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
84016c8d5e7SWolfgang Denk
84116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
84216c8d5e7SWolfgang Denk			Define this string as the name of your product
84316c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
84416c8d5e7SWolfgang Denk
84516c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
84616c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
84716c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
84816c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
84916c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
85016c8d5e7SWolfgang Denk
85116c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
85216c8d5e7SWolfgang Denk			Define this as the unique Product ID
85316c8d5e7SWolfgang Denk			for your device
85416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
855c609719bSwdenk
856c609719bSwdenk
857c609719bSwdenk- MMC Support:
858c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
859c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
860c609719bSwdenk		accessed from the boot prompt by mapping the device
861c609719bSwdenk		to physical memory similar to flash. Command line is
862602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
863602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
864c609719bSwdenk
8656705d81eSwdenk- Journaling Flash filesystem support:
8666705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8676705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8686705d81eSwdenk		Define these for a default partition on a NAND device
8696705d81eSwdenk
8706705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8716705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8726705d81eSwdenk		Define these for a default partition on a NOR device
8736705d81eSwdenk
8746705d81eSwdenk		CFG_JFFS_CUSTOM_PART
8756705d81eSwdenk		Define this to create an own partition. You have to provide a
8766705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
8776705d81eSwdenk
8786705d81eSwdenk		If you define only one JFFS2 partition you may also want to
8796705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
8806705d81eSwdenk		to disable the command chpart. This is the default when you
8816705d81eSwdenk		have not defined a custom partition
8826705d81eSwdenk
883c609719bSwdenk- Keyboard Support:
884c609719bSwdenk		CONFIG_ISA_KEYBOARD
885c609719bSwdenk
886c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
887c609719bSwdenk		support
888c609719bSwdenk
889c609719bSwdenk		CONFIG_I8042_KBD
890c609719bSwdenk		Standard PC keyboard driver with US (is default) and
891c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
892c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
893c609719bSwdenk		for cfb_console. Supports cursor blinking.
894c609719bSwdenk
895c609719bSwdenk- Video support:
896c609719bSwdenk		CONFIG_VIDEO
897c609719bSwdenk
898c609719bSwdenk		Define this to enable video support (for output to
899c609719bSwdenk		video).
900c609719bSwdenk
901c609719bSwdenk		CONFIG_VIDEO_CT69000
902c609719bSwdenk
903c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
904c609719bSwdenk
905c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
906eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
907eeb1b77bSwdenk		video output is selected via environment 'videoout'
908eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
909eeb1b77bSwdenk		assumed.
910c609719bSwdenk
911eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
912eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
913eeb1b77bSwdenk		are possible:
914eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
915eeb1b77bSwdenk		Following standard modes are supported	(* is default):
916eeb1b77bSwdenk
917eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
918eeb1b77bSwdenk		-------------+---------------------------------------------
919eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
920eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
921eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
922eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
923eeb1b77bSwdenk		-------------+---------------------------------------------
924c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
925c609719bSwdenk
926eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
927*7817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
928eeb1b77bSwdenk
929eeb1b77bSwdenk
930a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
931a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
932a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
933a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
934a6c7ad2fSwdenk
935682011ffSwdenk- Keyboard Support:
936682011ffSwdenk		CONFIG_KEYBOARD
937682011ffSwdenk
938682011ffSwdenk		Define this to enable a custom keyboard support.
939682011ffSwdenk		This simply calls drv_keyboard_init() which must be
940682011ffSwdenk		defined in your board-specific files.
941682011ffSwdenk		The only board using this so far is RBC823.
942a6c7ad2fSwdenk
943c609719bSwdenk- LCD Support:	CONFIG_LCD
944c609719bSwdenk
945c609719bSwdenk		Define this to enable LCD support (for output to LCD
946c609719bSwdenk		display); also select one of the supported displays
947c609719bSwdenk		by defining one of these:
948c609719bSwdenk
949fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
950c609719bSwdenk
951fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
952c609719bSwdenk
953fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
954c609719bSwdenk
955fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
956fd3103bbSwdenk			Active, color, single scan.
957fd3103bbSwdenk
958fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
959fd3103bbSwdenk
960fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
961c609719bSwdenk			Active, color, single scan.
962c609719bSwdenk
963c609719bSwdenk		CONFIG_SHARP_16x9
964c609719bSwdenk
965c609719bSwdenk			Sharp 320x240. Active, color, single scan.
966c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
967c609719bSwdenk
968c609719bSwdenk		CONFIG_SHARP_LQ64D341
969c609719bSwdenk
970c609719bSwdenk			Sharp LQ64D341 display, 640x480.
971c609719bSwdenk			Active, color, single scan.
972c609719bSwdenk
973c609719bSwdenk		CONFIG_HLD1045
974c609719bSwdenk
975c609719bSwdenk			HLD1045 display, 640x480.
976c609719bSwdenk			Active, color, single scan.
977c609719bSwdenk
978c609719bSwdenk		CONFIG_OPTREX_BW
979c609719bSwdenk
980c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
981c609719bSwdenk			or
982c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
983c609719bSwdenk			or
984c609719bSwdenk			Hitachi	 SP14Q002
985c609719bSwdenk
986c609719bSwdenk			320x240. Black & white.
987c609719bSwdenk
988c609719bSwdenk		Normally display is black on white background; define
989c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
990c609719bSwdenk
9917152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
992d791b1dcSwdenk
993d791b1dcSwdenk		If this option is set, the environment is checked for
994d791b1dcSwdenk		a variable "splashimage". If found, the usual display
995d791b1dcSwdenk		of logo, copyright and system information on the LCD
996e94d2cd9Swdenk		is suppressed and the BMP image at the address
997d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
998d791b1dcSwdenk		console is redirected to the "nulldev", too. This
999d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1000d791b1dcSwdenk		loaded very quickly after power-on.
1001d791b1dcSwdenk
100298f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
100398f4a3dfSStefan Roese
100498f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
100598f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
100698f4a3dfSStefan Roese		splashscreen support or the bmp command.
100798f4a3dfSStefan Roese
1008c29fdfc1Swdenk- Compression support:
1009c29fdfc1Swdenk		CONFIG_BZIP2
1010c29fdfc1Swdenk
1011c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1012c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1013c29fdfc1Swdenk		compressed images are supported.
1014c29fdfc1Swdenk
1015c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1016c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1017c29fdfc1Swdenk		be at least 4MB.
1018d791b1dcSwdenk
101917ea1177Swdenk- MII/PHY support:
102017ea1177Swdenk		CONFIG_PHY_ADDR
102117ea1177Swdenk
102217ea1177Swdenk		The address of PHY on MII bus.
102317ea1177Swdenk
102417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
102517ea1177Swdenk
102617ea1177Swdenk		The clock frequency of the MII bus
102717ea1177Swdenk
102817ea1177Swdenk		CONFIG_PHY_GIGE
102917ea1177Swdenk
103017ea1177Swdenk		If this option is set, support for speed/duplex
103117ea1177Swdenk		detection of Gigabit PHY is included.
103217ea1177Swdenk
103317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
103417ea1177Swdenk
103517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
103617ea1177Swdenk		reset before any MII register access is possible.
103717ea1177Swdenk		For such PHY, set this option to the usec delay
103817ea1177Swdenk		required. (minimum 300usec for LXT971A)
103917ea1177Swdenk
104017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
104117ea1177Swdenk
104217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
104317ea1177Swdenk		command issued before MII status register can be read
104417ea1177Swdenk
1045c609719bSwdenk- Ethernet address:
1046c609719bSwdenk		CONFIG_ETHADDR
1047c609719bSwdenk		CONFIG_ETH2ADDR
1048c609719bSwdenk		CONFIG_ETH3ADDR
1049c609719bSwdenk
1050c609719bSwdenk		Define a default value for ethernet address to use
1051c609719bSwdenk		for the respective ethernet interface, in case this
1052c609719bSwdenk		is not determined automatically.
1053c609719bSwdenk
1054c609719bSwdenk- IP address:
1055c609719bSwdenk		CONFIG_IPADDR
1056c609719bSwdenk
1057c609719bSwdenk		Define a default value for the IP address to use for
1058c609719bSwdenk		the default ethernet interface, in case this is not
1059c609719bSwdenk		determined through e.g. bootp.
1060c609719bSwdenk
1061c609719bSwdenk- Server IP address:
1062c609719bSwdenk		CONFIG_SERVERIP
1063c609719bSwdenk
1064c609719bSwdenk		Defines a default value for theIP address of a TFTP
1065c609719bSwdenk		server to contact when using the "tftboot" command.
1066c609719bSwdenk
106753a5c424SDavid Updegraff- Multicast TFTP Mode:
106853a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
106953a5c424SDavid Updegraff
107053a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
107153a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
107253a5c424SDavid Updegraff		tftp down the same boot image concurrently.  Note: the ethernet
107353a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
107453a5c424SDavid Updegraff		multicast group.
107553a5c424SDavid Updegraff
107653a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1077c609719bSwdenk- BOOTP Recovery Mode:
1078c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1079c609719bSwdenk
1080c609719bSwdenk		If you have many targets in a network that try to
1081c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1082c609719bSwdenk		systems send out BOOTP requests at precisely the same
1083c609719bSwdenk		moment (which would happen for instance at recovery
1084c609719bSwdenk		from a power failure, when all systems will try to
1085c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1086c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1087c609719bSwdenk		inserted before sending out BOOTP requests. The
10886c33c785SWolfgang Denk		following delays are inserted then:
1089c609719bSwdenk
1090c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1091c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1092c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1093c609719bSwdenk		4th and following
1094c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1095c609719bSwdenk
1096fe389a82Sstroese- DHCP Advanced Options:
10971fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
10981fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1099fe389a82Sstroese
11001fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
11011fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
11021fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
11031fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
11041fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
11051fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
11061fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
11071fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
11081fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
11091fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
11101fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
11111fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1112fe389a82Sstroese
11135d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
11145d110f0aSWilson Callan		environment variable, not the BOOTP server.
1115fe389a82Sstroese
1116fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1117fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1118fe389a82Sstroese		than one DNS serverip is offered to the client.
1119fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1120fe389a82Sstroese		serverip will be stored in the additional environment
1121fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1122fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
11231fe80d79SJon Loeliger		is defined.
1124fe389a82Sstroese
1125fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1126fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1127fe389a82Sstroese		need the hostname of the DHCP requester.
11285d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
11291fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
11301fe80d79SJon Loeliger		option 12 to the DHCP server.
1131fe389a82Sstroese
1132a3d991bdSwdenk - CDP Options:
1133a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1134a3d991bdSwdenk
1135a3d991bdSwdenk		The device id used in CDP trigger frames.
1136a3d991bdSwdenk
1137a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1138a3d991bdSwdenk
1139a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1140a3d991bdSwdenk		of the device.
1141a3d991bdSwdenk
1142a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1143a3d991bdSwdenk
1144a3d991bdSwdenk		A printf format string which contains the ascii name of
1145a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1146a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1147a3d991bdSwdenk
1148a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1149a3d991bdSwdenk
1150a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1151a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1152a3d991bdSwdenk
1153a3d991bdSwdenk		CONFIG_CDP_VERSION
1154a3d991bdSwdenk
1155a3d991bdSwdenk		An ascii string containing the version of the software.
1156a3d991bdSwdenk
1157a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1158a3d991bdSwdenk
1159a3d991bdSwdenk		An ascii string containing the name of the platform.
1160a3d991bdSwdenk
1161a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1162a3d991bdSwdenk
1163a3d991bdSwdenk		A 32bit integer sent on the trigger.
1164a3d991bdSwdenk
1165a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1166a3d991bdSwdenk
1167a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1168a3d991bdSwdenk		device in .1 of milliwatts.
1169a3d991bdSwdenk
1170a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1171a3d991bdSwdenk
1172a3d991bdSwdenk		A byte containing the id of the VLAN.
1173a3d991bdSwdenk
1174c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1175c609719bSwdenk
1176c609719bSwdenk		Several configurations allow to display the current
1177c609719bSwdenk		status using a LED. For instance, the LED will blink
1178c609719bSwdenk		fast while running U-Boot code, stop blinking as
1179c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1180c609719bSwdenk		start blinking slow once the Linux kernel is running
1181c609719bSwdenk		(supported by a status LED driver in the Linux
1182c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1183c609719bSwdenk		feature in U-Boot.
1184c609719bSwdenk
1185c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1186c609719bSwdenk
1187c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1188c609719bSwdenk		on those systems that support this (optional)
1189c609719bSwdenk		feature, like the TQM8xxL modules.
1190c609719bSwdenk
1191c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1192c609719bSwdenk
1193b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1194b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1195b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1196c609719bSwdenk
1197b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1198602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1199b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1200b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1201c609719bSwdenk		command line interface.
1202c609719bSwdenk
1203bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1204bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1205bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1206bb99ad6dSBen Warren		deprecated and may disappear in the future.
1207bb99ad6dSBen Warren
1208bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1209c609719bSwdenk
1210b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1211b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1212b37c7e5eSwdenk		support for I2C.
1213c609719bSwdenk
1214b37c7e5eSwdenk		There are several other quantities that must also be
1215b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1216c609719bSwdenk
1217b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1218b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1219b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1220b37c7e5eSwdenk		the cpu's i2c node address).
1221c609719bSwdenk
1222b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1223b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1224b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1225b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1226b37c7e5eSwdenk
1227b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1228b37c7e5eSwdenk
1229b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1230b37c7e5eSwdenk		then the following macros need to be defined (examples are
1231b37c7e5eSwdenk		from include/configs/lwmon.h):
1232c609719bSwdenk
1233c609719bSwdenk		I2C_INIT
1234c609719bSwdenk
1235b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1236c609719bSwdenk		controller or configure ports.
1237c609719bSwdenk
1238b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1239b37c7e5eSwdenk
1240c609719bSwdenk		I2C_PORT
1241c609719bSwdenk
1242c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1243c609719bSwdenk		assumes both bits are on the same port). Valid values
1244c609719bSwdenk		are 0..3 for ports A..D.
1245c609719bSwdenk
1246c609719bSwdenk		I2C_ACTIVE
1247c609719bSwdenk
1248c609719bSwdenk		The code necessary to make the I2C data line active
1249c609719bSwdenk		(driven).  If the data line is open collector, this
1250c609719bSwdenk		define can be null.
1251c609719bSwdenk
1252b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1253b37c7e5eSwdenk
1254c609719bSwdenk		I2C_TRISTATE
1255c609719bSwdenk
1256c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1257c609719bSwdenk		(inactive).  If the data line is open collector, this
1258c609719bSwdenk		define can be null.
1259c609719bSwdenk
1260b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1261b37c7e5eSwdenk
1262c609719bSwdenk		I2C_READ
1263c609719bSwdenk
1264c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1265c609719bSwdenk		FALSE if it is low.
1266c609719bSwdenk
1267b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1268b37c7e5eSwdenk
1269c609719bSwdenk		I2C_SDA(bit)
1270c609719bSwdenk
1271c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1272c609719bSwdenk		is FALSE, it clears it (low).
1273c609719bSwdenk
1274b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1275b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1276b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1277b37c7e5eSwdenk
1278c609719bSwdenk		I2C_SCL(bit)
1279c609719bSwdenk
1280c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1281c609719bSwdenk		is FALSE, it clears it (low).
1282c609719bSwdenk
1283b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1284b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1285b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1286b37c7e5eSwdenk
1287c609719bSwdenk		I2C_DELAY
1288c609719bSwdenk
1289c609719bSwdenk		This delay is invoked four times per clock cycle so this
1290c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1291b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1292b37c7e5eSwdenk		like:
1293b37c7e5eSwdenk
1294b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1295c609719bSwdenk
129647cd00faSwdenk		CFG_I2C_INIT_BOARD
129747cd00faSwdenk
129847cd00faSwdenk		When a board is reset during an i2c bus transfer
129947cd00faSwdenk		chips might think that the current transfer is still
130047cd00faSwdenk		in progress. On some boards it is possible to access
130147cd00faSwdenk		the i2c SCLK line directly, either by using the
130247cd00faSwdenk		processor pin as a GPIO or by having a second pin
130347cd00faSwdenk		connected to the bus. If this option is defined a
130447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
130547cd00faSwdenk		is run early in the boot sequence.
130647cd00faSwdenk
130717ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
130817ea1177Swdenk
130917ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
131017ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
131117ea1177Swdenk		variable "i2cfast". (see also i2cfast)
131217ea1177Swdenk
1313bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1314bb99ad6dSBen Warren
1315bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1316bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1317bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1318bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1319bb99ad6dSBen Warren
1320bb99ad6dSBen Warren		CFG_I2C_NOPROBES
1321bb99ad6dSBen Warren
1322bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1323bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1324bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1325bb99ad6dSBen Warren		pairs.  Otherwise, specify a 1D array of device addresses
1326bb99ad6dSBen Warren
1327bb99ad6dSBen Warren		e.g.
1328bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1329bb99ad6dSBen Warren			#define CFG_I2C_NOPROBES	{0x50,0x68}
1330bb99ad6dSBen Warren
1331bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1332bb99ad6dSBen Warren
1333bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1334bb99ad6dSBen Warren			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1335bb99ad6dSBen Warren
1336bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1337bb99ad6dSBen Warren
1338be5e6181STimur Tabi		CFG_SPD_BUS_NUM
1339be5e6181STimur Tabi
1340be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1341be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1342be5e6181STimur Tabi
13430dc018ecSStefan Roese		CFG_RTC_BUS_NUM
13440dc018ecSStefan Roese
13450dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
13460dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
13470dc018ecSStefan Roese
13480dc018ecSStefan Roese		CFG_DTT_BUS_NUM
13490dc018ecSStefan Roese
13500dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
13510dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
13520dc018ecSStefan Roese
1353be5e6181STimur Tabi		CONFIG_FSL_I2C
1354be5e6181STimur Tabi
1355be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
1356*7817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1357be5e6181STimur Tabi
1358be5e6181STimur Tabi
1359c609719bSwdenk- SPI Support:	CONFIG_SPI
1360c609719bSwdenk
1361c609719bSwdenk		Enables SPI driver (so far only tested with
1362c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1363c609719bSwdenk		D/As on the SACSng board)
1364c609719bSwdenk
1365c609719bSwdenk		CONFIG_SPI_X
1366c609719bSwdenk
1367c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1368c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1369c609719bSwdenk
1370c609719bSwdenk		CONFIG_SOFT_SPI
1371c609719bSwdenk
1372c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1373c609719bSwdenk		using hardware support. This is a general purpose
1374c609719bSwdenk		driver that only requires three general I/O port pins
1375c609719bSwdenk		(two outputs, one input) to function. If this is
1376c609719bSwdenk		defined, the board configuration must define several
1377c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1378c609719bSwdenk		an example, see include/configs/sacsng.h.
1379c609719bSwdenk
13800133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
13810133502eSMatthias Fuchs
13820133502eSMatthias Fuchs		Enables FPGA subsystem.
13830133502eSMatthias Fuchs
13840133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
13850133502eSMatthias Fuchs
13860133502eSMatthias Fuchs		Enables support for specific chip vendors.
13870133502eSMatthias Fuchs		(ALTERA, XILINX)
13880133502eSMatthias Fuchs
13890133502eSMatthias Fuchs		CONFIG_FPGA_<family>
13900133502eSMatthias Fuchs
13910133502eSMatthias Fuchs		Enables support for FPGA family.
13920133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
13930133502eSMatthias Fuchs
13940133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1395c609719bSwdenk
1396c609719bSwdenk		Specify the number of FPGA devices to support.
1397c609719bSwdenk
1398c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1399c609719bSwdenk
1400c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1401c609719bSwdenk
1402c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1403c609719bSwdenk
1404c609719bSwdenk		Enable checks on FPGA configuration interface busy
1405c609719bSwdenk		status by the configuration function. This option
1406c609719bSwdenk		will require a board or device specific function to
1407c609719bSwdenk		be written.
1408c609719bSwdenk
1409c609719bSwdenk		CONFIG_FPGA_DELAY
1410c609719bSwdenk
1411c609719bSwdenk		If defined, a function that provides delays in the FPGA
1412c609719bSwdenk		configuration driver.
1413c609719bSwdenk
1414c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1415c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1416c609719bSwdenk
1417c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1418c609719bSwdenk
1419c609719bSwdenk		Check for configuration errors during FPGA bitfile
1420c609719bSwdenk		loading. For example, abort during Virtex II
1421c609719bSwdenk		configuration if the INIT_B line goes low (which
1422c609719bSwdenk		indicated a CRC error).
1423c609719bSwdenk
1424c609719bSwdenk		CFG_FPGA_WAIT_INIT
1425c609719bSwdenk
1426c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1427c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1428c609719bSwdenk		FPGA configuration sequence. The default time is 500
1429c609719bSwdenk		mS.
1430c609719bSwdenk
1431c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1432c609719bSwdenk
1433c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1434c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1435c609719bSwdenk
1436c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1437c609719bSwdenk
1438c609719bSwdenk		Time to wait after FPGA configuration. The default is
1439c609719bSwdenk		200 mS.
1440c609719bSwdenk
1441c609719bSwdenk- Configuration Management:
1442c609719bSwdenk		CONFIG_IDENT_STRING
1443c609719bSwdenk
1444c609719bSwdenk		If defined, this string will be added to the U-Boot
1445c609719bSwdenk		version information (U_BOOT_VERSION)
1446c609719bSwdenk
1447c609719bSwdenk- Vendor Parameter Protection:
1448c609719bSwdenk
1449c609719bSwdenk		U-Boot considers the values of the environment
1450c609719bSwdenk		variables "serial#" (Board Serial Number) and
14517152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1452c609719bSwdenk		are set once by the board vendor / manufacturer, and
1453c609719bSwdenk		protects these variables from casual modification by
1454c609719bSwdenk		the user. Once set, these variables are read-only,
1455c609719bSwdenk		and write or delete attempts are rejected. You can
1456c609719bSwdenk		change this behviour:
1457c609719bSwdenk
1458c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1459c609719bSwdenk		file, the write protection for vendor parameters is
146047cd00faSwdenk		completely disabled. Anybody can change or delete
1461c609719bSwdenk		these parameters.
1462c609719bSwdenk
1463c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1464c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1465c609719bSwdenk		ethernet address is installed in the environment,
1466c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1467c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1468c609719bSwdenk		read-only.]
1469c609719bSwdenk
1470c609719bSwdenk- Protected RAM:
1471c609719bSwdenk		CONFIG_PRAM
1472c609719bSwdenk
1473c609719bSwdenk		Define this variable to enable the reservation of
1474c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1475c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1476c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1477c609719bSwdenk		this default value by defining an environment
1478c609719bSwdenk		variable "pram" to the number of kB you want to
1479c609719bSwdenk		reserve. Note that the board info structure will
1480c609719bSwdenk		still show the full amount of RAM. If pRAM is
1481c609719bSwdenk		reserved, a new environment variable "mem" will
1482c609719bSwdenk		automatically be defined to hold the amount of
1483c609719bSwdenk		remaining RAM in a form that can be passed as boot
1484c609719bSwdenk		argument to Linux, for instance like that:
1485c609719bSwdenk
1486fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1487c609719bSwdenk			saveenv
1488c609719bSwdenk
1489c609719bSwdenk		This way you can tell Linux not to use this memory,
1490c609719bSwdenk		either, which results in a memory region that will
1491c609719bSwdenk		not be affected by reboots.
1492c609719bSwdenk
1493c609719bSwdenk		*WARNING* If your board configuration uses automatic
1494c609719bSwdenk		detection of the RAM size, you must make sure that
1495c609719bSwdenk		this memory test is non-destructive. So far, the
1496c609719bSwdenk		following board configurations are known to be
1497c609719bSwdenk		"pRAM-clean":
1498c609719bSwdenk
1499c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1500c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1501c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1502c609719bSwdenk
1503c609719bSwdenk- Error Recovery:
1504c609719bSwdenk		CONFIG_PANIC_HANG
1505c609719bSwdenk
1506c609719bSwdenk		Define this variable to stop the system in case of a
1507c609719bSwdenk		fatal error, so that you have to reset it manually.
1508c609719bSwdenk		This is probably NOT a good idea for an embedded
1509c609719bSwdenk		system where you want to system to reboot
1510c609719bSwdenk		automatically as fast as possible, but it may be
1511c609719bSwdenk		useful during development since you can try to debug
1512c609719bSwdenk		the conditions that lead to the situation.
1513c609719bSwdenk
1514c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1515c609719bSwdenk
1516c609719bSwdenk		This variable defines the number of retries for
1517c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1518c609719bSwdenk		before giving up the operation. If not defined, a
1519c609719bSwdenk		default value of 5 is used.
1520c609719bSwdenk
1521c609719bSwdenk- Command Interpreter:
15228078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
152304a85b3bSwdenk
152404a85b3bSwdenk		Enable auto completion of commands using TAB.
152504a85b3bSwdenk
15268078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
15278078f1a5SWolfgang Denk		for the "hush" shell.
15288078f1a5SWolfgang Denk
15298078f1a5SWolfgang Denk
1530c609719bSwdenk		CFG_HUSH_PARSER
1531c609719bSwdenk
1532c609719bSwdenk		Define this variable to enable the "hush" shell (from
1533c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1534c609719bSwdenk		powerful command line syntax like
1535c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1536c609719bSwdenk		constructs ("shell scripts").
1537c609719bSwdenk
1538c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1539c609719bSwdenk		with a somewhat smaller memory footprint.
1540c609719bSwdenk
1541c609719bSwdenk
1542c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1543c609719bSwdenk
1544c609719bSwdenk		This defines the secondary prompt string, which is
1545c609719bSwdenk		printed when the command interpreter needs more input
1546c609719bSwdenk		to complete a command. Usually "> ".
1547c609719bSwdenk
1548c609719bSwdenk	Note:
1549c609719bSwdenk
1550c609719bSwdenk		In the current implementation, the local variables
1551c609719bSwdenk		space and global environment variables space are
1552c609719bSwdenk		separated. Local variables are those you define by
15533b57fe0aSwdenk		simply typing `name=value'. To access a local
1554c609719bSwdenk		variable later on, you have write `$name' or
15553b57fe0aSwdenk		`${name}'; to execute the contents of a variable
15563b57fe0aSwdenk		directly type `$name' at the command prompt.
1557c609719bSwdenk
1558c609719bSwdenk		Global environment variables are those you use
1559c609719bSwdenk		setenv/printenv to work with. To run a command stored
1560c609719bSwdenk		in such a variable, you need to use the run command,
1561c609719bSwdenk		and you must not use the '$' sign to access them.
1562c609719bSwdenk
1563c609719bSwdenk		To store commands and special characters in a
1564c609719bSwdenk		variable, please use double quotation marks
1565c609719bSwdenk		surrounding the whole text of the variable, instead
1566c609719bSwdenk		of the backslashes before semicolons and special
1567c609719bSwdenk		symbols.
1568c609719bSwdenk
1569aa0c71acSWolfgang Denk- Commandline Editing and History:
1570aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1571aa0c71acSWolfgang Denk
1572aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1573aa0c71acSWolfgang Denk		commandline input operations
1574aa0c71acSWolfgang Denk
1575a8c7c708Swdenk- Default Environment:
1576c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1577c609719bSwdenk
1578c609719bSwdenk		Define this to contain any number of null terminated
1579c609719bSwdenk		strings (variable = value pairs) that will be part of
15807152b1d0Swdenk		the default environment compiled into the boot image.
15812262cfeeSwdenk
1582c609719bSwdenk		For example, place something like this in your
1583c609719bSwdenk		board's config file:
1584c609719bSwdenk
1585c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1586c609719bSwdenk			"myvar1=value1\0" \
1587c609719bSwdenk			"myvar2=value2\0"
1588c609719bSwdenk
1589c609719bSwdenk		Warning: This method is based on knowledge about the
1590c609719bSwdenk		internal format how the environment is stored by the
15912262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1592c609719bSwdenk		interface! Although it is unlikely that this format
15937152b1d0Swdenk		will change soon, there is no guarantee either.
1594c609719bSwdenk		You better know what you are doing here.
1595c609719bSwdenk
1596c609719bSwdenk		Note: overly (ab)use of the default environment is
1597c609719bSwdenk		discouraged. Make sure to check other ways to preset
1598c609719bSwdenk		the environment like the autoscript function or the
1599c609719bSwdenk		boot command first.
1600c609719bSwdenk
1601a8c7c708Swdenk- DataFlash Support:
16022abbe075Swdenk		CONFIG_HAS_DATAFLASH
16032abbe075Swdenk
16042abbe075Swdenk		Defining this option enables DataFlash features and
16052abbe075Swdenk		allows to read/write in Dataflash via the standard
16062abbe075Swdenk		commands cp, md...
16072abbe075Swdenk
16083f85ce27Swdenk- SystemACE Support:
16093f85ce27Swdenk		CONFIG_SYSTEMACE
16103f85ce27Swdenk
16113f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
16123f85ce27Swdenk		chips attached via some sort of local bus. The address
16133f85ce27Swdenk		of the chip must alsh be defined in the
16143f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
16153f85ce27Swdenk
16163f85ce27Swdenk		#define CONFIG_SYSTEMACE
16173f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
16183f85ce27Swdenk
16193f85ce27Swdenk		When SystemACE support is added, the "ace" device type
16203f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
16213f85ce27Swdenk
1622ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1623ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1624ecb0ccd9SWolfgang Denk
162528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1626ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
162728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1628ecb0ccd9SWolfgang Denk		number generator is used.
1629ecb0ccd9SWolfgang Denk
163028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
163128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
163228cb9375SWolfgang Denk		defined, the normal port 69 is used.
163328cb9375SWolfgang Denk
163428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1635ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1636ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1637ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1638ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1639ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1640ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1641ecb0ccd9SWolfgang Denk
1642a8c7c708Swdenk- Show boot progress:
1643c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1644c609719bSwdenk
1645c609719bSwdenk		Defining this option allows to add some board-
1646c609719bSwdenk		specific code (calling a user-provided function
1647c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1648c609719bSwdenk		the system's boot progress on some display (for
1649c609719bSwdenk		example, some LED's) on your board. At the moment,
1650c609719bSwdenk		the following checkpoints are implemented:
1651c609719bSwdenk
1652c609719bSwdenk  Arg	Where			When
1653c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1654c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1655c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1656c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1657c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1658c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1659c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1660c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1661c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1662c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1663c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1664c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1665c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1666c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1667c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1668c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1669c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1670c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1671c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1672c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1673c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1674c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1675c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1676c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1677c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1678c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1679c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1680c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1681c609719bSwdenk
168263e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
168363e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
168463e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
168563e73c9aSwdenk
1686566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1687566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1688566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1689566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1690566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1691566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1692566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1693566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1694566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1695566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1696566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1697566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1698566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1699566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1700566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1701566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1702566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1703566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1704566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1705566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1706566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1707566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1708566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1709566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1710566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1711566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1712566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1713566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1714566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1715566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1716566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1717566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1718566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1719566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1720566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1721566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1722566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1723566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1724566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1725566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1726566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1727566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1728566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1729566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1730566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1731566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1732566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1733c609719bSwdenk
1734566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1735c609719bSwdenk
1736566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernetconfiguration.
1737566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
1738566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
1739206c60cbSwdenk
1740566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
1741566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
1742566a494fSHeiko Schocher  -81	common/cmd_net.c	some error in NetLoop() occured
1743566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
1744566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
1745566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
1746566a494fSHeiko Schocher   83	common/cmd_net.c	running autoscript
1747566a494fSHeiko Schocher  -83	common/cmd_net.c	some error in automatic boot or autoscript
1748566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
1749c609719bSwdenk
1750c609719bSwdenkModem Support:
1751c609719bSwdenk--------------
1752c609719bSwdenk
175385ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1754c609719bSwdenk
1755c609719bSwdenk- Modem support endable:
1756c609719bSwdenk		CONFIG_MODEM_SUPPORT
1757c609719bSwdenk
1758c609719bSwdenk- RTS/CTS Flow control enable:
1759c609719bSwdenk		CONFIG_HWFLOW
1760c609719bSwdenk
1761c609719bSwdenk- Modem debug support:
1762c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1763c609719bSwdenk
1764c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1765c609719bSwdenk		for modem support. Useful only with BDI2000.
1766c609719bSwdenk
1767a8c7c708Swdenk- Interrupt support (PPC):
1768a8c7c708Swdenk
1769a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1770a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1771a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1772a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1773a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1774a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1775a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1776a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1777a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1778a8c7c708Swdenk		general timer_interrupt().
1779a8c7c708Swdenk
1780c609719bSwdenk- General:
1781c609719bSwdenk
1782c609719bSwdenk		In the target system modem support is enabled when a
1783c609719bSwdenk		specific key (key combination) is pressed during
1784c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1785c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1786c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1787c609719bSwdenk		function, returning 1 and thus enabling modem
1788c609719bSwdenk		initialization.
1789c609719bSwdenk
1790c609719bSwdenk		If there are no modem init strings in the
1791c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1792c609719bSwdenk		previous output (banner, info printfs) will be
1793c609719bSwdenk		supressed, though.
1794c609719bSwdenk
1795c609719bSwdenk		See also: doc/README.Modem
1796c609719bSwdenk
1797c609719bSwdenk
1798c609719bSwdenkConfiguration Settings:
1799c609719bSwdenk-----------------------
1800c609719bSwdenk
1801c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1802c609719bSwdenk		undefine this when you're short of memory.
1803c609719bSwdenk
1804c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1805c609719bSwdenk		prompt for user input.
1806c609719bSwdenk
1807c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1808c609719bSwdenk
1809c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1810c609719bSwdenk
1811c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1812c609719bSwdenk
1813c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1814c609719bSwdenk		the application (usually a Linux kernel) when it is
1815c609719bSwdenk		booted
1816c609719bSwdenk
1817c609719bSwdenk- CFG_BAUDRATE_TABLE:
1818c609719bSwdenk		List of legal baudrate settings for this board.
1819c609719bSwdenk
1820c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1821c609719bSwdenk		Suppress display of console information at boot.
1822c609719bSwdenk
1823c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1824c609719bSwdenk		If the board specific function
1825c609719bSwdenk			extern int overwrite_console (void);
1826c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1827c609719bSwdenk		serial port, else the settings in the environment are used.
1828c609719bSwdenk
1829c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1830c609719bSwdenk		Enable the call to overwrite_console().
1831c609719bSwdenk
1832c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1833c609719bSwdenk		Enable overwrite of previous console environment settings.
1834c609719bSwdenk
1835c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1836c609719bSwdenk		Begin and End addresses of the area used by the
1837c609719bSwdenk		simple memory test.
1838c609719bSwdenk
1839c609719bSwdenk- CFG_ALT_MEMTEST:
1840c609719bSwdenk		Enable an alternate, more extensive memory test.
1841c609719bSwdenk
18425f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
18435f535fe1Swdenk		Scratch address used by the alternate memory test
18445f535fe1Swdenk		You only need to set this if address zero isn't writeable
18455f535fe1Swdenk
1846c609719bSwdenk- CFG_TFTP_LOADADDR:
1847c609719bSwdenk		Default load address for network file downloads
1848c609719bSwdenk
1849c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1850c609719bSwdenk		Enable temporary baudrate change while serial download
1851c609719bSwdenk
1852c609719bSwdenk- CFG_SDRAM_BASE:
1853c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1854c609719bSwdenk
1855c609719bSwdenk- CFG_MBIO_BASE:
1856c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1857c609719bSwdenk		Cogent motherboard)
1858c609719bSwdenk
1859c609719bSwdenk- CFG_FLASH_BASE:
1860c609719bSwdenk		Physical start address of Flash memory.
1861c609719bSwdenk
1862c609719bSwdenk- CFG_MONITOR_BASE:
1863c609719bSwdenk		Physical start address of boot monitor code (set by
1864c609719bSwdenk		make config files to be same as the text base address
1865c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1866c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1867c609719bSwdenk
1868c609719bSwdenk- CFG_MONITOR_LEN:
18693b57fe0aSwdenk		Size of memory reserved for monitor code, used to
18703b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
18713b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
18723b57fe0aSwdenk		flash sector.
1873c609719bSwdenk
1874c609719bSwdenk- CFG_MALLOC_LEN:
1875c609719bSwdenk		Size of DRAM reserved for malloc() use.
1876c609719bSwdenk
187715940c9aSStefan Roese- CFG_BOOTM_LEN:
187815940c9aSStefan Roese		Normally compressed uImages are limited to an
187915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
188015940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
188115940c9aSStefan Roese		to adjust this setting to your needs.
1882c609719bSwdenk
1883c609719bSwdenk- CFG_BOOTMAPSZ:
1884c609719bSwdenk		Maximum size of memory mapped by the startup code of
1885c609719bSwdenk		the Linux kernel; all data that must be processed by
1886c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1887c609719bSwdenk		initrd image) must be put below this limit.
1888c609719bSwdenk
1889c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1890c609719bSwdenk		Max number of Flash memory banks
1891c609719bSwdenk
1892c609719bSwdenk- CFG_MAX_FLASH_SECT:
1893c609719bSwdenk		Max number of sectors on a Flash chip
1894c609719bSwdenk
1895c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1896c609719bSwdenk		Timeout for Flash erase operations (in ms)
1897c609719bSwdenk
1898c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1899c609719bSwdenk		Timeout for Flash write operations (in ms)
1900c609719bSwdenk
19018564acf9Swdenk- CFG_FLASH_LOCK_TOUT
19028564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
19038564acf9Swdenk
19048564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
19058564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
19068564acf9Swdenk
19078564acf9Swdenk- CFG_FLASH_PROTECTION
19088564acf9Swdenk		If defined, hardware flash sectors protection is used
19098564acf9Swdenk		instead of U-Boot software protection.
19108564acf9Swdenk
1911c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1912c609719bSwdenk
1913c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1914c609719bSwdenk		without this option such a download has to be
1915c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1916c609719bSwdenk		copy from RAM to flash.
1917c609719bSwdenk
1918c609719bSwdenk		The two-step approach is usually more reliable, since
1919c609719bSwdenk		you can check if the download worked before you erase
1920c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1921c609719bSwdenk		too limited to allow for a tempory copy of the
1922c609719bSwdenk		downloaded image) this option may be very useful.
1923c609719bSwdenk
1924c609719bSwdenk- CFG_FLASH_CFI:
1925c609719bSwdenk		Define if the flash driver uses extra elements in the
19265653fc33Swdenk		common flash structure for storing flash geometry.
19275653fc33Swdenk
19285653fc33Swdenk- CFG_FLASH_CFI_DRIVER
19295653fc33Swdenk		This option also enables the building of the cfi_flash driver
19305653fc33Swdenk		in the drivers directory
193153cf9435Sstroese
19325568e613SStefan Roese- CFG_FLASH_QUIET_TEST
19335568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
19345568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
19355568e613SStefan Roese		is useful, if some of the configured banks are only
19365568e613SStefan Roese		optionally available.
19375568e613SStefan Roese
193853cf9435Sstroese- CFG_RX_ETH_BUFFER:
193953cf9435Sstroese		Defines the number of ethernet receive buffers. On some
194053cf9435Sstroese		ethernet controllers it is recommended to set this value
194153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
194253cf9435Sstroese		buffers can be full shortly after enabling the interface
194353cf9435Sstroese		on high ethernet traffic.
194453cf9435Sstroese		Defaults to 4 if not defined.
1945c609719bSwdenk
1946c609719bSwdenkThe following definitions that deal with the placement and management
1947c609719bSwdenkof environment data (variable area); in general, we support the
1948c609719bSwdenkfollowing configurations:
1949c609719bSwdenk
1950c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1951c609719bSwdenk
1952c609719bSwdenk	Define this if the environment is in flash memory.
1953c609719bSwdenk
1954c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1955c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1956c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1957c609719bSwdenk	   sector" type flash chips, which have several smaller
1958c609719bSwdenk	   sectors at the start or the end. For instance, such a
1959c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1960c609719bSwdenk	   such a case you would place the environment in one of the
1961c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1962c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1963c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1964c609719bSwdenk	   between U-Boot and the environment.
1965c609719bSwdenk
1966c609719bSwdenk	- CFG_ENV_OFFSET:
1967c609719bSwdenk
1968c609719bSwdenk	   Offset of environment data (variable area) to the
1969c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1970c609719bSwdenk	   type flash chips the second sector can be used: the offset
1971c609719bSwdenk	   for this sector is given here.
1972c609719bSwdenk
1973c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1974c609719bSwdenk
1975c609719bSwdenk	- CFG_ENV_ADDR:
1976c609719bSwdenk
1977c609719bSwdenk	   This is just another way to specify the start address of
1978c609719bSwdenk	   the flash sector containing the environment (instead of
1979c609719bSwdenk	   CFG_ENV_OFFSET).
1980c609719bSwdenk
1981c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1982c609719bSwdenk
1983c609719bSwdenk	   Size of the sector containing the environment.
1984c609719bSwdenk
1985c609719bSwdenk
1986c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1987c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1988c609719bSwdenk	   the environment.
1989c609719bSwdenk
1990c609719bSwdenk	- CFG_ENV_SIZE:
1991c609719bSwdenk
1992c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1993c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1994c609719bSwdenk	   of this flash sector for the environment. This saves
1995c609719bSwdenk	   memory for the RAM copy of the environment.
1996c609719bSwdenk
1997c609719bSwdenk	   It may also save flash memory if you decide to use this
1998c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1999c609719bSwdenk	   since then the remainder of the flash sector could be used
2000c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2001c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2002c609719bSwdenk	   updating the environment in flash makes it always
2003c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2004c609719bSwdenk	   wrong before the contents has been restored from a copy in
2005c609719bSwdenk	   RAM, your target system will be dead.
2006c609719bSwdenk
2007c609719bSwdenk	- CFG_ENV_ADDR_REDUND
2008c609719bSwdenk	  CFG_ENV_SIZE_REDUND
2009c609719bSwdenk
2010c609719bSwdenk	   These settings describe a second storage area used to hold
2011c609719bSwdenk	   a redundand copy of the environment data, so that there is
20123e38691eSwdenk	   a valid backup copy in case there is a power failure during
2013c609719bSwdenk	   a "saveenv" operation.
2014c609719bSwdenk
2015c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2016c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2017c609719bSwdenkaccordingly!
2018c609719bSwdenk
2019c609719bSwdenk
2020c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
2021c609719bSwdenk
2022c609719bSwdenk	Define this if you have some non-volatile memory device
2023c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2024c609719bSwdenk	environment.
2025c609719bSwdenk
2026c609719bSwdenk	- CFG_ENV_ADDR:
2027c609719bSwdenk	- CFG_ENV_SIZE:
2028c609719bSwdenk
2029c609719bSwdenk	  These two #defines are used to determin the memory area you
2030c609719bSwdenk	  want to use for environment. It is assumed that this memory
2031c609719bSwdenk	  can just be read and written to, without any special
2032c609719bSwdenk	  provision.
2033c609719bSwdenk
2034c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2035c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2036c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
2037c609719bSwdenkU-Boot will hang.
2038c609719bSwdenk
2039c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2040c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2041c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2042c609719bSwdenkto save the current settings.
2043c609719bSwdenk
2044c609719bSwdenk
2045c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
2046c609719bSwdenk
2047c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2048c609719bSwdenk	device and a driver for it.
2049c609719bSwdenk
2050c609719bSwdenk	- CFG_ENV_OFFSET:
2051c609719bSwdenk	- CFG_ENV_SIZE:
2052c609719bSwdenk
2053c609719bSwdenk	  These two #defines specify the offset and size of the
2054c609719bSwdenk	  environment area within the total memory of your EEPROM.
2055c609719bSwdenk
2056c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
2057c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2058c609719bSwdenk	  The default address is zero.
2059c609719bSwdenk
2060c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
2061c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2062c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2063c609719bSwdenk	  would require six bits.
2064c609719bSwdenk
2065c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2066c609719bSwdenk	  If defined, the number of milliseconds to delay between
2067c609719bSwdenk	  page writes.	The default is zero milliseconds.
2068c609719bSwdenk
2069c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
2070c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2071c609719bSwdenk	  that this is NOT the chip address length!
2072c609719bSwdenk
20735cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
20745cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
20755cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
20765cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
20775cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
20785cf91d6bSwdenk	  byte chips.
20795cf91d6bSwdenk
20805cf91d6bSwdenk	  Note that we consider the length of the address field to
20815cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
20825cf91d6bSwdenk	  in the chip address.
20835cf91d6bSwdenk
2084c609719bSwdenk	- CFG_EEPROM_SIZE:
2085c609719bSwdenk	  The size in bytes of the EEPROM device.
2086c609719bSwdenk
2087c609719bSwdenk
20885779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
20895779d8d9Swdenk
20905779d8d9Swdenk	Define this if you have a DataFlash memory device which you
20915779d8d9Swdenk	want to use for the environment.
20925779d8d9Swdenk
20935779d8d9Swdenk	- CFG_ENV_OFFSET:
20945779d8d9Swdenk	- CFG_ENV_ADDR:
20955779d8d9Swdenk	- CFG_ENV_SIZE:
20965779d8d9Swdenk
20975779d8d9Swdenk	  These three #defines specify the offset and size of the
20985779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
20995779d8d9Swdenk	  at the specified address.
21005779d8d9Swdenk
210113a5695bSwdenk- CFG_ENV_IS_IN_NAND:
210213a5695bSwdenk
210313a5695bSwdenk	Define this if you have a NAND device which you want to use
210413a5695bSwdenk	for the environment.
210513a5695bSwdenk
210613a5695bSwdenk	- CFG_ENV_OFFSET:
210713a5695bSwdenk	- CFG_ENV_SIZE:
210813a5695bSwdenk
210913a5695bSwdenk	  These two #defines specify the offset and size of the environment
211013a5695bSwdenk	  area within the first NAND device.
21115779d8d9Swdenk
2112e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2113e443c944SMarkus Klotzbuecher
2114e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2115e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2116e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2117e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2118e443c944SMarkus Klotzbuecher
2119e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2120e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2121e443c944SMarkus Klotzbuecher	the NAND devices block size.
2122e443c944SMarkus Klotzbuecher
2123c609719bSwdenk- CFG_SPI_INIT_OFFSET
2124c609719bSwdenk
2125c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2126c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2127c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2128c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2129c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2130c609719bSwdenk	to be a good choice since it makes it far enough from the
2131c609719bSwdenk	start of the data area as well as from the stack pointer.
2132c609719bSwdenk
2133e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2134c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2135c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2136c609719bSwdenkuntil then to read environment variables.
2137c609719bSwdenk
213885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
213985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
214085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
214185ec0bccSwdenknecessary, because the first environment variable we need is the
214285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
214385ec0bccSwdenkhave any device yet where we could complain.]
2144c609719bSwdenk
2145c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2146c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
214785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2148c609719bSwdenk
2149fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2150fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2151fc3e2165Swdenk
2152fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2153fc3e2165Swdenk		      also needs to be defined.
2154fc3e2165Swdenk
2155fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2156fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2157c609719bSwdenk
2158c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2159c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2160c40b2956Swdenk		of 64bit values by using the L quantifier
2161c40b2956Swdenk
2162c40b2956Swdenk- CFG_64BIT_STRTOUL:
2163c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2164c40b2956Swdenk
2165c609719bSwdenkLow Level (hardware related) configuration options:
2166dc7c9a1aSwdenk---------------------------------------------------
2167c609719bSwdenk
2168c609719bSwdenk- CFG_CACHELINE_SIZE:
2169c609719bSwdenk		Cache Line Size of the CPU.
2170c609719bSwdenk
2171c609719bSwdenk- CFG_DEFAULT_IMMR:
2172c609719bSwdenk		Default address of the IMMR after system reset.
21732535d602Swdenk
21742535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
21752535d602Swdenk		and RPXsuper) to be able to adjust the position of
21762535d602Swdenk		the IMMR register after a reset.
2177c609719bSwdenk
21787f6c2cbcSwdenk- Floppy Disk Support:
21797f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
21807f6c2cbcSwdenk
21817f6c2cbcSwdenk		the default drive number (default value 0)
21827f6c2cbcSwdenk
21837f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
21847f6c2cbcSwdenk
21857f6c2cbcSwdenk		defines the spacing between fdc chipset registers
21867f6c2cbcSwdenk		(default value 1)
21877f6c2cbcSwdenk
21887f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
21897f6c2cbcSwdenk
21907f6c2cbcSwdenk		defines the offset of register from address. It
21917f6c2cbcSwdenk		depends on which part of the data bus is connected to
21927f6c2cbcSwdenk		the fdc chipset. (default value 0)
21937f6c2cbcSwdenk
21947f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
21957f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
21967f6c2cbcSwdenk		default value.
21977f6c2cbcSwdenk
21987f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
21997f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
22007f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
22017f6c2cbcSwdenk		source code. It is used to make hardware dependant
22027f6c2cbcSwdenk		initializations.
22037f6c2cbcSwdenk
220425d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
220525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
220625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2207c609719bSwdenk
2208c609719bSwdenk- CFG_INIT_RAM_ADDR:
2209c609719bSwdenk
22107152b1d0Swdenk		Start address of memory area that can be used for
2211c609719bSwdenk		initial data and stack; please note that this must be
2212c609719bSwdenk		writable memory that is working WITHOUT special
2213c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2214c609719bSwdenk		will become available only after programming the
2215c609719bSwdenk		memory controller and running certain initialization
2216c609719bSwdenk		sequences.
2217c609719bSwdenk
2218c609719bSwdenk		U-Boot uses the following memory types:
2219c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2220c609719bSwdenk		- MPC824X: data cache
2221c609719bSwdenk		- PPC4xx:  data cache
2222c609719bSwdenk
222385ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2224c609719bSwdenk
2225c609719bSwdenk		Offset of the initial data structure in the memory
2226c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
222785ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2228c609719bSwdenk		data is located at the end of the available space
2229c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2230c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2231c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
223285ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2233c609719bSwdenk
2234c609719bSwdenk	Note:
2235c609719bSwdenk		On the MPC824X (or other systems that use the data
2236c609719bSwdenk		cache for initial memory) the address chosen for
2237c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2238c609719bSwdenk		point to an otherwise UNUSED address space between
2239c609719bSwdenk		the top of RAM and the start of the PCI space.
2240c609719bSwdenk
2241c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2242c609719bSwdenk
2243c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2244c609719bSwdenk
2245c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2246c609719bSwdenk
2247c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2248c609719bSwdenk
2249c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2250c609719bSwdenk
2251c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2252c609719bSwdenk
2253c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2254c609719bSwdenk		SDRAM timing
2255c609719bSwdenk
2256c609719bSwdenk- CFG_MAMR_PTA:
2257c609719bSwdenk		periodic timer for refresh
2258c609719bSwdenk
2259c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2260c609719bSwdenk
2261c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2262c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2263c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2264c609719bSwdenk  CFG_BR1_PRELIM:
2265c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2266c609719bSwdenk
2267c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2268c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2269c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2270c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2271c609719bSwdenk
2272c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2273c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2274c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2275c609719bSwdenk		Prescaler definitions (SDRAM timing)
2276c609719bSwdenk
2277c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2278c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2279c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2280c609719bSwdenk
2281c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2282c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2283c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2284c609719bSwdenk
2285c609719bSwdenk- CFG_USE_OSCCLK:
2286c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2287c609719bSwdenk		wrong setting might damage your board. Read
2288c609719bSwdenk		doc/README.MBX before setting this variable!
2289c609719bSwdenk
2290ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2291ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2292ea909b76Swdenk		(Power On Self Tests). This definition overrides
2293ea909b76Swdenk		#define'd default value in commproc.h resp.
2294ea909b76Swdenk		cpm_8260.h.
2295ea909b76Swdenk
22965d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
22975d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
22985d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
22995d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
23005d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
23015d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
23025d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
23035d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
23045d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
23055d232d0eSwdenk
2306bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2307bb99ad6dSBen Warren		Get DDR timing information from an I2C EEPROM.  Common with pluggable
2308bb99ad6dSBen Warren		memory modules such as SODIMMs
2309bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2310bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2311bb99ad6dSBen Warren
2312bb99ad6dSBen Warren- CFG_SPD_BUS_NUM
2313bb99ad6dSBen Warren		If SPD EEPROM is on an I2C bus other than the first one, specify here.
2314bb99ad6dSBen Warren		Note that the value must resolve to something your driver can deal with.
2315bb99ad6dSBen Warren
23162ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
23172ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
23182ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
23192ad6b513STimur Tabi
23202ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
23212ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
23222ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
23232ad6b513STimur Tabi
2324c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2325c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2326c26e454dSwdenk
2327c26e454dSwdenk- CONFIG_FEC[12]_PHY
2328c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
23296e592385Swdenk		to the given FEC; i. e.
2330c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2331c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2332c26e454dSwdenk
2333c26e454dSwdenk		When set to -1, means to probe for first available.
2334c26e454dSwdenk
2335c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2336c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2337c26e454dSwdenk		(so program the FEC to ignore it).
2338c26e454dSwdenk
2339c26e454dSwdenk- CONFIG_RMII
2340c26e454dSwdenk		Enable RMII mode for all FECs.
2341c26e454dSwdenk		Note that this is a global option, we can't
2342c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2343c26e454dSwdenk
23445cf91d6bSwdenk- CONFIG_CRC32_VERIFY
23455cf91d6bSwdenk		Add a verify option to the crc32 command.
23465cf91d6bSwdenk		The syntax is:
23475cf91d6bSwdenk
23485cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
23495cf91d6bSwdenk
23505cf91d6bSwdenk		Where address/count indicate a memory area
23515cf91d6bSwdenk		and crc32 is the correct crc32 which the
23525cf91d6bSwdenk		area should have.
23535cf91d6bSwdenk
235456523f12Swdenk- CONFIG_LOOPW
235556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2356602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
235756523f12Swdenk
23587b466641Sstroese- CONFIG_MX_CYCLIC
23597b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
23607b466641Sstroese		"md/mw" commands.
23617b466641Sstroese		Examples:
23627b466641Sstroese
23637b466641Sstroese		=> mdc.b 10 4 500
23647b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
23657b466641Sstroese
23667b466641Sstroese		=> mwc.l 100 12345678 10
23677b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
23687b466641Sstroese
23697b466641Sstroese		This only takes effect if the memory commands are activated
2370602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
23717b466641Sstroese
23728aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
23738aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
23748aa1a2d1Swdenk
23758aa1a2d1Swdenk		[ARM only] If these variables are defined, then
23768aa1a2d1Swdenk		certain low level initializations (like setting up
23778aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
23788aa1a2d1Swdenk		not relocate itself into RAM.
23798aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
23808aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
23818aa1a2d1Swdenk		some other boot loader or by a debugger which
23828aa1a2d1Swdenk		performs these intializations itself.
23838aa1a2d1Swdenk
2384400558b5Swdenk
2385c609719bSwdenkBuilding the Software:
2386c609719bSwdenk======================
2387c609719bSwdenk
2388c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2389c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2390c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2391c609719bSwdenkNetBSD 1.5 on x86).
2392c609719bSwdenk
2393c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2394c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2395c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2396c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2397c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2398c609719bSwdenkchange it to:
2399c609719bSwdenk
2400c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2401c609719bSwdenk
2402c609719bSwdenk
2403c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2404c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2405c609719bSwdenkis done by typing:
2406c609719bSwdenk
2407c609719bSwdenk	make NAME_config
2408c609719bSwdenk
2409c609719bSwdenkwhere "NAME_config" is the name of one of the existing
24102628114eSKim Phillipsconfigurations; see the main Makefile for supported names.
241154387ac9Swdenk
2412c609719bSwdenkNote: for some board special configuration names may exist; check if
2413c609719bSwdenk      additional information is available from the board vendor; for
24142729af9dSwdenk      instance, the TQM823L systems are available without (standard)
24152729af9dSwdenk      or with LCD support. You can select such additional "features"
2416c609719bSwdenk      when chosing the configuration, i. e.
2417c609719bSwdenk
24182729af9dSwdenk      make TQM823L_config
24192729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2420c609719bSwdenk
2421c609719bSwdenk      make TQM823L_LCD_config
2422c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2423c609719bSwdenk
2424c609719bSwdenk      etc.
2425c609719bSwdenk
2426c609719bSwdenk
2427c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
24287152b1d0Swdenkimages ready for download to / installation on your system:
2429c609719bSwdenk
2430c609719bSwdenk- "u-boot.bin" is a raw binary image
2431c609719bSwdenk- "u-boot" is an image in ELF binary format
2432c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2433c609719bSwdenk
2434baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2435baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2436baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2437baf31249SMarian Balakowicz
2438baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2439baf31249SMarian Balakowicz
2440baf31249SMarian Balakowicz	make O=/tmp/build distclean
2441baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2442baf31249SMarian Balakowicz	make O=/tmp/build all
2443baf31249SMarian Balakowicz
2444baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2445baf31249SMarian Balakowicz
2446baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2447baf31249SMarian Balakowicz	make distclean
2448baf31249SMarian Balakowicz	make NAME_config
2449baf31249SMarian Balakowicz	make all
2450baf31249SMarian Balakowicz
2451baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2452baf31249SMarian Balakowiczvariable.
2453baf31249SMarian Balakowicz
2454c609719bSwdenk
2455c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2456c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2457c609719bSwdenknative "make".
2458c609719bSwdenk
2459c609719bSwdenk
2460c609719bSwdenkIf the system board that you have is not listed, then you will need
2461c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2462c609719bSwdenksteps:
2463c609719bSwdenk
2464c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
246585ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
246685ec0bccSwdenk    entries as examples. Note that here and at many other places
24677152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
246885ec0bccSwdenk    keep this order.
2469c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
247085ec0bccSwdenk    files you need. In your board directory, you will need at least
247185ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
247285ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
247385ec0bccSwdenk    your board
2474c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2475c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
247685ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2477c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2478c609719bSwdenk    to be installed on your target system.
247985ec0bccSwdenk6.  Debug and solve any problems that might arise.
2480c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2481c609719bSwdenk
2482c609719bSwdenk
2483c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2484c609719bSwdenk==============================================================
2485c609719bSwdenk
2486c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2487c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2488c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2489c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2490c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2491c609719bSwdenk
2492c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2493c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2494c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2495c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2496c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
24977152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2498c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2499c609719bSwdenkMontaVista's Hard Hat Linux you can type
2500c609719bSwdenk
2501c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2502c609719bSwdenk
2503c609719bSwdenkor to build on a native PowerPC system you can type
2504c609719bSwdenk
2505c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2506c609719bSwdenk
2507baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2508baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2509baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2510baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2511baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2512baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2513baf31249SMarian Balakowicz
2514baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2515baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2516baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2517baf31249SMarian Balakowicz
2518baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2519baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2520baf31249SMarian Balakowiczthe whole build process.
2521baf31249SMarian Balakowicz
2522baf31249SMarian Balakowicz
2523c609719bSwdenkSee also "U-Boot Porting Guide" below.
2524c609719bSwdenk
2525c609719bSwdenk
2526c609719bSwdenkMonitor Commands - Overview:
2527c609719bSwdenk============================
2528c609719bSwdenk
2529c609719bSwdenkgo	- start application at address 'addr'
2530c609719bSwdenkrun	- run commands in an environment variable
2531c609719bSwdenkbootm	- boot application image from memory
2532c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2533c609719bSwdenktftpboot- boot image via network using TFTP protocol
2534c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2535c609719bSwdenk	       (and eventually "gatewayip")
2536c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2537c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2538c609719bSwdenkloads	- load S-Record file over serial line
2539c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2540c609719bSwdenkmd	- memory display
2541c609719bSwdenkmm	- memory modify (auto-incrementing)
2542c609719bSwdenknm	- memory modify (constant address)
2543c609719bSwdenkmw	- memory write (fill)
2544c609719bSwdenkcp	- memory copy
2545c609719bSwdenkcmp	- memory compare
2546c609719bSwdenkcrc32	- checksum calculation
2547c609719bSwdenkimd	- i2c memory display
2548c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2549c609719bSwdenkinm	- i2c memory modify (constant address)
2550c609719bSwdenkimw	- i2c memory write (fill)
2551c609719bSwdenkicrc32	- i2c checksum calculation
2552c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2553c609719bSwdenkiloop	- infinite loop on address range
2554c609719bSwdenkisdram	- print SDRAM configuration information
2555c609719bSwdenksspi	- SPI utility commands
2556c609719bSwdenkbase	- print or set address offset
2557c609719bSwdenkprintenv- print environment variables
2558c609719bSwdenksetenv	- set environment variables
2559c609719bSwdenksaveenv - save environment variables to persistent storage
2560c609719bSwdenkprotect - enable or disable FLASH write protection
2561c609719bSwdenkerase	- erase FLASH memory
2562c609719bSwdenkflinfo	- print FLASH memory information
2563c609719bSwdenkbdinfo	- print Board Info structure
2564c609719bSwdenkiminfo	- print header information for application image
2565c609719bSwdenkconinfo - print console devices and informations
2566c609719bSwdenkide	- IDE sub-system
2567c609719bSwdenkloop	- infinite loop on address range
256856523f12Swdenkloopw	- infinite write loop on address range
2569c609719bSwdenkmtest	- simple RAM test
2570c609719bSwdenkicache	- enable or disable instruction cache
2571c609719bSwdenkdcache	- enable or disable data cache
2572c609719bSwdenkreset	- Perform RESET of the CPU
2573c609719bSwdenkecho	- echo args to console
2574c609719bSwdenkversion - print monitor version
2575c609719bSwdenkhelp	- print online help
2576c609719bSwdenk?	- alias for 'help'
2577c609719bSwdenk
2578c609719bSwdenk
2579c609719bSwdenkMonitor Commands - Detailed Description:
2580c609719bSwdenk========================================
2581c609719bSwdenk
2582c609719bSwdenkTODO.
2583c609719bSwdenk
2584c609719bSwdenkFor now: just type "help <command>".
2585c609719bSwdenk
2586c609719bSwdenk
2587c609719bSwdenkEnvironment Variables:
2588c609719bSwdenk======================
2589c609719bSwdenk
2590c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2591c609719bSwdenkcan be made persistent by saving to Flash memory.
2592c609719bSwdenk
2593c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2594c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2595c609719bSwdenkwithout a value can be used to delete a variable from the
2596c609719bSwdenkenvironment. As long as you don't save the environment you are
2597c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2598c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2599c609719bSwdenk
2600c609719bSwdenkSome configuration options can be set using Environment Variables:
2601c609719bSwdenk
2602c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2603c609719bSwdenk
2604c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2605c609719bSwdenk
2606c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2607c609719bSwdenk
2608c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2609c609719bSwdenk
2610c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2611c609719bSwdenk
2612c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2613c609719bSwdenk		  "bootp" will just load perform a lookup of the
2614c609719bSwdenk		  configuration from the BOOTP server, but not try to
2615c609719bSwdenk		  load any image using TFTP
2616c609719bSwdenk
2617c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2618c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2619c609719bSwdenk		  be automatically started (by internally calling
2620c609719bSwdenk		  "bootm")
2621c609719bSwdenk
26224a6fd34bSwdenk		  If set to "no", a standalone image passed to the
26234a6fd34bSwdenk		  "bootm" command will be copied to the load address
26244a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
26254a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
26264a6fd34bSwdenk		  data.
26274a6fd34bSwdenk
262817ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
262917ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
263017ea1177Swdenk		  mode (400kHZ). This environment variable is used in
263117ea1177Swdenk		  initialization code. So, for changes to be effective
263217ea1177Swdenk		  it must be saved and board must be reset.
263317ea1177Swdenk
2634c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2635c609719bSwdenk		  If this variable is not set, initrd images will be
2636c609719bSwdenk		  copied to the highest possible address in RAM; this
2637c609719bSwdenk		  is usually what you want since it allows for
2638c609719bSwdenk		  maximum initrd size. If for some reason you want to
2639c609719bSwdenk		  make sure that the initrd image is loaded below the
2640c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2641c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2642c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2643c609719bSwdenk		  address to use (U-Boot will still check that it
2644c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2645c609719bSwdenk
2646c609719bSwdenk		  For instance, when you have a system with 16 MB
26477152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2648c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2649c609719bSwdenk		  the "bootargs" variable. However, now you must make
26507152b1d0Swdenk		  sure that the initrd image is placed in the first
2651c609719bSwdenk		  12 MB as well - this can be done with
2652c609719bSwdenk
2653c609719bSwdenk		  setenv initrd_high 00c00000
2654c609719bSwdenk
265538b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
265638b99261Swdenk		  indication to U-Boot that all addresses are legal
265738b99261Swdenk		  for the Linux kernel, including addresses in flash
265838b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
265938b99261Swdenk		  ramdisk at all. This may be useful to reduce the
266038b99261Swdenk		  boot time on your system, but requires that this
266138b99261Swdenk		  feature is supported by your Linux kernel.
266238b99261Swdenk
2663c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2664c609719bSwdenk
2665c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2666dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2667c609719bSwdenk
2668c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2669c609719bSwdenk
2670c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2671c609719bSwdenk
2672c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2673c609719bSwdenk
2674c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2675c609719bSwdenk
2676c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2677c609719bSwdenk
2678a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2679a3d991bdSwdenk		  interface is used first.
2680a3d991bdSwdenk
2681a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2682a3d991bdSwdenk		  interface is currently active. For example you
2683a3d991bdSwdenk		  can do the following
2684a3d991bdSwdenk
2685a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2686a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2687a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2688a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2689a3d991bdSwdenk
2690a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2691a3d991bdSwdenk		  either succeed or fail without retrying.
26926e592385Swdenk		  When set to "once" the network operation will
26936e592385Swdenk		  fail when all the available network interfaces
26946e592385Swdenk		  are tried once without success.
2695a3d991bdSwdenk		  Useful on scripts which control the retry operation
2696a3d991bdSwdenk		  themselves.
2697a3d991bdSwdenk
269828cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2699ecb0ccd9SWolfgang Denk		  UDP source port.
2700ecb0ccd9SWolfgang Denk
270128cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
270228cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
270328cb9375SWolfgang Denk
2704a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2705a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2706a3d991bdSwdenk		  VLAN tagged frames.
2707c609719bSwdenk
2708c609719bSwdenkThe following environment variables may be used and automatically
2709c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2710c609719bSwdenkdepending the information provided by your boot server:
2711c609719bSwdenk
2712c609719bSwdenk  bootfile	- see above
2713c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2714fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2715c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2716c609719bSwdenk  hostname	- Target hostname
2717c609719bSwdenk  ipaddr	- see above
2718c609719bSwdenk  netmask	- Subnet Mask
2719c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2720c609719bSwdenk  serverip	- see above
2721c609719bSwdenk
2722c609719bSwdenk
2723c609719bSwdenkThere are two special Environment Variables:
2724c609719bSwdenk
2725c609719bSwdenk  serial#	- contains hardware identification information such
2726c609719bSwdenk		  as type string and/or serial number
2727c609719bSwdenk  ethaddr	- Ethernet address
2728c609719bSwdenk
2729c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2730c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2731c609719bSwdenkonce they have been set once.
2732c609719bSwdenk
2733c609719bSwdenk
2734c1551ea8SstroeseFurther special Environment Variables:
2735c1551ea8Sstroese
2736c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2737c1551ea8Sstroese		  with the "version" command. This variable is
2738c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2739c1551ea8Sstroese
2740c1551ea8Sstroese
2741c609719bSwdenkPlease note that changes to some configuration parameters may take
2742c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2743c609719bSwdenk
2744c609719bSwdenk
2745f07771ccSwdenkCommand Line Parsing:
2746f07771ccSwdenk=====================
2747f07771ccSwdenk
2748f07771ccSwdenkThere are two different command line parsers available with U-Boot:
27497152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2750f07771ccSwdenk
2751f07771ccSwdenkOld, simple command line parser:
2752f07771ccSwdenk--------------------------------
2753f07771ccSwdenk
2754f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2755f07771ccSwdenk- several commands on one line, separated by ';'
2756fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2757f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2758f07771ccSwdenk  for example:
2759fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2760f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2761f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2762f07771ccSwdenk
2763f07771ccSwdenkHush shell:
2764f07771ccSwdenk-----------
2765f07771ccSwdenk
2766f07771ccSwdenk- similar to Bourne shell, with control structures like
2767f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2768f07771ccSwdenk  until...do...done, ...
2769f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2770f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2771f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2772f07771ccSwdenk  command
2773f07771ccSwdenk
2774f07771ccSwdenkGeneral rules:
2775f07771ccSwdenk--------------
2776f07771ccSwdenk
2777f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2778f07771ccSwdenk    command) contains several commands separated by semicolon, and
2779f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2780f07771ccSwdenk    executed anyway.
2781f07771ccSwdenk
2782f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2783f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2784f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2785f07771ccSwdenk    variables are not executed.
2786f07771ccSwdenk
2787c609719bSwdenkNote for Redundant Ethernet Interfaces:
2788c609719bSwdenk=======================================
2789c609719bSwdenk
27907152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2791c609719bSwdenksuch configurations and is capable of automatic selection of a
27927152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2793c609719bSwdenk
2794c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2795c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2796c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2797c609719bSwdenk
2798c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2799c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2800c609719bSwdenkding setting in the environment; if the corresponding environment
2801c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2802c609719bSwdenk
2803c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2804c609719bSwdenk  environment, the SROM's address is used.
2805c609719bSwdenk
2806c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2807c609719bSwdenk  environment exists, then the value from the environment variable is
2808c609719bSwdenk  used.
2809c609719bSwdenk
2810c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2811c609719bSwdenk  both addresses are the same, this MAC address is used.
2812c609719bSwdenk
2813c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2814c609719bSwdenk  addresses differ, the value from the environment is used and a
2815c609719bSwdenk  warning is printed.
2816c609719bSwdenk
2817c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2818c609719bSwdenk  is raised.
2819c609719bSwdenk
2820c609719bSwdenk
2821c609719bSwdenkImage Formats:
2822c609719bSwdenk==============
2823c609719bSwdenk
2824c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2825c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2826c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2827c609719bSwdenkdefines the following image properties:
2828c609719bSwdenk
2829c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2830c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
28317f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
28321f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
28337b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
28343d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
28357b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2836c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2837c609719bSwdenk* Load Address
2838c609719bSwdenk* Entry Point
2839c609719bSwdenk* Image Name
2840c609719bSwdenk* Image Timestamp
2841c609719bSwdenk
2842c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2843c609719bSwdenkand the data portions of the image are secured against corruption by
2844c609719bSwdenkCRC32 checksums.
2845c609719bSwdenk
2846c609719bSwdenk
2847c609719bSwdenkLinux Support:
2848c609719bSwdenk==============
2849c609719bSwdenk
2850c609719bSwdenkAlthough U-Boot should support any OS or standalone application
28517152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2852c609719bSwdenkU-Boot.
2853c609719bSwdenk
2854c609719bSwdenkU-Boot includes many features that so far have been part of some
2855c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2856c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2857c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
28587152b1d0Swdenkserves several purposes:
2859c609719bSwdenk
2860c609719bSwdenk- the same features can be used for other OS or standalone
2861c609719bSwdenk  applications (for instance: using compressed images to reduce the
2862c609719bSwdenk  Flash memory footprint)
2863c609719bSwdenk
2864c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
28657152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2866c609719bSwdenk
2867c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2868c609719bSwdenk  images; of course this also means that different kernel images can
2869c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2870c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2871c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2872c609719bSwdenk  software is easier now.
2873c609719bSwdenk
2874c609719bSwdenk
2875c609719bSwdenkLinux HOWTO:
2876c609719bSwdenk============
2877c609719bSwdenk
2878c609719bSwdenkPorting Linux to U-Boot based systems:
2879c609719bSwdenk---------------------------------------
2880c609719bSwdenk
2881c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2882c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2883c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2884c609719bSwdenkLinux :-).
2885c609719bSwdenk
2886c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2887c609719bSwdenk
2888c609719bSwdenkJust make sure your machine specific header file (for instance
2889c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2890c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2891c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2892c609719bSwdenkU-Boot configuration in CFG_IMMR.
2893c609719bSwdenk
2894c609719bSwdenk
2895c609719bSwdenkConfiguring the Linux kernel:
2896c609719bSwdenk-----------------------------
2897c609719bSwdenk
2898c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2899c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2900c609719bSwdenk
2901c609719bSwdenk
2902c609719bSwdenkBuilding a Linux Image:
2903c609719bSwdenk-----------------------
2904c609719bSwdenk
290524ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
290624ee89b9Swdenknot used. If you use recent kernel source, a new build target
290724ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
290824ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
290924ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
291024ee89b9Swdenk100% compatible format.
2911c609719bSwdenk
2912c609719bSwdenkExample:
2913c609719bSwdenk
2914c609719bSwdenk	make TQM850L_config
2915c609719bSwdenk	make oldconfig
2916c609719bSwdenk	make dep
291724ee89b9Swdenk	make uImage
2918c609719bSwdenk
291924ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
292024ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
292124ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2922c609719bSwdenk
292324ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
292424ee89b9Swdenk
292524ee89b9Swdenk* convert the kernel into a raw binary image:
292624ee89b9Swdenk
292724ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
292824ee89b9Swdenk				 -R .note -R .comment \
292924ee89b9Swdenk				 -S vmlinux linux.bin
293024ee89b9Swdenk
293124ee89b9Swdenk* compress the binary image:
293224ee89b9Swdenk
293324ee89b9Swdenk	gzip -9 linux.bin
293424ee89b9Swdenk
293524ee89b9Swdenk* package compressed binary image for U-Boot:
293624ee89b9Swdenk
293724ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
293824ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
293924ee89b9Swdenk		-d linux.bin.gz uImage
294024ee89b9Swdenk
294124ee89b9Swdenk
294224ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
294324ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
294424ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
294524ee89b9Swdenkbyte header containing information about target architecture,
294624ee89b9Swdenkoperating system, image type, compression method, entry points, time
294724ee89b9Swdenkstamp, CRC32 checksums, etc.
294824ee89b9Swdenk
294924ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
295024ee89b9Swdenkprint the header information, or to build new images.
2951c609719bSwdenk
2952c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2953c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2954c609719bSwdenkchecksum verification:
2955c609719bSwdenk
2956c609719bSwdenk	tools/mkimage -l image
2957c609719bSwdenk	  -l ==> list image header information
2958c609719bSwdenk
2959c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2960c609719bSwdenkfrom a "data file" which is used as image payload:
2961c609719bSwdenk
2962c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2963c609719bSwdenk		      -n name -d data_file image
2964c609719bSwdenk	  -A ==> set architecture to 'arch'
2965c609719bSwdenk	  -O ==> set operating system to 'os'
2966c609719bSwdenk	  -T ==> set image type to 'type'
2967c609719bSwdenk	  -C ==> set compression type 'comp'
2968c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2969c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2970c609719bSwdenk	  -n ==> set image name to 'name'
2971c609719bSwdenk	  -d ==> use image data from 'datafile'
2972c609719bSwdenk
297369459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
297469459791Swdenkaddress (0x00000000), but the entry point address depends on the
297569459791Swdenkkernel version:
2976c609719bSwdenk
2977c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
297824ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2979c609719bSwdenk
2980c609719bSwdenkSo a typical call to build a U-Boot image would read:
2981c609719bSwdenk
298224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
298324ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
298424ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
298524ee89b9Swdenk	> examples/uImage.TQM850L
298624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2987c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2988c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2989c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2990c609719bSwdenk	Load Address: 0x00000000
299124ee89b9Swdenk	Entry Point:  0x00000000
2992c609719bSwdenk
2993c609719bSwdenkTo verify the contents of the image (or check for corruption):
2994c609719bSwdenk
299524ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
299624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2997c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2998c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2999c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3000c609719bSwdenk	Load Address: 0x00000000
300124ee89b9Swdenk	Entry Point:  0x00000000
3002c609719bSwdenk
3003c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3004c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3005c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3006c609719bSwdenkneed to be uncompressed:
3007c609719bSwdenk
300824ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
300924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
301024ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
301124ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
301224ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
301324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3014c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3015c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3016c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3017c609719bSwdenk	Load Address: 0x00000000
301824ee89b9Swdenk	Entry Point:  0x00000000
3019c609719bSwdenk
3020c609719bSwdenk
3021c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3022c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3023c609719bSwdenk
3024c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3025c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3026c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3027c609719bSwdenk	Image Name:   Simple Ramdisk Image
3028c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3029c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3030c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3031c609719bSwdenk	Load Address: 0x00000000
3032c609719bSwdenk	Entry Point:  0x00000000
3033c609719bSwdenk
3034c609719bSwdenk
3035c609719bSwdenkInstalling a Linux Image:
3036c609719bSwdenk-------------------------
3037c609719bSwdenk
3038c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3039c609719bSwdenkyou must convert the image to S-Record format:
3040c609719bSwdenk
3041c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3042c609719bSwdenk
3043c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3044c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3045c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3046c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3047c609719bSwdenkcommand.
3048c609719bSwdenk
3049c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3050c609719bSwdenkTQM8xxL is in the first Flash bank):
3051c609719bSwdenk
3052c609719bSwdenk	=> erase 40100000 401FFFFF
3053c609719bSwdenk
3054c609719bSwdenk	.......... done
3055c609719bSwdenk	Erased 8 sectors
3056c609719bSwdenk
3057c609719bSwdenk	=> loads 40100000
3058c609719bSwdenk	## Ready for S-Record download ...
3059c609719bSwdenk	~>examples/image.srec
3060c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3061c609719bSwdenk	...
3062c609719bSwdenk	15989 15990 15991 15992
3063c609719bSwdenk	[file transfer complete]
3064c609719bSwdenk	[connected]
3065c609719bSwdenk	## Start Addr = 0x00000000
3066c609719bSwdenk
3067c609719bSwdenk
3068c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3069c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
3070c609719bSwdenkcorruption happened:
3071c609719bSwdenk
3072c609719bSwdenk	=> imi 40100000
3073c609719bSwdenk
3074c609719bSwdenk	## Checking Image at 40100000 ...
3075c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3076c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3077c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3078c609719bSwdenk	   Load Address: 00000000
3079c609719bSwdenk	   Entry Point:	 0000000c
3080c609719bSwdenk	   Verifying Checksum ... OK
3081c609719bSwdenk
3082c609719bSwdenk
3083c609719bSwdenkBoot Linux:
3084c609719bSwdenk-----------
3085c609719bSwdenk
3086c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3087c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3088c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3089c609719bSwdenkparameters. You can check and modify this variable using the
3090c609719bSwdenk"printenv" and "setenv" commands:
3091c609719bSwdenk
3092c609719bSwdenk
3093c609719bSwdenk	=> printenv bootargs
3094c609719bSwdenk	bootargs=root=/dev/ram
3095c609719bSwdenk
3096c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3097c609719bSwdenk
3098c609719bSwdenk	=> printenv bootargs
3099c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3100c609719bSwdenk
3101c609719bSwdenk	=> bootm 40020000
3102c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3103c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3104c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3105c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3106c609719bSwdenk	   Load Address: 00000000
3107c609719bSwdenk	   Entry Point:	 0000000c
3108c609719bSwdenk	   Verifying Checksum ... OK
3109c609719bSwdenk	   Uncompressing Kernel Image ... OK
3110c609719bSwdenk	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
3111c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3112c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3113c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3114c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3115c609719bSwdenk	...
3116c609719bSwdenk
3117c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
31187152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3119c609719bSwdenkformat!) to the "bootm" command:
3120c609719bSwdenk
3121c609719bSwdenk	=> imi 40100000 40200000
3122c609719bSwdenk
3123c609719bSwdenk	## Checking Image at 40100000 ...
3124c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3125c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3126c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3127c609719bSwdenk	   Load Address: 00000000
3128c609719bSwdenk	   Entry Point:	 0000000c
3129c609719bSwdenk	   Verifying Checksum ... OK
3130c609719bSwdenk
3131c609719bSwdenk	## Checking Image at 40200000 ...
3132c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3133c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3134c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3135c609719bSwdenk	   Load Address: 00000000
3136c609719bSwdenk	   Entry Point:	 00000000
3137c609719bSwdenk	   Verifying Checksum ... OK
3138c609719bSwdenk
3139c609719bSwdenk	=> bootm 40100000 40200000
3140c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3141c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3142c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3143c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3144c609719bSwdenk	   Load Address: 00000000
3145c609719bSwdenk	   Entry Point:	 0000000c
3146c609719bSwdenk	   Verifying Checksum ... OK
3147c609719bSwdenk	   Uncompressing Kernel Image ... OK
3148c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3149c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3150c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3151c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3152c609719bSwdenk	   Load Address: 00000000
3153c609719bSwdenk	   Entry Point:	 00000000
3154c609719bSwdenk	   Verifying Checksum ... OK
3155c609719bSwdenk	   Loading Ramdisk ... OK
3156c609719bSwdenk	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
3157c609719bSwdenk	Boot arguments: root=/dev/ram
3158c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3159c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3160c609719bSwdenk	...
3161c609719bSwdenk	RAMDISK: Compressed image found at block 0
3162c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3163c609719bSwdenk
3164c609719bSwdenk	bash#
3165c609719bSwdenk
31660267768eSMatthew McClintockBoot Linux and pass a flat device tree:
31670267768eSMatthew McClintock-----------
31680267768eSMatthew McClintock
31690267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
31700267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
31710267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
31720267768eSMatthew McClintockflat device tree:
31730267768eSMatthew McClintock
31740267768eSMatthew McClintock=> print oftaddr
31750267768eSMatthew McClintockoftaddr=0x300000
31760267768eSMatthew McClintock=> print oft
31770267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
31780267768eSMatthew McClintock=> tftp $oftaddr $oft
31790267768eSMatthew McClintockSpeed: 1000, full duplex
31800267768eSMatthew McClintockUsing TSEC0 device
31810267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
31820267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
31830267768eSMatthew McClintockLoad address: 0x300000
31840267768eSMatthew McClintockLoading: #
31850267768eSMatthew McClintockdone
31860267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
31870267768eSMatthew McClintock=> tftp $loadaddr $bootfile
31880267768eSMatthew McClintockSpeed: 1000, full duplex
31890267768eSMatthew McClintockUsing TSEC0 device
31900267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
31910267768eSMatthew McClintockFilename 'uImage'.
31920267768eSMatthew McClintockLoad address: 0x200000
31930267768eSMatthew McClintockLoading:############
31940267768eSMatthew McClintockdone
31950267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
31960267768eSMatthew McClintock=> print loadaddr
31970267768eSMatthew McClintockloadaddr=200000
31980267768eSMatthew McClintock=> print oftaddr
31990267768eSMatthew McClintockoftaddr=0x300000
32000267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
32010267768eSMatthew McClintock## Booting image at 00200000 ...
32020267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
32030267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
32040267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
32050267768eSMatthew McClintock   Load Address: 00000000
32060267768eSMatthew McClintock   Entry Point:	 00000000
32070267768eSMatthew McClintock   Verifying Checksum ... OK
32080267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
32090267768eSMatthew McClintockBooting using flat device tree at 0x300000
32100267768eSMatthew McClintockUsing MPC85xx ADS machine description
32110267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
32120267768eSMatthew McClintock[snip]
32130267768eSMatthew McClintock
32140267768eSMatthew McClintock
32156069ff26SwdenkMore About U-Boot Image Types:
32166069ff26Swdenk------------------------------
32176069ff26Swdenk
32186069ff26SwdenkU-Boot supports the following image types:
32196069ff26Swdenk
32206069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
32216069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
32226069ff26Swdenk	well) you can continue to work in U-Boot after return from
32236069ff26Swdenk	the Standalone Program.
32246069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
32256069ff26Swdenk	will take over control completely. Usually these programs
32266069ff26Swdenk	will install their own set of exception handlers, device
32276069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
32286069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
32296069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
32306069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
32316069ff26Swdenk	being started.
32326069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
32336069ff26Swdenk	(Linux) kernel image and one or more data images like
32346069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
32356069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
32366069ff26Swdenk	server provides just a single image file, but you want to get
32376069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
32386069ff26Swdenk
32396069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
32406069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
32416069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
32426069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
32436069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
32446069ff26Swdenk	a multiple of 4 bytes).
32456069ff26Swdenk
32466069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
32476069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
32486069ff26Swdenk	flash memory.
32496069ff26Swdenk
32506069ff26Swdenk   "Script files" are command sequences that will be executed by
32516069ff26Swdenk	U-Boot's command interpreter; this feature is especially
32526069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
32536069ff26Swdenk	as command interpreter.
32546069ff26Swdenk
3255c609719bSwdenk
3256c609719bSwdenkStandalone HOWTO:
3257c609719bSwdenk=================
3258c609719bSwdenk
3259c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3260c609719bSwdenkrun "standalone" applications, which can use some resources of
3261c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3262c609719bSwdenk
3263c609719bSwdenkTwo simple examples are included with the sources:
3264c609719bSwdenk
3265c609719bSwdenk"Hello World" Demo:
3266c609719bSwdenk-------------------
3267c609719bSwdenk
3268c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3269c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3270c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3271c609719bSwdenklike that:
3272c609719bSwdenk
3273c609719bSwdenk	=> loads
3274c609719bSwdenk	## Ready for S-Record download ...
3275c609719bSwdenk	~>examples/hello_world.srec
3276c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3277c609719bSwdenk	[file transfer complete]
3278c609719bSwdenk	[connected]
3279c609719bSwdenk	## Start Addr = 0x00040004
3280c609719bSwdenk
3281c609719bSwdenk	=> go 40004 Hello World! This is a test.
3282c609719bSwdenk	## Starting application at 0x00040004 ...
3283c609719bSwdenk	Hello World
3284c609719bSwdenk	argc = 7
3285c609719bSwdenk	argv[0] = "40004"
3286c609719bSwdenk	argv[1] = "Hello"
3287c609719bSwdenk	argv[2] = "World!"
3288c609719bSwdenk	argv[3] = "This"
3289c609719bSwdenk	argv[4] = "is"
3290c609719bSwdenk	argv[5] = "a"
3291c609719bSwdenk	argv[6] = "test."
3292c609719bSwdenk	argv[7] = "<NULL>"
3293c609719bSwdenk	Hit any key to exit ...
3294c609719bSwdenk
3295c609719bSwdenk	## Application terminated, rc = 0x0
3296c609719bSwdenk
3297c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3298c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3299c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3300c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3301c609719bSwdenkcharacter, but this is just a demo program. The application can be
3302c609719bSwdenkcontrolled by the following keys:
3303c609719bSwdenk
3304c609719bSwdenk	? - print current values og the CPM Timer registers
3305c609719bSwdenk	b - enable interrupts and start timer
3306c609719bSwdenk	e - stop timer and disable interrupts
3307c609719bSwdenk	q - quit application
3308c609719bSwdenk
3309c609719bSwdenk	=> loads
3310c609719bSwdenk	## Ready for S-Record download ...
3311c609719bSwdenk	~>examples/timer.srec
3312c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3313c609719bSwdenk	[file transfer complete]
3314c609719bSwdenk	[connected]
3315c609719bSwdenk	## Start Addr = 0x00040004
3316c609719bSwdenk
3317c609719bSwdenk	=> go 40004
3318c609719bSwdenk	## Starting application at 0x00040004 ...
3319c609719bSwdenk	TIMERS=0xfff00980
3320c609719bSwdenk	Using timer 1
3321c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3322c609719bSwdenk
3323c609719bSwdenkHit 'b':
3324c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3325c609719bSwdenk	Enabling timer
3326c609719bSwdenkHit '?':
3327c609719bSwdenk	[q, b, e, ?] ........
3328c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3329c609719bSwdenkHit '?':
3330c609719bSwdenk	[q, b, e, ?] .
3331c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3332c609719bSwdenkHit '?':
3333c609719bSwdenk	[q, b, e, ?] .
3334c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3335c609719bSwdenkHit '?':
3336c609719bSwdenk	[q, b, e, ?] .
3337c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3338c609719bSwdenkHit 'e':
3339c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3340c609719bSwdenkHit 'q':
3341c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3342c609719bSwdenk
3343c609719bSwdenk
334485ec0bccSwdenkMinicom warning:
334585ec0bccSwdenk================
334685ec0bccSwdenk
33477152b1d0SwdenkOver time, many people have reported problems when trying to use the
334885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
334985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3350f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
335185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
335285ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
335385ec0bccSwdenk
335452f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
335552f52c14Swdenkconfiguration to your "File transfer protocols" section:
335652f52c14Swdenk
335752f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
335852f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
335952f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
336052f52c14Swdenk
336152f52c14Swdenk
3362c609719bSwdenkNetBSD Notes:
3363c609719bSwdenk=============
3364c609719bSwdenk
3365c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3366c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3367c609719bSwdenk
3368c609719bSwdenkBuilding requires a cross environment; it is known to work on
3369c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3370c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3371c609719bSwdenkNote that the cross-powerpc package does not install include files;
3372c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3373c609719bSwdenkmissing.  This file has to be installed and patched manually:
3374c609719bSwdenk
3375c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3376c609719bSwdenk	# mkdir powerpc
3377c609719bSwdenk	# ln -s powerpc machine
3378c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3379c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3380c609719bSwdenk
3381c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3382c609719bSwdenkand U-Boot include files.
3383c609719bSwdenk
3384c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3385c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3386c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3387c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
33882a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3389c609719bSwdenk
3390c609719bSwdenk
3391c609719bSwdenkImplementation Internals:
3392c609719bSwdenk=========================
3393c609719bSwdenk
3394c609719bSwdenkThe following is not intended to be a complete description of every
3395c609719bSwdenkimplementation detail. However, it should help to understand the
3396c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3397c609719bSwdenkhardware.
3398c609719bSwdenk
3399c609719bSwdenk
3400c609719bSwdenkInitial Stack, Global Data:
3401c609719bSwdenk---------------------------
3402c609719bSwdenk
3403c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3404c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3405c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3406c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3407c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3408c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3409c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3410c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3411c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3412c609719bSwdenklocked as (mis-) used as memory, etc.
3413c609719bSwdenk
34147152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
341543d9616cSwdenk	u-boot-users mailing list:
341643d9616cSwdenk
341743d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
341843d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
341943d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
342043d9616cSwdenk	...
342143d9616cSwdenk
342243d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
342343d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
342443d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
342543d9616cSwdenk	is that the cache is being used as a temporary supply of
342643d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
342743d9616cSwdenk	beyond the scope of this list to expain the details, but you
342843d9616cSwdenk	can see how this works by studying the cache architecture and
342943d9616cSwdenk	operation in the architecture and processor-specific manuals.
343043d9616cSwdenk
343143d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
343243d9616cSwdenk	is another option for the system designer to use as an
343343d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
343443d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
343543d9616cSwdenk	board designers haven't used it for something that would
343643d9616cSwdenk	cause you grief during the initial boot! It is frequently not
343743d9616cSwdenk	used.
343843d9616cSwdenk
343943d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
344043d9616cSwdenk	with your processor/board/system design. The default value
344143d9616cSwdenk	you will find in any recent u-boot distribution in
34428a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
344343d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
344443d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
344543d9616cSwdenk	that are supposed to respond to that address! That code in
344643d9616cSwdenk	start.S has been around a while and should work as is when
344743d9616cSwdenk	you get the config right.
344843d9616cSwdenk
344943d9616cSwdenk	-Chris Hallinan
345043d9616cSwdenk	DS4.COM, Inc.
345143d9616cSwdenk
3452c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3453c609719bSwdenkcode for the initialization procedures:
3454c609719bSwdenk
3455c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3456c609719bSwdenk  to write it.
3457c609719bSwdenk
3458c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3459c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
34607152b1d0Swdenk  zation is performed later (when relocating to RAM).
3461c609719bSwdenk
3462c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3463c609719bSwdenk  that.
3464c609719bSwdenk
3465c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3466c609719bSwdenknormal global data to share information beween the code. But it
3467c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3468c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3469c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3470c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3471c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3472c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3473c609719bSwdenkreserve for this purpose.
3474c609719bSwdenk
34757152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3476c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3477c609719bSwdenkGCC's implementation.
3478c609719bSwdenk
3479c609719bSwdenkFor PowerPC, the following registers have specific use:
3480c609719bSwdenk	R1:	stack pointer
3481c609719bSwdenk	R2:	TOC pointer
3482c609719bSwdenk	R3-R4:	parameter passing and return values
3483c609719bSwdenk	R5-R10: parameter passing
3484c609719bSwdenk	R13:	small data area pointer
3485c609719bSwdenk	R30:	GOT pointer
3486c609719bSwdenk	R31:	frame pointer
3487c609719bSwdenk
3488c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3489c609719bSwdenk
3490c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3491c609719bSwdenk
3492c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3493c609719bSwdenk    address of the global data structure is known at compile time),
3494c609719bSwdenk    but it turned out that reserving a register results in somewhat
3495c609719bSwdenk    smaller code - although the code savings are not that big (on
3496c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3497c609719bSwdenk    624 text + 127 data).
3498c609719bSwdenk
3499c609719bSwdenkOn ARM, the following registers are used:
3500c609719bSwdenk
3501c609719bSwdenk	R0:	function argument word/integer result
3502c609719bSwdenk	R1-R3:	function argument word
3503c609719bSwdenk	R9:	GOT pointer
3504c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3505c609719bSwdenk	R11:	argument (frame) pointer
3506c609719bSwdenk	R12:	temporary workspace
3507c609719bSwdenk	R13:	stack pointer
3508c609719bSwdenk	R14:	link register
3509c609719bSwdenk	R15:	program counter
3510c609719bSwdenk
3511c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3512c609719bSwdenk
3513d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3514d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3515c609719bSwdenk
3516c609719bSwdenkMemory Management:
3517c609719bSwdenk------------------
3518c609719bSwdenk
3519c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3520c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3521c609719bSwdenk
3522c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3523c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3524c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3525c609719bSwdenkphysical memory banks.
3526c609719bSwdenk
3527c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3528c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3529c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3530c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3531c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3532c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3533c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3534c609719bSwdenk
3535c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3536c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3537c609719bSwdenk
3538c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3539c609719bSwdenkthis:
3540c609719bSwdenk
3541c609719bSwdenk	0x0000 0000	Exception Vector code
3542c609719bSwdenk	      :
3543c609719bSwdenk	0x0000 1FFF
3544c609719bSwdenk	0x0000 2000	Free for Application Use
3545c609719bSwdenk	      :
3546c609719bSwdenk	      :
3547c609719bSwdenk
3548c609719bSwdenk	      :
3549c609719bSwdenk	      :
3550c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3551c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3552c609719bSwdenk	0x00FC 0000	Malloc Arena
3553c609719bSwdenk	      :
3554c609719bSwdenk	0x00FD FFFF
3555c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3556c609719bSwdenk	...		eventually: LCD or video framebuffer
3557c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3558c609719bSwdenk	0x00FF FFFF	[End of RAM]
3559c609719bSwdenk
3560c609719bSwdenk
3561c609719bSwdenkSystem Initialization:
3562c609719bSwdenk----------------------
3563c609719bSwdenk
3564c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3565c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3566c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
35677152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3568c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3569c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3570c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3571c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3572c609719bSwdenkthe caches and the SIU.
3573c609719bSwdenk
3574c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3575c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3576c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3577c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3578c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3579c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3580c609719bSwdenkbanks.
3581c609719bSwdenk
3582c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
35837152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3584c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3585c609719bSwdenk0x00000000, with any additional banks following immediately to create
3586c609719bSwdenkcontiguous memory starting from 0.
3587c609719bSwdenk
3588c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3589c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3590c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3591c609719bSwdenkpages, and the final stack is set up.
3592c609719bSwdenk
3593c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3594c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3595c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3596c609719bSwdenknew address in RAM.
3597c609719bSwdenk
3598c609719bSwdenk
3599c609719bSwdenkU-Boot Porting Guide:
3600c609719bSwdenk----------------------
3601c609719bSwdenk
3602c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
36036aff3115Swdenklist, October 2002]
3604c609719bSwdenk
3605c609719bSwdenk
3606c609719bSwdenkint main (int argc, char *argv[])
3607c609719bSwdenk{
3608c609719bSwdenk	sighandler_t no_more_time;
3609c609719bSwdenk
3610c609719bSwdenk	signal (SIGALRM, no_more_time);
3611c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3612c609719bSwdenk
3613c609719bSwdenk	if (available_money > available_manpower) {
3614c609719bSwdenk		pay consultant to port U-Boot;
3615c609719bSwdenk		return 0;
3616c609719bSwdenk	}
3617c609719bSwdenk
3618c609719bSwdenk	Download latest U-Boot source;
3619c609719bSwdenk
36206aff3115Swdenk	Subscribe to u-boot-users mailing list;
36216aff3115Swdenk
3622c609719bSwdenk	if (clueless) {
3623c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3624c609719bSwdenk	}
3625c609719bSwdenk
3626c609719bSwdenk	while (learning) {
3627c609719bSwdenk		Read the README file in the top level directory;
36287cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3629c609719bSwdenk		Read the source, Luke;
3630c609719bSwdenk	}
3631c609719bSwdenk
3632c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3633c609719bSwdenk		Buy a BDI2000;
3634c609719bSwdenk	} else {
3635c609719bSwdenk		Add a lot of aggravation and time;
3636c609719bSwdenk	}
3637c609719bSwdenk
3638c609719bSwdenk	Create your own board support subdirectory;
3639c609719bSwdenk
36406aff3115Swdenk	Create your own board config file;
36416aff3115Swdenk
3642c609719bSwdenk	while (!running) {
3643c609719bSwdenk		do {
3644c609719bSwdenk			Add / modify source code;
3645c609719bSwdenk		} until (compiles);
3646c609719bSwdenk		Debug;
3647c609719bSwdenk		if (clueless)
3648c609719bSwdenk			email ("Hi, I am having problems...");
3649c609719bSwdenk	}
3650c609719bSwdenk	Send patch file to Wolfgang;
3651c609719bSwdenk
3652c609719bSwdenk	return 0;
3653c609719bSwdenk}
3654c609719bSwdenk
3655c609719bSwdenkvoid no_more_time (int sig)
3656c609719bSwdenk{
3657c609719bSwdenk      hire_a_guru();
3658c609719bSwdenk}
3659c609719bSwdenk
3660c609719bSwdenk
3661c609719bSwdenkCoding Standards:
3662c609719bSwdenk-----------------
3663c609719bSwdenk
3664c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
36652c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
36662c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
36672c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
36682c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3669c609719bSwdenk
36702c051651SDetlev ZundelSource files originating from a different project (for example the
36712c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
36722c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
36732c051651SDetlev Zundelsources.
36742c051651SDetlev Zundel
36752c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
36762c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
36772c051651SDetlev Zundelin your code.
3678c609719bSwdenk
3679c178d3daSwdenkPlease also stick to the following formatting rules:
3680180d3f74Swdenk- remove any trailing white space
3681180d3f74Swdenk- use TAB characters for indentation, not spaces
3682180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3683180d3f74Swdenk- do not add more than 2 empty lines to source files
3684180d3f74Swdenk- do not add trailing empty lines to source files
3685180d3f74Swdenk
3686c609719bSwdenkSubmissions which do not conform to the standards may be returned
3687c609719bSwdenkwith a request to reformat the changes.
3688c609719bSwdenk
3689c609719bSwdenk
3690c609719bSwdenkSubmitting Patches:
3691c609719bSwdenk-------------------
3692c609719bSwdenk
3693c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3694c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3695c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3696c609719bSwdenk
369790dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3698c609719bSwdenk
3699c609719bSwdenkWhen you send a patch, please include the following information with
3700c609719bSwdenkit:
3701c609719bSwdenk
3702c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3703c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3704c609719bSwdenk  patch actually fixes something.
3705c609719bSwdenk
3706c609719bSwdenk* For new features: a description of the feature and your
3707c609719bSwdenk  implementation.
3708c609719bSwdenk
3709c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3710c609719bSwdenk
3711c609719bSwdenk* For major contributions, your entry to the CREDITS file
3712c609719bSwdenk
3713c609719bSwdenk* When you add support for a new board, don't forget to add this
3714c609719bSwdenk  board to the MAKEALL script, too.
3715c609719bSwdenk
3716c609719bSwdenk* If your patch adds new configuration options, don't forget to
3717c609719bSwdenk  document these in the README file.
3718c609719bSwdenk
3719c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3720c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3721c609719bSwdenk  version of diff does not support these options, then get the latest
3722c609719bSwdenk  version of GNU diff.
3723c609719bSwdenk
37246dff5529Swdenk  The current directory when running this command shall be the top
37256dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
37266dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
37276dff5529Swdenk  directory information for the affected files).
37286dff5529Swdenk
3729c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3730c609719bSwdenk  gzipped text.
3731c609719bSwdenk
373252f52c14Swdenk* If one logical set of modifications affects or creates several
373352f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
373452f52c14Swdenk
373552f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
373652f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
373752f52c14Swdenk
373852f52c14Swdenk
3739c609719bSwdenkNotes:
3740c609719bSwdenk
3741c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3742c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3743c609719bSwdenk  for any of the boards.
3744c609719bSwdenk
3745c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3746c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3747c609719bSwdenk  returned with a request to re-formatting / split it.
3748c609719bSwdenk
3749c609719bSwdenk* If you modify existing code, make sure that your new code does not
3750c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3751c609719bSwdenk  When adding new features, these should compile conditionally only
3752c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3753c609719bSwdenk  disabled must not need more memory than the old code without your
3754c609719bSwdenk  modification.
375590dc6704Swdenk
375690dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
375790dc6704Swdenk  u-boot-users mailing list. Compression may help.
3758