xref: /openbmc/u-boot/README (revision 218ca724c08ca8a649f0917cf201cf23d4b33f39)
1c609719bSwdenk#
2*218ca724SWolfgang Denk# (C) Copyright 2000 - 2008
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54*218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55*218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
63c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
64c609719bSwdenkprevious traffic on the mailing list - please search the archive
65c609719bSwdenkbefore asking FAQ's. Please see
66c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
67c609719bSwdenk
68c609719bSwdenk
69*218ca724SWolfgang DenkWhere to get source code:
70*218ca724SWolfgang Denk=========================
71*218ca724SWolfgang Denk
72*218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73*218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74*218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75*218ca724SWolfgang Denk
76*218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
77*218ca724SWolfgang Denkany version you might be interested in. Ofifcial releases are also
78*218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79*218ca724SWolfgang Denkdirectory.
80*218ca724SWolfgang Denk
81*218ca724SWolfgang DenkPre-build (and tested) images are available from
82*218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83*218ca724SWolfgang Denk
84*218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
97c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
101*218ca724SWolfgang Denk- current project page: see http://www.denx.de/wiki/UBoot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
12993f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
13093f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
13193f19cc0Swdenksub-version "34", and patchlevel "4".
13293f19cc0Swdenk
13393f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
13493f19cc0Swdenkbetween released versions, i. e. officially released versions of
13593f19cc0SwdenkU-Boot will always have a patchlevel of "0".
13693f19cc0Swdenk
13793f19cc0Swdenk
138c609719bSwdenkDirectory Hierarchy:
139c609719bSwdenk====================
140c609719bSwdenk
1417152b1d0Swdenk- board		Board dependent files
1427152b1d0Swdenk- common	Misc architecture independent functions
143c609719bSwdenk- cpu		CPU specific files
144983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
14511dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
14611dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
147a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
148983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1491d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
15011dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
15111dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1528ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
15372a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
15411dadd54Swdenk  - i386	Files specific to i386 CPUs
15511dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
156983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
1571552af70STsiChungLiew  - mcf5227x	Files specific to Freescale ColdFire MCF5227x CPUs
1588e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
1598ae158cdSTsiChungLiew  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
16057a12720STsiChungLiew  - mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
16111dadd54Swdenk  - mips	Files specific to MIPS CPUs
162983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
163983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
164983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
165983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
166983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
167983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
168983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
16911dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1705c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1710c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
17211dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
17311dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
17411dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
175c609719bSwdenk- disk		Code for disk drive partition handling
176c609719bSwdenk- doc		Documentation (don't expect too much)
1777152b1d0Swdenk- drivers	Commonly used device drivers
178c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
179c609719bSwdenk- examples	Example code for standalone applications, etc.
180c609719bSwdenk- include	Header Files
18111dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1827b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
18311dadd54Swdenk- lib_generic	Files generic to all	 architectures
18411dadd54Swdenk- lib_i386	Files generic to i386	 architecture
18511dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
18611dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
18711dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
18811dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
189213bf8c8SGerald Van Baren- libfdt	Library files to support flattened device trees
190c609719bSwdenk- net		Networking code
191c609719bSwdenk- post		Power On Self Test
192c609719bSwdenk- rtc		Real Time Clock drivers
193c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
194c609719bSwdenk
195c609719bSwdenkSoftware Configuration:
196c609719bSwdenk=======================
197c609719bSwdenk
198c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
199c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
200c609719bSwdenk
201c609719bSwdenkThere are two classes of configuration variables:
202c609719bSwdenk
203c609719bSwdenk* Configuration _OPTIONS_:
204c609719bSwdenk  These are selectable by the user and have names beginning with
205c609719bSwdenk  "CONFIG_".
206c609719bSwdenk
207c609719bSwdenk* Configuration _SETTINGS_:
208c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
209c609719bSwdenk  you don't know what you're doing; they have names beginning with
210c609719bSwdenk  "CFG_".
211c609719bSwdenk
212c609719bSwdenkLater we will add a configuration tool - probably similar to or even
213c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
214c609719bSwdenkdo the configuration by hand, which means creating some symbolic
215c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
216c609719bSwdenkas an example here.
217c609719bSwdenk
218c609719bSwdenk
219c609719bSwdenkSelection of Processor Architecture and Board Type:
220c609719bSwdenk---------------------------------------------------
221c609719bSwdenk
222c609719bSwdenkFor all supported boards there are ready-to-use default
223c609719bSwdenkconfigurations available; just type "make <board_name>_config".
224c609719bSwdenk
225c609719bSwdenkExample: For a TQM823L module type:
226c609719bSwdenk
227c609719bSwdenk	cd u-boot
228c609719bSwdenk	make TQM823L_config
229c609719bSwdenk
230c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
231c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
232c609719bSwdenkdirectory according to the instructions in cogent/README.
233c609719bSwdenk
234c609719bSwdenk
235c609719bSwdenkConfiguration Options:
236c609719bSwdenk----------------------
237c609719bSwdenk
238c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
239c609719bSwdenksuch information is kept in a configuration file
240c609719bSwdenk"include/configs/<board_name>.h".
241c609719bSwdenk
242c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
243c609719bSwdenk"include/configs/TQM823L.h".
244c609719bSwdenk
245c609719bSwdenk
2467f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2477f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2487f6c2cbcSwdenkbuild a config tool - later.
2497f6c2cbcSwdenk
2507f6c2cbcSwdenk
251c609719bSwdenkThe following options need to be configured:
252c609719bSwdenk
2532628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
254c609719bSwdenk
2552628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2566ccec449SWolfgang Denk
2576ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
25809ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
259c609719bSwdenk
260c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
261c609719bSwdenk		Define exactly one of
262c609719bSwdenk		CONFIG_CMA286_60_OLD
263c609719bSwdenk--- FIXME --- not tested yet:
264c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
265c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
266c609719bSwdenk
267c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
268c609719bSwdenk		Define exactly one of
269c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
270c609719bSwdenk
271c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
272c609719bSwdenk		Define one or more of
273c609719bSwdenk		CONFIG_CMA302
274c609719bSwdenk
275c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
276c609719bSwdenk		Define one or more of
277c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
278c609719bSwdenk					  the lcd display every second with
279c609719bSwdenk					  a "rotator" |\-/|\-/
280c609719bSwdenk
2812535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
2822535d602Swdenk		CONFIG_ADSTYPE
2832535d602Swdenk		Possible values are:
2842535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
285180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
28654387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
28704a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
2882535d602Swdenk
289c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
290c609719bSwdenk		Define exactly one of
291c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
292c609719bSwdenk
29375d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
29466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
29566ca92a5Swdenk					  get_gclk_freq() cannot work
2965da627a4Swdenk					  e.g. if there is no 32KHz
2975da627a4Swdenk					  reference PIT/RTC clock
29866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
29966ca92a5Swdenk					  or XTAL/EXTAL)
300c609719bSwdenk
30166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
30266ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
30366ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
30466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
30575d1ea7fSwdenk			See doc/README.MPC866
30675d1ea7fSwdenk
30775d1ea7fSwdenk		CFG_MEASURE_CPUCLK
30875d1ea7fSwdenk
30975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
31075d1ea7fSwdenk		of relying on the correctness of the configured
31175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
31275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
31375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
31466ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
31575d1ea7fSwdenk
3160b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3170b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
3180b953ffcSMarkus Klotzbuecher
3190b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3200b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3210b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3220b953ffcSMarkus Klotzbuecher
3230b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
3240b953ffcSMarkus Klotzbuecher
3250b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3260b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3270b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3280b953ffcSMarkus Klotzbuecher		by this value.
3290b953ffcSMarkus Klotzbuecher
3305da627a4Swdenk- Linux Kernel Interface:
331c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
332c609719bSwdenk
333c609719bSwdenk		U-Boot stores all clock information in Hz
334c609719bSwdenk		internally. For binary compatibility with older Linux
335c609719bSwdenk		kernels (which expect the clocks passed in the
336c609719bSwdenk		bd_info data to be in MHz) the environment variable
337c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
338c609719bSwdenk		converts clock data to MHZ before passing it to the
339c609719bSwdenk		Linux kernel.
340c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
341c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
342c609719bSwdenk		default environment.
343c609719bSwdenk
3445da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3455da627a4Swdenk
3465da627a4Swdenk		When transfering memsize parameter to linux, some versions
3475da627a4Swdenk		expect it to be in bytes, others in MB.
3485da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3495da627a4Swdenk
350213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
351f57f70aaSWolfgang Denk
352f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
353213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
354213bf8c8SGerald Van Baren		concepts).
355213bf8c8SGerald Van Baren
356213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
357213bf8c8SGerald Van Baren		 * New libfdt-based support
358213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3593bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
360213bf8c8SGerald Van Baren
361213bf8c8SGerald Van Baren		CONFIG_OF_FLAT_TREE
362213bf8c8SGerald Van Baren		 * Deprecated, see CONFIG_OF_LIBFDT
363213bf8c8SGerald Van Baren		 * Original ft_build.c-based support
364213bf8c8SGerald Van Baren		 * Automatically modifies the dft as part of the bootm command
365213bf8c8SGerald Van Baren		 * The environment variable "disable_of", when set,
366213bf8c8SGerald Van Baren		     disables this functionality.
367f57f70aaSWolfgang Denk
368f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
369c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
370f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
371c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
372f57f70aaSWolfgang Denk
3733bb342fcSKim Phillips		boards with QUICC Engines require OF_QE to set UCC mac addresses
3743bb342fcSKim Phillips
375e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
376e4f880edSKumar Gala
377213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
378213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
379213bf8c8SGerald Van Baren		     will have a copy of the bd_t.  Space should be
380213bf8c8SGerald Van Baren		     pre-allocated in the dts for the bd_t.
381e4f880edSKumar Gala
382e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
383e4f880edSKumar Gala
3843bb342fcSKim Phillips		 * CONFIG_OF_LIBFDT - enables the "fdt env" command
385213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
386213bf8c8SGerald Van Baren		     will have a copy of u-boot's environment variables
387e4f880edSKumar Gala
3884e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
3894e253137SKumar Gala
3904e253137SKumar Gala		Board code has addition modification that it wants to make
3914e253137SKumar Gala		to the flat device tree before handing it off to the kernel
3926705d81eSwdenk
3930267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
3940267768eSMatthew McClintock
3950267768eSMatthew McClintock		This define fills in the correct boot cpu in the boot
3960267768eSMatthew McClintock		param header, the default value is zero if undefined.
3970267768eSMatthew McClintock
3986705d81eSwdenk- Serial Ports:
3996705d81eSwdenk		CFG_PL010_SERIAL
4006705d81eSwdenk
4016705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4026705d81eSwdenk
4036705d81eSwdenk		CFG_PL011_SERIAL
4046705d81eSwdenk
4056705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4066705d81eSwdenk
4076705d81eSwdenk		CONFIG_PL011_CLOCK
4086705d81eSwdenk
4096705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4106705d81eSwdenk		the clock speed of the UARTs.
4116705d81eSwdenk
4126705d81eSwdenk		CONFIG_PL01x_PORTS
4136705d81eSwdenk
4146705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4156705d81eSwdenk		define this to a list of base addresses for each (supported)
4166705d81eSwdenk		port. See e.g. include/configs/versatile.h
4176705d81eSwdenk
4186705d81eSwdenk
419c609719bSwdenk- Console Interface:
420c609719bSwdenk		Depending on board, define exactly one serial port
421c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
422c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
423c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
424c609719bSwdenk
425c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
426c609719bSwdenk		port routines must be defined elsewhere
427c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
428c609719bSwdenk
429c609719bSwdenk		CONFIG_CFB_CONSOLE
430c609719bSwdenk		Enables console device for a color framebuffer. Needs following
431c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
432c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
433c609719bSwdenk						(default big endian)
434c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
435c609719bSwdenk						rectangle fill
436c609719bSwdenk						(cf. smiLynxEM)
437c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
438c609719bSwdenk						bit-blit (cf. smiLynxEM)
439c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
440c609719bSwdenk						(cols=pitch)
441c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
442c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
443c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
444c609719bSwdenk						(0-5, cf. cfb_console.c)
445c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
446c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
447c609719bSwdenk						(i.e. i8042_kbd_init())
448c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
449c609719bSwdenk						(i.e. i8042_tstc)
450c609719bSwdenk			VIDEO_GETC_FCT		get char fct
451c609719bSwdenk						(i.e. i8042_getc)
452c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
453c609719bSwdenk						(requires blink timer
454c609719bSwdenk						cf. i8042.c)
455c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
456c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
457c609719bSwdenk						upper right corner
458602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
459c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
460c609719bSwdenk						upper left corner
461a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
462a6c7ad2fSwdenk						linux_logo.h for logo.
463a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
464c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
465c609719bSwdenk						addional board info beside
466c609719bSwdenk						the logo
467c609719bSwdenk
468c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
469c609719bSwdenk		default i/o. Serial console can be forced with
470c609719bSwdenk		environment 'console=serial'.
471c609719bSwdenk
472a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
473a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
474a3ad8e26Swdenk		the "silent" environment variable. See
475a3ad8e26Swdenk		doc/README.silent for more information.
476a3ad8e26Swdenk
477c609719bSwdenk- Console Baudrate:
478c609719bSwdenk		CONFIG_BAUDRATE - in bps
479c609719bSwdenk		Select one of the baudrates listed in
480c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
4813bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
482c609719bSwdenk
483c609719bSwdenk- Interrupt driven serial port input:
484c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
485c609719bSwdenk
486c609719bSwdenk		PPC405GP only.
487c609719bSwdenk		Use an interrupt handler for receiving data on the
488c609719bSwdenk		serial port. It also enables using hardware handshake
489c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
490c609719bSwdenk		bytes the interrupt driven input buffer should have.
491c609719bSwdenk
492109c0e3aSwdenk		Leave undefined to disable this feature, including
493109c0e3aSwdenk		disable the buffer and hardware handshake.
494c609719bSwdenk
4951d49b1f3Sstroese- Console UART Number:
4961d49b1f3Sstroese		CONFIG_UART1_CONSOLE
4971d49b1f3Sstroese
4980c8721a4SWolfgang Denk		AMCC PPC4xx only.
4991d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5001d49b1f3Sstroese		as default U-Boot console.
5011d49b1f3Sstroese
502c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
503c609719bSwdenk		Delay before automatically booting the default image;
504c609719bSwdenk		set to -1 to disable autoboot.
505c609719bSwdenk
506c609719bSwdenk		See doc/README.autoboot for these options that
507c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
508c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
509c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
510c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
511c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
512c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
513c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
514c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
515c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
516c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
517c609719bSwdenk		CONFIG_RESET_TO_RETRY
518c609719bSwdenk
519c609719bSwdenk- Autoboot Command:
520c609719bSwdenk		CONFIG_BOOTCOMMAND
521c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
522c609719bSwdenk		define a command string that is automatically executed
523c609719bSwdenk		when no character is read on the console interface
524c609719bSwdenk		within "Boot Delay" after reset.
525c609719bSwdenk
526c609719bSwdenk		CONFIG_BOOTARGS
527c609719bSwdenk		This can be used to pass arguments to the bootm
528c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
529c609719bSwdenk		environment value "bootargs".
530c609719bSwdenk
531c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
532c609719bSwdenk		The value of these goes into the environment as
533c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
534c609719bSwdenk		as a convenience, when switching between booting from
535c609719bSwdenk		ram and nfs.
536c609719bSwdenk
537c609719bSwdenk- Pre-Boot Commands:
538c609719bSwdenk		CONFIG_PREBOOT
539c609719bSwdenk
540c609719bSwdenk		When this option is #defined, the existence of the
541c609719bSwdenk		environment variable "preboot" will be checked
542c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
543c609719bSwdenk		countdown and/or running the auto-boot command resp.
544c609719bSwdenk		entering interactive mode.
545c609719bSwdenk
546c609719bSwdenk		This feature is especially useful when "preboot" is
547c609719bSwdenk		automatically generated or modified. For an example
548c609719bSwdenk		see the LWMON board specific code: here "preboot" is
549c609719bSwdenk		modified when the user holds down a certain
550c609719bSwdenk		combination of keys on the (special) keyboard when
551c609719bSwdenk		booting the systems
552c609719bSwdenk
553c609719bSwdenk- Serial Download Echo Mode:
554c609719bSwdenk		CONFIG_LOADS_ECHO
555c609719bSwdenk		If defined to 1, all characters received during a
556c609719bSwdenk		serial download (using the "loads" command) are
557c609719bSwdenk		echoed back. This might be needed by some terminal
558c609719bSwdenk		emulations (like "cu"), but may as well just take
559c609719bSwdenk		time on others. This setting #define's the initial
560c609719bSwdenk		value of the "loads_echo" environment variable.
561c609719bSwdenk
562602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
563c609719bSwdenk		CONFIG_KGDB_BAUDRATE
564c609719bSwdenk		Select one of the baudrates listed in
565c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
566c609719bSwdenk
567c609719bSwdenk- Monitor Functions:
568602ad3b3SJon Loeliger		Monitor commands can be included or excluded
569602ad3b3SJon Loeliger		from the build by using the #include files
570602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
571602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
572602ad3b3SJon Loeliger		and augmenting with additional #define's
573602ad3b3SJon Loeliger		for wanted commands.
574c609719bSwdenk
575602ad3b3SJon Loeliger		The default command configuration includes all commands
576602ad3b3SJon Loeliger		except those marked below with a "*".
577602ad3b3SJon Loeliger
578602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
579602ad3b3SJon Loeliger		CONFIG_CMD_AUTOSCRIPT	  Autoscript Support
580602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
581602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
582602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
583602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
584602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
585602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
586602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
587602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
588602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
589602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
590602ad3b3SJon Loeliger		CONFIG_CMD_DOC		* Disk-On-Chip Support
591602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
592602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
593602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
594602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
595602ad3b3SJon Loeliger		CONFIG_CMD_ENV		  saveenv
596602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
597602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
598602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
599602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
600602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
601602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
602602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
603602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
604602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
605602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
606602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
607602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
608602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
609602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
610602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
611602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
612602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
613602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
61456523f12Swdenk					  loop, loopw, mtest
615602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
616602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
617602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
618602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
619602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
620602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
621602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
622602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
623602ad3b3SJon Loeliger					  host
624602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
625602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
626602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
627602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
628602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
629602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
630602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
631602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
632602ad3b3SJon Loeliger					  (4xx only)
633602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
634602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
635602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
636602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board SPecific functions
637602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
638602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
639c609719bSwdenk
640c609719bSwdenk
641c609719bSwdenk		EXAMPLE: If you want all functions except of network
642c609719bSwdenk		support you can write:
643c609719bSwdenk
644602ad3b3SJon Loeliger		#include "config_cmd_all.h"
645602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
646c609719bSwdenk
647213bf8c8SGerald Van Baren	Other Commands:
648213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
649c609719bSwdenk
650c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
651602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
652c609719bSwdenk		what you (and your U-Boot users) are doing. Data
653c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
654c609719bSwdenk		8260 (where accesses to the IMMR region must be
655c609719bSwdenk		uncached), and it cannot be disabled on all other
656c609719bSwdenk		systems where we (mis-) use the data cache to hold an
657c609719bSwdenk		initial stack and some data.
658c609719bSwdenk
659c609719bSwdenk
660c609719bSwdenk		XXX - this list needs to get updated!
661c609719bSwdenk
662c609719bSwdenk- Watchdog:
663c609719bSwdenk		CONFIG_WATCHDOG
664c609719bSwdenk		If this variable is defined, it enables watchdog
6657152b1d0Swdenk		support. There must be support in the platform specific
666c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
667c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
668c609719bSwdenk		register.
669c609719bSwdenk
670c1551ea8Sstroese- U-Boot Version:
671c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
672c1551ea8Sstroese		If this variable is defined, an environment variable
673c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
674c1551ea8Sstroese		version as printed by the "version" command.
675c1551ea8Sstroese		This variable is readonly.
676c1551ea8Sstroese
677c609719bSwdenk- Real-Time Clock:
678c609719bSwdenk
679602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
680c609719bSwdenk		has to be selected, too. Define exactly one of the
681c609719bSwdenk		following options:
682c609719bSwdenk
683c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
684c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
685c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
6861cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
687c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
6887f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
6893bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
6909536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
6914c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
692c609719bSwdenk
693b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
694b37c7e5eSwdenk		must also be configured. See I2C Support, below.
695b37c7e5eSwdenk
696c609719bSwdenk- Timestamp Support:
697c609719bSwdenk
698c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
699c609719bSwdenk		(date and time) of an image is printed by image
700c609719bSwdenk		commands like bootm or iminfo. This option is
701602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
702c609719bSwdenk
703c609719bSwdenk- Partition Support:
704c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
705c609719bSwdenk		and/or CONFIG_ISO_PARTITION
706c609719bSwdenk
707602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
708*218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
709*218ca724SWolfgang Denk		least one partition type as well.
710c609719bSwdenk
711c609719bSwdenk- IDE Reset method:
7124d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7134d13cbadSwdenk		board configurations files but used nowhere!
714c609719bSwdenk
7154d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7164d13cbadSwdenk		be performed by calling the function
7174d13cbadSwdenk			ide_set_reset(int reset)
7184d13cbadSwdenk		which has to be defined in a board specific file
719c609719bSwdenk
720c609719bSwdenk- ATAPI Support:
721c609719bSwdenk		CONFIG_ATAPI
722c609719bSwdenk
723c609719bSwdenk		Set this to enable ATAPI support.
724c609719bSwdenk
725c40b2956Swdenk- LBA48 Support
726c40b2956Swdenk		CONFIG_LBA48
727c40b2956Swdenk
728c40b2956Swdenk		Set this to enable support for disks larger than 137GB
729c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
730c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
731c40b2956Swdenk		support disks up to 2.1TB.
732c40b2956Swdenk
733c40b2956Swdenk		CFG_64BIT_LBA:
734c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
735c40b2956Swdenk			Default is 32bit.
736c40b2956Swdenk
737c609719bSwdenk- SCSI Support:
738c609719bSwdenk		At the moment only there is only support for the
739c609719bSwdenk		SYM53C8XX SCSI controller; define
740c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
741c609719bSwdenk
742c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
743c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
744c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
745c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
746c609719bSwdenk		devices.
747c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
748c609719bSwdenk
749c609719bSwdenk- NETWORK Support (PCI):
750682011ffSwdenk		CONFIG_E1000
751682011ffSwdenk		Support for Intel 8254x gigabit chips.
752682011ffSwdenk
753c609719bSwdenk		CONFIG_EEPRO100
754c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
755c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
756c609719bSwdenk		write routine for first time initialisation.
757c609719bSwdenk
758c609719bSwdenk		CONFIG_TULIP
759c609719bSwdenk		Support for Digital 2114x chips.
760c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
761c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
762c609719bSwdenk
763c609719bSwdenk		CONFIG_NATSEMI
764c609719bSwdenk		Support for National dp83815 chips.
765c609719bSwdenk
766c609719bSwdenk		CONFIG_NS8382X
767c609719bSwdenk		Support for National dp8382[01] gigabit chips.
768c609719bSwdenk
76945219c46Swdenk- NETWORK Support (other):
77045219c46Swdenk
77145219c46Swdenk		CONFIG_DRIVER_LAN91C96
77245219c46Swdenk		Support for SMSC's LAN91C96 chips.
77345219c46Swdenk
77445219c46Swdenk			CONFIG_LAN91C96_BASE
77545219c46Swdenk			Define this to hold the physical address
77645219c46Swdenk			of the LAN91C96's I/O space
77745219c46Swdenk
77845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
77945219c46Swdenk			Define this to enable 32 bit addressing
78045219c46Swdenk
781f39748aeSwdenk		CONFIG_DRIVER_SMC91111
782f39748aeSwdenk		Support for SMSC's LAN91C111 chip
783f39748aeSwdenk
784f39748aeSwdenk			CONFIG_SMC91111_BASE
785f39748aeSwdenk			Define this to hold the physical address
786f39748aeSwdenk			of the device (I/O space)
787f39748aeSwdenk
788f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
789f39748aeSwdenk			Define this if data bus is 32 bits
790f39748aeSwdenk
791f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
792f39748aeSwdenk			Define this to use i/o functions instead of macros
793f39748aeSwdenk			(some hardware wont work with macros)
794f39748aeSwdenk
795c609719bSwdenk- USB Support:
796c609719bSwdenk		At the moment only the UHCI host controller is
7974d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
798c609719bSwdenk		CONFIG_USB_UHCI to enable it.
799c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
80030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
801c609719bSwdenk		storage devices.
802c609719bSwdenk		Note:
803c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
804c609719bSwdenk		(TEAC FD-05PUB).
8054d13cbadSwdenk		MPC5200 USB requires additional defines:
8064d13cbadSwdenk			CONFIG_USB_CLOCK
8074d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8084d13cbadSwdenk			CONFIG_USB_CONFIG
8094d13cbadSwdenk				for differential drivers: 0x00001000
8104d13cbadSwdenk				for single ended drivers: 0x00005000
811fdcfaa1bSZhang Wei			CFG_USB_EVENT_POLL
812fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
813fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
8144d13cbadSwdenk
81516c8d5e7SWolfgang Denk- USB Device:
81616c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
81716c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
81816c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
81916c8d5e7SWolfgang Denk		attach your usb cable. The Unix command "dmesg" should print
82016c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
82116c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
82216c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
82316c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
82416c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
82516c8d5e7SWolfgang Denk		a Linux host by
82616c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
82716c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
82816c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
82916c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
83016c8d5e7SWolfgang Denk
83116c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
83216c8d5e7SWolfgang Denk			Define this to build a UDC device
83316c8d5e7SWolfgang Denk
83416c8d5e7SWolfgang Denk			CONFIG_USB_TTY
83516c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
83616c8d5e7SWolfgang Denk			talk to the UDC device
83716c8d5e7SWolfgang Denk
83816c8d5e7SWolfgang Denk			CFG_CONSOLE_IS_IN_ENV
83916c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
84016c8d5e7SWolfgang Denk			be set to usbtty.
84116c8d5e7SWolfgang Denk
84216c8d5e7SWolfgang Denk			mpc8xx:
84316c8d5e7SWolfgang Denk				CFG_USB_EXTC_CLK 0xBLAH
84416c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
84516c8d5e7SWolfgang Denk				- CFG_USB_EXTC_CLK 0x02
84616c8d5e7SWolfgang Denk
84716c8d5e7SWolfgang Denk				CFG_USB_BRG_CLK 0xBLAH
84816c8d5e7SWolfgang Denk				Derive USB clock from brgclk
84916c8d5e7SWolfgang Denk				- CFG_USB_BRG_CLK 0x04
85016c8d5e7SWolfgang Denk
85116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
85216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
85316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
85416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
85516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
85616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
85716c8d5e7SWolfgang Denk
85816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
85916c8d5e7SWolfgang Denk			Define this string as the name of your company for
86016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
86116c8d5e7SWolfgang Denk
86216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
86316c8d5e7SWolfgang Denk			Define this string as the name of your product
86416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
86516c8d5e7SWolfgang Denk
86616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
86716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
86816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
86916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
87016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
87116c8d5e7SWolfgang Denk
87216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
87316c8d5e7SWolfgang Denk			Define this as the unique Product ID
87416c8d5e7SWolfgang Denk			for your device
87516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
876c609719bSwdenk
877c609719bSwdenk
878c609719bSwdenk- MMC Support:
879c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
880c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
881c609719bSwdenk		accessed from the boot prompt by mapping the device
882c609719bSwdenk		to physical memory similar to flash. Command line is
883602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
884602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
885c609719bSwdenk
8866705d81eSwdenk- Journaling Flash filesystem support:
8876705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8886705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8896705d81eSwdenk		Define these for a default partition on a NAND device
8906705d81eSwdenk
8916705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8926705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8936705d81eSwdenk		Define these for a default partition on a NOR device
8946705d81eSwdenk
8956705d81eSwdenk		CFG_JFFS_CUSTOM_PART
8966705d81eSwdenk		Define this to create an own partition. You have to provide a
8976705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
8986705d81eSwdenk
8996705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9006705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
9016705d81eSwdenk		to disable the command chpart. This is the default when you
9026705d81eSwdenk		have not defined a custom partition
9036705d81eSwdenk
904c609719bSwdenk- Keyboard Support:
905c609719bSwdenk		CONFIG_ISA_KEYBOARD
906c609719bSwdenk
907c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
908c609719bSwdenk		support
909c609719bSwdenk
910c609719bSwdenk		CONFIG_I8042_KBD
911c609719bSwdenk		Standard PC keyboard driver with US (is default) and
912c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
913c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
914c609719bSwdenk		for cfb_console. Supports cursor blinking.
915c609719bSwdenk
916c609719bSwdenk- Video support:
917c609719bSwdenk		CONFIG_VIDEO
918c609719bSwdenk
919c609719bSwdenk		Define this to enable video support (for output to
920c609719bSwdenk		video).
921c609719bSwdenk
922c609719bSwdenk		CONFIG_VIDEO_CT69000
923c609719bSwdenk
924c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
925c609719bSwdenk
926c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
927eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
928eeb1b77bSwdenk		video output is selected via environment 'videoout'
929eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
930eeb1b77bSwdenk		assumed.
931c609719bSwdenk
932eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
933eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
934eeb1b77bSwdenk		are possible:
935eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
936eeb1b77bSwdenk		Following standard modes are supported	(* is default):
937eeb1b77bSwdenk
938eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
939eeb1b77bSwdenk		-------------+---------------------------------------------
940eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
941eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
942eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
943eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
944eeb1b77bSwdenk		-------------+---------------------------------------------
945c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
946c609719bSwdenk
947eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
9487817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
949eeb1b77bSwdenk
950eeb1b77bSwdenk
951a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
952a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
953a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
954a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
955a6c7ad2fSwdenk
956682011ffSwdenk- Keyboard Support:
957682011ffSwdenk		CONFIG_KEYBOARD
958682011ffSwdenk
959682011ffSwdenk		Define this to enable a custom keyboard support.
960682011ffSwdenk		This simply calls drv_keyboard_init() which must be
961682011ffSwdenk		defined in your board-specific files.
962682011ffSwdenk		The only board using this so far is RBC823.
963a6c7ad2fSwdenk
964c609719bSwdenk- LCD Support:	CONFIG_LCD
965c609719bSwdenk
966c609719bSwdenk		Define this to enable LCD support (for output to LCD
967c609719bSwdenk		display); also select one of the supported displays
968c609719bSwdenk		by defining one of these:
969c609719bSwdenk
970fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
971c609719bSwdenk
972fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
973c609719bSwdenk
974fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
975c609719bSwdenk
976fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
977fd3103bbSwdenk			Active, color, single scan.
978fd3103bbSwdenk
979fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
980fd3103bbSwdenk
981fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
982c609719bSwdenk			Active, color, single scan.
983c609719bSwdenk
984c609719bSwdenk		CONFIG_SHARP_16x9
985c609719bSwdenk
986c609719bSwdenk			Sharp 320x240. Active, color, single scan.
987c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
988c609719bSwdenk
989c609719bSwdenk		CONFIG_SHARP_LQ64D341
990c609719bSwdenk
991c609719bSwdenk			Sharp LQ64D341 display, 640x480.
992c609719bSwdenk			Active, color, single scan.
993c609719bSwdenk
994c609719bSwdenk		CONFIG_HLD1045
995c609719bSwdenk
996c609719bSwdenk			HLD1045 display, 640x480.
997c609719bSwdenk			Active, color, single scan.
998c609719bSwdenk
999c609719bSwdenk		CONFIG_OPTREX_BW
1000c609719bSwdenk
1001c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1002c609719bSwdenk			or
1003c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1004c609719bSwdenk			or
1005c609719bSwdenk			Hitachi	 SP14Q002
1006c609719bSwdenk
1007c609719bSwdenk			320x240. Black & white.
1008c609719bSwdenk
1009c609719bSwdenk		Normally display is black on white background; define
1010c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1011c609719bSwdenk
10127152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1013d791b1dcSwdenk
1014d791b1dcSwdenk		If this option is set, the environment is checked for
1015d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1016d791b1dcSwdenk		of logo, copyright and system information on the LCD
1017e94d2cd9Swdenk		is suppressed and the BMP image at the address
1018d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1019d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1020d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1021d791b1dcSwdenk		loaded very quickly after power-on.
1022d791b1dcSwdenk
102398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
102498f4a3dfSStefan Roese
102598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
102698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
102798f4a3dfSStefan Roese		splashscreen support or the bmp command.
102898f4a3dfSStefan Roese
1029c29fdfc1Swdenk- Compression support:
1030c29fdfc1Swdenk		CONFIG_BZIP2
1031c29fdfc1Swdenk
1032c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1033c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1034c29fdfc1Swdenk		compressed images are supported.
1035c29fdfc1Swdenk
1036c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1037c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1038c29fdfc1Swdenk		be at least 4MB.
1039d791b1dcSwdenk
104017ea1177Swdenk- MII/PHY support:
104117ea1177Swdenk		CONFIG_PHY_ADDR
104217ea1177Swdenk
104317ea1177Swdenk		The address of PHY on MII bus.
104417ea1177Swdenk
104517ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
104617ea1177Swdenk
104717ea1177Swdenk		The clock frequency of the MII bus
104817ea1177Swdenk
104917ea1177Swdenk		CONFIG_PHY_GIGE
105017ea1177Swdenk
105117ea1177Swdenk		If this option is set, support for speed/duplex
105217ea1177Swdenk		detection of Gigabit PHY is included.
105317ea1177Swdenk
105417ea1177Swdenk		CONFIG_PHY_RESET_DELAY
105517ea1177Swdenk
105617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
105717ea1177Swdenk		reset before any MII register access is possible.
105817ea1177Swdenk		For such PHY, set this option to the usec delay
105917ea1177Swdenk		required. (minimum 300usec for LXT971A)
106017ea1177Swdenk
106117ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
106217ea1177Swdenk
106317ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
106417ea1177Swdenk		command issued before MII status register can be read
106517ea1177Swdenk
1066c609719bSwdenk- Ethernet address:
1067c609719bSwdenk		CONFIG_ETHADDR
1068c609719bSwdenk		CONFIG_ETH2ADDR
1069c609719bSwdenk		CONFIG_ETH3ADDR
1070c609719bSwdenk
1071c609719bSwdenk		Define a default value for ethernet address to use
1072c609719bSwdenk		for the respective ethernet interface, in case this
1073c609719bSwdenk		is not determined automatically.
1074c609719bSwdenk
1075c609719bSwdenk- IP address:
1076c609719bSwdenk		CONFIG_IPADDR
1077c609719bSwdenk
1078c609719bSwdenk		Define a default value for the IP address to use for
1079c609719bSwdenk		the default ethernet interface, in case this is not
1080c609719bSwdenk		determined through e.g. bootp.
1081c609719bSwdenk
1082c609719bSwdenk- Server IP address:
1083c609719bSwdenk		CONFIG_SERVERIP
1084c609719bSwdenk
1085c609719bSwdenk		Defines a default value for theIP address of a TFTP
1086c609719bSwdenk		server to contact when using the "tftboot" command.
1087c609719bSwdenk
108853a5c424SDavid Updegraff- Multicast TFTP Mode:
108953a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
109053a5c424SDavid Updegraff
109153a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
109253a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
109353a5c424SDavid Updegraff		tftp down the same boot image concurrently.  Note: the ethernet
109453a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
109553a5c424SDavid Updegraff		multicast group.
109653a5c424SDavid Updegraff
109753a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1098c609719bSwdenk- BOOTP Recovery Mode:
1099c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1100c609719bSwdenk
1101c609719bSwdenk		If you have many targets in a network that try to
1102c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1103c609719bSwdenk		systems send out BOOTP requests at precisely the same
1104c609719bSwdenk		moment (which would happen for instance at recovery
1105c609719bSwdenk		from a power failure, when all systems will try to
1106c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1107c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1108c609719bSwdenk		inserted before sending out BOOTP requests. The
11096c33c785SWolfgang Denk		following delays are inserted then:
1110c609719bSwdenk
1111c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1112c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1113c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1114c609719bSwdenk		4th and following
1115c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1116c609719bSwdenk
1117fe389a82Sstroese- DHCP Advanced Options:
11181fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
11191fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1120fe389a82Sstroese
11211fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
11221fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
11231fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
11241fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
11251fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
11261fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
11271fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
11281fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
11291fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
11301fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
11311fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
11321fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1133fe389a82Sstroese
11345d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
11355d110f0aSWilson Callan		environment variable, not the BOOTP server.
1136fe389a82Sstroese
1137fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1138fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1139fe389a82Sstroese		than one DNS serverip is offered to the client.
1140fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1141fe389a82Sstroese		serverip will be stored in the additional environment
1142fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1143fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
11441fe80d79SJon Loeliger		is defined.
1145fe389a82Sstroese
1146fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1147fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1148fe389a82Sstroese		need the hostname of the DHCP requester.
11495d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
11501fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
11511fe80d79SJon Loeliger		option 12 to the DHCP server.
1152fe389a82Sstroese
1153a3d991bdSwdenk - CDP Options:
1154a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1155a3d991bdSwdenk
1156a3d991bdSwdenk		The device id used in CDP trigger frames.
1157a3d991bdSwdenk
1158a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1159a3d991bdSwdenk
1160a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1161a3d991bdSwdenk		of the device.
1162a3d991bdSwdenk
1163a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1164a3d991bdSwdenk
1165a3d991bdSwdenk		A printf format string which contains the ascii name of
1166a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1167a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1168a3d991bdSwdenk
1169a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1170a3d991bdSwdenk
1171a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1172a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1173a3d991bdSwdenk
1174a3d991bdSwdenk		CONFIG_CDP_VERSION
1175a3d991bdSwdenk
1176a3d991bdSwdenk		An ascii string containing the version of the software.
1177a3d991bdSwdenk
1178a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1179a3d991bdSwdenk
1180a3d991bdSwdenk		An ascii string containing the name of the platform.
1181a3d991bdSwdenk
1182a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1183a3d991bdSwdenk
1184a3d991bdSwdenk		A 32bit integer sent on the trigger.
1185a3d991bdSwdenk
1186a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1187a3d991bdSwdenk
1188a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1189a3d991bdSwdenk		device in .1 of milliwatts.
1190a3d991bdSwdenk
1191a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1192a3d991bdSwdenk
1193a3d991bdSwdenk		A byte containing the id of the VLAN.
1194a3d991bdSwdenk
1195c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1196c609719bSwdenk
1197c609719bSwdenk		Several configurations allow to display the current
1198c609719bSwdenk		status using a LED. For instance, the LED will blink
1199c609719bSwdenk		fast while running U-Boot code, stop blinking as
1200c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1201c609719bSwdenk		start blinking slow once the Linux kernel is running
1202c609719bSwdenk		(supported by a status LED driver in the Linux
1203c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1204c609719bSwdenk		feature in U-Boot.
1205c609719bSwdenk
1206c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1207c609719bSwdenk
1208c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1209c609719bSwdenk		on those systems that support this (optional)
1210c609719bSwdenk		feature, like the TQM8xxL modules.
1211c609719bSwdenk
1212c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1213c609719bSwdenk
1214b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1215b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1216b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1217c609719bSwdenk
1218b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1219602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1220b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1221b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1222c609719bSwdenk		command line interface.
1223c609719bSwdenk
1224bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1225bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1226bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1227bb99ad6dSBen Warren		deprecated and may disappear in the future.
1228bb99ad6dSBen Warren
1229bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1230c609719bSwdenk
1231b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1232b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1233b37c7e5eSwdenk		support for I2C.
1234c609719bSwdenk
1235b37c7e5eSwdenk		There are several other quantities that must also be
1236b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1237c609719bSwdenk
1238b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1239b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1240b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1241b37c7e5eSwdenk		the cpu's i2c node address).
1242c609719bSwdenk
1243b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1244b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1245b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1246b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1247b37c7e5eSwdenk
1248b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1249b37c7e5eSwdenk
1250b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1251b37c7e5eSwdenk		then the following macros need to be defined (examples are
1252b37c7e5eSwdenk		from include/configs/lwmon.h):
1253c609719bSwdenk
1254c609719bSwdenk		I2C_INIT
1255c609719bSwdenk
1256b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1257c609719bSwdenk		controller or configure ports.
1258c609719bSwdenk
1259b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1260b37c7e5eSwdenk
1261c609719bSwdenk		I2C_PORT
1262c609719bSwdenk
1263c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1264c609719bSwdenk		assumes both bits are on the same port). Valid values
1265c609719bSwdenk		are 0..3 for ports A..D.
1266c609719bSwdenk
1267c609719bSwdenk		I2C_ACTIVE
1268c609719bSwdenk
1269c609719bSwdenk		The code necessary to make the I2C data line active
1270c609719bSwdenk		(driven).  If the data line is open collector, this
1271c609719bSwdenk		define can be null.
1272c609719bSwdenk
1273b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1274b37c7e5eSwdenk
1275c609719bSwdenk		I2C_TRISTATE
1276c609719bSwdenk
1277c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1278c609719bSwdenk		(inactive).  If the data line is open collector, this
1279c609719bSwdenk		define can be null.
1280c609719bSwdenk
1281b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1282b37c7e5eSwdenk
1283c609719bSwdenk		I2C_READ
1284c609719bSwdenk
1285c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1286c609719bSwdenk		FALSE if it is low.
1287c609719bSwdenk
1288b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1289b37c7e5eSwdenk
1290c609719bSwdenk		I2C_SDA(bit)
1291c609719bSwdenk
1292c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1293c609719bSwdenk		is FALSE, it clears it (low).
1294c609719bSwdenk
1295b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1296b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1297b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1298b37c7e5eSwdenk
1299c609719bSwdenk		I2C_SCL(bit)
1300c609719bSwdenk
1301c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1302c609719bSwdenk		is FALSE, it clears it (low).
1303c609719bSwdenk
1304b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1305b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1306b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1307b37c7e5eSwdenk
1308c609719bSwdenk		I2C_DELAY
1309c609719bSwdenk
1310c609719bSwdenk		This delay is invoked four times per clock cycle so this
1311c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1312b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1313b37c7e5eSwdenk		like:
1314b37c7e5eSwdenk
1315b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1316c609719bSwdenk
131747cd00faSwdenk		CFG_I2C_INIT_BOARD
131847cd00faSwdenk
131947cd00faSwdenk		When a board is reset during an i2c bus transfer
132047cd00faSwdenk		chips might think that the current transfer is still
132147cd00faSwdenk		in progress. On some boards it is possible to access
132247cd00faSwdenk		the i2c SCLK line directly, either by using the
132347cd00faSwdenk		processor pin as a GPIO or by having a second pin
132447cd00faSwdenk		connected to the bus. If this option is defined a
132547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
132647cd00faSwdenk		is run early in the boot sequence.
132747cd00faSwdenk
132817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
132917ea1177Swdenk
133017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
133117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
133217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
133317ea1177Swdenk
1334bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1335bb99ad6dSBen Warren
1336bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1337bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1338bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1339bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1340bb99ad6dSBen Warren
1341bb99ad6dSBen Warren		CFG_I2C_NOPROBES
1342bb99ad6dSBen Warren
1343bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1344bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1345bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1346bb99ad6dSBen Warren		pairs.	Otherwise, specify a 1D array of device addresses
1347bb99ad6dSBen Warren
1348bb99ad6dSBen Warren		e.g.
1349bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1350bb99ad6dSBen Warren			#define CFG_I2C_NOPROBES	{0x50,0x68}
1351bb99ad6dSBen Warren
1352bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1353bb99ad6dSBen Warren
1354bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1355bb99ad6dSBen Warren			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1356bb99ad6dSBen Warren
1357bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1358bb99ad6dSBen Warren
1359be5e6181STimur Tabi		CFG_SPD_BUS_NUM
1360be5e6181STimur Tabi
1361be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1362be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1363be5e6181STimur Tabi
13640dc018ecSStefan Roese		CFG_RTC_BUS_NUM
13650dc018ecSStefan Roese
13660dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
13670dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
13680dc018ecSStefan Roese
13690dc018ecSStefan Roese		CFG_DTT_BUS_NUM
13700dc018ecSStefan Roese
13710dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
13720dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
13730dc018ecSStefan Roese
1374be5e6181STimur Tabi		CONFIG_FSL_I2C
1375be5e6181STimur Tabi
1376be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
13777817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1378be5e6181STimur Tabi
1379be5e6181STimur Tabi
1380c609719bSwdenk- SPI Support:	CONFIG_SPI
1381c609719bSwdenk
1382c609719bSwdenk		Enables SPI driver (so far only tested with
1383c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1384c609719bSwdenk		D/As on the SACSng board)
1385c609719bSwdenk
1386c609719bSwdenk		CONFIG_SPI_X
1387c609719bSwdenk
1388c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1389c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1390c609719bSwdenk
1391c609719bSwdenk		CONFIG_SOFT_SPI
1392c609719bSwdenk
1393c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1394c609719bSwdenk		using hardware support. This is a general purpose
1395c609719bSwdenk		driver that only requires three general I/O port pins
1396c609719bSwdenk		(two outputs, one input) to function. If this is
1397c609719bSwdenk		defined, the board configuration must define several
1398c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1399c609719bSwdenk		an example, see include/configs/sacsng.h.
1400c609719bSwdenk
140104a9e118SBen Warren		CONFIG_HARD_SPI
140204a9e118SBen Warren
140304a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
140404a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
140504a9e118SBen Warren		must define a list of chip-select function pointers.
140604a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
140704a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
140804a9e118SBen Warren
14090133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
14100133502eSMatthias Fuchs
14110133502eSMatthias Fuchs		Enables FPGA subsystem.
14120133502eSMatthias Fuchs
14130133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
14140133502eSMatthias Fuchs
14150133502eSMatthias Fuchs		Enables support for specific chip vendors.
14160133502eSMatthias Fuchs		(ALTERA, XILINX)
14170133502eSMatthias Fuchs
14180133502eSMatthias Fuchs		CONFIG_FPGA_<family>
14190133502eSMatthias Fuchs
14200133502eSMatthias Fuchs		Enables support for FPGA family.
14210133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
14220133502eSMatthias Fuchs
14230133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1424c609719bSwdenk
1425c609719bSwdenk		Specify the number of FPGA devices to support.
1426c609719bSwdenk
1427c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1428c609719bSwdenk
1429c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1430c609719bSwdenk
1431c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1432c609719bSwdenk
1433c609719bSwdenk		Enable checks on FPGA configuration interface busy
1434c609719bSwdenk		status by the configuration function. This option
1435c609719bSwdenk		will require a board or device specific function to
1436c609719bSwdenk		be written.
1437c609719bSwdenk
1438c609719bSwdenk		CONFIG_FPGA_DELAY
1439c609719bSwdenk
1440c609719bSwdenk		If defined, a function that provides delays in the FPGA
1441c609719bSwdenk		configuration driver.
1442c609719bSwdenk
1443c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1444c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1445c609719bSwdenk
1446c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1447c609719bSwdenk
1448c609719bSwdenk		Check for configuration errors during FPGA bitfile
1449c609719bSwdenk		loading. For example, abort during Virtex II
1450c609719bSwdenk		configuration if the INIT_B line goes low (which
1451c609719bSwdenk		indicated a CRC error).
1452c609719bSwdenk
1453c609719bSwdenk		CFG_FPGA_WAIT_INIT
1454c609719bSwdenk
1455c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1456c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1457c609719bSwdenk		FPGA configuration sequence. The default time is 500
1458c609719bSwdenk		mS.
1459c609719bSwdenk
1460c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1461c609719bSwdenk
1462c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1463c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1464c609719bSwdenk
1465c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1466c609719bSwdenk
1467c609719bSwdenk		Time to wait after FPGA configuration. The default is
1468c609719bSwdenk		200 mS.
1469c609719bSwdenk
1470c609719bSwdenk- Configuration Management:
1471c609719bSwdenk		CONFIG_IDENT_STRING
1472c609719bSwdenk
1473c609719bSwdenk		If defined, this string will be added to the U-Boot
1474c609719bSwdenk		version information (U_BOOT_VERSION)
1475c609719bSwdenk
1476c609719bSwdenk- Vendor Parameter Protection:
1477c609719bSwdenk
1478c609719bSwdenk		U-Boot considers the values of the environment
1479c609719bSwdenk		variables "serial#" (Board Serial Number) and
14807152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1481c609719bSwdenk		are set once by the board vendor / manufacturer, and
1482c609719bSwdenk		protects these variables from casual modification by
1483c609719bSwdenk		the user. Once set, these variables are read-only,
1484c609719bSwdenk		and write or delete attempts are rejected. You can
1485c609719bSwdenk		change this behviour:
1486c609719bSwdenk
1487c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1488c609719bSwdenk		file, the write protection for vendor parameters is
148947cd00faSwdenk		completely disabled. Anybody can change or delete
1490c609719bSwdenk		these parameters.
1491c609719bSwdenk
1492c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1493c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1494c609719bSwdenk		ethernet address is installed in the environment,
1495c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1496c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1497c609719bSwdenk		read-only.]
1498c609719bSwdenk
1499c609719bSwdenk- Protected RAM:
1500c609719bSwdenk		CONFIG_PRAM
1501c609719bSwdenk
1502c609719bSwdenk		Define this variable to enable the reservation of
1503c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1504c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1505c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1506c609719bSwdenk		this default value by defining an environment
1507c609719bSwdenk		variable "pram" to the number of kB you want to
1508c609719bSwdenk		reserve. Note that the board info structure will
1509c609719bSwdenk		still show the full amount of RAM. If pRAM is
1510c609719bSwdenk		reserved, a new environment variable "mem" will
1511c609719bSwdenk		automatically be defined to hold the amount of
1512c609719bSwdenk		remaining RAM in a form that can be passed as boot
1513c609719bSwdenk		argument to Linux, for instance like that:
1514c609719bSwdenk
1515fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1516c609719bSwdenk			saveenv
1517c609719bSwdenk
1518c609719bSwdenk		This way you can tell Linux not to use this memory,
1519c609719bSwdenk		either, which results in a memory region that will
1520c609719bSwdenk		not be affected by reboots.
1521c609719bSwdenk
1522c609719bSwdenk		*WARNING* If your board configuration uses automatic
1523c609719bSwdenk		detection of the RAM size, you must make sure that
1524c609719bSwdenk		this memory test is non-destructive. So far, the
1525c609719bSwdenk		following board configurations are known to be
1526c609719bSwdenk		"pRAM-clean":
1527c609719bSwdenk
1528c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1529c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1530c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1531c609719bSwdenk
1532c609719bSwdenk- Error Recovery:
1533c609719bSwdenk		CONFIG_PANIC_HANG
1534c609719bSwdenk
1535c609719bSwdenk		Define this variable to stop the system in case of a
1536c609719bSwdenk		fatal error, so that you have to reset it manually.
1537c609719bSwdenk		This is probably NOT a good idea for an embedded
1538c609719bSwdenk		system where you want to system to reboot
1539c609719bSwdenk		automatically as fast as possible, but it may be
1540c609719bSwdenk		useful during development since you can try to debug
1541c609719bSwdenk		the conditions that lead to the situation.
1542c609719bSwdenk
1543c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1544c609719bSwdenk
1545c609719bSwdenk		This variable defines the number of retries for
1546c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1547c609719bSwdenk		before giving up the operation. If not defined, a
1548c609719bSwdenk		default value of 5 is used.
1549c609719bSwdenk
1550c609719bSwdenk- Command Interpreter:
15518078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
155204a85b3bSwdenk
155304a85b3bSwdenk		Enable auto completion of commands using TAB.
155404a85b3bSwdenk
15558078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
15568078f1a5SWolfgang Denk		for the "hush" shell.
15578078f1a5SWolfgang Denk
15588078f1a5SWolfgang Denk
1559c609719bSwdenk		CFG_HUSH_PARSER
1560c609719bSwdenk
1561c609719bSwdenk		Define this variable to enable the "hush" shell (from
1562c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1563c609719bSwdenk		powerful command line syntax like
1564c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1565c609719bSwdenk		constructs ("shell scripts").
1566c609719bSwdenk
1567c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1568c609719bSwdenk		with a somewhat smaller memory footprint.
1569c609719bSwdenk
1570c609719bSwdenk
1571c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1572c609719bSwdenk
1573c609719bSwdenk		This defines the secondary prompt string, which is
1574c609719bSwdenk		printed when the command interpreter needs more input
1575c609719bSwdenk		to complete a command. Usually "> ".
1576c609719bSwdenk
1577c609719bSwdenk	Note:
1578c609719bSwdenk
1579c609719bSwdenk		In the current implementation, the local variables
1580c609719bSwdenk		space and global environment variables space are
1581c609719bSwdenk		separated. Local variables are those you define by
15823b57fe0aSwdenk		simply typing `name=value'. To access a local
1583c609719bSwdenk		variable later on, you have write `$name' or
15843b57fe0aSwdenk		`${name}'; to execute the contents of a variable
15853b57fe0aSwdenk		directly type `$name' at the command prompt.
1586c609719bSwdenk
1587c609719bSwdenk		Global environment variables are those you use
1588c609719bSwdenk		setenv/printenv to work with. To run a command stored
1589c609719bSwdenk		in such a variable, you need to use the run command,
1590c609719bSwdenk		and you must not use the '$' sign to access them.
1591c609719bSwdenk
1592c609719bSwdenk		To store commands and special characters in a
1593c609719bSwdenk		variable, please use double quotation marks
1594c609719bSwdenk		surrounding the whole text of the variable, instead
1595c609719bSwdenk		of the backslashes before semicolons and special
1596c609719bSwdenk		symbols.
1597c609719bSwdenk
1598aa0c71acSWolfgang Denk- Commandline Editing and History:
1599aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1600aa0c71acSWolfgang Denk
1601aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1602aa0c71acSWolfgang Denk		commandline input operations
1603aa0c71acSWolfgang Denk
1604a8c7c708Swdenk- Default Environment:
1605c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1606c609719bSwdenk
1607c609719bSwdenk		Define this to contain any number of null terminated
1608c609719bSwdenk		strings (variable = value pairs) that will be part of
16097152b1d0Swdenk		the default environment compiled into the boot image.
16102262cfeeSwdenk
1611c609719bSwdenk		For example, place something like this in your
1612c609719bSwdenk		board's config file:
1613c609719bSwdenk
1614c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1615c609719bSwdenk			"myvar1=value1\0" \
1616c609719bSwdenk			"myvar2=value2\0"
1617c609719bSwdenk
1618c609719bSwdenk		Warning: This method is based on knowledge about the
1619c609719bSwdenk		internal format how the environment is stored by the
16202262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1621c609719bSwdenk		interface! Although it is unlikely that this format
16227152b1d0Swdenk		will change soon, there is no guarantee either.
1623c609719bSwdenk		You better know what you are doing here.
1624c609719bSwdenk
1625c609719bSwdenk		Note: overly (ab)use of the default environment is
1626c609719bSwdenk		discouraged. Make sure to check other ways to preset
1627c609719bSwdenk		the environment like the autoscript function or the
1628c609719bSwdenk		boot command first.
1629c609719bSwdenk
1630a8c7c708Swdenk- DataFlash Support:
16312abbe075Swdenk		CONFIG_HAS_DATAFLASH
16322abbe075Swdenk
16332abbe075Swdenk		Defining this option enables DataFlash features and
16342abbe075Swdenk		allows to read/write in Dataflash via the standard
16352abbe075Swdenk		commands cp, md...
16362abbe075Swdenk
16373f85ce27Swdenk- SystemACE Support:
16383f85ce27Swdenk		CONFIG_SYSTEMACE
16393f85ce27Swdenk
16403f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
16413f85ce27Swdenk		chips attached via some sort of local bus. The address
16423f85ce27Swdenk		of the chip must alsh be defined in the
16433f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
16443f85ce27Swdenk
16453f85ce27Swdenk		#define CONFIG_SYSTEMACE
16463f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
16473f85ce27Swdenk
16483f85ce27Swdenk		When SystemACE support is added, the "ace" device type
16493f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
16503f85ce27Swdenk
1651ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1652ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1653ecb0ccd9SWolfgang Denk
165428cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1655ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
165628cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1657ecb0ccd9SWolfgang Denk		number generator is used.
1658ecb0ccd9SWolfgang Denk
165928cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
166028cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
166128cb9375SWolfgang Denk		defined, the normal port 69 is used.
166228cb9375SWolfgang Denk
166328cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1664ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1665ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1666ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1667ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1668ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1669ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1670ecb0ccd9SWolfgang Denk
1671a8c7c708Swdenk- Show boot progress:
1672c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1673c609719bSwdenk
1674c609719bSwdenk		Defining this option allows to add some board-
1675c609719bSwdenk		specific code (calling a user-provided function
1676c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1677c609719bSwdenk		the system's boot progress on some display (for
1678c609719bSwdenk		example, some LED's) on your board. At the moment,
1679c609719bSwdenk		the following checkpoints are implemented:
1680c609719bSwdenk
1681c609719bSwdenk  Arg	Where			When
1682c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1683c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1684c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1685c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1686c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1687c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1688c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1689c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1690c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1691c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1692c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1693c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1694c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1695c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1696c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1697c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1698c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1699c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1700c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1701c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1702c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1703c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1704c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1705c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1706c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1707c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1708c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1709c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1710c609719bSwdenk
171163e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
171263e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
171363e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
171463e73c9aSwdenk
1715566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1716566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1717566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1718566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1719566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1720566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1721566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1722566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1723566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1724566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1725566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1726566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1727566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1728566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1729566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1730566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1731566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1732566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1733566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1734566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1735566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1736566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1737566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1738566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1739566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1740566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1741566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1742566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1743566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1744566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1745566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1746566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1747566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1748566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1749566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1750566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1751566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1752566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1753566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1754566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1755566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1756566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1757566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1758566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1759566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1760566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1761566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1762c609719bSwdenk
1763566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1764c609719bSwdenk
1765566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernetconfiguration.
1766566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
1767566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
1768206c60cbSwdenk
1769566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
1770566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
1771566a494fSHeiko Schocher  -81	common/cmd_net.c	some error in NetLoop() occured
1772566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
1773566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
1774566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
1775566a494fSHeiko Schocher   83	common/cmd_net.c	running autoscript
1776566a494fSHeiko Schocher  -83	common/cmd_net.c	some error in automatic boot or autoscript
1777566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
1778c609719bSwdenk
1779c609719bSwdenkModem Support:
1780c609719bSwdenk--------------
1781c609719bSwdenk
178285ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1783c609719bSwdenk
1784c609719bSwdenk- Modem support endable:
1785c609719bSwdenk		CONFIG_MODEM_SUPPORT
1786c609719bSwdenk
1787c609719bSwdenk- RTS/CTS Flow control enable:
1788c609719bSwdenk		CONFIG_HWFLOW
1789c609719bSwdenk
1790c609719bSwdenk- Modem debug support:
1791c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1792c609719bSwdenk
1793c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1794c609719bSwdenk		for modem support. Useful only with BDI2000.
1795c609719bSwdenk
1796a8c7c708Swdenk- Interrupt support (PPC):
1797a8c7c708Swdenk
1798a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1799a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1800a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1801a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1802a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1803a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1804a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1805a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1806a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1807a8c7c708Swdenk		general timer_interrupt().
1808a8c7c708Swdenk
1809c609719bSwdenk- General:
1810c609719bSwdenk
1811c609719bSwdenk		In the target system modem support is enabled when a
1812c609719bSwdenk		specific key (key combination) is pressed during
1813c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1814c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1815c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1816c609719bSwdenk		function, returning 1 and thus enabling modem
1817c609719bSwdenk		initialization.
1818c609719bSwdenk
1819c609719bSwdenk		If there are no modem init strings in the
1820c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1821c609719bSwdenk		previous output (banner, info printfs) will be
1822c609719bSwdenk		supressed, though.
1823c609719bSwdenk
1824c609719bSwdenk		See also: doc/README.Modem
1825c609719bSwdenk
1826c609719bSwdenk
1827c609719bSwdenkConfiguration Settings:
1828c609719bSwdenk-----------------------
1829c609719bSwdenk
1830c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1831c609719bSwdenk		undefine this when you're short of memory.
1832c609719bSwdenk
1833c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1834c609719bSwdenk		prompt for user input.
1835c609719bSwdenk
1836c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1837c609719bSwdenk
1838c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1839c609719bSwdenk
1840c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1841c609719bSwdenk
1842c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1843c609719bSwdenk		the application (usually a Linux kernel) when it is
1844c609719bSwdenk		booted
1845c609719bSwdenk
1846c609719bSwdenk- CFG_BAUDRATE_TABLE:
1847c609719bSwdenk		List of legal baudrate settings for this board.
1848c609719bSwdenk
1849c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1850c609719bSwdenk		Suppress display of console information at boot.
1851c609719bSwdenk
1852c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1853c609719bSwdenk		If the board specific function
1854c609719bSwdenk			extern int overwrite_console (void);
1855c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1856c609719bSwdenk		serial port, else the settings in the environment are used.
1857c609719bSwdenk
1858c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1859c609719bSwdenk		Enable the call to overwrite_console().
1860c609719bSwdenk
1861c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1862c609719bSwdenk		Enable overwrite of previous console environment settings.
1863c609719bSwdenk
1864c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1865c609719bSwdenk		Begin and End addresses of the area used by the
1866c609719bSwdenk		simple memory test.
1867c609719bSwdenk
1868c609719bSwdenk- CFG_ALT_MEMTEST:
1869c609719bSwdenk		Enable an alternate, more extensive memory test.
1870c609719bSwdenk
18715f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
18725f535fe1Swdenk		Scratch address used by the alternate memory test
18735f535fe1Swdenk		You only need to set this if address zero isn't writeable
18745f535fe1Swdenk
1875c609719bSwdenk- CFG_TFTP_LOADADDR:
1876c609719bSwdenk		Default load address for network file downloads
1877c609719bSwdenk
1878c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1879c609719bSwdenk		Enable temporary baudrate change while serial download
1880c609719bSwdenk
1881c609719bSwdenk- CFG_SDRAM_BASE:
1882c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1883c609719bSwdenk
1884c609719bSwdenk- CFG_MBIO_BASE:
1885c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1886c609719bSwdenk		Cogent motherboard)
1887c609719bSwdenk
1888c609719bSwdenk- CFG_FLASH_BASE:
1889c609719bSwdenk		Physical start address of Flash memory.
1890c609719bSwdenk
1891c609719bSwdenk- CFG_MONITOR_BASE:
1892c609719bSwdenk		Physical start address of boot monitor code (set by
1893c609719bSwdenk		make config files to be same as the text base address
1894c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1895c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1896c609719bSwdenk
1897c609719bSwdenk- CFG_MONITOR_LEN:
18983b57fe0aSwdenk		Size of memory reserved for monitor code, used to
18993b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
19003b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
19013b57fe0aSwdenk		flash sector.
1902c609719bSwdenk
1903c609719bSwdenk- CFG_MALLOC_LEN:
1904c609719bSwdenk		Size of DRAM reserved for malloc() use.
1905c609719bSwdenk
190615940c9aSStefan Roese- CFG_BOOTM_LEN:
190715940c9aSStefan Roese		Normally compressed uImages are limited to an
190815940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
190915940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
191015940c9aSStefan Roese		to adjust this setting to your needs.
1911c609719bSwdenk
1912c609719bSwdenk- CFG_BOOTMAPSZ:
1913c609719bSwdenk		Maximum size of memory mapped by the startup code of
1914c609719bSwdenk		the Linux kernel; all data that must be processed by
1915c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1916c609719bSwdenk		initrd image) must be put below this limit.
1917c609719bSwdenk
1918c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1919c609719bSwdenk		Max number of Flash memory banks
1920c609719bSwdenk
1921c609719bSwdenk- CFG_MAX_FLASH_SECT:
1922c609719bSwdenk		Max number of sectors on a Flash chip
1923c609719bSwdenk
1924c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1925c609719bSwdenk		Timeout for Flash erase operations (in ms)
1926c609719bSwdenk
1927c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1928c609719bSwdenk		Timeout for Flash write operations (in ms)
1929c609719bSwdenk
19308564acf9Swdenk- CFG_FLASH_LOCK_TOUT
19318564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
19328564acf9Swdenk
19338564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
19348564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
19358564acf9Swdenk
19368564acf9Swdenk- CFG_FLASH_PROTECTION
19378564acf9Swdenk		If defined, hardware flash sectors protection is used
19388564acf9Swdenk		instead of U-Boot software protection.
19398564acf9Swdenk
1940c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1941c609719bSwdenk
1942c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1943c609719bSwdenk		without this option such a download has to be
1944c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1945c609719bSwdenk		copy from RAM to flash.
1946c609719bSwdenk
1947c609719bSwdenk		The two-step approach is usually more reliable, since
1948c609719bSwdenk		you can check if the download worked before you erase
1949c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1950c609719bSwdenk		too limited to allow for a tempory copy of the
1951c609719bSwdenk		downloaded image) this option may be very useful.
1952c609719bSwdenk
1953c609719bSwdenk- CFG_FLASH_CFI:
1954c609719bSwdenk		Define if the flash driver uses extra elements in the
19555653fc33Swdenk		common flash structure for storing flash geometry.
19565653fc33Swdenk
19575653fc33Swdenk- CFG_FLASH_CFI_DRIVER
19585653fc33Swdenk		This option also enables the building of the cfi_flash driver
19595653fc33Swdenk		in the drivers directory
196053cf9435Sstroese
19615568e613SStefan Roese- CFG_FLASH_QUIET_TEST
19625568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
19635568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
19645568e613SStefan Roese		is useful, if some of the configured banks are only
19655568e613SStefan Roese		optionally available.
19665568e613SStefan Roese
19679a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
19689a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
19699a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
19709a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
19719a042e9cSJerry Van Baren
197253cf9435Sstroese- CFG_RX_ETH_BUFFER:
197353cf9435Sstroese		Defines the number of ethernet receive buffers. On some
197453cf9435Sstroese		ethernet controllers it is recommended to set this value
197553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
197653cf9435Sstroese		buffers can be full shortly after enabling the interface
197753cf9435Sstroese		on high ethernet traffic.
197853cf9435Sstroese		Defaults to 4 if not defined.
1979c609719bSwdenk
1980c609719bSwdenkThe following definitions that deal with the placement and management
1981c609719bSwdenkof environment data (variable area); in general, we support the
1982c609719bSwdenkfollowing configurations:
1983c609719bSwdenk
1984c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1985c609719bSwdenk
1986c609719bSwdenk	Define this if the environment is in flash memory.
1987c609719bSwdenk
1988c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1989c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1990c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1991c609719bSwdenk	   sector" type flash chips, which have several smaller
1992c609719bSwdenk	   sectors at the start or the end. For instance, such a
1993c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1994c609719bSwdenk	   such a case you would place the environment in one of the
1995c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1996c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1997c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1998c609719bSwdenk	   between U-Boot and the environment.
1999c609719bSwdenk
2000c609719bSwdenk	- CFG_ENV_OFFSET:
2001c609719bSwdenk
2002c609719bSwdenk	   Offset of environment data (variable area) to the
2003c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2004c609719bSwdenk	   type flash chips the second sector can be used: the offset
2005c609719bSwdenk	   for this sector is given here.
2006c609719bSwdenk
2007c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
2008c609719bSwdenk
2009c609719bSwdenk	- CFG_ENV_ADDR:
2010c609719bSwdenk
2011c609719bSwdenk	   This is just another way to specify the start address of
2012c609719bSwdenk	   the flash sector containing the environment (instead of
2013c609719bSwdenk	   CFG_ENV_OFFSET).
2014c609719bSwdenk
2015c609719bSwdenk	- CFG_ENV_SECT_SIZE:
2016c609719bSwdenk
2017c609719bSwdenk	   Size of the sector containing the environment.
2018c609719bSwdenk
2019c609719bSwdenk
2020c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2021c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2022c609719bSwdenk	   the environment.
2023c609719bSwdenk
2024c609719bSwdenk	- CFG_ENV_SIZE:
2025c609719bSwdenk
2026c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
2027c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
2028c609719bSwdenk	   of this flash sector for the environment. This saves
2029c609719bSwdenk	   memory for the RAM copy of the environment.
2030c609719bSwdenk
2031c609719bSwdenk	   It may also save flash memory if you decide to use this
2032c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2033c609719bSwdenk	   since then the remainder of the flash sector could be used
2034c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2035c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2036c609719bSwdenk	   updating the environment in flash makes it always
2037c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2038c609719bSwdenk	   wrong before the contents has been restored from a copy in
2039c609719bSwdenk	   RAM, your target system will be dead.
2040c609719bSwdenk
2041c609719bSwdenk	- CFG_ENV_ADDR_REDUND
2042c609719bSwdenk	  CFG_ENV_SIZE_REDUND
2043c609719bSwdenk
2044c609719bSwdenk	   These settings describe a second storage area used to hold
2045c609719bSwdenk	   a redundand copy of the environment data, so that there is
20463e38691eSwdenk	   a valid backup copy in case there is a power failure during
2047c609719bSwdenk	   a "saveenv" operation.
2048c609719bSwdenk
2049c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2050c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2051c609719bSwdenkaccordingly!
2052c609719bSwdenk
2053c609719bSwdenk
2054c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
2055c609719bSwdenk
2056c609719bSwdenk	Define this if you have some non-volatile memory device
2057c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2058c609719bSwdenk	environment.
2059c609719bSwdenk
2060c609719bSwdenk	- CFG_ENV_ADDR:
2061c609719bSwdenk	- CFG_ENV_SIZE:
2062c609719bSwdenk
2063c609719bSwdenk	  These two #defines are used to determin the memory area you
2064c609719bSwdenk	  want to use for environment. It is assumed that this memory
2065c609719bSwdenk	  can just be read and written to, without any special
2066c609719bSwdenk	  provision.
2067c609719bSwdenk
2068c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2069c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2070c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
2071c609719bSwdenkU-Boot will hang.
2072c609719bSwdenk
2073c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2074c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2075c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2076c609719bSwdenkto save the current settings.
2077c609719bSwdenk
2078c609719bSwdenk
2079c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
2080c609719bSwdenk
2081c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2082c609719bSwdenk	device and a driver for it.
2083c609719bSwdenk
2084c609719bSwdenk	- CFG_ENV_OFFSET:
2085c609719bSwdenk	- CFG_ENV_SIZE:
2086c609719bSwdenk
2087c609719bSwdenk	  These two #defines specify the offset and size of the
2088c609719bSwdenk	  environment area within the total memory of your EEPROM.
2089c609719bSwdenk
2090c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
2091c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2092c609719bSwdenk	  The default address is zero.
2093c609719bSwdenk
2094c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
2095c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2096c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2097c609719bSwdenk	  would require six bits.
2098c609719bSwdenk
2099c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2100c609719bSwdenk	  If defined, the number of milliseconds to delay between
2101c609719bSwdenk	  page writes.	The default is zero milliseconds.
2102c609719bSwdenk
2103c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
2104c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2105c609719bSwdenk	  that this is NOT the chip address length!
2106c609719bSwdenk
21075cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
21085cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
21095cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
21105cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
21115cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
21125cf91d6bSwdenk	  byte chips.
21135cf91d6bSwdenk
21145cf91d6bSwdenk	  Note that we consider the length of the address field to
21155cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
21165cf91d6bSwdenk	  in the chip address.
21175cf91d6bSwdenk
2118c609719bSwdenk	- CFG_EEPROM_SIZE:
2119c609719bSwdenk	  The size in bytes of the EEPROM device.
2120c609719bSwdenk
2121c609719bSwdenk
21225779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
21235779d8d9Swdenk
21245779d8d9Swdenk	Define this if you have a DataFlash memory device which you
21255779d8d9Swdenk	want to use for the environment.
21265779d8d9Swdenk
21275779d8d9Swdenk	- CFG_ENV_OFFSET:
21285779d8d9Swdenk	- CFG_ENV_ADDR:
21295779d8d9Swdenk	- CFG_ENV_SIZE:
21305779d8d9Swdenk
21315779d8d9Swdenk	  These three #defines specify the offset and size of the
21325779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
21335779d8d9Swdenk	  at the specified address.
21345779d8d9Swdenk
213513a5695bSwdenk- CFG_ENV_IS_IN_NAND:
213613a5695bSwdenk
213713a5695bSwdenk	Define this if you have a NAND device which you want to use
213813a5695bSwdenk	for the environment.
213913a5695bSwdenk
214013a5695bSwdenk	- CFG_ENV_OFFSET:
214113a5695bSwdenk	- CFG_ENV_SIZE:
214213a5695bSwdenk
214313a5695bSwdenk	  These two #defines specify the offset and size of the environment
214413a5695bSwdenk	  area within the first NAND device.
21455779d8d9Swdenk
2146e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2147e443c944SMarkus Klotzbuecher
2148e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2149e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2150e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2151e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2152e443c944SMarkus Klotzbuecher
2153e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2154e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2155e443c944SMarkus Klotzbuecher	the NAND devices block size.
2156e443c944SMarkus Klotzbuecher
2157c609719bSwdenk- CFG_SPI_INIT_OFFSET
2158c609719bSwdenk
2159c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2160c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2161c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2162c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2163c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2164c609719bSwdenk	to be a good choice since it makes it far enough from the
2165c609719bSwdenk	start of the data area as well as from the stack pointer.
2166c609719bSwdenk
2167e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2168c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2169c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2170c609719bSwdenkuntil then to read environment variables.
2171c609719bSwdenk
217285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
217385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
217485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
217585ec0bccSwdenknecessary, because the first environment variable we need is the
217685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
217785ec0bccSwdenkhave any device yet where we could complain.]
2178c609719bSwdenk
2179c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2180c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
218185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2182c609719bSwdenk
2183fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2184fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2185fc3e2165Swdenk
2186fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2187fc3e2165Swdenk		      also needs to be defined.
2188fc3e2165Swdenk
2189fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2190fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2191c609719bSwdenk
2192c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2193c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2194c40b2956Swdenk		of 64bit values by using the L quantifier
2195c40b2956Swdenk
2196c40b2956Swdenk- CFG_64BIT_STRTOUL:
2197c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2198c40b2956Swdenk
2199c609719bSwdenkLow Level (hardware related) configuration options:
2200dc7c9a1aSwdenk---------------------------------------------------
2201c609719bSwdenk
2202c609719bSwdenk- CFG_CACHELINE_SIZE:
2203c609719bSwdenk		Cache Line Size of the CPU.
2204c609719bSwdenk
2205c609719bSwdenk- CFG_DEFAULT_IMMR:
2206c609719bSwdenk		Default address of the IMMR after system reset.
22072535d602Swdenk
22082535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
22092535d602Swdenk		and RPXsuper) to be able to adjust the position of
22102535d602Swdenk		the IMMR register after a reset.
2211c609719bSwdenk
22127f6c2cbcSwdenk- Floppy Disk Support:
22137f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
22147f6c2cbcSwdenk
22157f6c2cbcSwdenk		the default drive number (default value 0)
22167f6c2cbcSwdenk
22177f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
22187f6c2cbcSwdenk
22197f6c2cbcSwdenk		defines the spacing between fdc chipset registers
22207f6c2cbcSwdenk		(default value 1)
22217f6c2cbcSwdenk
22227f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
22237f6c2cbcSwdenk
22247f6c2cbcSwdenk		defines the offset of register from address. It
22257f6c2cbcSwdenk		depends on which part of the data bus is connected to
22267f6c2cbcSwdenk		the fdc chipset. (default value 0)
22277f6c2cbcSwdenk
22287f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
22297f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
22307f6c2cbcSwdenk		default value.
22317f6c2cbcSwdenk
22327f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
22337f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
22347f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
22357f6c2cbcSwdenk		source code. It is used to make hardware dependant
22367f6c2cbcSwdenk		initializations.
22377f6c2cbcSwdenk
223825d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
223925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
224025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2241c609719bSwdenk
2242c609719bSwdenk- CFG_INIT_RAM_ADDR:
2243c609719bSwdenk
22447152b1d0Swdenk		Start address of memory area that can be used for
2245c609719bSwdenk		initial data and stack; please note that this must be
2246c609719bSwdenk		writable memory that is working WITHOUT special
2247c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2248c609719bSwdenk		will become available only after programming the
2249c609719bSwdenk		memory controller and running certain initialization
2250c609719bSwdenk		sequences.
2251c609719bSwdenk
2252c609719bSwdenk		U-Boot uses the following memory types:
2253c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2254c609719bSwdenk		- MPC824X: data cache
2255c609719bSwdenk		- PPC4xx:  data cache
2256c609719bSwdenk
225785ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2258c609719bSwdenk
2259c609719bSwdenk		Offset of the initial data structure in the memory
2260c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
226185ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2262c609719bSwdenk		data is located at the end of the available space
2263c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2264c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2265c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
226685ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2267c609719bSwdenk
2268c609719bSwdenk	Note:
2269c609719bSwdenk		On the MPC824X (or other systems that use the data
2270c609719bSwdenk		cache for initial memory) the address chosen for
2271c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2272c609719bSwdenk		point to an otherwise UNUSED address space between
2273c609719bSwdenk		the top of RAM and the start of the PCI space.
2274c609719bSwdenk
2275c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2276c609719bSwdenk
2277c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2278c609719bSwdenk
2279c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2280c609719bSwdenk
2281c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2282c609719bSwdenk
2283c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2284c609719bSwdenk
2285c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2286c609719bSwdenk
2287c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2288c609719bSwdenk		SDRAM timing
2289c609719bSwdenk
2290c609719bSwdenk- CFG_MAMR_PTA:
2291c609719bSwdenk		periodic timer for refresh
2292c609719bSwdenk
2293c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2294c609719bSwdenk
2295c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2296c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2297c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2298c609719bSwdenk  CFG_BR1_PRELIM:
2299c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2300c609719bSwdenk
2301c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2302c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2303c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2304c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2305c609719bSwdenk
2306c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2307c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2308c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2309c609719bSwdenk		Prescaler definitions (SDRAM timing)
2310c609719bSwdenk
2311c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2312c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2313c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2314c609719bSwdenk
2315b423d055SHeiko Schocher- CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]:
2316b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2317b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2318b423d055SHeiko Schocher
2319c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2320c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2321c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2322c609719bSwdenk
2323c609719bSwdenk- CFG_USE_OSCCLK:
2324c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2325c609719bSwdenk		wrong setting might damage your board. Read
2326c609719bSwdenk		doc/README.MBX before setting this variable!
2327c609719bSwdenk
2328ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2329ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2330ea909b76Swdenk		(Power On Self Tests). This definition overrides
2331ea909b76Swdenk		#define'd default value in commproc.h resp.
2332ea909b76Swdenk		cpm_8260.h.
2333ea909b76Swdenk
23345d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
23355d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
23365d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
23375d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
23385d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
23395d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
23405d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
23415d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
23425d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
23435d232d0eSwdenk
2344bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2345*218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2346*218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2347*218ca724SWolfgang Denk
2348bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2349bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2350bb99ad6dSBen Warren
2351bb99ad6dSBen Warren- CFG_SPD_BUS_NUM
2352*218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2353*218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2354*218ca724SWolfgang Denk		to something your driver can deal with.
2355bb99ad6dSBen Warren
23562ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
2357*218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2358*218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
23592ad6b513STimur Tabi
23602ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
2361*218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2362*218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
23632ad6b513STimur Tabi
2364c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2365c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2366c26e454dSwdenk
2367c26e454dSwdenk- CONFIG_FEC[12]_PHY
2368c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
23696e592385Swdenk		to the given FEC; i. e.
2370c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2371c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2372c26e454dSwdenk
2373c26e454dSwdenk		When set to -1, means to probe for first available.
2374c26e454dSwdenk
2375c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2376c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2377c26e454dSwdenk		(so program the FEC to ignore it).
2378c26e454dSwdenk
2379c26e454dSwdenk- CONFIG_RMII
2380c26e454dSwdenk		Enable RMII mode for all FECs.
2381c26e454dSwdenk		Note that this is a global option, we can't
2382c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2383c26e454dSwdenk
23845cf91d6bSwdenk- CONFIG_CRC32_VERIFY
23855cf91d6bSwdenk		Add a verify option to the crc32 command.
23865cf91d6bSwdenk		The syntax is:
23875cf91d6bSwdenk
23885cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
23895cf91d6bSwdenk
23905cf91d6bSwdenk		Where address/count indicate a memory area
23915cf91d6bSwdenk		and crc32 is the correct crc32 which the
23925cf91d6bSwdenk		area should have.
23935cf91d6bSwdenk
239456523f12Swdenk- CONFIG_LOOPW
239556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2396602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
239756523f12Swdenk
23987b466641Sstroese- CONFIG_MX_CYCLIC
23997b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
24007b466641Sstroese		"md/mw" commands.
24017b466641Sstroese		Examples:
24027b466641Sstroese
24037b466641Sstroese		=> mdc.b 10 4 500
24047b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
24057b466641Sstroese
24067b466641Sstroese		=> mwc.l 100 12345678 10
24077b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
24087b466641Sstroese
24097b466641Sstroese		This only takes effect if the memory commands are activated
2410602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
24117b466641Sstroese
24128aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
24138aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
24148aa1a2d1Swdenk
24158aa1a2d1Swdenk		[ARM only] If these variables are defined, then
24168aa1a2d1Swdenk		certain low level initializations (like setting up
24178aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
24188aa1a2d1Swdenk		not relocate itself into RAM.
24198aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
24208aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
24218aa1a2d1Swdenk		some other boot loader or by a debugger which
24228aa1a2d1Swdenk		performs these intializations itself.
24238aa1a2d1Swdenk
2424400558b5Swdenk
2425c609719bSwdenkBuilding the Software:
2426c609719bSwdenk======================
2427c609719bSwdenk
2428*218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2429*218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2430*218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2431*218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2432*218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2433*218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2434c609719bSwdenk
2435*218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2436*218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2437*218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2438*218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2439*218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2440c609719bSwdenk
2441*218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2442*218ca724SWolfgang Denk	$ export CROSS_COMPILE
2443c609719bSwdenk
2444c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2445c609719bSwdenksources you must configure U-Boot for one specific board type. This
2446c609719bSwdenkis done by typing:
2447c609719bSwdenk
2448c609719bSwdenk	make NAME_config
2449c609719bSwdenk
2450*218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2451*218ca724SWolfgang Denkrations; see the main Makefile for supported names.
245254387ac9Swdenk
2453c609719bSwdenkNote: for some board special configuration names may exist; check if
2454c609719bSwdenk      additional information is available from the board vendor; for
24552729af9dSwdenk      instance, the TQM823L systems are available without (standard)
24562729af9dSwdenk      or with LCD support. You can select such additional "features"
2457c609719bSwdenk      when chosing the configuration, i. e.
2458c609719bSwdenk
24592729af9dSwdenk      make TQM823L_config
24602729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2461c609719bSwdenk
2462c609719bSwdenk      make TQM823L_LCD_config
2463c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2464c609719bSwdenk
2465c609719bSwdenk      etc.
2466c609719bSwdenk
2467c609719bSwdenk
2468c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
24697152b1d0Swdenkimages ready for download to / installation on your system:
2470c609719bSwdenk
2471c609719bSwdenk- "u-boot.bin" is a raw binary image
2472c609719bSwdenk- "u-boot" is an image in ELF binary format
2473c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2474c609719bSwdenk
2475baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2476baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2477baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2478baf31249SMarian Balakowicz
2479baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2480baf31249SMarian Balakowicz
2481baf31249SMarian Balakowicz	make O=/tmp/build distclean
2482baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2483baf31249SMarian Balakowicz	make O=/tmp/build all
2484baf31249SMarian Balakowicz
2485baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2486baf31249SMarian Balakowicz
2487baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2488baf31249SMarian Balakowicz	make distclean
2489baf31249SMarian Balakowicz	make NAME_config
2490baf31249SMarian Balakowicz	make all
2491baf31249SMarian Balakowicz
2492baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2493baf31249SMarian Balakowiczvariable.
2494baf31249SMarian Balakowicz
2495c609719bSwdenk
2496c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2497c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2498c609719bSwdenknative "make".
2499c609719bSwdenk
2500c609719bSwdenk
2501c609719bSwdenkIf the system board that you have is not listed, then you will need
2502c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2503c609719bSwdenksteps:
2504c609719bSwdenk
2505c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
250685ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
250785ec0bccSwdenk    entries as examples. Note that here and at many other places
25087152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
250985ec0bccSwdenk    keep this order.
2510c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
251185ec0bccSwdenk    files you need. In your board directory, you will need at least
251285ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
251385ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
251485ec0bccSwdenk    your board
2515c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2516c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
251785ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2518c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2519c609719bSwdenk    to be installed on your target system.
252085ec0bccSwdenk6.  Debug and solve any problems that might arise.
2521c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2522c609719bSwdenk
2523c609719bSwdenk
2524c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2525c609719bSwdenk==============================================================
2526c609719bSwdenk
2527c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2528c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2529c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2530c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2531*218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2532c609719bSwdenk
2533c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2534c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2535c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2536c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2537c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
25387152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2539*218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2540*218ca724SWolfgang Denkyou can type
2541c609719bSwdenk
2542c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2543c609719bSwdenk
2544c609719bSwdenkor to build on a native PowerPC system you can type
2545c609719bSwdenk
2546c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2547c609719bSwdenk
2548*218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2549*218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2550*218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2551*218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2552*218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2553*218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2554*218ca724SWolfgang Denkvariable. For example:
2555baf31249SMarian Balakowicz
2556baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2557baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2558baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2559baf31249SMarian Balakowicz
2560*218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2561*218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2562*218ca724SWolfgang Denkduring the whole build process.
2563baf31249SMarian Balakowicz
2564baf31249SMarian Balakowicz
2565c609719bSwdenkSee also "U-Boot Porting Guide" below.
2566c609719bSwdenk
2567c609719bSwdenk
2568c609719bSwdenkMonitor Commands - Overview:
2569c609719bSwdenk============================
2570c609719bSwdenk
2571c609719bSwdenkgo	- start application at address 'addr'
2572c609719bSwdenkrun	- run commands in an environment variable
2573c609719bSwdenkbootm	- boot application image from memory
2574c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2575c609719bSwdenktftpboot- boot image via network using TFTP protocol
2576c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2577c609719bSwdenk	       (and eventually "gatewayip")
2578c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2579c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2580c609719bSwdenkloads	- load S-Record file over serial line
2581c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2582c609719bSwdenkmd	- memory display
2583c609719bSwdenkmm	- memory modify (auto-incrementing)
2584c609719bSwdenknm	- memory modify (constant address)
2585c609719bSwdenkmw	- memory write (fill)
2586c609719bSwdenkcp	- memory copy
2587c609719bSwdenkcmp	- memory compare
2588c609719bSwdenkcrc32	- checksum calculation
2589c609719bSwdenkimd	- i2c memory display
2590c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2591c609719bSwdenkinm	- i2c memory modify (constant address)
2592c609719bSwdenkimw	- i2c memory write (fill)
2593c609719bSwdenkicrc32	- i2c checksum calculation
2594c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2595c609719bSwdenkiloop	- infinite loop on address range
2596c609719bSwdenkisdram	- print SDRAM configuration information
2597c609719bSwdenksspi	- SPI utility commands
2598c609719bSwdenkbase	- print or set address offset
2599c609719bSwdenkprintenv- print environment variables
2600c609719bSwdenksetenv	- set environment variables
2601c609719bSwdenksaveenv - save environment variables to persistent storage
2602c609719bSwdenkprotect - enable or disable FLASH write protection
2603c609719bSwdenkerase	- erase FLASH memory
2604c609719bSwdenkflinfo	- print FLASH memory information
2605c609719bSwdenkbdinfo	- print Board Info structure
2606c609719bSwdenkiminfo	- print header information for application image
2607c609719bSwdenkconinfo - print console devices and informations
2608c609719bSwdenkide	- IDE sub-system
2609c609719bSwdenkloop	- infinite loop on address range
261056523f12Swdenkloopw	- infinite write loop on address range
2611c609719bSwdenkmtest	- simple RAM test
2612c609719bSwdenkicache	- enable or disable instruction cache
2613c609719bSwdenkdcache	- enable or disable data cache
2614c609719bSwdenkreset	- Perform RESET of the CPU
2615c609719bSwdenkecho	- echo args to console
2616c609719bSwdenkversion - print monitor version
2617c609719bSwdenkhelp	- print online help
2618c609719bSwdenk?	- alias for 'help'
2619c609719bSwdenk
2620c609719bSwdenk
2621c609719bSwdenkMonitor Commands - Detailed Description:
2622c609719bSwdenk========================================
2623c609719bSwdenk
2624c609719bSwdenkTODO.
2625c609719bSwdenk
2626c609719bSwdenkFor now: just type "help <command>".
2627c609719bSwdenk
2628c609719bSwdenk
2629c609719bSwdenkEnvironment Variables:
2630c609719bSwdenk======================
2631c609719bSwdenk
2632c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2633c609719bSwdenkcan be made persistent by saving to Flash memory.
2634c609719bSwdenk
2635c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2636c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2637c609719bSwdenkwithout a value can be used to delete a variable from the
2638c609719bSwdenkenvironment. As long as you don't save the environment you are
2639c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2640c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2641c609719bSwdenk
2642c609719bSwdenkSome configuration options can be set using Environment Variables:
2643c609719bSwdenk
2644c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2645c609719bSwdenk
2646c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2647c609719bSwdenk
2648c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2649c609719bSwdenk
2650c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2651c609719bSwdenk
2652c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2653c609719bSwdenk
2654c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2655c609719bSwdenk		  "bootp" will just load perform a lookup of the
2656c609719bSwdenk		  configuration from the BOOTP server, but not try to
2657c609719bSwdenk		  load any image using TFTP
2658c609719bSwdenk
2659c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2660c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2661c609719bSwdenk		  be automatically started (by internally calling
2662c609719bSwdenk		  "bootm")
2663c609719bSwdenk
26644a6fd34bSwdenk		  If set to "no", a standalone image passed to the
26654a6fd34bSwdenk		  "bootm" command will be copied to the load address
26664a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
26674a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
26684a6fd34bSwdenk		  data.
26694a6fd34bSwdenk
267017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
267117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
267217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
267317ea1177Swdenk		  initialization code. So, for changes to be effective
267417ea1177Swdenk		  it must be saved and board must be reset.
267517ea1177Swdenk
2676c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2677c609719bSwdenk		  If this variable is not set, initrd images will be
2678c609719bSwdenk		  copied to the highest possible address in RAM; this
2679c609719bSwdenk		  is usually what you want since it allows for
2680c609719bSwdenk		  maximum initrd size. If for some reason you want to
2681c609719bSwdenk		  make sure that the initrd image is loaded below the
2682c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2683c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2684c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2685c609719bSwdenk		  address to use (U-Boot will still check that it
2686c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2687c609719bSwdenk
2688c609719bSwdenk		  For instance, when you have a system with 16 MB
26897152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2690c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2691c609719bSwdenk		  the "bootargs" variable. However, now you must make
26927152b1d0Swdenk		  sure that the initrd image is placed in the first
2693c609719bSwdenk		  12 MB as well - this can be done with
2694c609719bSwdenk
2695c609719bSwdenk		  setenv initrd_high 00c00000
2696c609719bSwdenk
269738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
269838b99261Swdenk		  indication to U-Boot that all addresses are legal
269938b99261Swdenk		  for the Linux kernel, including addresses in flash
270038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
270138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
270238b99261Swdenk		  boot time on your system, but requires that this
270338b99261Swdenk		  feature is supported by your Linux kernel.
270438b99261Swdenk
2705c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2706c609719bSwdenk
2707c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2708dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2709c609719bSwdenk
2710c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2711c609719bSwdenk
2712c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2713c609719bSwdenk
2714c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2715c609719bSwdenk
2716c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2717c609719bSwdenk
2718c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2719c609719bSwdenk
2720a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2721a3d991bdSwdenk		  interface is used first.
2722a3d991bdSwdenk
2723a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2724a3d991bdSwdenk		  interface is currently active. For example you
2725a3d991bdSwdenk		  can do the following
2726a3d991bdSwdenk
2727a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2728a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2729a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2730a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2731a3d991bdSwdenk
2732e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
2733e1692577SMatthias Fuchs		  available network interfaces.
2734e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
2735e1692577SMatthias Fuchs
2736a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2737a3d991bdSwdenk		  either succeed or fail without retrying.
27386e592385Swdenk		  When set to "once" the network operation will
27396e592385Swdenk		  fail when all the available network interfaces
27406e592385Swdenk		  are tried once without success.
2741a3d991bdSwdenk		  Useful on scripts which control the retry operation
2742a3d991bdSwdenk		  themselves.
2743a3d991bdSwdenk
2744a1cf027aSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- see CONFIG_IXP4XX_NPE_EXT_UCOD
2745a1cf027aSJean-Christophe PLAGNIOL-VILLARD		  if set load address for the npe microcode
2746a1cf027aSJean-Christophe PLAGNIOL-VILLARD
274728cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2748ecb0ccd9SWolfgang Denk		  UDP source port.
2749ecb0ccd9SWolfgang Denk
275028cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
275128cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
275228cb9375SWolfgang Denk
2753a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2754a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2755a3d991bdSwdenk		  VLAN tagged frames.
2756c609719bSwdenk
2757c609719bSwdenkThe following environment variables may be used and automatically
2758c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2759c609719bSwdenkdepending the information provided by your boot server:
2760c609719bSwdenk
2761c609719bSwdenk  bootfile	- see above
2762c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2763fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2764c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2765c609719bSwdenk  hostname	- Target hostname
2766c609719bSwdenk  ipaddr	- see above
2767c609719bSwdenk  netmask	- Subnet Mask
2768c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2769c609719bSwdenk  serverip	- see above
2770c609719bSwdenk
2771c609719bSwdenk
2772c609719bSwdenkThere are two special Environment Variables:
2773c609719bSwdenk
2774c609719bSwdenk  serial#	- contains hardware identification information such
2775c609719bSwdenk		  as type string and/or serial number
2776c609719bSwdenk  ethaddr	- Ethernet address
2777c609719bSwdenk
2778c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2779c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2780c609719bSwdenkonce they have been set once.
2781c609719bSwdenk
2782c609719bSwdenk
2783c1551ea8SstroeseFurther special Environment Variables:
2784c1551ea8Sstroese
2785c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2786c1551ea8Sstroese		  with the "version" command. This variable is
2787c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2788c1551ea8Sstroese
2789c1551ea8Sstroese
2790c609719bSwdenkPlease note that changes to some configuration parameters may take
2791c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2792c609719bSwdenk
2793c609719bSwdenk
2794f07771ccSwdenkCommand Line Parsing:
2795f07771ccSwdenk=====================
2796f07771ccSwdenk
2797f07771ccSwdenkThere are two different command line parsers available with U-Boot:
27987152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2799f07771ccSwdenk
2800f07771ccSwdenkOld, simple command line parser:
2801f07771ccSwdenk--------------------------------
2802f07771ccSwdenk
2803f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2804f07771ccSwdenk- several commands on one line, separated by ';'
2805fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2806f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2807f07771ccSwdenk  for example:
2808fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2809f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2810f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2811f07771ccSwdenk
2812f07771ccSwdenkHush shell:
2813f07771ccSwdenk-----------
2814f07771ccSwdenk
2815f07771ccSwdenk- similar to Bourne shell, with control structures like
2816f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2817f07771ccSwdenk  until...do...done, ...
2818f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2819f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2820f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2821f07771ccSwdenk  command
2822f07771ccSwdenk
2823f07771ccSwdenkGeneral rules:
2824f07771ccSwdenk--------------
2825f07771ccSwdenk
2826f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2827f07771ccSwdenk    command) contains several commands separated by semicolon, and
2828f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2829f07771ccSwdenk    executed anyway.
2830f07771ccSwdenk
2831f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2832f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2833f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2834f07771ccSwdenk    variables are not executed.
2835f07771ccSwdenk
2836c609719bSwdenkNote for Redundant Ethernet Interfaces:
2837c609719bSwdenk=======================================
2838c609719bSwdenk
28397152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2840c609719bSwdenksuch configurations and is capable of automatic selection of a
28417152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2842c609719bSwdenk
2843c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2844c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2845c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2846c609719bSwdenk
2847c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2848c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2849c609719bSwdenkding setting in the environment; if the corresponding environment
2850c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2851c609719bSwdenk
2852c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2853c609719bSwdenk  environment, the SROM's address is used.
2854c609719bSwdenk
2855c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2856c609719bSwdenk  environment exists, then the value from the environment variable is
2857c609719bSwdenk  used.
2858c609719bSwdenk
2859c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2860c609719bSwdenk  both addresses are the same, this MAC address is used.
2861c609719bSwdenk
2862c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2863c609719bSwdenk  addresses differ, the value from the environment is used and a
2864c609719bSwdenk  warning is printed.
2865c609719bSwdenk
2866c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2867c609719bSwdenk  is raised.
2868c609719bSwdenk
2869c609719bSwdenk
2870c609719bSwdenkImage Formats:
2871c609719bSwdenk==============
2872c609719bSwdenk
2873c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2874c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2875c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2876c609719bSwdenkdefines the following image properties:
2877c609719bSwdenk
2878c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2879c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
28807f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
28811f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
28827b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
28833d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
28847b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2885c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2886c609719bSwdenk* Load Address
2887c609719bSwdenk* Entry Point
2888c609719bSwdenk* Image Name
2889c609719bSwdenk* Image Timestamp
2890c609719bSwdenk
2891c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2892c609719bSwdenkand the data portions of the image are secured against corruption by
2893c609719bSwdenkCRC32 checksums.
2894c609719bSwdenk
2895c609719bSwdenk
2896c609719bSwdenkLinux Support:
2897c609719bSwdenk==============
2898c609719bSwdenk
2899c609719bSwdenkAlthough U-Boot should support any OS or standalone application
29007152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2901c609719bSwdenkU-Boot.
2902c609719bSwdenk
2903c609719bSwdenkU-Boot includes many features that so far have been part of some
2904c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2905c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2906c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
29077152b1d0Swdenkserves several purposes:
2908c609719bSwdenk
2909c609719bSwdenk- the same features can be used for other OS or standalone
2910c609719bSwdenk  applications (for instance: using compressed images to reduce the
2911c609719bSwdenk  Flash memory footprint)
2912c609719bSwdenk
2913c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
29147152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2915c609719bSwdenk
2916c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2917c609719bSwdenk  images; of course this also means that different kernel images can
2918c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2919c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2920c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2921c609719bSwdenk  software is easier now.
2922c609719bSwdenk
2923c609719bSwdenk
2924c609719bSwdenkLinux HOWTO:
2925c609719bSwdenk============
2926c609719bSwdenk
2927c609719bSwdenkPorting Linux to U-Boot based systems:
2928c609719bSwdenk---------------------------------------
2929c609719bSwdenk
2930c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2931c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2932c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2933c609719bSwdenkLinux :-).
2934c609719bSwdenk
2935c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2936c609719bSwdenk
2937c609719bSwdenkJust make sure your machine specific header file (for instance
2938c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2939c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2940c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2941c609719bSwdenkU-Boot configuration in CFG_IMMR.
2942c609719bSwdenk
2943c609719bSwdenk
2944c609719bSwdenkConfiguring the Linux kernel:
2945c609719bSwdenk-----------------------------
2946c609719bSwdenk
2947c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2948c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2949c609719bSwdenk
2950c609719bSwdenk
2951c609719bSwdenkBuilding a Linux Image:
2952c609719bSwdenk-----------------------
2953c609719bSwdenk
295424ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
295524ee89b9Swdenknot used. If you use recent kernel source, a new build target
295624ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
295724ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
295824ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
295924ee89b9Swdenk100% compatible format.
2960c609719bSwdenk
2961c609719bSwdenkExample:
2962c609719bSwdenk
2963c609719bSwdenk	make TQM850L_config
2964c609719bSwdenk	make oldconfig
2965c609719bSwdenk	make dep
296624ee89b9Swdenk	make uImage
2967c609719bSwdenk
296824ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
296924ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
297024ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2971c609719bSwdenk
297224ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
297324ee89b9Swdenk
297424ee89b9Swdenk* convert the kernel into a raw binary image:
297524ee89b9Swdenk
297624ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
297724ee89b9Swdenk				 -R .note -R .comment \
297824ee89b9Swdenk				 -S vmlinux linux.bin
297924ee89b9Swdenk
298024ee89b9Swdenk* compress the binary image:
298124ee89b9Swdenk
298224ee89b9Swdenk	gzip -9 linux.bin
298324ee89b9Swdenk
298424ee89b9Swdenk* package compressed binary image for U-Boot:
298524ee89b9Swdenk
298624ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
298724ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
298824ee89b9Swdenk		-d linux.bin.gz uImage
298924ee89b9Swdenk
299024ee89b9Swdenk
299124ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
299224ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
299324ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
299424ee89b9Swdenkbyte header containing information about target architecture,
299524ee89b9Swdenkoperating system, image type, compression method, entry points, time
299624ee89b9Swdenkstamp, CRC32 checksums, etc.
299724ee89b9Swdenk
299824ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
299924ee89b9Swdenkprint the header information, or to build new images.
3000c609719bSwdenk
3001c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3002c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3003c609719bSwdenkchecksum verification:
3004c609719bSwdenk
3005c609719bSwdenk	tools/mkimage -l image
3006c609719bSwdenk	  -l ==> list image header information
3007c609719bSwdenk
3008c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3009c609719bSwdenkfrom a "data file" which is used as image payload:
3010c609719bSwdenk
3011c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3012c609719bSwdenk		      -n name -d data_file image
3013c609719bSwdenk	  -A ==> set architecture to 'arch'
3014c609719bSwdenk	  -O ==> set operating system to 'os'
3015c609719bSwdenk	  -T ==> set image type to 'type'
3016c609719bSwdenk	  -C ==> set compression type 'comp'
3017c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3018c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3019c609719bSwdenk	  -n ==> set image name to 'name'
3020c609719bSwdenk	  -d ==> use image data from 'datafile'
3021c609719bSwdenk
302269459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
302369459791Swdenkaddress (0x00000000), but the entry point address depends on the
302469459791Swdenkkernel version:
3025c609719bSwdenk
3026c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
302724ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3028c609719bSwdenk
3029c609719bSwdenkSo a typical call to build a U-Boot image would read:
3030c609719bSwdenk
303124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
303224ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
303324ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
303424ee89b9Swdenk	> examples/uImage.TQM850L
303524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3036c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3037c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3038c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3039c609719bSwdenk	Load Address: 0x00000000
304024ee89b9Swdenk	Entry Point:  0x00000000
3041c609719bSwdenk
3042c609719bSwdenkTo verify the contents of the image (or check for corruption):
3043c609719bSwdenk
304424ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
304524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3046c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3047c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3048c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3049c609719bSwdenk	Load Address: 0x00000000
305024ee89b9Swdenk	Entry Point:  0x00000000
3051c609719bSwdenk
3052c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3053c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3054c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3055c609719bSwdenkneed to be uncompressed:
3056c609719bSwdenk
305724ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
305824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
305924ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
306024ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
306124ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
306224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3063c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3064c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3065c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3066c609719bSwdenk	Load Address: 0x00000000
306724ee89b9Swdenk	Entry Point:  0x00000000
3068c609719bSwdenk
3069c609719bSwdenk
3070c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3071c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3072c609719bSwdenk
3073c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3074c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3075c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3076c609719bSwdenk	Image Name:   Simple Ramdisk Image
3077c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3078c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3079c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3080c609719bSwdenk	Load Address: 0x00000000
3081c609719bSwdenk	Entry Point:  0x00000000
3082c609719bSwdenk
3083c609719bSwdenk
3084c609719bSwdenkInstalling a Linux Image:
3085c609719bSwdenk-------------------------
3086c609719bSwdenk
3087c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3088c609719bSwdenkyou must convert the image to S-Record format:
3089c609719bSwdenk
3090c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3091c609719bSwdenk
3092c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3093c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3094c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3095c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3096c609719bSwdenkcommand.
3097c609719bSwdenk
3098c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3099c609719bSwdenkTQM8xxL is in the first Flash bank):
3100c609719bSwdenk
3101c609719bSwdenk	=> erase 40100000 401FFFFF
3102c609719bSwdenk
3103c609719bSwdenk	.......... done
3104c609719bSwdenk	Erased 8 sectors
3105c609719bSwdenk
3106c609719bSwdenk	=> loads 40100000
3107c609719bSwdenk	## Ready for S-Record download ...
3108c609719bSwdenk	~>examples/image.srec
3109c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3110c609719bSwdenk	...
3111c609719bSwdenk	15989 15990 15991 15992
3112c609719bSwdenk	[file transfer complete]
3113c609719bSwdenk	[connected]
3114c609719bSwdenk	## Start Addr = 0x00000000
3115c609719bSwdenk
3116c609719bSwdenk
3117c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3118c609719bSwdenkthis includes a checksum verification so you can be sure no data
3119c609719bSwdenkcorruption happened:
3120c609719bSwdenk
3121c609719bSwdenk	=> imi 40100000
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
3132c609719bSwdenkBoot Linux:
3133c609719bSwdenk-----------
3134c609719bSwdenk
3135c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3136c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3137c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3138c609719bSwdenkparameters. You can check and modify this variable using the
3139c609719bSwdenk"printenv" and "setenv" commands:
3140c609719bSwdenk
3141c609719bSwdenk
3142c609719bSwdenk	=> printenv bootargs
3143c609719bSwdenk	bootargs=root=/dev/ram
3144c609719bSwdenk
3145c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3146c609719bSwdenk
3147c609719bSwdenk	=> printenv bootargs
3148c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3149c609719bSwdenk
3150c609719bSwdenk	=> bootm 40020000
3151c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3152c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3153c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3154c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3155c609719bSwdenk	   Load Address: 00000000
3156c609719bSwdenk	   Entry Point:	 0000000c
3157c609719bSwdenk	   Verifying Checksum ... OK
3158c609719bSwdenk	   Uncompressing Kernel Image ... OK
3159c609719bSwdenk	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
3160c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3161c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3162c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3163c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3164c609719bSwdenk	...
3165c609719bSwdenk
3166c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
31677152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3168c609719bSwdenkformat!) to the "bootm" command:
3169c609719bSwdenk
3170c609719bSwdenk	=> imi 40100000 40200000
3171c609719bSwdenk
3172c609719bSwdenk	## Checking Image at 40100000 ...
3173c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3174c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3175c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3176c609719bSwdenk	   Load Address: 00000000
3177c609719bSwdenk	   Entry Point:	 0000000c
3178c609719bSwdenk	   Verifying Checksum ... OK
3179c609719bSwdenk
3180c609719bSwdenk	## Checking Image at 40200000 ...
3181c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3182c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3183c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3184c609719bSwdenk	   Load Address: 00000000
3185c609719bSwdenk	   Entry Point:	 00000000
3186c609719bSwdenk	   Verifying Checksum ... OK
3187c609719bSwdenk
3188c609719bSwdenk	=> bootm 40100000 40200000
3189c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3190c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3191c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3192c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3193c609719bSwdenk	   Load Address: 00000000
3194c609719bSwdenk	   Entry Point:	 0000000c
3195c609719bSwdenk	   Verifying Checksum ... OK
3196c609719bSwdenk	   Uncompressing Kernel Image ... OK
3197c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3198c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3199c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3200c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3201c609719bSwdenk	   Load Address: 00000000
3202c609719bSwdenk	   Entry Point:	 00000000
3203c609719bSwdenk	   Verifying Checksum ... OK
3204c609719bSwdenk	   Loading Ramdisk ... OK
3205c609719bSwdenk	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
3206c609719bSwdenk	Boot arguments: root=/dev/ram
3207c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3208c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3209c609719bSwdenk	...
3210c609719bSwdenk	RAMDISK: Compressed image found at block 0
3211c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3212c609719bSwdenk
3213c609719bSwdenk	bash#
3214c609719bSwdenk
32150267768eSMatthew McClintockBoot Linux and pass a flat device tree:
32160267768eSMatthew McClintock-----------
32170267768eSMatthew McClintock
32180267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
32190267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
32200267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
32210267768eSMatthew McClintockflat device tree:
32220267768eSMatthew McClintock
32230267768eSMatthew McClintock=> print oftaddr
32240267768eSMatthew McClintockoftaddr=0x300000
32250267768eSMatthew McClintock=> print oft
32260267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
32270267768eSMatthew McClintock=> tftp $oftaddr $oft
32280267768eSMatthew McClintockSpeed: 1000, full duplex
32290267768eSMatthew McClintockUsing TSEC0 device
32300267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
32310267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
32320267768eSMatthew McClintockLoad address: 0x300000
32330267768eSMatthew McClintockLoading: #
32340267768eSMatthew McClintockdone
32350267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
32360267768eSMatthew McClintock=> tftp $loadaddr $bootfile
32370267768eSMatthew McClintockSpeed: 1000, full duplex
32380267768eSMatthew McClintockUsing TSEC0 device
32390267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
32400267768eSMatthew McClintockFilename 'uImage'.
32410267768eSMatthew McClintockLoad address: 0x200000
32420267768eSMatthew McClintockLoading:############
32430267768eSMatthew McClintockdone
32440267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
32450267768eSMatthew McClintock=> print loadaddr
32460267768eSMatthew McClintockloadaddr=200000
32470267768eSMatthew McClintock=> print oftaddr
32480267768eSMatthew McClintockoftaddr=0x300000
32490267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
32500267768eSMatthew McClintock## Booting image at 00200000 ...
32510267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
32520267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
32530267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
32540267768eSMatthew McClintock   Load Address: 00000000
32550267768eSMatthew McClintock   Entry Point:	 00000000
32560267768eSMatthew McClintock   Verifying Checksum ... OK
32570267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
32580267768eSMatthew McClintockBooting using flat device tree at 0x300000
32590267768eSMatthew McClintockUsing MPC85xx ADS machine description
32600267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
32610267768eSMatthew McClintock[snip]
32620267768eSMatthew McClintock
32630267768eSMatthew McClintock
32646069ff26SwdenkMore About U-Boot Image Types:
32656069ff26Swdenk------------------------------
32666069ff26Swdenk
32676069ff26SwdenkU-Boot supports the following image types:
32686069ff26Swdenk
32696069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
32706069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
32716069ff26Swdenk	well) you can continue to work in U-Boot after return from
32726069ff26Swdenk	the Standalone Program.
32736069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
32746069ff26Swdenk	will take over control completely. Usually these programs
32756069ff26Swdenk	will install their own set of exception handlers, device
32766069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
32776069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
32786069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
32796069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
32806069ff26Swdenk	being started.
32816069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
32826069ff26Swdenk	(Linux) kernel image and one or more data images like
32836069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
32846069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
32856069ff26Swdenk	server provides just a single image file, but you want to get
32866069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
32876069ff26Swdenk
32886069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
32896069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
32906069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
32916069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
32926069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
32936069ff26Swdenk	a multiple of 4 bytes).
32946069ff26Swdenk
32956069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
32966069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
32976069ff26Swdenk	flash memory.
32986069ff26Swdenk
32996069ff26Swdenk   "Script files" are command sequences that will be executed by
33006069ff26Swdenk	U-Boot's command interpreter; this feature is especially
33016069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
33026069ff26Swdenk	as command interpreter.
33036069ff26Swdenk
3304c609719bSwdenk
3305c609719bSwdenkStandalone HOWTO:
3306c609719bSwdenk=================
3307c609719bSwdenk
3308c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3309c609719bSwdenkrun "standalone" applications, which can use some resources of
3310c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3311c609719bSwdenk
3312c609719bSwdenkTwo simple examples are included with the sources:
3313c609719bSwdenk
3314c609719bSwdenk"Hello World" Demo:
3315c609719bSwdenk-------------------
3316c609719bSwdenk
3317c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3318c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3319c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3320c609719bSwdenklike that:
3321c609719bSwdenk
3322c609719bSwdenk	=> loads
3323c609719bSwdenk	## Ready for S-Record download ...
3324c609719bSwdenk	~>examples/hello_world.srec
3325c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3326c609719bSwdenk	[file transfer complete]
3327c609719bSwdenk	[connected]
3328c609719bSwdenk	## Start Addr = 0x00040004
3329c609719bSwdenk
3330c609719bSwdenk	=> go 40004 Hello World! This is a test.
3331c609719bSwdenk	## Starting application at 0x00040004 ...
3332c609719bSwdenk	Hello World
3333c609719bSwdenk	argc = 7
3334c609719bSwdenk	argv[0] = "40004"
3335c609719bSwdenk	argv[1] = "Hello"
3336c609719bSwdenk	argv[2] = "World!"
3337c609719bSwdenk	argv[3] = "This"
3338c609719bSwdenk	argv[4] = "is"
3339c609719bSwdenk	argv[5] = "a"
3340c609719bSwdenk	argv[6] = "test."
3341c609719bSwdenk	argv[7] = "<NULL>"
3342c609719bSwdenk	Hit any key to exit ...
3343c609719bSwdenk
3344c609719bSwdenk	## Application terminated, rc = 0x0
3345c609719bSwdenk
3346c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3347c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3348c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3349c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3350c609719bSwdenkcharacter, but this is just a demo program. The application can be
3351c609719bSwdenkcontrolled by the following keys:
3352c609719bSwdenk
3353c609719bSwdenk	? - print current values og the CPM Timer registers
3354c609719bSwdenk	b - enable interrupts and start timer
3355c609719bSwdenk	e - stop timer and disable interrupts
3356c609719bSwdenk	q - quit application
3357c609719bSwdenk
3358c609719bSwdenk	=> loads
3359c609719bSwdenk	## Ready for S-Record download ...
3360c609719bSwdenk	~>examples/timer.srec
3361c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3362c609719bSwdenk	[file transfer complete]
3363c609719bSwdenk	[connected]
3364c609719bSwdenk	## Start Addr = 0x00040004
3365c609719bSwdenk
3366c609719bSwdenk	=> go 40004
3367c609719bSwdenk	## Starting application at 0x00040004 ...
3368c609719bSwdenk	TIMERS=0xfff00980
3369c609719bSwdenk	Using timer 1
3370c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3371c609719bSwdenk
3372c609719bSwdenkHit 'b':
3373c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3374c609719bSwdenk	Enabling timer
3375c609719bSwdenkHit '?':
3376c609719bSwdenk	[q, b, e, ?] ........
3377c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3378c609719bSwdenkHit '?':
3379c609719bSwdenk	[q, b, e, ?] .
3380c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3381c609719bSwdenkHit '?':
3382c609719bSwdenk	[q, b, e, ?] .
3383c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3384c609719bSwdenkHit '?':
3385c609719bSwdenk	[q, b, e, ?] .
3386c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3387c609719bSwdenkHit 'e':
3388c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3389c609719bSwdenkHit 'q':
3390c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3391c609719bSwdenk
3392c609719bSwdenk
339385ec0bccSwdenkMinicom warning:
339485ec0bccSwdenk================
339585ec0bccSwdenk
33967152b1d0SwdenkOver time, many people have reported problems when trying to use the
339785ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
339885ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3399f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
340085ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
340185ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
340285ec0bccSwdenk
340352f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
340452f52c14Swdenkconfiguration to your "File transfer protocols" section:
340552f52c14Swdenk
340652f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
340752f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
340852f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
340952f52c14Swdenk
341052f52c14Swdenk
3411c609719bSwdenkNetBSD Notes:
3412c609719bSwdenk=============
3413c609719bSwdenk
3414c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3415c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3416c609719bSwdenk
3417c609719bSwdenkBuilding requires a cross environment; it is known to work on
3418c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3419c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3420c609719bSwdenkNote that the cross-powerpc package does not install include files;
3421c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3422c609719bSwdenkmissing.  This file has to be installed and patched manually:
3423c609719bSwdenk
3424c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3425c609719bSwdenk	# mkdir powerpc
3426c609719bSwdenk	# ln -s powerpc machine
3427c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3428c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3429c609719bSwdenk
3430c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3431c609719bSwdenkand U-Boot include files.
3432c609719bSwdenk
3433c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3434c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3435c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3436c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
34372a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3438c609719bSwdenk
3439c609719bSwdenk
3440c609719bSwdenkImplementation Internals:
3441c609719bSwdenk=========================
3442c609719bSwdenk
3443c609719bSwdenkThe following is not intended to be a complete description of every
3444c609719bSwdenkimplementation detail. However, it should help to understand the
3445c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3446c609719bSwdenkhardware.
3447c609719bSwdenk
3448c609719bSwdenk
3449c609719bSwdenkInitial Stack, Global Data:
3450c609719bSwdenk---------------------------
3451c609719bSwdenk
3452c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3453c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3454c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3455c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3456c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3457c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3458c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3459c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3460c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3461c609719bSwdenklocked as (mis-) used as memory, etc.
3462c609719bSwdenk
34637152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
346443d9616cSwdenk	u-boot-users mailing list:
346543d9616cSwdenk
346643d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
346743d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
346843d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
346943d9616cSwdenk	...
347043d9616cSwdenk
347143d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
347243d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
347343d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
347443d9616cSwdenk	is that the cache is being used as a temporary supply of
347543d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
347643d9616cSwdenk	beyond the scope of this list to expain the details, but you
347743d9616cSwdenk	can see how this works by studying the cache architecture and
347843d9616cSwdenk	operation in the architecture and processor-specific manuals.
347943d9616cSwdenk
348043d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
348143d9616cSwdenk	is another option for the system designer to use as an
348243d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
348343d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
348443d9616cSwdenk	board designers haven't used it for something that would
348543d9616cSwdenk	cause you grief during the initial boot! It is frequently not
348643d9616cSwdenk	used.
348743d9616cSwdenk
348843d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
348943d9616cSwdenk	with your processor/board/system design. The default value
349043d9616cSwdenk	you will find in any recent u-boot distribution in
34918a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
349243d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
349343d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
349443d9616cSwdenk	that are supposed to respond to that address! That code in
349543d9616cSwdenk	start.S has been around a while and should work as is when
349643d9616cSwdenk	you get the config right.
349743d9616cSwdenk
349843d9616cSwdenk	-Chris Hallinan
349943d9616cSwdenk	DS4.COM, Inc.
350043d9616cSwdenk
3501c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3502c609719bSwdenkcode for the initialization procedures:
3503c609719bSwdenk
3504c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3505c609719bSwdenk  to write it.
3506c609719bSwdenk
3507c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3508c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
35097152b1d0Swdenk  zation is performed later (when relocating to RAM).
3510c609719bSwdenk
3511c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3512c609719bSwdenk  that.
3513c609719bSwdenk
3514c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3515c609719bSwdenknormal global data to share information beween the code. But it
3516c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3517c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3518c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3519c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3520c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3521c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3522c609719bSwdenkreserve for this purpose.
3523c609719bSwdenk
35247152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3525c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3526c609719bSwdenkGCC's implementation.
3527c609719bSwdenk
3528c609719bSwdenkFor PowerPC, the following registers have specific use:
3529c609719bSwdenk	R1:	stack pointer
3530e7670f6cSWolfgang Denk	R2:	reserved for system use
3531c609719bSwdenk	R3-R4:	parameter passing and return values
3532c609719bSwdenk	R5-R10: parameter passing
3533c609719bSwdenk	R13:	small data area pointer
3534c609719bSwdenk	R30:	GOT pointer
3535c609719bSwdenk	R31:	frame pointer
3536c609719bSwdenk
3537c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3538c609719bSwdenk
3539e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3540c609719bSwdenk
3541c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3542c609719bSwdenk    address of the global data structure is known at compile time),
3543c609719bSwdenk    but it turned out that reserving a register results in somewhat
3544c609719bSwdenk    smaller code - although the code savings are not that big (on
3545c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3546c609719bSwdenk    624 text + 127 data).
3547c609719bSwdenk
35484c58eb55SMike FrysingerOn Blackfin, the normal C ABI (except for P5) is followed as documented here:
35494c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
35504c58eb55SMike Frysinger
35514c58eb55SMike Frysinger    ==> U-Boot will use P5 to hold a pointer to the global data
35524c58eb55SMike Frysinger
3553c609719bSwdenkOn ARM, the following registers are used:
3554c609719bSwdenk
3555c609719bSwdenk	R0:	function argument word/integer result
3556c609719bSwdenk	R1-R3:	function argument word
3557c609719bSwdenk	R9:	GOT pointer
3558c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3559c609719bSwdenk	R11:	argument (frame) pointer
3560c609719bSwdenk	R12:	temporary workspace
3561c609719bSwdenk	R13:	stack pointer
3562c609719bSwdenk	R14:	link register
3563c609719bSwdenk	R15:	program counter
3564c609719bSwdenk
3565c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3566c609719bSwdenk
3567d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3568d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3569c609719bSwdenk
3570c609719bSwdenkMemory Management:
3571c609719bSwdenk------------------
3572c609719bSwdenk
3573c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3574c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3575c609719bSwdenk
3576c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3577c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3578c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3579c609719bSwdenkphysical memory banks.
3580c609719bSwdenk
3581c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3582c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3583c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3584c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3585c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3586c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3587c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3588c609719bSwdenk
3589c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3590c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3591c609719bSwdenk
3592c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3593c609719bSwdenkthis:
3594c609719bSwdenk
3595c609719bSwdenk	0x0000 0000	Exception Vector code
3596c609719bSwdenk	      :
3597c609719bSwdenk	0x0000 1FFF
3598c609719bSwdenk	0x0000 2000	Free for Application Use
3599c609719bSwdenk	      :
3600c609719bSwdenk	      :
3601c609719bSwdenk
3602c609719bSwdenk	      :
3603c609719bSwdenk	      :
3604c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3605c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3606c609719bSwdenk	0x00FC 0000	Malloc Arena
3607c609719bSwdenk	      :
3608c609719bSwdenk	0x00FD FFFF
3609c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3610c609719bSwdenk	...		eventually: LCD or video framebuffer
3611c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3612c609719bSwdenk	0x00FF FFFF	[End of RAM]
3613c609719bSwdenk
3614c609719bSwdenk
3615c609719bSwdenkSystem Initialization:
3616c609719bSwdenk----------------------
3617c609719bSwdenk
3618c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3619c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3620c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
36217152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3622c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3623c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3624c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3625c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3626c609719bSwdenkthe caches and the SIU.
3627c609719bSwdenk
3628c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3629c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3630c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3631c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3632c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3633c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3634c609719bSwdenkbanks.
3635c609719bSwdenk
3636c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
36377152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3638c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3639c609719bSwdenk0x00000000, with any additional banks following immediately to create
3640c609719bSwdenkcontiguous memory starting from 0.
3641c609719bSwdenk
3642c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3643c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3644c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3645c609719bSwdenkpages, and the final stack is set up.
3646c609719bSwdenk
3647c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3648c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3649c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3650c609719bSwdenknew address in RAM.
3651c609719bSwdenk
3652c609719bSwdenk
3653c609719bSwdenkU-Boot Porting Guide:
3654c609719bSwdenk----------------------
3655c609719bSwdenk
3656c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
36576aff3115Swdenklist, October 2002]
3658c609719bSwdenk
3659c609719bSwdenk
3660c609719bSwdenkint main (int argc, char *argv[])
3661c609719bSwdenk{
3662c609719bSwdenk	sighandler_t no_more_time;
3663c609719bSwdenk
3664c609719bSwdenk	signal (SIGALRM, no_more_time);
3665c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3666c609719bSwdenk
3667c609719bSwdenk	if (available_money > available_manpower) {
3668c609719bSwdenk		pay consultant to port U-Boot;
3669c609719bSwdenk		return 0;
3670c609719bSwdenk	}
3671c609719bSwdenk
3672c609719bSwdenk	Download latest U-Boot source;
3673c609719bSwdenk
36746aff3115Swdenk	Subscribe to u-boot-users mailing list;
36756aff3115Swdenk
3676c609719bSwdenk	if (clueless) {
3677c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3678c609719bSwdenk	}
3679c609719bSwdenk
3680c609719bSwdenk	while (learning) {
3681c609719bSwdenk		Read the README file in the top level directory;
36827cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3683c609719bSwdenk		Read the source, Luke;
3684c609719bSwdenk	}
3685c609719bSwdenk
3686c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3687c609719bSwdenk		Buy a BDI2000;
3688c609719bSwdenk	} else {
3689c609719bSwdenk		Add a lot of aggravation and time;
3690c609719bSwdenk	}
3691c609719bSwdenk
3692c609719bSwdenk	Create your own board support subdirectory;
3693c609719bSwdenk
36946aff3115Swdenk	Create your own board config file;
36956aff3115Swdenk
3696c609719bSwdenk	while (!running) {
3697c609719bSwdenk		do {
3698c609719bSwdenk			Add / modify source code;
3699c609719bSwdenk		} until (compiles);
3700c609719bSwdenk		Debug;
3701c609719bSwdenk		if (clueless)
3702c609719bSwdenk			email ("Hi, I am having problems...");
3703c609719bSwdenk	}
3704c609719bSwdenk	Send patch file to Wolfgang;
3705c609719bSwdenk
3706c609719bSwdenk	return 0;
3707c609719bSwdenk}
3708c609719bSwdenk
3709c609719bSwdenkvoid no_more_time (int sig)
3710c609719bSwdenk{
3711c609719bSwdenk      hire_a_guru();
3712c609719bSwdenk}
3713c609719bSwdenk
3714c609719bSwdenk
3715c609719bSwdenkCoding Standards:
3716c609719bSwdenk-----------------
3717c609719bSwdenk
3718c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
37192c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
37202c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
37212c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
37222c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3723c609719bSwdenk
37242c051651SDetlev ZundelSource files originating from a different project (for example the
37252c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
37262c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
37272c051651SDetlev Zundelsources.
37282c051651SDetlev Zundel
37292c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
37302c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
37312c051651SDetlev Zundelin your code.
3732c609719bSwdenk
3733c178d3daSwdenkPlease also stick to the following formatting rules:
3734180d3f74Swdenk- remove any trailing white space
3735180d3f74Swdenk- use TAB characters for indentation, not spaces
3736180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3737180d3f74Swdenk- do not add more than 2 empty lines to source files
3738180d3f74Swdenk- do not add trailing empty lines to source files
3739180d3f74Swdenk
3740c609719bSwdenkSubmissions which do not conform to the standards may be returned
3741c609719bSwdenkwith a request to reformat the changes.
3742c609719bSwdenk
3743c609719bSwdenk
3744c609719bSwdenkSubmitting Patches:
3745c609719bSwdenk-------------------
3746c609719bSwdenk
3747c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3748c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3749c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3750c609719bSwdenk
375190dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3752c609719bSwdenk
3753*218ca724SWolfgang DenkPlease see http://www.denx.de/wiki/UBoot/Patches for details.
3754*218ca724SWolfgang Denk
3755c609719bSwdenkWhen you send a patch, please include the following information with
3756c609719bSwdenkit:
3757c609719bSwdenk
3758c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3759c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3760c609719bSwdenk  patch actually fixes something.
3761c609719bSwdenk
3762c609719bSwdenk* For new features: a description of the feature and your
3763c609719bSwdenk  implementation.
3764c609719bSwdenk
3765c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3766c609719bSwdenk
3767c609719bSwdenk* For major contributions, your entry to the CREDITS file
3768c609719bSwdenk
3769c609719bSwdenk* When you add support for a new board, don't forget to add this
3770c609719bSwdenk  board to the MAKEALL script, too.
3771c609719bSwdenk
3772c609719bSwdenk* If your patch adds new configuration options, don't forget to
3773c609719bSwdenk  document these in the README file.
3774c609719bSwdenk
3775*218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
3776*218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
3777*218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
3778*218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
3779*218ca724SWolfgang Denk  with some other mail clients.
3780c609719bSwdenk
3781*218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
3782*218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
3783*218ca724SWolfgang Denk  GNU diff.
37846dff5529Swdenk
3785*218ca724SWolfgang Denk  The current directory when running this command shall be the parent
3786*218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
3787*218ca724SWolfgang Denk  your patch includes sufficient directory information for the
3788*218ca724SWolfgang Denk  affected files).
3789*218ca724SWolfgang Denk
3790*218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
3791*218ca724SWolfgang Denk  and compressed attachments must not be used.
3792c609719bSwdenk
379352f52c14Swdenk* If one logical set of modifications affects or creates several
379452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
379552f52c14Swdenk
379652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
379752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
379852f52c14Swdenk
379952f52c14Swdenk
3800c609719bSwdenkNotes:
3801c609719bSwdenk
3802c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3803c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3804c609719bSwdenk  for any of the boards.
3805c609719bSwdenk
3806c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3807c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3808c609719bSwdenk  returned with a request to re-formatting / split it.
3809c609719bSwdenk
3810c609719bSwdenk* If you modify existing code, make sure that your new code does not
3811c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3812c609719bSwdenk  When adding new features, these should compile conditionally only
3813c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3814c609719bSwdenk  disabled must not need more memory than the old code without your
3815c609719bSwdenk  modification.
381690dc6704Swdenk
381790dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
3818*218ca724SWolfgang Denk  u-boot-users mailing list. Bigger patches will be moderated. If
3819*218ca724SWolfgang Denk  they are reasonable and not bigger than 100 kB, they will be
3820*218ca724SWolfgang Denk  acknowledged. Even bigger patches should be avoided.
3821