xref: /openbmc/u-boot/README (revision 2fb2604d5c20beb061b0a94282b7f6eb14d00cb8)
1c609719bSwdenk#
2218ca724SWolfgang Denk# (C) Copyright 2000 - 2008
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54218ca724SWolfgang Denkwho contributed the specific port. The MAINTAINERS file lists board
55218ca724SWolfgang Denkmaintainers.
56c609719bSwdenk
57c609719bSwdenk
58c609719bSwdenkWhere to get help:
59c609719bSwdenk==================
60c609719bSwdenk
61c609719bSwdenkIn case you have questions about, problems with or contributions for
62c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
630c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
640c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
650c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
660c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
67c609719bSwdenk
68c609719bSwdenk
69218ca724SWolfgang DenkWhere to get source code:
70218ca724SWolfgang Denk=========================
71218ca724SWolfgang Denk
72218ca724SWolfgang DenkThe U-Boot source code is maintained in the git repository at
73218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
74218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
75218ca724SWolfgang Denk
76218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
7711ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
78218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
79218ca724SWolfgang Denkdirectory.
80218ca724SWolfgang Denk
81d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
82218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
83218ca724SWolfgang Denk
84218ca724SWolfgang Denk
85c609719bSwdenkWhere we come from:
86c609719bSwdenk===================
87c609719bSwdenk
88c609719bSwdenk- start from 8xxrom sources
8924ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
90c609719bSwdenk- clean up code
91c609719bSwdenk- make it easier to add custom boards
92c609719bSwdenk- make it possible to add other [PowerPC] CPUs
93c609719bSwdenk- extend functions, especially:
94c609719bSwdenk  * Provide extended interface to Linux boot loader
95c609719bSwdenk  * S-Record download
96c609719bSwdenk  * network boot
9711ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
9824ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
99c609719bSwdenk- add other CPU families (starting with ARM)
10024ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
1010d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
10224ee89b9Swdenk
10324ee89b9Swdenk
10424ee89b9SwdenkNames and Spelling:
10524ee89b9Swdenk===================
10624ee89b9Swdenk
10724ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
10824ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10924ee89b9Swdenkin source files etc.). Example:
11024ee89b9Swdenk
11124ee89b9Swdenk	This is the README file for the U-Boot project.
11224ee89b9Swdenk
11324ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
11424ee89b9Swdenk
11524ee89b9Swdenk	include/asm-ppc/u-boot.h
11624ee89b9Swdenk
11724ee89b9Swdenk	#include <asm/u-boot.h>
11824ee89b9Swdenk
11924ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
12024ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
12124ee89b9Swdenk
12224ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
12324ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
124c609719bSwdenk
125c609719bSwdenk
12693f19cc0SwdenkVersioning:
12793f19cc0Swdenk===========
12893f19cc0Swdenk
12993f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
13093f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
13193f19cc0Swdenksub-version "34", and patchlevel "4".
13293f19cc0Swdenk
13393f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
13493f19cc0Swdenkbetween released versions, i. e. officially released versions of
13593f19cc0SwdenkU-Boot will always have a patchlevel of "0".
13693f19cc0Swdenk
13793f19cc0Swdenk
138c609719bSwdenkDirectory Hierarchy:
139c609719bSwdenk====================
140c609719bSwdenk
1417152b1d0Swdenk- board		Board dependent files
1427152b1d0Swdenk- common	Misc architecture independent functions
143c609719bSwdenk- cpu		CPU specific files
144983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
14511dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
14611dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
147a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
148983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1491d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
15011dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
15111dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1528ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
15372a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
154adbfeeb7SMike Frysinger  - blackfin	Files specific to Analog Devices Blackfin CPUs
15511dadd54Swdenk  - i386	Files specific to i386 CPUs
15611dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
157b330990cSDaniel Hellstrom  - leon2	Files specific to Gaisler LEON2 SPARC CPU
1581e9a164eSDaniel Hellstrom  - leon3	Files specific to Gaisler LEON3 SPARC CPU
159983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
1601552af70STsiChungLiew  - mcf5227x	Files specific to Freescale ColdFire MCF5227x CPUs
1618e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
1628ae158cdSTsiChungLiew  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
16357a12720STsiChungLiew  - mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
16411dadd54Swdenk  - mips	Files specific to MIPS CPUs
165983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
166983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
167983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
168983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
169983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
170983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
171983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
17211dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1735c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1740c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
17511dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
17611dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
17711dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
178c609719bSwdenk- disk		Code for disk drive partition handling
179c609719bSwdenk- doc		Documentation (don't expect too much)
1807152b1d0Swdenk- drivers	Commonly used device drivers
181c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
182c609719bSwdenk- examples	Example code for standalone applications, etc.
183c609719bSwdenk- include	Header Files
18411dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1857b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
186adbfeeb7SMike Frysinger- lib_blackfin	Files generic to Blackfin architecture
18711dadd54Swdenk- lib_generic	Files generic to all	 architectures
18811dadd54Swdenk- lib_i386	Files generic to i386	 architecture
18911dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
19011dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
19111dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
19211dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
193c2f02da2SDaniel Hellstrom- lib_sparc	Files generic to SPARC	 architecture
194213bf8c8SGerald Van Baren- libfdt	Library files to support flattened device trees
195c609719bSwdenk- net		Networking code
196c609719bSwdenk- post		Power On Self Test
197c609719bSwdenk- rtc		Real Time Clock drivers
198c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
199c609719bSwdenk
200c609719bSwdenkSoftware Configuration:
201c609719bSwdenk=======================
202c609719bSwdenk
203c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
204c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
205c609719bSwdenk
206c609719bSwdenkThere are two classes of configuration variables:
207c609719bSwdenk
208c609719bSwdenk* Configuration _OPTIONS_:
209c609719bSwdenk  These are selectable by the user and have names beginning with
210c609719bSwdenk  "CONFIG_".
211c609719bSwdenk
212c609719bSwdenk* Configuration _SETTINGS_:
213c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
214c609719bSwdenk  you don't know what you're doing; they have names beginning with
2156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
216c609719bSwdenk
217c609719bSwdenkLater we will add a configuration tool - probably similar to or even
218c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
219c609719bSwdenkdo the configuration by hand, which means creating some symbolic
220c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
221c609719bSwdenkas an example here.
222c609719bSwdenk
223c609719bSwdenk
224c609719bSwdenkSelection of Processor Architecture and Board Type:
225c609719bSwdenk---------------------------------------------------
226c609719bSwdenk
227c609719bSwdenkFor all supported boards there are ready-to-use default
228c609719bSwdenkconfigurations available; just type "make <board_name>_config".
229c609719bSwdenk
230c609719bSwdenkExample: For a TQM823L module type:
231c609719bSwdenk
232c609719bSwdenk	cd u-boot
233c609719bSwdenk	make TQM823L_config
234c609719bSwdenk
23511ccc33fSMarcel ZiswilerFor the Cogent platform, you need to specify the CPU type as well;
236c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
237c609719bSwdenkdirectory according to the instructions in cogent/README.
238c609719bSwdenk
239c609719bSwdenk
240c609719bSwdenkConfiguration Options:
241c609719bSwdenk----------------------
242c609719bSwdenk
243c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
244c609719bSwdenksuch information is kept in a configuration file
245c609719bSwdenk"include/configs/<board_name>.h".
246c609719bSwdenk
247c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
248c609719bSwdenk"include/configs/TQM823L.h".
249c609719bSwdenk
250c609719bSwdenk
2517f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2527f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2537f6c2cbcSwdenkbuild a config tool - later.
2547f6c2cbcSwdenk
2557f6c2cbcSwdenk
256c609719bSwdenkThe following options need to be configured:
257c609719bSwdenk
2582628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
259c609719bSwdenk
2602628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
2616ccec449SWolfgang Denk
2626ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
26309ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
264c609719bSwdenk
265c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
266c609719bSwdenk		Define exactly one of
267c609719bSwdenk		CONFIG_CMA286_60_OLD
268c609719bSwdenk--- FIXME --- not tested yet:
269c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
270c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
271c609719bSwdenk
272c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
273c609719bSwdenk		Define exactly one of
274c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
275c609719bSwdenk
276c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
277c609719bSwdenk		Define one or more of
278c609719bSwdenk		CONFIG_CMA302
279c609719bSwdenk
280c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
281c609719bSwdenk		Define one or more of
282c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
28311ccc33fSMarcel Ziswiler					  the LCD display every second with
284c609719bSwdenk					  a "rotator" |\-/|\-/
285c609719bSwdenk
2862535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
2872535d602Swdenk		CONFIG_ADSTYPE
2882535d602Swdenk		Possible values are:
2896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8260ADS	- original MPC8260ADS
2906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8266ADS	- MPC8266ADS
2916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
2926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_8272ADS	- MPC8272ADS
2932535d602Swdenk
294c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
295c609719bSwdenk		Define exactly one of
296c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
297c609719bSwdenk
29811ccc33fSMarcel Ziswiler- 8xx CPU Options: (if using an MPC8xx CPU)
29966ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
30066ca92a5Swdenk					  get_gclk_freq() cannot work
3015da627a4Swdenk					  e.g. if there is no 32KHz
3025da627a4Swdenk					  reference PIT/RTC clock
30366ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
30466ca92a5Swdenk					  or XTAL/EXTAL)
305c609719bSwdenk
30666ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
3076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MIN
3086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_8xx_CPUCLK_MAX
30966ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
31075d1ea7fSwdenk			See doc/README.MPC866
31175d1ea7fSwdenk
3126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MEASURE_CPUCLK
31375d1ea7fSwdenk
31475d1ea7fSwdenk		Define this to measure the actual CPU clock instead
31575d1ea7fSwdenk		of relying on the correctness of the configured
31675d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
31775d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
31875d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
3196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		RTC clock or CONFIG_SYS_8XX_XIN)
32075d1ea7fSwdenk
3210b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
3230b953ffcSMarkus Klotzbuecher
3240b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3250b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3260b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3270b953ffcSMarkus Klotzbuecher
3286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
3290b953ffcSMarkus Klotzbuecher
3300b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3310b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3320b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3330b953ffcSMarkus Klotzbuecher		by this value.
3340b953ffcSMarkus Klotzbuecher
3355da627a4Swdenk- Linux Kernel Interface:
336c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
337c609719bSwdenk
338c609719bSwdenk		U-Boot stores all clock information in Hz
339c609719bSwdenk		internally. For binary compatibility with older Linux
340c609719bSwdenk		kernels (which expect the clocks passed in the
341c609719bSwdenk		bd_info data to be in MHz) the environment variable
342c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
343c609719bSwdenk		converts clock data to MHZ before passing it to the
344c609719bSwdenk		Linux kernel.
345c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
346c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
347c609719bSwdenk		default environment.
348c609719bSwdenk
3495da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3505da627a4Swdenk
35111ccc33fSMarcel Ziswiler		When transferring memsize parameter to linux, some versions
3525da627a4Swdenk		expect it to be in bytes, others in MB.
3535da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3545da627a4Swdenk
355fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
356f57f70aaSWolfgang Denk
357f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
358213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
359213bf8c8SGerald Van Baren		concepts).
360213bf8c8SGerald Van Baren
361213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
362213bf8c8SGerald Van Baren		 * New libfdt-based support
363213bf8c8SGerald Van Baren		 * Adds the "fdt" command
3643bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
365213bf8c8SGerald Van Baren
366f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
367c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
368f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
369c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
370f57f70aaSWolfgang Denk
37111ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
37211ccc33fSMarcel Ziswiler		addresses
3733bb342fcSKim Phillips
3744e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
3754e253137SKumar Gala
3764e253137SKumar Gala		Board code has addition modification that it wants to make
3774e253137SKumar Gala		to the flat device tree before handing it off to the kernel
3786705d81eSwdenk
3790267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
3800267768eSMatthew McClintock
38111ccc33fSMarcel Ziswiler		This define fills in the correct boot CPU in the boot
3820267768eSMatthew McClintock		param header, the default value is zero if undefined.
3830267768eSMatthew McClintock
3840b2f4ecaSNiklaus Giger- vxWorks boot parameters:
3850b2f4ecaSNiklaus Giger
3860b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
3870b2f4ecaSNiklaus Giger		environments variables: bootfile, ipaddr, serverip, hostname.
3880b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
3890b2f4ecaSNiklaus Giger
3900b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
3910b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
3920b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
3930b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
3940b2f4ecaSNiklaus Giger
3950b2f4ecaSNiklaus Giger		CONFIG_SYS_VXWORKS_ADD_PARAMS
3960b2f4ecaSNiklaus Giger
3970b2f4ecaSNiklaus Giger		Add it at the end of the bootline. E.g "u=username pw=secret"
3980b2f4ecaSNiklaus Giger
3990b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
4000b2f4ecaSNiklaus Giger		the defaults discussed just above.
4010b2f4ecaSNiklaus Giger
4026705d81eSwdenk- Serial Ports:
40348d0192fSAndreas Engel		CONFIG_PL010_SERIAL
4046705d81eSwdenk
4056705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4066705d81eSwdenk
40748d0192fSAndreas Engel		CONFIG_PL011_SERIAL
4086705d81eSwdenk
4096705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4106705d81eSwdenk
4116705d81eSwdenk		CONFIG_PL011_CLOCK
4126705d81eSwdenk
4136705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4146705d81eSwdenk		the clock speed of the UARTs.
4156705d81eSwdenk
4166705d81eSwdenk		CONFIG_PL01x_PORTS
4176705d81eSwdenk
4186705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4196705d81eSwdenk		define this to a list of base addresses for each (supported)
4206705d81eSwdenk		port. See e.g. include/configs/versatile.h
4216705d81eSwdenk
4226705d81eSwdenk
423c609719bSwdenk- Console Interface:
424c609719bSwdenk		Depending on board, define exactly one serial port
425c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
426c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
427c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
428c609719bSwdenk
429c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
430c609719bSwdenk		port routines must be defined elsewhere
431c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
432c609719bSwdenk
433c609719bSwdenk		CONFIG_CFB_CONSOLE
434c609719bSwdenk		Enables console device for a color framebuffer. Needs following
435c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
436c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
437c609719bSwdenk						(default big endian)
438c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
439c609719bSwdenk						rectangle fill
440c609719bSwdenk						(cf. smiLynxEM)
441c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
442c609719bSwdenk						bit-blit (cf. smiLynxEM)
443c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
444c609719bSwdenk						(cols=pitch)
445c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
446c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
447c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
448c609719bSwdenk						(0-5, cf. cfb_console.c)
449c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
450c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
451c609719bSwdenk						(i.e. i8042_kbd_init())
452c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
453c609719bSwdenk						(i.e. i8042_tstc)
454c609719bSwdenk			VIDEO_GETC_FCT		get char fct
455c609719bSwdenk						(i.e. i8042_getc)
456c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
457c609719bSwdenk						(requires blink timer
458c609719bSwdenk						cf. i8042.c)
4596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
460c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
461c609719bSwdenk						upper right corner
462602ad3b3SJon Loeliger						(requires CONFIG_CMD_DATE)
463c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
464c609719bSwdenk						upper left corner
465a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
466a6c7ad2fSwdenk						linux_logo.h for logo.
467a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
468c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
46911ccc33fSMarcel Ziswiler						additional board info beside
470c609719bSwdenk						the logo
471c609719bSwdenk
472c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
473c609719bSwdenk		default i/o. Serial console can be forced with
474c609719bSwdenk		environment 'console=serial'.
475c609719bSwdenk
476a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
477a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
478a3ad8e26Swdenk		the "silent" environment variable. See
479a3ad8e26Swdenk		doc/README.silent for more information.
480a3ad8e26Swdenk
481c609719bSwdenk- Console Baudrate:
482c609719bSwdenk		CONFIG_BAUDRATE - in bps
483c609719bSwdenk		Select one of the baudrates listed in
4846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
4856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
486c609719bSwdenk
487c609719bSwdenk- Interrupt driven serial port input:
488c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
489c609719bSwdenk
490c609719bSwdenk		PPC405GP only.
491c609719bSwdenk		Use an interrupt handler for receiving data on the
492c609719bSwdenk		serial port. It also enables using hardware handshake
493c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
494c609719bSwdenk		bytes the interrupt driven input buffer should have.
495c609719bSwdenk
496109c0e3aSwdenk		Leave undefined to disable this feature, including
497109c0e3aSwdenk		disable the buffer and hardware handshake.
498c609719bSwdenk
4991d49b1f3Sstroese- Console UART Number:
5001d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5011d49b1f3Sstroese
5020c8721a4SWolfgang Denk		AMCC PPC4xx only.
5031d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5041d49b1f3Sstroese		as default U-Boot console.
5051d49b1f3Sstroese
506c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
507c609719bSwdenk		Delay before automatically booting the default image;
508c609719bSwdenk		set to -1 to disable autoboot.
509c609719bSwdenk
510c609719bSwdenk		See doc/README.autoboot for these options that
511c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
512c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
513c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
514c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
515c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
516c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
517c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
518c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
519c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
520c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
521c609719bSwdenk		CONFIG_RESET_TO_RETRY
522c609719bSwdenk
523c609719bSwdenk- Autoboot Command:
524c609719bSwdenk		CONFIG_BOOTCOMMAND
525c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
526c609719bSwdenk		define a command string that is automatically executed
527c609719bSwdenk		when no character is read on the console interface
528c609719bSwdenk		within "Boot Delay" after reset.
529c609719bSwdenk
530c609719bSwdenk		CONFIG_BOOTARGS
531c609719bSwdenk		This can be used to pass arguments to the bootm
532c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
533c609719bSwdenk		environment value "bootargs".
534c609719bSwdenk
535c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
536c609719bSwdenk		The value of these goes into the environment as
537c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
538c609719bSwdenk		as a convenience, when switching between booting from
53911ccc33fSMarcel Ziswiler		RAM and NFS.
540c609719bSwdenk
541c609719bSwdenk- Pre-Boot Commands:
542c609719bSwdenk		CONFIG_PREBOOT
543c609719bSwdenk
544c609719bSwdenk		When this option is #defined, the existence of the
545c609719bSwdenk		environment variable "preboot" will be checked
546c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
547c609719bSwdenk		countdown and/or running the auto-boot command resp.
548c609719bSwdenk		entering interactive mode.
549c609719bSwdenk
550c609719bSwdenk		This feature is especially useful when "preboot" is
551c609719bSwdenk		automatically generated or modified. For an example
552c609719bSwdenk		see the LWMON board specific code: here "preboot" is
553c609719bSwdenk		modified when the user holds down a certain
554c609719bSwdenk		combination of keys on the (special) keyboard when
555c609719bSwdenk		booting the systems
556c609719bSwdenk
557c609719bSwdenk- Serial Download Echo Mode:
558c609719bSwdenk		CONFIG_LOADS_ECHO
559c609719bSwdenk		If defined to 1, all characters received during a
560c609719bSwdenk		serial download (using the "loads" command) are
561c609719bSwdenk		echoed back. This might be needed by some terminal
562c609719bSwdenk		emulations (like "cu"), but may as well just take
563c609719bSwdenk		time on others. This setting #define's the initial
564c609719bSwdenk		value of the "loads_echo" environment variable.
565c609719bSwdenk
566602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
567c609719bSwdenk		CONFIG_KGDB_BAUDRATE
568c609719bSwdenk		Select one of the baudrates listed in
5696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
570c609719bSwdenk
571c609719bSwdenk- Monitor Functions:
572602ad3b3SJon Loeliger		Monitor commands can be included or excluded
573602ad3b3SJon Loeliger		from the build by using the #include files
574602ad3b3SJon Loeliger		"config_cmd_all.h" and #undef'ing unwanted
575602ad3b3SJon Loeliger		commands, or using "config_cmd_default.h"
576602ad3b3SJon Loeliger		and augmenting with additional #define's
577602ad3b3SJon Loeliger		for wanted commands.
578c609719bSwdenk
579602ad3b3SJon Loeliger		The default command configuration includes all commands
580602ad3b3SJon Loeliger		except those marked below with a "*".
581602ad3b3SJon Loeliger
582602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
583602ad3b3SJon Loeliger		CONFIG_CMD_AUTOSCRIPT	  Autoscript Support
584602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
585602ad3b3SJon Loeliger		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
586602ad3b3SJon Loeliger		CONFIG_CMD_BMP		* BMP support
587602ad3b3SJon Loeliger		CONFIG_CMD_BSP		* Board specific commands
588602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
589602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
590602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
591602ad3b3SJon Loeliger		CONFIG_CMD_DATE		* support for RTC, date/time...
592602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
593602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
594602ad3b3SJon Loeliger		CONFIG_CMD_DOC		* Disk-On-Chip Support
595a7c93104SPeter Tyser		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
596a7c93104SPeter Tyser		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
597a7c93104SPeter Tyser		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
598a7c93104SPeter Tyser		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
599602ad3b3SJon Loeliger		CONFIG_CMD_DTT		* Digital Therm and Thermostat
600602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
601602ad3b3SJon Loeliger		CONFIG_CMD_EEPROM	* EEPROM read/write support
602602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
603602ad3b3SJon Loeliger		CONFIG_CMD_ENV		  saveenv
604602ad3b3SJon Loeliger		CONFIG_CMD_FDC		* Floppy Disk Support
605602ad3b3SJon Loeliger		CONFIG_CMD_FAT		* FAT partition support
606602ad3b3SJon Loeliger		CONFIG_CMD_FDOS		* Dos diskette Support
607602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
608602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
609602ad3b3SJon Loeliger		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
610602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
611602ad3b3SJon Loeliger		CONFIG_CMD_IDE		* IDE harddisk support
612602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
613602ad3b3SJon Loeliger		CONFIG_CMD_IMLS		  List all found images
614602ad3b3SJon Loeliger		CONFIG_CMD_IMMAP	* IMMR dump support
615602ad3b3SJon Loeliger		CONFIG_CMD_IRQ		* irqinfo
616602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
617602ad3b3SJon Loeliger		CONFIG_CMD_JFFS2	* JFFS2 Support
618602ad3b3SJon Loeliger		CONFIG_CMD_KGDB		* kgdb
619602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
620602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
621602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
62256523f12Swdenk					  loop, loopw, mtest
623602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
624602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
625602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
626602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
627602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
628e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
629e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
630602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
631602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
632602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
633602ad3b3SJon Loeliger					  host
634602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
635602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
636602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
637602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
638602ad3b3SJon Loeliger		CONFIG_CMD_SCSI		* SCSI Support
639602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
640602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
641602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
642602ad3b3SJon Loeliger					  (4xx only)
643602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
644602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
645602ad3b3SJon Loeliger		CONFIG_CMD_VFD		* VFD support (TRAB)
646602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
647602ad3b3SJon Loeliger		CONFIG_CMD_FSL		* Microblaze FSL support
648c609719bSwdenk
649c609719bSwdenk
650c609719bSwdenk		EXAMPLE: If you want all functions except of network
651c609719bSwdenk		support you can write:
652c609719bSwdenk
653602ad3b3SJon Loeliger		#include "config_cmd_all.h"
654602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
655c609719bSwdenk
656213bf8c8SGerald Van Baren	Other Commands:
657213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
658c609719bSwdenk
659c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
660602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
661c609719bSwdenk		what you (and your U-Boot users) are doing. Data
662c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
663c609719bSwdenk		8260 (where accesses to the IMMR region must be
664c609719bSwdenk		uncached), and it cannot be disabled on all other
665c609719bSwdenk		systems where we (mis-) use the data cache to hold an
666c609719bSwdenk		initial stack and some data.
667c609719bSwdenk
668c609719bSwdenk
669c609719bSwdenk		XXX - this list needs to get updated!
670c609719bSwdenk
671c609719bSwdenk- Watchdog:
672c609719bSwdenk		CONFIG_WATCHDOG
673c609719bSwdenk		If this variable is defined, it enables watchdog
6747152b1d0Swdenk		support. There must be support in the platform specific
675c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
676c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
677c609719bSwdenk		register.
678c609719bSwdenk
679c1551ea8Sstroese- U-Boot Version:
680c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
681c1551ea8Sstroese		If this variable is defined, an environment variable
682c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
683c1551ea8Sstroese		version as printed by the "version" command.
684c1551ea8Sstroese		This variable is readonly.
685c1551ea8Sstroese
686c609719bSwdenk- Real-Time Clock:
687c609719bSwdenk
688602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
689c609719bSwdenk		has to be selected, too. Define exactly one of the
690c609719bSwdenk		following options:
691c609719bSwdenk
692c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
693c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
6947ce63709SGuennadi Liakhovetski		CONFIG_RTC_MC13783	- use MC13783 RTC
695c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
6961cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
697c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
6987f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
6993bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7009536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
7014c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
7026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
703c609719bSwdenk
704b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
705b37c7e5eSwdenk		must also be configured. See I2C Support, below.
706b37c7e5eSwdenk
707e92739d3SPeter Tyser- GPIO Support:
708e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
709e92739d3SPeter Tyser		CONFIG_PCA953X_INFO	- enable pca953x info command
710e92739d3SPeter Tyser
711e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
712e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
713e92739d3SPeter Tyser
714c609719bSwdenk- Timestamp Support:
715c609719bSwdenk
716c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
717c609719bSwdenk		(date and time) of an image is printed by image
718c609719bSwdenk		commands like bootm or iminfo. This option is
719602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
720c609719bSwdenk
721c609719bSwdenk- Partition Support:
722c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
72307f3d789Srichardretanubun		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
724c609719bSwdenk
725602ad3b3SJon Loeliger		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
726218ca724SWolfgang Denk		CONFIG_CMD_SCSI) you must configure support for at
727218ca724SWolfgang Denk		least one partition type as well.
728c609719bSwdenk
729c609719bSwdenk- IDE Reset method:
7304d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7314d13cbadSwdenk		board configurations files but used nowhere!
732c609719bSwdenk
7334d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7344d13cbadSwdenk		be performed by calling the function
7354d13cbadSwdenk			ide_set_reset(int reset)
7364d13cbadSwdenk		which has to be defined in a board specific file
737c609719bSwdenk
738c609719bSwdenk- ATAPI Support:
739c609719bSwdenk		CONFIG_ATAPI
740c609719bSwdenk
741c609719bSwdenk		Set this to enable ATAPI support.
742c609719bSwdenk
743c40b2956Swdenk- LBA48 Support
744c40b2956Swdenk		CONFIG_LBA48
745c40b2956Swdenk
746c40b2956Swdenk		Set this to enable support for disks larger than 137GB
7476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
748c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
749c40b2956Swdenk		support disks up to 2.1TB.
750c40b2956Swdenk
7516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
752c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
753c40b2956Swdenk			Default is 32bit.
754c40b2956Swdenk
755c609719bSwdenk- SCSI Support:
756c609719bSwdenk		At the moment only there is only support for the
757c609719bSwdenk		SYM53C8XX SCSI controller; define
758c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
759c609719bSwdenk
7606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
7616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
7626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
763c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
764c609719bSwdenk		devices.
7656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
766c609719bSwdenk
767c609719bSwdenk- NETWORK Support (PCI):
768682011ffSwdenk		CONFIG_E1000
769682011ffSwdenk		Support for Intel 8254x gigabit chips.
770682011ffSwdenk
771ac3315c2SAndre Schwarz		CONFIG_E1000_FALLBACK_MAC
77211ccc33fSMarcel Ziswiler		default MAC for empty EEPROM after production.
773ac3315c2SAndre Schwarz
774c609719bSwdenk		CONFIG_EEPRO100
775c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
77611ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
777c609719bSwdenk		write routine for first time initialisation.
778c609719bSwdenk
779c609719bSwdenk		CONFIG_TULIP
780c609719bSwdenk		Support for Digital 2114x chips.
781c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
782c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
783c609719bSwdenk
784c609719bSwdenk		CONFIG_NATSEMI
785c609719bSwdenk		Support for National dp83815 chips.
786c609719bSwdenk
787c609719bSwdenk		CONFIG_NS8382X
788c609719bSwdenk		Support for National dp8382[01] gigabit chips.
789c609719bSwdenk
79045219c46Swdenk- NETWORK Support (other):
79145219c46Swdenk
79245219c46Swdenk		CONFIG_DRIVER_LAN91C96
79345219c46Swdenk		Support for SMSC's LAN91C96 chips.
79445219c46Swdenk
79545219c46Swdenk			CONFIG_LAN91C96_BASE
79645219c46Swdenk			Define this to hold the physical address
79745219c46Swdenk			of the LAN91C96's I/O space
79845219c46Swdenk
79945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
80045219c46Swdenk			Define this to enable 32 bit addressing
80145219c46Swdenk
802f39748aeSwdenk		CONFIG_DRIVER_SMC91111
803f39748aeSwdenk		Support for SMSC's LAN91C111 chip
804f39748aeSwdenk
805f39748aeSwdenk			CONFIG_SMC91111_BASE
806f39748aeSwdenk			Define this to hold the physical address
807f39748aeSwdenk			of the device (I/O space)
808f39748aeSwdenk
809f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
810f39748aeSwdenk			Define this if data bus is 32 bits
811f39748aeSwdenk
812f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
813f39748aeSwdenk			Define this to use i/o functions instead of macros
814f39748aeSwdenk			(some hardware wont work with macros)
815f39748aeSwdenk
816557b377dSJens Gehrlein		CONFIG_DRIVER_SMC911X
817557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
818557b377dSJens Gehrlein
819557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_BASE
820557b377dSJens Gehrlein			Define this to hold the physical address
821557b377dSJens Gehrlein			of the device (I/O space)
822557b377dSJens Gehrlein
823557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_32_BIT
824557b377dSJens Gehrlein			Define this if data bus is 32 bits
825557b377dSJens Gehrlein
826557b377dSJens Gehrlein			CONFIG_DRIVER_SMC911X_16_BIT
827557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
828557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
829557b377dSJens Gehrlein			words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
830557b377dSJens Gehrlein
831c609719bSwdenk- USB Support:
832c609719bSwdenk		At the moment only the UHCI host controller is
8334d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
834c609719bSwdenk		CONFIG_USB_UHCI to enable it.
835c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
83630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
837c609719bSwdenk		storage devices.
838c609719bSwdenk		Note:
839c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
840c609719bSwdenk		(TEAC FD-05PUB).
8414d13cbadSwdenk		MPC5200 USB requires additional defines:
8424d13cbadSwdenk			CONFIG_USB_CLOCK
8434d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8444d13cbadSwdenk			CONFIG_USB_CONFIG
8454d13cbadSwdenk				for differential drivers: 0x00001000
8464d13cbadSwdenk				for single ended drivers: 0x00005000
8476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
848fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
849fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
8504d13cbadSwdenk
85116c8d5e7SWolfgang Denk- USB Device:
85216c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
85316c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
85416c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
85511ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
85616c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
85716c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
85816c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
85916c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
86016c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
86116c8d5e7SWolfgang Denk		a Linux host by
86216c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
86316c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
86416c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
86516c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
86616c8d5e7SWolfgang Denk
86716c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
86816c8d5e7SWolfgang Denk			Define this to build a UDC device
86916c8d5e7SWolfgang Denk
87016c8d5e7SWolfgang Denk			CONFIG_USB_TTY
87116c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
87216c8d5e7SWolfgang Denk			talk to the UDC device
87316c8d5e7SWolfgang Denk
8746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
87516c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
87616c8d5e7SWolfgang Denk			be set to usbtty.
87716c8d5e7SWolfgang Denk
87816c8d5e7SWolfgang Denk			mpc8xx:
8796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
88016c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
8816d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_EXTC_CLK 0x02
88216c8d5e7SWolfgang Denk
8836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				CONFIG_SYS_USB_BRG_CLK 0xBLAH
88416c8d5e7SWolfgang Denk				Derive USB clock from brgclk
8856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD				- CONFIG_SYS_USB_BRG_CLK 0x04
88616c8d5e7SWolfgang Denk
88716c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
88816c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
88916c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
89016c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
89116c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
89216c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
89316c8d5e7SWolfgang Denk
89416c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
89516c8d5e7SWolfgang Denk			Define this string as the name of your company for
89616c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
89716c8d5e7SWolfgang Denk
89816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
89916c8d5e7SWolfgang Denk			Define this string as the name of your product
90016c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
90116c8d5e7SWolfgang Denk
90216c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
90316c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
90416c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
90516c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
90616c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
90716c8d5e7SWolfgang Denk
90816c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
90916c8d5e7SWolfgang Denk			Define this as the unique Product ID
91016c8d5e7SWolfgang Denk			for your device
91116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
912c609719bSwdenk
913c609719bSwdenk
914c609719bSwdenk- MMC Support:
915c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
916c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
917c609719bSwdenk		accessed from the boot prompt by mapping the device
918c609719bSwdenk		to physical memory similar to flash. Command line is
919602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
920602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
921c609719bSwdenk
9226705d81eSwdenk- Journaling Flash filesystem support:
9236705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9246705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9256705d81eSwdenk		Define these for a default partition on a NAND device
9266705d81eSwdenk
9276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
9286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
9296705d81eSwdenk		Define these for a default partition on a NOR device
9306705d81eSwdenk
9316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS_CUSTOM_PART
9326705d81eSwdenk		Define this to create an own partition. You have to provide a
9336705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9346705d81eSwdenk
9356705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_JFFS_SINGLE_PART	1
9376705d81eSwdenk		to disable the command chpart. This is the default when you
9386705d81eSwdenk		have not defined a custom partition
9396705d81eSwdenk
940c609719bSwdenk- Keyboard Support:
941c609719bSwdenk		CONFIG_ISA_KEYBOARD
942c609719bSwdenk
943c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
944c609719bSwdenk		support
945c609719bSwdenk
946c609719bSwdenk		CONFIG_I8042_KBD
947c609719bSwdenk		Standard PC keyboard driver with US (is default) and
948c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
949c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
950c609719bSwdenk		for cfb_console. Supports cursor blinking.
951c609719bSwdenk
952c609719bSwdenk- Video support:
953c609719bSwdenk		CONFIG_VIDEO
954c609719bSwdenk
955c609719bSwdenk		Define this to enable video support (for output to
956c609719bSwdenk		video).
957c609719bSwdenk
958c609719bSwdenk		CONFIG_VIDEO_CT69000
959c609719bSwdenk
960c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
961c609719bSwdenk
962c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
963eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
964eeb1b77bSwdenk		video output is selected via environment 'videoout'
965eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
966eeb1b77bSwdenk		assumed.
967c609719bSwdenk
968eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
96911ccc33fSMarcel Ziswiler		selected via environment 'videomode'. Two different ways
970eeb1b77bSwdenk		are possible:
971eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
972eeb1b77bSwdenk		Following standard modes are supported	(* is default):
973eeb1b77bSwdenk
974eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
975eeb1b77bSwdenk		-------------+---------------------------------------------
976eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
977eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
978eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
979eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
980eeb1b77bSwdenk		-------------+---------------------------------------------
981c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
982c609719bSwdenk
983eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
9847817cb20SMarcel Ziswiler		from the bootargs. (See drivers/video/videomodes.c)
985eeb1b77bSwdenk
986eeb1b77bSwdenk
987a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
988a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
989a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
990a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
991a6c7ad2fSwdenk
992682011ffSwdenk- Keyboard Support:
993682011ffSwdenk		CONFIG_KEYBOARD
994682011ffSwdenk
995682011ffSwdenk		Define this to enable a custom keyboard support.
996682011ffSwdenk		This simply calls drv_keyboard_init() which must be
997682011ffSwdenk		defined in your board-specific files.
998682011ffSwdenk		The only board using this so far is RBC823.
999a6c7ad2fSwdenk
1000c609719bSwdenk- LCD Support:	CONFIG_LCD
1001c609719bSwdenk
1002c609719bSwdenk		Define this to enable LCD support (for output to LCD
1003c609719bSwdenk		display); also select one of the supported displays
1004c609719bSwdenk		by defining one of these:
1005c609719bSwdenk
100639cf4804SStelian Pop		CONFIG_ATMEL_LCD:
100739cf4804SStelian Pop
100839cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
100939cf4804SStelian Pop
1010fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1011c609719bSwdenk
1012fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1013c609719bSwdenk
1014fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1015c609719bSwdenk
1016fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1017fd3103bbSwdenk			Active, color, single scan.
1018fd3103bbSwdenk
1019fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1020fd3103bbSwdenk
1021fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1022c609719bSwdenk			Active, color, single scan.
1023c609719bSwdenk
1024c609719bSwdenk		CONFIG_SHARP_16x9
1025c609719bSwdenk
1026c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1027c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1028c609719bSwdenk
1029c609719bSwdenk		CONFIG_SHARP_LQ64D341
1030c609719bSwdenk
1031c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1032c609719bSwdenk			Active, color, single scan.
1033c609719bSwdenk
1034c609719bSwdenk		CONFIG_HLD1045
1035c609719bSwdenk
1036c609719bSwdenk			HLD1045 display, 640x480.
1037c609719bSwdenk			Active, color, single scan.
1038c609719bSwdenk
1039c609719bSwdenk		CONFIG_OPTREX_BW
1040c609719bSwdenk
1041c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1042c609719bSwdenk			or
1043c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1044c609719bSwdenk			or
1045c609719bSwdenk			Hitachi	 SP14Q002
1046c609719bSwdenk
1047c609719bSwdenk			320x240. Black & white.
1048c609719bSwdenk
1049c609719bSwdenk		Normally display is black on white background; define
10506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
1051c609719bSwdenk
10527152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1053d791b1dcSwdenk
1054d791b1dcSwdenk		If this option is set, the environment is checked for
1055d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1056d791b1dcSwdenk		of logo, copyright and system information on the LCD
1057e94d2cd9Swdenk		is suppressed and the BMP image at the address
1058d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1059d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1060d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1061d791b1dcSwdenk		loaded very quickly after power-on.
1062d791b1dcSwdenk
106398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
106498f4a3dfSStefan Roese
106598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
106698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
106798f4a3dfSStefan Roese		splashscreen support or the bmp command.
106898f4a3dfSStefan Roese
1069c29fdfc1Swdenk- Compression support:
1070c29fdfc1Swdenk		CONFIG_BZIP2
1071c29fdfc1Swdenk
1072c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1073c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1074c29fdfc1Swdenk		compressed images are supported.
1075c29fdfc1Swdenk
1076c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
10776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1078c29fdfc1Swdenk		be at least 4MB.
1079d791b1dcSwdenk
1080fc9c1727SLuigi 'Comio' Mantellini		CONFIG_LZMA
1081fc9c1727SLuigi 'Comio' Mantellini
1082fc9c1727SLuigi 'Comio' Mantellini		If this option is set, support for lzma compressed
1083fc9c1727SLuigi 'Comio' Mantellini		images is included.
1084fc9c1727SLuigi 'Comio' Mantellini
1085fc9c1727SLuigi 'Comio' Mantellini		Note: The LZMA algorithm adds between 2 and 4KB of code and it
1086fc9c1727SLuigi 'Comio' Mantellini		requires an amount of dynamic memory that is given by the
1087fc9c1727SLuigi 'Comio' Mantellini		formula:
1088fc9c1727SLuigi 'Comio' Mantellini
1089fc9c1727SLuigi 'Comio' Mantellini			(1846 + 768 << (lc + lp)) * sizeof(uint16)
1090fc9c1727SLuigi 'Comio' Mantellini
1091fc9c1727SLuigi 'Comio' Mantellini		Where lc and lp stand for, respectively, Literal context bits
1092fc9c1727SLuigi 'Comio' Mantellini		and Literal pos bits.
1093fc9c1727SLuigi 'Comio' Mantellini
1094fc9c1727SLuigi 'Comio' Mantellini		This value is upper-bounded by 14MB in the worst case. Anyway,
1095fc9c1727SLuigi 'Comio' Mantellini		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1096fc9c1727SLuigi 'Comio' Mantellini		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1097fc9c1727SLuigi 'Comio' Mantellini		a very small buffer.
1098fc9c1727SLuigi 'Comio' Mantellini
1099fc9c1727SLuigi 'Comio' Mantellini		Use the lzmainfo tool to determinate the lc and lp values and
1100fc9c1727SLuigi 'Comio' Mantellini		then calculate the amount of needed dynamic memory (ensuring
11016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the appropriate CONFIG_SYS_MALLOC_LEN value).
1102fc9c1727SLuigi 'Comio' Mantellini
110317ea1177Swdenk- MII/PHY support:
110417ea1177Swdenk		CONFIG_PHY_ADDR
110517ea1177Swdenk
110617ea1177Swdenk		The address of PHY on MII bus.
110717ea1177Swdenk
110817ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
110917ea1177Swdenk
111017ea1177Swdenk		The clock frequency of the MII bus
111117ea1177Swdenk
111217ea1177Swdenk		CONFIG_PHY_GIGE
111317ea1177Swdenk
111417ea1177Swdenk		If this option is set, support for speed/duplex
111511ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
111617ea1177Swdenk
111717ea1177Swdenk		CONFIG_PHY_RESET_DELAY
111817ea1177Swdenk
111917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
112017ea1177Swdenk		reset before any MII register access is possible.
112117ea1177Swdenk		For such PHY, set this option to the usec delay
112217ea1177Swdenk		required. (minimum 300usec for LXT971A)
112317ea1177Swdenk
112417ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
112517ea1177Swdenk
112617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
112717ea1177Swdenk		command issued before MII status register can be read
112817ea1177Swdenk
1129c609719bSwdenk- Ethernet address:
1130c609719bSwdenk		CONFIG_ETHADDR
1131c68a05feSrichardretanubun		CONFIG_ETH1ADDR
1132c609719bSwdenk		CONFIG_ETH2ADDR
1133c609719bSwdenk		CONFIG_ETH3ADDR
1134c68a05feSrichardretanubun		CONFIG_ETH4ADDR
1135c68a05feSrichardretanubun		CONFIG_ETH5ADDR
1136c609719bSwdenk
113711ccc33fSMarcel Ziswiler		Define a default value for Ethernet address to use
113811ccc33fSMarcel Ziswiler		for the respective Ethernet interface, in case this
1139c609719bSwdenk		is not determined automatically.
1140c609719bSwdenk
1141c609719bSwdenk- IP address:
1142c609719bSwdenk		CONFIG_IPADDR
1143c609719bSwdenk
1144c609719bSwdenk		Define a default value for the IP address to use for
114511ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1146c609719bSwdenk		determined through e.g. bootp.
1147c609719bSwdenk
1148c609719bSwdenk- Server IP address:
1149c609719bSwdenk		CONFIG_SERVERIP
1150c609719bSwdenk
1151c609719bSwdenk		Defines a default value for the IP address of a TFTP
1152c609719bSwdenk		server to contact when using the "tftboot" command.
1153c609719bSwdenk
115453a5c424SDavid Updegraff- Multicast TFTP Mode:
115553a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
115653a5c424SDavid Updegraff
115753a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
115853a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
115911ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
116053a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
116153a5c424SDavid Updegraff		multicast group.
116253a5c424SDavid Updegraff
116353a5c424SDavid Updegraff		CONFIG_BOOTP_RANDOM_DELAY
1164c609719bSwdenk- BOOTP Recovery Mode:
1165c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1166c609719bSwdenk
1167c609719bSwdenk		If you have many targets in a network that try to
1168c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1169c609719bSwdenk		systems send out BOOTP requests at precisely the same
1170c609719bSwdenk		moment (which would happen for instance at recovery
1171c609719bSwdenk		from a power failure, when all systems will try to
1172c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1173c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1174c609719bSwdenk		inserted before sending out BOOTP requests. The
11756c33c785SWolfgang Denk		following delays are inserted then:
1176c609719bSwdenk
1177c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1178c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1179c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1180c609719bSwdenk		4th and following
1181c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1182c609719bSwdenk
1183fe389a82Sstroese- DHCP Advanced Options:
11841fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
11851fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1186fe389a82Sstroese
11871fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
11881fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
11891fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
11901fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
11911fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
11921fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
11931fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
11941fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
11951fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
11961fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
11971fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
11981fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
1199fe389a82Sstroese
12005d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
12015d110f0aSWilson Callan		environment variable, not the BOOTP server.
1202fe389a82Sstroese
1203fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1204fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1205fe389a82Sstroese		than one DNS serverip is offered to the client.
1206fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1207fe389a82Sstroese		serverip will be stored in the additional environment
1208fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1209fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
12101fe80d79SJon Loeliger		is defined.
1211fe389a82Sstroese
1212fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1213fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1214fe389a82Sstroese		need the hostname of the DHCP requester.
12155d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
12161fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
12171fe80d79SJon Loeliger		option 12 to the DHCP server.
1218fe389a82Sstroese
1219d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1220d9a2f416SAras Vaichas
1221d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1222d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1223d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1224d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1225d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1226d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1227d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1228d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1229d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1230d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1231d9a2f416SAras Vaichas		this delay.
1232d9a2f416SAras Vaichas
1233a3d991bdSwdenk - CDP Options:
1234a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1235a3d991bdSwdenk
1236a3d991bdSwdenk		The device id used in CDP trigger frames.
1237a3d991bdSwdenk
1238a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1239a3d991bdSwdenk
1240a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1241a3d991bdSwdenk		of the device.
1242a3d991bdSwdenk
1243a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1244a3d991bdSwdenk
1245a3d991bdSwdenk		A printf format string which contains the ascii name of
1246a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
124711ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1248a3d991bdSwdenk
1249a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1250a3d991bdSwdenk
1251a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1252a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1253a3d991bdSwdenk
1254a3d991bdSwdenk		CONFIG_CDP_VERSION
1255a3d991bdSwdenk
1256a3d991bdSwdenk		An ascii string containing the version of the software.
1257a3d991bdSwdenk
1258a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1259a3d991bdSwdenk
1260a3d991bdSwdenk		An ascii string containing the name of the platform.
1261a3d991bdSwdenk
1262a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1263a3d991bdSwdenk
1264a3d991bdSwdenk		A 32bit integer sent on the trigger.
1265a3d991bdSwdenk
1266a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1267a3d991bdSwdenk
1268a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1269a3d991bdSwdenk		device in .1 of milliwatts.
1270a3d991bdSwdenk
1271a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1272a3d991bdSwdenk
1273a3d991bdSwdenk		A byte containing the id of the VLAN.
1274a3d991bdSwdenk
1275c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1276c609719bSwdenk
1277c609719bSwdenk		Several configurations allow to display the current
1278c609719bSwdenk		status using a LED. For instance, the LED will blink
1279c609719bSwdenk		fast while running U-Boot code, stop blinking as
1280c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1281c609719bSwdenk		start blinking slow once the Linux kernel is running
1282c609719bSwdenk		(supported by a status LED driver in the Linux
1283c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1284c609719bSwdenk		feature in U-Boot.
1285c609719bSwdenk
1286c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1287c609719bSwdenk
1288c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1289c609719bSwdenk		on those systems that support this (optional)
1290c609719bSwdenk		feature, like the TQM8xxL modules.
1291c609719bSwdenk
1292c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1293c609719bSwdenk
1294b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1295b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
129611ccc33fSMarcel Ziswiler		include the appropriate I2C driver for the selected CPU.
1297c609719bSwdenk
1298b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1299602ad3b3SJon Loeliger		command line (as long as you set CONFIG_CMD_I2C in
1300b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1301b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1302c609719bSwdenk		command line interface.
1303c609719bSwdenk
1304bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1305bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1306bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1307bb99ad6dSBen Warren		deprecated and may disappear in the future.
1308bb99ad6dSBen Warren
1309bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1310c609719bSwdenk
1311b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1312b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1313b37c7e5eSwdenk		support for I2C.
1314c609719bSwdenk
1315b37c7e5eSwdenk		There are several other quantities that must also be
1316b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1317c609719bSwdenk
13186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1319b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
13206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
132111ccc33fSMarcel Ziswiler		the CPU's i2c node address).
1322c609719bSwdenk
1323b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
132411ccc33fSMarcel Ziswiler		sets the CPU up as a master node and so its address should
1325b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
13266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		p.16-473). So, set CONFIG_SYS_I2C_SLAVE to 0.
1327b37c7e5eSwdenk
1328b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1329b37c7e5eSwdenk
1330b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1331b37c7e5eSwdenk		then the following macros need to be defined (examples are
1332b37c7e5eSwdenk		from include/configs/lwmon.h):
1333c609719bSwdenk
1334c609719bSwdenk		I2C_INIT
1335c609719bSwdenk
1336b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1337c609719bSwdenk		controller or configure ports.
1338c609719bSwdenk
1339b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1340b37c7e5eSwdenk
1341c609719bSwdenk		I2C_PORT
1342c609719bSwdenk
1343c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1344c609719bSwdenk		assumes both bits are on the same port). Valid values
1345c609719bSwdenk		are 0..3 for ports A..D.
1346c609719bSwdenk
1347c609719bSwdenk		I2C_ACTIVE
1348c609719bSwdenk
1349c609719bSwdenk		The code necessary to make the I2C data line active
1350c609719bSwdenk		(driven).  If the data line is open collector, this
1351c609719bSwdenk		define can be null.
1352c609719bSwdenk
1353b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1354b37c7e5eSwdenk
1355c609719bSwdenk		I2C_TRISTATE
1356c609719bSwdenk
1357c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1358c609719bSwdenk		(inactive).  If the data line is open collector, this
1359c609719bSwdenk		define can be null.
1360c609719bSwdenk
1361b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1362b37c7e5eSwdenk
1363c609719bSwdenk		I2C_READ
1364c609719bSwdenk
1365c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1366c609719bSwdenk		FALSE if it is low.
1367c609719bSwdenk
1368b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1369b37c7e5eSwdenk
1370c609719bSwdenk		I2C_SDA(bit)
1371c609719bSwdenk
1372c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1373c609719bSwdenk		is FALSE, it clears it (low).
1374c609719bSwdenk
1375b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1376b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1377b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1378b37c7e5eSwdenk
1379c609719bSwdenk		I2C_SCL(bit)
1380c609719bSwdenk
1381c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1382c609719bSwdenk		is FALSE, it clears it (low).
1383c609719bSwdenk
1384b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1385b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1386b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1387b37c7e5eSwdenk
1388c609719bSwdenk		I2C_DELAY
1389c609719bSwdenk
1390c609719bSwdenk		This delay is invoked four times per clock cycle so this
1391c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1392b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1393b37c7e5eSwdenk		like:
1394b37c7e5eSwdenk
1395b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1396c609719bSwdenk
13976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
139847cd00faSwdenk
139947cd00faSwdenk		When a board is reset during an i2c bus transfer
140047cd00faSwdenk		chips might think that the current transfer is still
140147cd00faSwdenk		in progress. On some boards it is possible to access
140247cd00faSwdenk		the i2c SCLK line directly, either by using the
140347cd00faSwdenk		processor pin as a GPIO or by having a second pin
140447cd00faSwdenk		connected to the bus. If this option is defined a
140547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
140647cd00faSwdenk		is run early in the boot sequence.
140747cd00faSwdenk
140817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
140917ea1177Swdenk
141017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
141117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
141217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
141317ea1177Swdenk
1414bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1415bb99ad6dSBen Warren
1416bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1417bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1418bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1419bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1420bb99ad6dSBen Warren
14216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
1422bb99ad6dSBen Warren
1423bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1424bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1425bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1426bb99ad6dSBen Warren		pairs.	Otherwise, specify a 1D array of device addresses
1427bb99ad6dSBen Warren
1428bb99ad6dSBen Warren		e.g.
1429bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
14306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1431bb99ad6dSBen Warren
1432bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1433bb99ad6dSBen Warren
1434bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
14356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1436bb99ad6dSBen Warren
1437bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1438bb99ad6dSBen Warren
14396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
1440be5e6181STimur Tabi
1441be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1442be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1443be5e6181STimur Tabi
14446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
14450dc018ecSStefan Roese
14460dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
14470dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
14480dc018ecSStefan Roese
14496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_DTT_BUS_NUM
14500dc018ecSStefan Roese
14510dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
14520dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
14530dc018ecSStefan Roese
14546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_DTT_ADDR:
14559ebbb54fSVictor Gallardo
14569ebbb54fSVictor Gallardo		If defined, specifies the I2C address of the DTT device.
14579ebbb54fSVictor Gallardo		If not defined, then U-Boot uses predefined value for
14589ebbb54fSVictor Gallardo		specified DTT device.
14599ebbb54fSVictor Gallardo
1460be5e6181STimur Tabi		CONFIG_FSL_I2C
1461be5e6181STimur Tabi
1462be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
14637817cb20SMarcel Ziswiler		drivers/i2c/fsl_i2c.c.
1464be5e6181STimur Tabi
146567b23a32SHeiko Schocher		CONFIG_I2C_MUX
146667b23a32SHeiko Schocher
146767b23a32SHeiko Schocher		Define this option if you have I2C devices reached over 1 .. n
146867b23a32SHeiko Schocher		I2C Muxes like the pca9544a. This option addes a new I2C
146967b23a32SHeiko Schocher		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
147067b23a32SHeiko Schocher		new I2C Bus to the existing I2C Busses. If you select the
147167b23a32SHeiko Schocher		new Bus with "i2c dev", u-bbot sends first the commandos for
147267b23a32SHeiko Schocher		the muxes to activate this new "bus".
147367b23a32SHeiko Schocher
147467b23a32SHeiko Schocher		CONFIG_I2C_MULTI_BUS must be also defined, to use this
147567b23a32SHeiko Schocher		feature!
147667b23a32SHeiko Schocher
147767b23a32SHeiko Schocher		Example:
147867b23a32SHeiko Schocher		Adding a new I2C Bus reached over 2 pca9544a muxes
147967b23a32SHeiko Schocher			The First mux with address 70 and channel 6
148067b23a32SHeiko Schocher			The Second mux with address 71 and channel 4
148167b23a32SHeiko Schocher
148267b23a32SHeiko Schocher		=> i2c bus pca9544a:70:6:pca9544a:71:4
148367b23a32SHeiko Schocher
148467b23a32SHeiko Schocher		Use the "i2c bus" command without parameter, to get a list
148567b23a32SHeiko Schocher		of I2C Busses with muxes:
148667b23a32SHeiko Schocher
148767b23a32SHeiko Schocher		=> i2c bus
148867b23a32SHeiko Schocher		Busses reached over muxes:
148967b23a32SHeiko Schocher		Bus ID: 2
149067b23a32SHeiko Schocher		  reached over Mux(es):
149167b23a32SHeiko Schocher		    pca9544a@70 ch: 4
149267b23a32SHeiko Schocher		Bus ID: 3
149367b23a32SHeiko Schocher		  reached over Mux(es):
149467b23a32SHeiko Schocher		    pca9544a@70 ch: 6
149567b23a32SHeiko Schocher		    pca9544a@71 ch: 4
149667b23a32SHeiko Schocher		=>
149767b23a32SHeiko Schocher
149867b23a32SHeiko Schocher		If you now switch to the new I2C Bus 3 with "i2c dev 3"
149967b23a32SHeiko Schocher		u-boot sends First the Commando to the mux@70 to enable
150067b23a32SHeiko Schocher		channel 6, and then the Commando to the mux@71 to enable
150167b23a32SHeiko Schocher		the channel 4.
150267b23a32SHeiko Schocher
150367b23a32SHeiko Schocher		After that, you can use the "normal" i2c commands as
150467b23a32SHeiko Schocher		usual, to communicate with your I2C devices behind
150567b23a32SHeiko Schocher		the 2 muxes.
150667b23a32SHeiko Schocher
150767b23a32SHeiko Schocher		This option is actually implemented for the bitbanging
150867b23a32SHeiko Schocher		algorithm in common/soft_i2c.c and for the Hardware I2C
150967b23a32SHeiko Schocher		Bus on the MPC8260. But it should be not so difficult
151067b23a32SHeiko Schocher		to add this option to other architectures.
151167b23a32SHeiko Schocher
15122ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
15132ac6985aSAndrew Dyer
15142ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
15152ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
15162ac6985aSAndrew Dyer		between writing the address pointer and reading the
15172ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
15182ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
15192ac6985aSAndrew Dyer		devices can use either method, but some require one or
15202ac6985aSAndrew Dyer		the other.
1521be5e6181STimur Tabi
1522c609719bSwdenk- SPI Support:	CONFIG_SPI
1523c609719bSwdenk
1524c609719bSwdenk		Enables SPI driver (so far only tested with
1525c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1526c609719bSwdenk		D/As on the SACSng board)
1527c609719bSwdenk
1528c609719bSwdenk		CONFIG_SPI_X
1529c609719bSwdenk
1530c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1531c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1532c609719bSwdenk
1533c609719bSwdenk		CONFIG_SOFT_SPI
1534c609719bSwdenk
1535c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1536c609719bSwdenk		using hardware support. This is a general purpose
1537c609719bSwdenk		driver that only requires three general I/O port pins
1538c609719bSwdenk		(two outputs, one input) to function. If this is
1539c609719bSwdenk		defined, the board configuration must define several
1540c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1541c609719bSwdenk		an example, see include/configs/sacsng.h.
1542c609719bSwdenk
154304a9e118SBen Warren		CONFIG_HARD_SPI
154404a9e118SBen Warren
154504a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
154604a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
154704a9e118SBen Warren		must define a list of chip-select function pointers.
154804a9e118SBen Warren		Currently supported on some MPC8xxx processors.  For an
154904a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
155004a9e118SBen Warren
155138254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
155238254f45SGuennadi Liakhovetski
155338254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
155438254f45SGuennadi Liakhovetski		SoCs. Currently only i.MX31 is supported.
155538254f45SGuennadi Liakhovetski
15560133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
15570133502eSMatthias Fuchs
15580133502eSMatthias Fuchs		Enables FPGA subsystem.
15590133502eSMatthias Fuchs
15600133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
15610133502eSMatthias Fuchs
15620133502eSMatthias Fuchs		Enables support for specific chip vendors.
15630133502eSMatthias Fuchs		(ALTERA, XILINX)
15640133502eSMatthias Fuchs
15650133502eSMatthias Fuchs		CONFIG_FPGA_<family>
15660133502eSMatthias Fuchs
15670133502eSMatthias Fuchs		Enables support for FPGA family.
15680133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
15690133502eSMatthias Fuchs
15700133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
1571c609719bSwdenk
1572c609719bSwdenk		Specify the number of FPGA devices to support.
1573c609719bSwdenk
15746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
1575c609719bSwdenk
1576c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1577c609719bSwdenk
15786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
1579c609719bSwdenk
1580c609719bSwdenk		Enable checks on FPGA configuration interface busy
1581c609719bSwdenk		status by the configuration function. This option
1582c609719bSwdenk		will require a board or device specific function to
1583c609719bSwdenk		be written.
1584c609719bSwdenk
1585c609719bSwdenk		CONFIG_FPGA_DELAY
1586c609719bSwdenk
1587c609719bSwdenk		If defined, a function that provides delays in the FPGA
1588c609719bSwdenk		configuration driver.
1589c609719bSwdenk
15906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
1591c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1592c609719bSwdenk
15936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
1594c609719bSwdenk
1595c609719bSwdenk		Check for configuration errors during FPGA bitfile
1596c609719bSwdenk		loading. For example, abort during Virtex II
1597c609719bSwdenk		configuration if the INIT_B line goes low (which
1598c609719bSwdenk		indicated a CRC error).
1599c609719bSwdenk
16006d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
1601c609719bSwdenk
1602c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1603c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1604c609719bSwdenk		FPGA configuration sequence. The default time is 500
160511ccc33fSMarcel Ziswiler		ms.
1606c609719bSwdenk
16076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
1608c609719bSwdenk
1609c609719bSwdenk		Maximum time to wait for BUSY to deassert during
161011ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
1611c609719bSwdenk
16126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
1613c609719bSwdenk
1614c609719bSwdenk		Time to wait after FPGA configuration. The default is
161511ccc33fSMarcel Ziswiler		200 ms.
1616c609719bSwdenk
1617c609719bSwdenk- Configuration Management:
1618c609719bSwdenk		CONFIG_IDENT_STRING
1619c609719bSwdenk
1620c609719bSwdenk		If defined, this string will be added to the U-Boot
1621c609719bSwdenk		version information (U_BOOT_VERSION)
1622c609719bSwdenk
1623c609719bSwdenk- Vendor Parameter Protection:
1624c609719bSwdenk
1625c609719bSwdenk		U-Boot considers the values of the environment
1626c609719bSwdenk		variables "serial#" (Board Serial Number) and
16277152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1628c609719bSwdenk		are set once by the board vendor / manufacturer, and
1629c609719bSwdenk		protects these variables from casual modification by
1630c609719bSwdenk		the user. Once set, these variables are read-only,
1631c609719bSwdenk		and write or delete attempts are rejected. You can
163211ccc33fSMarcel Ziswiler		change this behaviour:
1633c609719bSwdenk
1634c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1635c609719bSwdenk		file, the write protection for vendor parameters is
163647cd00faSwdenk		completely disabled. Anybody can change or delete
1637c609719bSwdenk		these parameters.
1638c609719bSwdenk
1639c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1640c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
164111ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
1642c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1643c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1644c609719bSwdenk		read-only.]
1645c609719bSwdenk
1646c609719bSwdenk- Protected RAM:
1647c609719bSwdenk		CONFIG_PRAM
1648c609719bSwdenk
1649c609719bSwdenk		Define this variable to enable the reservation of
1650c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1651c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1652c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1653c609719bSwdenk		this default value by defining an environment
1654c609719bSwdenk		variable "pram" to the number of kB you want to
1655c609719bSwdenk		reserve. Note that the board info structure will
1656c609719bSwdenk		still show the full amount of RAM. If pRAM is
1657c609719bSwdenk		reserved, a new environment variable "mem" will
1658c609719bSwdenk		automatically be defined to hold the amount of
1659c609719bSwdenk		remaining RAM in a form that can be passed as boot
1660c609719bSwdenk		argument to Linux, for instance like that:
1661c609719bSwdenk
1662fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1663c609719bSwdenk			saveenv
1664c609719bSwdenk
1665c609719bSwdenk		This way you can tell Linux not to use this memory,
1666c609719bSwdenk		either, which results in a memory region that will
1667c609719bSwdenk		not be affected by reboots.
1668c609719bSwdenk
1669c609719bSwdenk		*WARNING* If your board configuration uses automatic
1670c609719bSwdenk		detection of the RAM size, you must make sure that
1671c609719bSwdenk		this memory test is non-destructive. So far, the
1672c609719bSwdenk		following board configurations are known to be
1673c609719bSwdenk		"pRAM-clean":
1674c609719bSwdenk
1675c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1676c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1677c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1678c609719bSwdenk
1679c609719bSwdenk- Error Recovery:
1680c609719bSwdenk		CONFIG_PANIC_HANG
1681c609719bSwdenk
1682c609719bSwdenk		Define this variable to stop the system in case of a
1683c609719bSwdenk		fatal error, so that you have to reset it manually.
1684c609719bSwdenk		This is probably NOT a good idea for an embedded
168511ccc33fSMarcel Ziswiler		system where you want the system to reboot
1686c609719bSwdenk		automatically as fast as possible, but it may be
1687c609719bSwdenk		useful during development since you can try to debug
1688c609719bSwdenk		the conditions that lead to the situation.
1689c609719bSwdenk
1690c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1691c609719bSwdenk
1692c609719bSwdenk		This variable defines the number of retries for
1693c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1694c609719bSwdenk		before giving up the operation. If not defined, a
1695c609719bSwdenk		default value of 5 is used.
1696c609719bSwdenk
169740cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
169840cb90eeSGuennadi Liakhovetski
169940cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
170040cb90eeSGuennadi Liakhovetski
1701c609719bSwdenk- Command Interpreter:
17028078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
170304a85b3bSwdenk
170404a85b3bSwdenk		Enable auto completion of commands using TAB.
170504a85b3bSwdenk
17068078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
17078078f1a5SWolfgang Denk		for the "hush" shell.
17088078f1a5SWolfgang Denk
17098078f1a5SWolfgang Denk
17106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_HUSH_PARSER
1711c609719bSwdenk
1712c609719bSwdenk		Define this variable to enable the "hush" shell (from
1713c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1714c609719bSwdenk		powerful command line syntax like
1715c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1716c609719bSwdenk		constructs ("shell scripts").
1717c609719bSwdenk
1718c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1719c609719bSwdenk		with a somewhat smaller memory footprint.
1720c609719bSwdenk
1721c609719bSwdenk
17226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
1723c609719bSwdenk
1724c609719bSwdenk		This defines the secondary prompt string, which is
1725c609719bSwdenk		printed when the command interpreter needs more input
1726c609719bSwdenk		to complete a command. Usually "> ".
1727c609719bSwdenk
1728c609719bSwdenk	Note:
1729c609719bSwdenk
1730c609719bSwdenk		In the current implementation, the local variables
1731c609719bSwdenk		space and global environment variables space are
1732c609719bSwdenk		separated. Local variables are those you define by
17333b57fe0aSwdenk		simply typing `name=value'. To access a local
1734c609719bSwdenk		variable later on, you have write `$name' or
17353b57fe0aSwdenk		`${name}'; to execute the contents of a variable
17363b57fe0aSwdenk		directly type `$name' at the command prompt.
1737c609719bSwdenk
1738c609719bSwdenk		Global environment variables are those you use
1739c609719bSwdenk		setenv/printenv to work with. To run a command stored
1740c609719bSwdenk		in such a variable, you need to use the run command,
1741c609719bSwdenk		and you must not use the '$' sign to access them.
1742c609719bSwdenk
1743c609719bSwdenk		To store commands and special characters in a
1744c609719bSwdenk		variable, please use double quotation marks
1745c609719bSwdenk		surrounding the whole text of the variable, instead
1746c609719bSwdenk		of the backslashes before semicolons and special
1747c609719bSwdenk		symbols.
1748c609719bSwdenk
1749aa0c71acSWolfgang Denk- Commandline Editing and History:
1750aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1751aa0c71acSWolfgang Denk
175211ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
1753aa0c71acSWolfgang Denk		commandline input operations
1754aa0c71acSWolfgang Denk
1755a8c7c708Swdenk- Default Environment:
1756c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1757c609719bSwdenk
1758c609719bSwdenk		Define this to contain any number of null terminated
1759c609719bSwdenk		strings (variable = value pairs) that will be part of
17607152b1d0Swdenk		the default environment compiled into the boot image.
17612262cfeeSwdenk
1762c609719bSwdenk		For example, place something like this in your
1763c609719bSwdenk		board's config file:
1764c609719bSwdenk
1765c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1766c609719bSwdenk			"myvar1=value1\0" \
1767c609719bSwdenk			"myvar2=value2\0"
1768c609719bSwdenk
1769c609719bSwdenk		Warning: This method is based on knowledge about the
1770c609719bSwdenk		internal format how the environment is stored by the
17712262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1772c609719bSwdenk		interface! Although it is unlikely that this format
17737152b1d0Swdenk		will change soon, there is no guarantee either.
1774c609719bSwdenk		You better know what you are doing here.
1775c609719bSwdenk
1776c609719bSwdenk		Note: overly (ab)use of the default environment is
1777c609719bSwdenk		discouraged. Make sure to check other ways to preset
1778c609719bSwdenk		the environment like the autoscript function or the
1779c609719bSwdenk		boot command first.
1780c609719bSwdenk
1781a8c7c708Swdenk- DataFlash Support:
17822abbe075Swdenk		CONFIG_HAS_DATAFLASH
17832abbe075Swdenk
17842abbe075Swdenk		Defining this option enables DataFlash features and
17852abbe075Swdenk		allows to read/write in Dataflash via the standard
17862abbe075Swdenk		commands cp, md...
17872abbe075Swdenk
17883f85ce27Swdenk- SystemACE Support:
17893f85ce27Swdenk		CONFIG_SYSTEMACE
17903f85ce27Swdenk
17913f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
17923f85ce27Swdenk		chips attached via some sort of local bus. The address
179311ccc33fSMarcel Ziswiler		of the chip must also be defined in the
17946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
17953f85ce27Swdenk
17963f85ce27Swdenk		#define CONFIG_SYSTEMACE
17976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
17983f85ce27Swdenk
17993f85ce27Swdenk		When SystemACE support is added, the "ace" device type
18003f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
18013f85ce27Swdenk
1802ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1803ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1804ecb0ccd9SWolfgang Denk
180528cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1806ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
180728cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1808ecb0ccd9SWolfgang Denk		number generator is used.
1809ecb0ccd9SWolfgang Denk
181028cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
181128cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
181228cb9375SWolfgang Denk		defined, the normal port 69 is used.
181328cb9375SWolfgang Denk
181428cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1815ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1816ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1817ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1818ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1819ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1820ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1821ecb0ccd9SWolfgang Denk
1822a8c7c708Swdenk- Show boot progress:
1823c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1824c609719bSwdenk
1825c609719bSwdenk		Defining this option allows to add some board-
1826c609719bSwdenk		specific code (calling a user-provided function
1827c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1828c609719bSwdenk		the system's boot progress on some display (for
1829c609719bSwdenk		example, some LED's) on your board. At the moment,
1830c609719bSwdenk		the following checkpoints are implemented:
1831c609719bSwdenk
18324bae9090SBartlomiej Sieka- Automatic software updates via TFTP server
18334bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP
18344bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_CNT_MAX
18354bae9090SBartlomiej Sieka		CONFIG_UPDATE_TFTP_MSEC_MAX
18364bae9090SBartlomiej Sieka
18374bae9090SBartlomiej Sieka		These options enable and control the auto-update feature;
18384bae9090SBartlomiej Sieka		for a more detailed description refer to doc/README.update.
18394bae9090SBartlomiej Sieka
18401372cce2SMarian BalakowiczLegacy uImage format:
18411372cce2SMarian Balakowicz
1842c609719bSwdenk  Arg	Where			When
1843c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1844c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1845c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1846c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1847c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1848c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1849c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1850c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1851c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
18521372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
1853c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1854c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1855c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1856c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
18571372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
1858c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
18591372cce2SMarian Balakowicz
18601372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
18611372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
18621372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
18631372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
18641372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
18651372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
18661372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
186711ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
18681372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
18691372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
18701372cce2SMarian Balakowicz
18711372cce2SMarian Balakowicz   15	lib_<arch>/bootm.c	All preparation done, transferring control to OS
1872c609719bSwdenk
187363e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
187463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
187563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
187663e73c9aSwdenk
1877566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
1878566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
1879566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
1880566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
1881566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
1882566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
1883566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
1884566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
1885566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
1886566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
1887566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
1888566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
1889566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
1890566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
1891566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
1892566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
1893566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
1894566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
1895566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
1896566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
1897566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
1898566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
1899566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
1900566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
1901566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
1902566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
1903566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
1904566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
1905566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
1906566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
1907566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
1908566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
1909566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
1910566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
1911566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
1912566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
1913566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
1914566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
1915566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
1916566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
1917566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
1918566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
1919566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
1920566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
1921566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
1922566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
1923566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
1924c609719bSwdenk
1925566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
1926c609719bSwdenk
1927566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
1928566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
1929566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
1930206c60cbSwdenk
1931566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
1932566a494fSHeiko Schocher   80	common/cmd_net.c	before calling NetLoop()
193311ccc33fSMarcel Ziswiler  -81	common/cmd_net.c	some error in NetLoop() occurred
1934566a494fSHeiko Schocher   81	common/cmd_net.c	NetLoop() back without error
1935566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
1936566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
1937566a494fSHeiko Schocher   83	common/cmd_net.c	running autoscript
1938566a494fSHeiko Schocher  -83	common/cmd_net.c	some error in automatic boot or autoscript
1939566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
1940c609719bSwdenk
19411372cce2SMarian BalakowiczFIT uImage format:
19421372cce2SMarian Balakowicz
19431372cce2SMarian Balakowicz  Arg	Where			When
19441372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
19451372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
19461372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
19471372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
19481372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
19491372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
1950f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
19511372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
19521372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
19531372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
19541372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
19551372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
195611ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
195711ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
19581372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
19591372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
19601372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
19611372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
19621372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
19631372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
19641372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
19651372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
19661372cce2SMarian Balakowicz
19671372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
19681372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
19691372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
197011ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
19711372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
19721372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
19731372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
19741372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
19751372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
19761372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
19771372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
19781372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
19791372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
19801372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
19811372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
19821372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
19831372cce2SMarian Balakowicz
198411ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
19851372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
19861372cce2SMarian Balakowicz
198711ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
19881372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
19891372cce2SMarian Balakowicz
199011ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
19911372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
19921372cce2SMarian Balakowicz
19931372cce2SMarian Balakowicz
1994c609719bSwdenkModem Support:
1995c609719bSwdenk--------------
1996c609719bSwdenk
199785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1998c609719bSwdenk
199911ccc33fSMarcel Ziswiler- Modem support enable:
2000c609719bSwdenk		CONFIG_MODEM_SUPPORT
2001c609719bSwdenk
2002c609719bSwdenk- RTS/CTS Flow control enable:
2003c609719bSwdenk		CONFIG_HWFLOW
2004c609719bSwdenk
2005c609719bSwdenk- Modem debug support:
2006c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
2007c609719bSwdenk
2008c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
2009c609719bSwdenk		for modem support. Useful only with BDI2000.
2010c609719bSwdenk
2011a8c7c708Swdenk- Interrupt support (PPC):
2012a8c7c708Swdenk
2013a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
2014a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
201511ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
2016a8c7c708Swdenk		should set decrementer_count to appropriate value. If
201711ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
2018a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
201911ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
2020a8c7c708Swdenk		specific handling. If board has watchdog / status_led
2021a8c7c708Swdenk		/ other_activity_monitor it works automatically from
2022a8c7c708Swdenk		general timer_interrupt().
2023a8c7c708Swdenk
2024c609719bSwdenk- General:
2025c609719bSwdenk
2026c609719bSwdenk		In the target system modem support is enabled when a
2027c609719bSwdenk		specific key (key combination) is pressed during
2028c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
202911ccc33fSMarcel Ziswiler		(autoboot). The key_pressed() function is called from
2030c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
2031c609719bSwdenk		function, returning 1 and thus enabling modem
2032c609719bSwdenk		initialization.
2033c609719bSwdenk
2034c609719bSwdenk		If there are no modem init strings in the
2035c609719bSwdenk		environment, U-Boot proceed to autoboot; the
2036c609719bSwdenk		previous output (banner, info printfs) will be
203711ccc33fSMarcel Ziswiler		suppressed, though.
2038c609719bSwdenk
2039c609719bSwdenk		See also: doc/README.Modem
2040c609719bSwdenk
2041c609719bSwdenk
2042c609719bSwdenkConfiguration Settings:
2043c609719bSwdenk-----------------------
2044c609719bSwdenk
20456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
2046c609719bSwdenk		undefine this when you're short of memory.
2047c609719bSwdenk
2048*2fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
2049*2fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
2050*2fb2604dSPeter Tyser
20516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
2052c609719bSwdenk		prompt for user input.
2053c609719bSwdenk
20546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
2055c609719bSwdenk
20566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
2057c609719bSwdenk
20586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
2059c609719bSwdenk
20606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
2061c609719bSwdenk		the application (usually a Linux kernel) when it is
2062c609719bSwdenk		booted
2063c609719bSwdenk
20646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
2065c609719bSwdenk		List of legal baudrate settings for this board.
2066c609719bSwdenk
20676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_INFO_QUIET
2068c609719bSwdenk		Suppress display of console information at boot.
2069c609719bSwdenk
20706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_IS_IN_ENV
2071c609719bSwdenk		If the board specific function
2072c609719bSwdenk			extern int overwrite_console (void);
2073c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
2074c609719bSwdenk		serial port, else the settings in the environment are used.
2075c609719bSwdenk
20766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
2077c609719bSwdenk		Enable the call to overwrite_console().
2078c609719bSwdenk
20796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
2080c609719bSwdenk		Enable overwrite of previous console environment settings.
2081c609719bSwdenk
20826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
2083c609719bSwdenk		Begin and End addresses of the area used by the
2084c609719bSwdenk		simple memory test.
2085c609719bSwdenk
20866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
2087c609719bSwdenk		Enable an alternate, more extensive memory test.
2088c609719bSwdenk
20896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
20905f535fe1Swdenk		Scratch address used by the alternate memory test
20915f535fe1Swdenk		You only need to set this if address zero isn't writeable
20925f535fe1Swdenk
20936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEM_TOP_HIDE (PPC only):
20946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
209514f73ca6SStefan Roese		this specified memory area will get subtracted from the top
209611ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
209714f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
209814f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
209914f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
21005e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
210114f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
21025e12e75dSStefan Roese		will have to get fixed in Linux additionally.
210314f73ca6SStefan Roese
210414f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
210514f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
210614f73ca6SStefan Roese		be touched.
210714f73ca6SStefan Roese
210814f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
210914f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
211014f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
211114f73ca6SStefan Roese		non page size aligned address and this could cause major
211214f73ca6SStefan Roese		problems.
211314f73ca6SStefan Roese
21146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TFTP_LOADADDR:
2115c609719bSwdenk		Default load address for network file downloads
2116c609719bSwdenk
21176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
2118c609719bSwdenk		Enable temporary baudrate change while serial download
2119c609719bSwdenk
21206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
2121c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
2122c609719bSwdenk
21236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MBIO_BASE:
2124c609719bSwdenk		Physical start address of Motherboard I/O (if using a
2125c609719bSwdenk		Cogent motherboard)
2126c609719bSwdenk
21276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
2128c609719bSwdenk		Physical start address of Flash memory.
2129c609719bSwdenk
21306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
2131c609719bSwdenk		Physical start address of boot monitor code (set by
2132c609719bSwdenk		make config files to be same as the text base address
2133c609719bSwdenk		(TEXT_BASE) used when linking) - same as
21346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
2135c609719bSwdenk
21366d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
21373b57fe0aSwdenk		Size of memory reserved for monitor code, used to
21383b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
21393b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
21403b57fe0aSwdenk		flash sector.
2141c609719bSwdenk
21426d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
2143c609719bSwdenk		Size of DRAM reserved for malloc() use.
2144c609719bSwdenk
21456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
214615940c9aSStefan Roese		Normally compressed uImages are limited to an
214715940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
21486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
214915940c9aSStefan Roese		to adjust this setting to your needs.
2150c609719bSwdenk
21516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
2152c609719bSwdenk		Maximum size of memory mapped by the startup code of
2153c609719bSwdenk		the Linux kernel; all data that must be processed by
21547d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
21557d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
21567d721e34SBartlomiej Sieka		enviroment variable is defined and non-zero. In such case
21577d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
21586d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.
2159c609719bSwdenk
21606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
2161c609719bSwdenk		Max number of Flash memory banks
2162c609719bSwdenk
21636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
2164c609719bSwdenk		Max number of sectors on a Flash chip
2165c609719bSwdenk
21666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
2167c609719bSwdenk		Timeout for Flash erase operations (in ms)
2168c609719bSwdenk
21696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
2170c609719bSwdenk		Timeout for Flash write operations (in ms)
2171c609719bSwdenk
21726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
21738564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
21748564acf9Swdenk
21756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
21768564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
21778564acf9Swdenk
21786d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
21798564acf9Swdenk		If defined, hardware flash sectors protection is used
21808564acf9Swdenk		instead of U-Boot software protection.
21818564acf9Swdenk
21826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
2183c609719bSwdenk
2184c609719bSwdenk		Enable TFTP transfers directly to flash memory;
2185c609719bSwdenk		without this option such a download has to be
2186c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
2187c609719bSwdenk		copy from RAM to flash.
2188c609719bSwdenk
2189c609719bSwdenk		The two-step approach is usually more reliable, since
2190c609719bSwdenk		you can check if the download worked before you erase
219111ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
219211ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
2193c609719bSwdenk		downloaded image) this option may be very useful.
2194c609719bSwdenk
21956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
2196c609719bSwdenk		Define if the flash driver uses extra elements in the
21975653fc33Swdenk		common flash structure for storing flash geometry.
21985653fc33Swdenk
219900b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
22005653fc33Swdenk		This option also enables the building of the cfi_flash driver
22015653fc33Swdenk		in the drivers directory
220253cf9435Sstroese
220391809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
220491809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
220591809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
220691809ed5SPiotr Ziecik		to the MTD layer.
220791809ed5SPiotr Ziecik
22086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
220996ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
221096ef831fSGuennadi Liakhovetski
221196ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
221296ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
221396ef831fSGuennadi Liakhovetski		write commands.
221496ef831fSGuennadi Liakhovetski
22156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
22165568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
22175568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
22185568e613SStefan Roese		is useful, if some of the configured banks are only
22195568e613SStefan Roese		optionally available.
22205568e613SStefan Roese
22219a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
22229a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
22239a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
22249a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
22259a042e9cSJerry Van Baren
22266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
222711ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
222811ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
222953cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
223053cf9435Sstroese		buffers can be full shortly after enabling the interface
223111ccc33fSMarcel Ziswiler		on high Ethernet traffic.
223253cf9435Sstroese		Defaults to 4 if not defined.
2233c609719bSwdenk
2234c609719bSwdenkThe following definitions that deal with the placement and management
2235c609719bSwdenkof environment data (variable area); in general, we support the
2236c609719bSwdenkfollowing configurations:
2237c609719bSwdenk
22385a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
2239c609719bSwdenk
2240c609719bSwdenk	Define this if the environment is in flash memory.
2241c609719bSwdenk
2242c609719bSwdenk	a) The environment occupies one whole flash sector, which is
2243c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
2244c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
2245c609719bSwdenk	   sector" type flash chips, which have several smaller
2246c609719bSwdenk	   sectors at the start or the end. For instance, such a
2247c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2248c609719bSwdenk	   such a case you would place the environment in one of the
2249c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2250c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2251c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2252c609719bSwdenk	   between U-Boot and the environment.
2253c609719bSwdenk
22540e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
2255c609719bSwdenk
2256c609719bSwdenk	   Offset of environment data (variable area) to the
2257c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2258c609719bSwdenk	   type flash chips the second sector can be used: the offset
2259c609719bSwdenk	   for this sector is given here.
2260c609719bSwdenk
22616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
2262c609719bSwdenk
22630e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
2264c609719bSwdenk
2265c609719bSwdenk	   This is just another way to specify the start address of
2266c609719bSwdenk	   the flash sector containing the environment (instead of
22670e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
2268c609719bSwdenk
22690e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
2270c609719bSwdenk
2271c609719bSwdenk	   Size of the sector containing the environment.
2272c609719bSwdenk
2273c609719bSwdenk
2274c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2275c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2276c609719bSwdenk	   the environment.
2277c609719bSwdenk
22780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2279c609719bSwdenk
22805a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
22810e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
2282c609719bSwdenk	   of this flash sector for the environment. This saves
2283c609719bSwdenk	   memory for the RAM copy of the environment.
2284c609719bSwdenk
2285c609719bSwdenk	   It may also save flash memory if you decide to use this
2286c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2287c609719bSwdenk	   since then the remainder of the flash sector could be used
2288c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2289c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2290c609719bSwdenk	   updating the environment in flash makes it always
2291c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2292c609719bSwdenk	   wrong before the contents has been restored from a copy in
2293c609719bSwdenk	   RAM, your target system will be dead.
2294c609719bSwdenk
22950e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
22960e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
2297c609719bSwdenk
2298c609719bSwdenk	   These settings describe a second storage area used to hold
229911ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
23003e38691eSwdenk	   a valid backup copy in case there is a power failure during
2301c609719bSwdenk	   a "saveenv" operation.
2302c609719bSwdenk
2303c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2304c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2305c609719bSwdenkaccordingly!
2306c609719bSwdenk
2307c609719bSwdenk
23089314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
2309c609719bSwdenk
2310c609719bSwdenk	Define this if you have some non-volatile memory device
2311c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2312c609719bSwdenk	environment.
2313c609719bSwdenk
23140e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
23150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2316c609719bSwdenk
231711ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
2318c609719bSwdenk	  want to use for environment. It is assumed that this memory
2319c609719bSwdenk	  can just be read and written to, without any special
2320c609719bSwdenk	  provision.
2321c609719bSwdenk
2322c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2323c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
232411ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
2325c609719bSwdenkU-Boot will hang.
2326c609719bSwdenk
2327c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2328c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2329c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2330c609719bSwdenkto save the current settings.
2331c609719bSwdenk
2332c609719bSwdenk
2333bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
2334c609719bSwdenk
2335c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2336c609719bSwdenk	device and a driver for it.
2337c609719bSwdenk
23380e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
23390e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
2340c609719bSwdenk
2341c609719bSwdenk	  These two #defines specify the offset and size of the
2342c609719bSwdenk	  environment area within the total memory of your EEPROM.
2343c609719bSwdenk
23446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
2345c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2346c609719bSwdenk	  The default address is zero.
2347c609719bSwdenk
23486d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
2349c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2350c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2351c609719bSwdenk	  would require six bits.
2352c609719bSwdenk
23536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
2354c609719bSwdenk	  If defined, the number of milliseconds to delay between
2355c609719bSwdenk	  page writes.	The default is zero milliseconds.
2356c609719bSwdenk
23576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
2358c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2359c609719bSwdenk	  that this is NOT the chip address length!
2360c609719bSwdenk
23616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
23625cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
23635cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
23645cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
23655cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
23665cf91d6bSwdenk	  byte chips.
23675cf91d6bSwdenk
23685cf91d6bSwdenk	  Note that we consider the length of the address field to
23695cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
23705cf91d6bSwdenk	  in the chip address.
23715cf91d6bSwdenk
23726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
2373c609719bSwdenk	  The size in bytes of the EEPROM device.
2374c609719bSwdenk
2375c609719bSwdenk
2376057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
23775779d8d9Swdenk
23785779d8d9Swdenk	Define this if you have a DataFlash memory device which you
23795779d8d9Swdenk	want to use for the environment.
23805779d8d9Swdenk
23810e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
23820e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
23830e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
23845779d8d9Swdenk
23855779d8d9Swdenk	  These three #defines specify the offset and size of the
23865779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
23875779d8d9Swdenk	  at the specified address.
23885779d8d9Swdenk
238951bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
239013a5695bSwdenk
239113a5695bSwdenk	Define this if you have a NAND device which you want to use
239213a5695bSwdenk	for the environment.
239313a5695bSwdenk
23940e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
23950e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
239613a5695bSwdenk
239713a5695bSwdenk	  These two #defines specify the offset and size of the environment
239813a5695bSwdenk	  area within the first NAND device.
23995779d8d9Swdenk
24000e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET_REDUND
2401e443c944SMarkus Klotzbuecher
24020e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
2403e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2404e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2405e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2406e443c944SMarkus Klotzbuecher
24070e8d1586SJean-Christophe PLAGNIOL-VILLARD	Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
24080e8d1586SJean-Christophe PLAGNIOL-VILLARD	to a block boundary, and CONFIG_ENV_SIZE must be a multiple of
2409e443c944SMarkus Klotzbuecher	the NAND devices block size.
2410e443c944SMarkus Klotzbuecher
24116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
2412c609719bSwdenk
2413c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2414c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2415c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2416c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2417c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2418c609719bSwdenk	to be a good choice since it makes it far enough from the
2419c609719bSwdenk	start of the data area as well as from the stack pointer.
2420c609719bSwdenk
2421e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
2422c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2423c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2424c609719bSwdenkuntil then to read environment variables.
2425c609719bSwdenk
242685ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
242785ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
242885ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
242985ec0bccSwdenknecessary, because the first environment variable we need is the
243085ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
243185ec0bccSwdenkhave any device yet where we could complain.]
2432c609719bSwdenk
2433c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2434c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
243585ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2436c609719bSwdenk
24376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
2438fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2439fc3e2165Swdenk
24406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
2441fc3e2165Swdenk		      also needs to be defined.
2442fc3e2165Swdenk
24436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
2444fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2445c609719bSwdenk
24466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_VSPRINTF:
2447c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2448c40b2956Swdenk		of 64bit values by using the L quantifier
2449c40b2956Swdenk
24506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_64BIT_STRTOUL:
2451c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2452c40b2956Swdenk
2453c609719bSwdenkLow Level (hardware related) configuration options:
2454dc7c9a1aSwdenk---------------------------------------------------
2455c609719bSwdenk
24566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
2457c609719bSwdenk		Cache Line Size of the CPU.
2458c609719bSwdenk
24596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
2460c609719bSwdenk		Default address of the IMMR after system reset.
24612535d602Swdenk
24622535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
24632535d602Swdenk		and RPXsuper) to be able to adjust the position of
24642535d602Swdenk		the IMMR register after a reset.
2465c609719bSwdenk
24667f6c2cbcSwdenk- Floppy Disk Support:
24676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
24687f6c2cbcSwdenk
24697f6c2cbcSwdenk		the default drive number (default value 0)
24707f6c2cbcSwdenk
24716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
24727f6c2cbcSwdenk
247311ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
24747f6c2cbcSwdenk		(default value 1)
24757f6c2cbcSwdenk
24766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
24777f6c2cbcSwdenk
24787f6c2cbcSwdenk		defines the offset of register from address. It
24797f6c2cbcSwdenk		depends on which part of the data bus is connected to
248011ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
24817f6c2cbcSwdenk
24826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
24836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
24847f6c2cbcSwdenk		default value.
24857f6c2cbcSwdenk
24866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
24877f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
24887f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
24897f6c2cbcSwdenk		source code. It is used to make hardware dependant
24907f6c2cbcSwdenk		initializations.
24917f6c2cbcSwdenk
24926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
249325d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
249425d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2495c609719bSwdenk
24966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
2497c609719bSwdenk
24987152b1d0Swdenk		Start address of memory area that can be used for
2499c609719bSwdenk		initial data and stack; please note that this must be
2500c609719bSwdenk		writable memory that is working WITHOUT special
2501c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2502c609719bSwdenk		will become available only after programming the
2503c609719bSwdenk		memory controller and running certain initialization
2504c609719bSwdenk		sequences.
2505c609719bSwdenk
2506c609719bSwdenk		U-Boot uses the following memory types:
2507c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2508c609719bSwdenk		- MPC824X: data cache
2509c609719bSwdenk		- PPC4xx:  data cache
2510c609719bSwdenk
25116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
2512c609719bSwdenk
2513c609719bSwdenk		Offset of the initial data structure in the memory
25146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
25156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
2516c609719bSwdenk		data is located at the end of the available space
25176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		(sometimes written as (CONFIG_SYS_INIT_RAM_END -
25186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
25196d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
25206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
2521c609719bSwdenk
2522c609719bSwdenk	Note:
2523c609719bSwdenk		On the MPC824X (or other systems that use the data
2524c609719bSwdenk		cache for initial memory) the address chosen for
25256d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
2526c609719bSwdenk		point to an otherwise UNUSED address space between
2527c609719bSwdenk		the top of RAM and the start of the PCI space.
2528c609719bSwdenk
25296d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
2530c609719bSwdenk
25316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
2532c609719bSwdenk
25336d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
2534c609719bSwdenk
25356d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
2536c609719bSwdenk
25376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2538c609719bSwdenk
25396d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
2540c609719bSwdenk
25416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
2542c609719bSwdenk		SDRAM timing
2543c609719bSwdenk
25446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
2545c609719bSwdenk		periodic timer for refresh
2546c609719bSwdenk
25476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
2548c609719bSwdenk
25496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
25506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
25516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
25526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
2553c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2554c609719bSwdenk
2555c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
25566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
25576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
2558c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2559c609719bSwdenk
25606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
25616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
2562c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2563c609719bSwdenk		Prescaler definitions (SDRAM timing)
2564c609719bSwdenk
25656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
2566c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2567c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2568c609719bSwdenk
25696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
2570b423d055SHeiko Schocher		enable SMC microcode relocation patch (MPC8xx);
2571b423d055SHeiko Schocher		define relocation offset in DPRAM [SMC1]
2572b423d055SHeiko Schocher
25736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
2574c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2575c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2576c609719bSwdenk
25776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_USE_OSCCLK:
2578c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2579c609719bSwdenk		wrong setting might damage your board. Read
2580c609719bSwdenk		doc/README.MBX before setting this variable!
2581c609719bSwdenk
25826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2583ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2584ea909b76Swdenk		(Power On Self Tests). This definition overrides
2585ea909b76Swdenk		#define'd default value in commproc.h resp.
2586ea909b76Swdenk		cpm_8260.h.
2587ea909b76Swdenk
25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
25896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
25906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
25926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
25936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
25946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
25956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
25965d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
25975d232d0eSwdenk
2598bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2599218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
2600218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
2601218ca724SWolfgang Denk
2602bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2603bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2604bb99ad6dSBen Warren
26056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
2606218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
2607218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
2608218ca724SWolfgang Denk		to something your driver can deal with.
2609bb99ad6dSBen Warren
26106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2611218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2612218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
26132ad6b513STimur Tabi
26146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
2615218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
2616218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
26172ad6b513STimur Tabi
2618c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2619c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2620c26e454dSwdenk
2621c26e454dSwdenk- CONFIG_FEC[12]_PHY
2622c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
26236e592385Swdenk		to the given FEC; i. e.
2624c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2625c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2626c26e454dSwdenk
2627c26e454dSwdenk		When set to -1, means to probe for first available.
2628c26e454dSwdenk
2629c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2630c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2631c26e454dSwdenk		(so program the FEC to ignore it).
2632c26e454dSwdenk
2633c26e454dSwdenk- CONFIG_RMII
2634c26e454dSwdenk		Enable RMII mode for all FECs.
2635c26e454dSwdenk		Note that this is a global option, we can't
2636c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2637c26e454dSwdenk
26385cf91d6bSwdenk- CONFIG_CRC32_VERIFY
26395cf91d6bSwdenk		Add a verify option to the crc32 command.
26405cf91d6bSwdenk		The syntax is:
26415cf91d6bSwdenk
26425cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
26435cf91d6bSwdenk
26445cf91d6bSwdenk		Where address/count indicate a memory area
26455cf91d6bSwdenk		and crc32 is the correct crc32 which the
26465cf91d6bSwdenk		area should have.
26475cf91d6bSwdenk
264856523f12Swdenk- CONFIG_LOOPW
264956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
2650602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
265156523f12Swdenk
26527b466641Sstroese- CONFIG_MX_CYCLIC
26537b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
26547b466641Sstroese		"md/mw" commands.
26557b466641Sstroese		Examples:
26567b466641Sstroese
26577b466641Sstroese		=> mdc.b 10 4 500
26587b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
26597b466641Sstroese
26607b466641Sstroese		=> mwc.l 100 12345678 10
26617b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
26627b466641Sstroese
26637b466641Sstroese		This only takes effect if the memory commands are activated
2664602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
26657b466641Sstroese
26668aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
26678aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
26688aa1a2d1Swdenk
26698aa1a2d1Swdenk		[ARM only] If these variables are defined, then
26708aa1a2d1Swdenk		certain low level initializations (like setting up
26718aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
26728aa1a2d1Swdenk		not relocate itself into RAM.
26738aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
26748aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
26758aa1a2d1Swdenk		some other boot loader or by a debugger which
267611ccc33fSMarcel Ziswiler		performs these initializations itself.
26778aa1a2d1Swdenk
2678400558b5Swdenk
2679c609719bSwdenkBuilding the Software:
2680c609719bSwdenk======================
2681c609719bSwdenk
2682218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
2683218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
2684218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
2685218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
2686218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
2687218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
2688c609719bSwdenk
2689218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
2690218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
2691218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
2692218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
2693218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
2694c609719bSwdenk
2695218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
2696218ca724SWolfgang Denk	$ export CROSS_COMPILE
2697c609719bSwdenk
2698c609719bSwdenkU-Boot is intended to be simple to build. After installing the
2699c609719bSwdenksources you must configure U-Boot for one specific board type. This
2700c609719bSwdenkis done by typing:
2701c609719bSwdenk
2702c609719bSwdenk	make NAME_config
2703c609719bSwdenk
2704218ca724SWolfgang Denkwhere "NAME_config" is the name of one of the existing configu-
2705218ca724SWolfgang Denkrations; see the main Makefile for supported names.
270654387ac9Swdenk
2707c609719bSwdenkNote: for some board special configuration names may exist; check if
2708c609719bSwdenk      additional information is available from the board vendor; for
27092729af9dSwdenk      instance, the TQM823L systems are available without (standard)
27102729af9dSwdenk      or with LCD support. You can select such additional "features"
271111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
2712c609719bSwdenk
27132729af9dSwdenk      make TQM823L_config
27142729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2715c609719bSwdenk
2716c609719bSwdenk      make TQM823L_LCD_config
2717c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2718c609719bSwdenk
2719c609719bSwdenk      etc.
2720c609719bSwdenk
2721c609719bSwdenk
2722c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
27237152b1d0Swdenkimages ready for download to / installation on your system:
2724c609719bSwdenk
2725c609719bSwdenk- "u-boot.bin" is a raw binary image
2726c609719bSwdenk- "u-boot" is an image in ELF binary format
2727c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2728c609719bSwdenk
2729baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2730baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2731baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2732baf31249SMarian Balakowicz
2733baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2734baf31249SMarian Balakowicz
2735baf31249SMarian Balakowicz	make O=/tmp/build distclean
2736baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2737baf31249SMarian Balakowicz	make O=/tmp/build all
2738baf31249SMarian Balakowicz
2739baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2740baf31249SMarian Balakowicz
2741baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2742baf31249SMarian Balakowicz	make distclean
2743baf31249SMarian Balakowicz	make NAME_config
2744baf31249SMarian Balakowicz	make all
2745baf31249SMarian Balakowicz
2746baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2747baf31249SMarian Balakowiczvariable.
2748baf31249SMarian Balakowicz
2749c609719bSwdenk
2750c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2751c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2752c609719bSwdenknative "make".
2753c609719bSwdenk
2754c609719bSwdenk
2755c609719bSwdenkIf the system board that you have is not listed, then you will need
2756c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2757c609719bSwdenksteps:
2758c609719bSwdenk
2759c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
276085ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
276185ec0bccSwdenk    entries as examples. Note that here and at many other places
27627152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
276385ec0bccSwdenk    keep this order.
2764c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
276585ec0bccSwdenk    files you need. In your board directory, you will need at least
276685ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
276785ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
276885ec0bccSwdenk    your board
2769c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2770c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
277185ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2772c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2773c609719bSwdenk    to be installed on your target system.
277485ec0bccSwdenk6.  Debug and solve any problems that might arise.
2775c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2776c609719bSwdenk
2777c609719bSwdenk
2778c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2779c609719bSwdenk==============================================================
2780c609719bSwdenk
2781c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
2782c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
2783c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2784c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2785218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
2786c609719bSwdenk
2787c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
2788c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
2789c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2790c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2791c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You can
27927152b1d0Swdenkselect which (cross) compiler to use by passing a `CROSS_COMPILE'
2793218ca724SWolfgang Denkenvironment variable to the script, i. e. to use the ELDK cross tools
2794218ca724SWolfgang Denkyou can type
2795c609719bSwdenk
2796c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2797c609719bSwdenk
2798c609719bSwdenkor to build on a native PowerPC system you can type
2799c609719bSwdenk
2800c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2801c609719bSwdenk
2802218ca724SWolfgang DenkWhen using the MAKEALL script, the default behaviour is to build
2803218ca724SWolfgang DenkU-Boot in the source directory. This location can be changed by
2804218ca724SWolfgang Denksetting the BUILD_DIR environment variable. Also, for each target
2805218ca724SWolfgang Denkbuilt, the MAKEALL script saves two log files (<target>.ERR and
2806218ca724SWolfgang Denk<target>.MAKEALL) in the <source dir>/LOG directory. This default
2807218ca724SWolfgang Denklocation can be changed by setting the MAKEALL_LOGDIR environment
2808218ca724SWolfgang Denkvariable. For example:
2809baf31249SMarian Balakowicz
2810baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2811baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2812baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2813baf31249SMarian Balakowicz
2814218ca724SWolfgang DenkWith the above settings build objects are saved in the /tmp/build,
2815218ca724SWolfgang Denklog files are saved in the /tmp/log and the source tree remains clean
2816218ca724SWolfgang Denkduring the whole build process.
2817baf31249SMarian Balakowicz
2818baf31249SMarian Balakowicz
2819c609719bSwdenkSee also "U-Boot Porting Guide" below.
2820c609719bSwdenk
2821c609719bSwdenk
2822c609719bSwdenkMonitor Commands - Overview:
2823c609719bSwdenk============================
2824c609719bSwdenk
2825c609719bSwdenkgo	- start application at address 'addr'
2826c609719bSwdenkrun	- run commands in an environment variable
2827c609719bSwdenkbootm	- boot application image from memory
2828c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2829c609719bSwdenktftpboot- boot image via network using TFTP protocol
2830c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2831c609719bSwdenk	       (and eventually "gatewayip")
2832c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2833c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2834c609719bSwdenkloads	- load S-Record file over serial line
2835c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2836c609719bSwdenkmd	- memory display
2837c609719bSwdenkmm	- memory modify (auto-incrementing)
2838c609719bSwdenknm	- memory modify (constant address)
2839c609719bSwdenkmw	- memory write (fill)
2840c609719bSwdenkcp	- memory copy
2841c609719bSwdenkcmp	- memory compare
2842c609719bSwdenkcrc32	- checksum calculation
2843c609719bSwdenkimd	- i2c memory display
2844c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2845c609719bSwdenkinm	- i2c memory modify (constant address)
2846c609719bSwdenkimw	- i2c memory write (fill)
2847c609719bSwdenkicrc32	- i2c checksum calculation
2848c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2849c609719bSwdenkiloop	- infinite loop on address range
2850c609719bSwdenkisdram	- print SDRAM configuration information
2851c609719bSwdenksspi	- SPI utility commands
2852c609719bSwdenkbase	- print or set address offset
2853c609719bSwdenkprintenv- print environment variables
2854c609719bSwdenksetenv	- set environment variables
2855c609719bSwdenksaveenv - save environment variables to persistent storage
2856c609719bSwdenkprotect - enable or disable FLASH write protection
2857c609719bSwdenkerase	- erase FLASH memory
2858c609719bSwdenkflinfo	- print FLASH memory information
2859c609719bSwdenkbdinfo	- print Board Info structure
2860c609719bSwdenkiminfo	- print header information for application image
2861c609719bSwdenkconinfo - print console devices and informations
2862c609719bSwdenkide	- IDE sub-system
2863c609719bSwdenkloop	- infinite loop on address range
286456523f12Swdenkloopw	- infinite write loop on address range
2865c609719bSwdenkmtest	- simple RAM test
2866c609719bSwdenkicache	- enable or disable instruction cache
2867c609719bSwdenkdcache	- enable or disable data cache
2868c609719bSwdenkreset	- Perform RESET of the CPU
2869c609719bSwdenkecho	- echo args to console
2870c609719bSwdenkversion - print monitor version
2871c609719bSwdenkhelp	- print online help
2872c609719bSwdenk?	- alias for 'help'
2873c609719bSwdenk
2874c609719bSwdenk
2875c609719bSwdenkMonitor Commands - Detailed Description:
2876c609719bSwdenk========================================
2877c609719bSwdenk
2878c609719bSwdenkTODO.
2879c609719bSwdenk
2880c609719bSwdenkFor now: just type "help <command>".
2881c609719bSwdenk
2882c609719bSwdenk
2883c609719bSwdenkEnvironment Variables:
2884c609719bSwdenk======================
2885c609719bSwdenk
2886c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2887c609719bSwdenkcan be made persistent by saving to Flash memory.
2888c609719bSwdenk
2889c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2890c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2891c609719bSwdenkwithout a value can be used to delete a variable from the
2892c609719bSwdenkenvironment. As long as you don't save the environment you are
2893c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2894c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2895c609719bSwdenk
2896c609719bSwdenkSome configuration options can be set using Environment Variables:
2897c609719bSwdenk
2898c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2899c609719bSwdenk
2900c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2901c609719bSwdenk
2902c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2903c609719bSwdenk
2904c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2905c609719bSwdenk
2906c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2907c609719bSwdenk
29087d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
29097d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
29107d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
29117d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
29127d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
29137d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
29146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ.
29157d721e34SBartlomiej Sieka
29167d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
29177d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
29187d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
29197d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
29207d721e34SBartlomiej Sieka		  environment variable.
29217d721e34SBartlomiej Sieka
29224bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
29234bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
29244bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
29254bae9090SBartlomiej Sieka
2926c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2927c609719bSwdenk		  "bootp" will just load perform a lookup of the
2928c609719bSwdenk		  configuration from the BOOTP server, but not try to
2929c609719bSwdenk		  load any image using TFTP
2930c609719bSwdenk
29313310c549SMarian Balakowicz  autoscript	- if set to "yes" commands like "loadb", "loady",
29323310c549SMarian Balakowicz		  "bootp", "tftpb", "rarpboot" and "nfs" will attempt
29333310c549SMarian Balakowicz		  to automatically run script images (by internally
29343310c549SMarian Balakowicz		  calling "autoscript").
29353310c549SMarian Balakowicz
29363310c549SMarian Balakowicz  autoscript_uname - if script image is in a format (FIT) this
29373310c549SMarian Balakowicz		     variable is used to get script subimage unit name.
29383310c549SMarian Balakowicz
2939c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2940c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2941c609719bSwdenk		  be automatically started (by internally calling
2942c609719bSwdenk		  "bootm")
2943c609719bSwdenk
29444a6fd34bSwdenk		  If set to "no", a standalone image passed to the
29454a6fd34bSwdenk		  "bootm" command will be copied to the load address
29464a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
29474a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
29484a6fd34bSwdenk		  data.
29494a6fd34bSwdenk
295017ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
295117ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
295217ea1177Swdenk		  mode (400kHZ). This environment variable is used in
295317ea1177Swdenk		  initialization code. So, for changes to be effective
295417ea1177Swdenk		  it must be saved and board must be reset.
295517ea1177Swdenk
2956c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2957c609719bSwdenk		  If this variable is not set, initrd images will be
2958c609719bSwdenk		  copied to the highest possible address in RAM; this
2959c609719bSwdenk		  is usually what you want since it allows for
2960c609719bSwdenk		  maximum initrd size. If for some reason you want to
2961c609719bSwdenk		  make sure that the initrd image is loaded below the
29626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
2963c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2964c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2965c609719bSwdenk		  address to use (U-Boot will still check that it
2966c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2967c609719bSwdenk
2968c609719bSwdenk		  For instance, when you have a system with 16 MB
29697152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2970c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2971c609719bSwdenk		  the "bootargs" variable. However, now you must make
29727152b1d0Swdenk		  sure that the initrd image is placed in the first
2973c609719bSwdenk		  12 MB as well - this can be done with
2974c609719bSwdenk
2975c609719bSwdenk		  setenv initrd_high 00c00000
2976c609719bSwdenk
297738b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
297838b99261Swdenk		  indication to U-Boot that all addresses are legal
297938b99261Swdenk		  for the Linux kernel, including addresses in flash
298038b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
298138b99261Swdenk		  ramdisk at all. This may be useful to reduce the
298238b99261Swdenk		  boot time on your system, but requires that this
298338b99261Swdenk		  feature is supported by your Linux kernel.
298438b99261Swdenk
2985c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2986c609719bSwdenk
2987c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2988dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2989c609719bSwdenk
2990c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2991c609719bSwdenk
2992c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2993c609719bSwdenk
2994c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2995c609719bSwdenk
2996c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2997c609719bSwdenk
2998c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2999c609719bSwdenk
3000a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
3001a3d991bdSwdenk		  interface is used first.
3002a3d991bdSwdenk
3003a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
3004a3d991bdSwdenk		  interface is currently active. For example you
3005a3d991bdSwdenk		  can do the following
3006a3d991bdSwdenk
3007a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
3008a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
3009a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
3010a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
3011a3d991bdSwdenk
3012e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
3013e1692577SMatthias Fuchs		  available network interfaces.
3014e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
3015e1692577SMatthias Fuchs
3016a3d991bdSwdenk   netretry	- When set to "no" each network operation will
3017a3d991bdSwdenk		  either succeed or fail without retrying.
30186e592385Swdenk		  When set to "once" the network operation will
30196e592385Swdenk		  fail when all the available network interfaces
30206e592385Swdenk		  are tried once without success.
3021a3d991bdSwdenk		  Useful on scripts which control the retry operation
3022a3d991bdSwdenk		  themselves.
3023a3d991bdSwdenk
3024a1cf027aSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- see CONFIG_IXP4XX_NPE_EXT_UCOD
302511ccc33fSMarcel Ziswiler		  if set load address for the NPE microcode
3026a1cf027aSJean-Christophe PLAGNIOL-VILLARD
302728cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
3028ecb0ccd9SWolfgang Denk		  UDP source port.
3029ecb0ccd9SWolfgang Denk
303028cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
303128cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
303228cb9375SWolfgang Denk
3033a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
303411ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
3035a3d991bdSwdenk		  VLAN tagged frames.
3036c609719bSwdenk
3037c609719bSwdenkThe following environment variables may be used and automatically
3038c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
3039c609719bSwdenkdepending the information provided by your boot server:
3040c609719bSwdenk
3041c609719bSwdenk  bootfile	- see above
3042c609719bSwdenk  dnsip		- IP address of your Domain Name Server
3043fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
3044c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
3045c609719bSwdenk  hostname	- Target hostname
3046c609719bSwdenk  ipaddr	- see above
3047c609719bSwdenk  netmask	- Subnet Mask
3048c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
3049c609719bSwdenk  serverip	- see above
3050c609719bSwdenk
3051c609719bSwdenk
3052c609719bSwdenkThere are two special Environment Variables:
3053c609719bSwdenk
3054c609719bSwdenk  serial#	- contains hardware identification information such
3055c609719bSwdenk		  as type string and/or serial number
3056c609719bSwdenk  ethaddr	- Ethernet address
3057c609719bSwdenk
3058c609719bSwdenkThese variables can be set only once (usually during manufacturing of
3059c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
3060c609719bSwdenkonce they have been set once.
3061c609719bSwdenk
3062c609719bSwdenk
3063c1551ea8SstroeseFurther special Environment Variables:
3064c1551ea8Sstroese
3065c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
3066c1551ea8Sstroese		  with the "version" command. This variable is
3067c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
3068c1551ea8Sstroese
3069c1551ea8Sstroese
3070c609719bSwdenkPlease note that changes to some configuration parameters may take
3071c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
3072c609719bSwdenk
3073c609719bSwdenk
3074f07771ccSwdenkCommand Line Parsing:
3075f07771ccSwdenk=====================
3076f07771ccSwdenk
3077f07771ccSwdenkThere are two different command line parsers available with U-Boot:
30787152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
3079f07771ccSwdenk
3080f07771ccSwdenkOld, simple command line parser:
3081f07771ccSwdenk--------------------------------
3082f07771ccSwdenk
3083f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
3084f07771ccSwdenk- several commands on one line, separated by ';'
3085fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
3086f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
3087f07771ccSwdenk  for example:
3088fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
3089f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
3090f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
3091f07771ccSwdenk
3092f07771ccSwdenkHush shell:
3093f07771ccSwdenk-----------
3094f07771ccSwdenk
3095f07771ccSwdenk- similar to Bourne shell, with control structures like
3096f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
3097f07771ccSwdenk  until...do...done, ...
3098f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
3099f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
3100f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
3101f07771ccSwdenk  command
3102f07771ccSwdenk
3103f07771ccSwdenkGeneral rules:
3104f07771ccSwdenk--------------
3105f07771ccSwdenk
3106f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
3107f07771ccSwdenk    command) contains several commands separated by semicolon, and
3108f07771ccSwdenk    one of these commands fails, then the remaining commands will be
3109f07771ccSwdenk    executed anyway.
3110f07771ccSwdenk
3111f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
311211ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
3113f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
3114f07771ccSwdenk    variables are not executed.
3115f07771ccSwdenk
3116c609719bSwdenkNote for Redundant Ethernet Interfaces:
3117c609719bSwdenk=======================================
3118c609719bSwdenk
311911ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
3120c609719bSwdenksuch configurations and is capable of automatic selection of a
31217152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
3122c609719bSwdenk
3123c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
3124c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
3125c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
3126c609719bSwdenk
3127c609719bSwdenkIf the network interface stores some valid MAC address (for instance
3128c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
3129c609719bSwdenkding setting in the environment; if the corresponding environment
3130c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
3131c609719bSwdenk
3132c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
3133c609719bSwdenk  environment, the SROM's address is used.
3134c609719bSwdenk
3135c609719bSwdenko If there is no valid address in the SROM, and a definition in the
3136c609719bSwdenk  environment exists, then the value from the environment variable is
3137c609719bSwdenk  used.
3138c609719bSwdenk
3139c609719bSwdenko If both the SROM and the environment contain a MAC address, and
3140c609719bSwdenk  both addresses are the same, this MAC address is used.
3141c609719bSwdenk
3142c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
3143c609719bSwdenk  addresses differ, the value from the environment is used and a
3144c609719bSwdenk  warning is printed.
3145c609719bSwdenk
3146c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
3147c609719bSwdenk  is raised.
3148c609719bSwdenk
3149c609719bSwdenk
3150c609719bSwdenkImage Formats:
3151c609719bSwdenk==============
3152c609719bSwdenk
31533310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
31543310c549SMarian Balakowiczimages in two formats:
31553310c549SMarian Balakowicz
31563310c549SMarian BalakowiczNew uImage format (FIT)
31573310c549SMarian Balakowicz-----------------------
31583310c549SMarian Balakowicz
31593310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
31603310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
31613310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
31623310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
31633310c549SMarian Balakowicz
31643310c549SMarian Balakowicz
31653310c549SMarian BalakowiczOld uImage format
31663310c549SMarian Balakowicz-----------------
31673310c549SMarian Balakowicz
31683310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
31693310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
31703310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
3171c609719bSwdenk
3172c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
3173c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
3174f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
3175f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
3176f5ed9e39SPeter Tyser  INTEGRITY).
31777b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
31783d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
31797b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
3180c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
3181c609719bSwdenk* Load Address
3182c609719bSwdenk* Entry Point
3183c609719bSwdenk* Image Name
3184c609719bSwdenk* Image Timestamp
3185c609719bSwdenk
3186c609719bSwdenkThe header is marked by a special Magic Number, and both the header
3187c609719bSwdenkand the data portions of the image are secured against corruption by
3188c609719bSwdenkCRC32 checksums.
3189c609719bSwdenk
3190c609719bSwdenk
3191c609719bSwdenkLinux Support:
3192c609719bSwdenk==============
3193c609719bSwdenk
3194c609719bSwdenkAlthough U-Boot should support any OS or standalone application
31957152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
3196c609719bSwdenkU-Boot.
3197c609719bSwdenk
3198c609719bSwdenkU-Boot includes many features that so far have been part of some
3199c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
3200c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
3201c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
32027152b1d0Swdenkserves several purposes:
3203c609719bSwdenk
3204c609719bSwdenk- the same features can be used for other OS or standalone
3205c609719bSwdenk  applications (for instance: using compressed images to reduce the
3206c609719bSwdenk  Flash memory footprint)
3207c609719bSwdenk
3208c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
32097152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
3210c609719bSwdenk
3211c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
3212c609719bSwdenk  images; of course this also means that different kernel images can
3213c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
3214c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
3215c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
3216c609719bSwdenk  software is easier now.
3217c609719bSwdenk
3218c609719bSwdenk
3219c609719bSwdenkLinux HOWTO:
3220c609719bSwdenk============
3221c609719bSwdenk
3222c609719bSwdenkPorting Linux to U-Boot based systems:
3223c609719bSwdenk---------------------------------------
3224c609719bSwdenk
3225c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
3226c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
3227c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
3228c609719bSwdenkLinux :-).
3229c609719bSwdenk
3230c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
3231c609719bSwdenk
3232c609719bSwdenkJust make sure your machine specific header file (for instance
3233c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
32341dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
32351dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
32366d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
3237c609719bSwdenk
3238c609719bSwdenk
3239c609719bSwdenkConfiguring the Linux kernel:
3240c609719bSwdenk-----------------------------
3241c609719bSwdenk
3242c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
3243c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
3244c609719bSwdenk
3245c609719bSwdenk
3246c609719bSwdenkBuilding a Linux Image:
3247c609719bSwdenk-----------------------
3248c609719bSwdenk
324924ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
325024ee89b9Swdenknot used. If you use recent kernel source, a new build target
325124ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
325224ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
325324ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
325424ee89b9Swdenk100% compatible format.
3255c609719bSwdenk
3256c609719bSwdenkExample:
3257c609719bSwdenk
3258c609719bSwdenk	make TQM850L_config
3259c609719bSwdenk	make oldconfig
3260c609719bSwdenk	make dep
326124ee89b9Swdenk	make uImage
3262c609719bSwdenk
326324ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
326424ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
326524ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
3266c609719bSwdenk
326724ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
326824ee89b9Swdenk
326924ee89b9Swdenk* convert the kernel into a raw binary image:
327024ee89b9Swdenk
327124ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
327224ee89b9Swdenk				 -R .note -R .comment \
327324ee89b9Swdenk				 -S vmlinux linux.bin
327424ee89b9Swdenk
327524ee89b9Swdenk* compress the binary image:
327624ee89b9Swdenk
327724ee89b9Swdenk	gzip -9 linux.bin
327824ee89b9Swdenk
327924ee89b9Swdenk* package compressed binary image for U-Boot:
328024ee89b9Swdenk
328124ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
328224ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
328324ee89b9Swdenk		-d linux.bin.gz uImage
328424ee89b9Swdenk
328524ee89b9Swdenk
328624ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
328724ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
328824ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
328924ee89b9Swdenkbyte header containing information about target architecture,
329024ee89b9Swdenkoperating system, image type, compression method, entry points, time
329124ee89b9Swdenkstamp, CRC32 checksums, etc.
329224ee89b9Swdenk
329324ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
329424ee89b9Swdenkprint the header information, or to build new images.
3295c609719bSwdenk
3296c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3297c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3298c609719bSwdenkchecksum verification:
3299c609719bSwdenk
3300c609719bSwdenk	tools/mkimage -l image
3301c609719bSwdenk	  -l ==> list image header information
3302c609719bSwdenk
3303c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3304c609719bSwdenkfrom a "data file" which is used as image payload:
3305c609719bSwdenk
3306c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3307c609719bSwdenk		      -n name -d data_file image
3308c609719bSwdenk	  -A ==> set architecture to 'arch'
3309c609719bSwdenk	  -O ==> set operating system to 'os'
3310c609719bSwdenk	  -T ==> set image type to 'type'
3311c609719bSwdenk	  -C ==> set compression type 'comp'
3312c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3313c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3314c609719bSwdenk	  -n ==> set image name to 'name'
3315c609719bSwdenk	  -d ==> use image data from 'datafile'
3316c609719bSwdenk
331769459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
331869459791Swdenkaddress (0x00000000), but the entry point address depends on the
331969459791Swdenkkernel version:
3320c609719bSwdenk
3321c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
332224ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3323c609719bSwdenk
3324c609719bSwdenkSo a typical call to build a U-Boot image would read:
3325c609719bSwdenk
332624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
332724ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
332824ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
332924ee89b9Swdenk	> examples/uImage.TQM850L
333024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3331c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3332c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3333c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3334c609719bSwdenk	Load Address: 0x00000000
333524ee89b9Swdenk	Entry Point:  0x00000000
3336c609719bSwdenk
3337c609719bSwdenkTo verify the contents of the image (or check for corruption):
3338c609719bSwdenk
333924ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
334024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3341c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3342c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3343c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3344c609719bSwdenk	Load Address: 0x00000000
334524ee89b9Swdenk	Entry Point:  0x00000000
3346c609719bSwdenk
3347c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3348c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3349c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3350c609719bSwdenkneed to be uncompressed:
3351c609719bSwdenk
335224ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
335324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
335424ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
335524ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
335624ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
335724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3358c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3359c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3360c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3361c609719bSwdenk	Load Address: 0x00000000
336224ee89b9Swdenk	Entry Point:  0x00000000
3363c609719bSwdenk
3364c609719bSwdenk
3365c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3366c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3367c609719bSwdenk
3368c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3369c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3370c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3371c609719bSwdenk	Image Name:   Simple Ramdisk Image
3372c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3373c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3374c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3375c609719bSwdenk	Load Address: 0x00000000
3376c609719bSwdenk	Entry Point:  0x00000000
3377c609719bSwdenk
3378c609719bSwdenk
3379c609719bSwdenkInstalling a Linux Image:
3380c609719bSwdenk-------------------------
3381c609719bSwdenk
3382c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3383c609719bSwdenkyou must convert the image to S-Record format:
3384c609719bSwdenk
3385c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3386c609719bSwdenk
3387c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3388c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3389c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3390c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3391c609719bSwdenkcommand.
3392c609719bSwdenk
3393c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3394c609719bSwdenkTQM8xxL is in the first Flash bank):
3395c609719bSwdenk
3396c609719bSwdenk	=> erase 40100000 401FFFFF
3397c609719bSwdenk
3398c609719bSwdenk	.......... done
3399c609719bSwdenk	Erased 8 sectors
3400c609719bSwdenk
3401c609719bSwdenk	=> loads 40100000
3402c609719bSwdenk	## Ready for S-Record download ...
3403c609719bSwdenk	~>examples/image.srec
3404c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3405c609719bSwdenk	...
3406c609719bSwdenk	15989 15990 15991 15992
3407c609719bSwdenk	[file transfer complete]
3408c609719bSwdenk	[connected]
3409c609719bSwdenk	## Start Addr = 0x00000000
3410c609719bSwdenk
3411c609719bSwdenk
3412c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3413c609719bSwdenkthis includes a checksum verification so you can be sure no data
3414c609719bSwdenkcorruption happened:
3415c609719bSwdenk
3416c609719bSwdenk	=> imi 40100000
3417c609719bSwdenk
3418c609719bSwdenk	## Checking Image at 40100000 ...
3419c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3420c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3421c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3422c609719bSwdenk	   Load Address: 00000000
3423c609719bSwdenk	   Entry Point:	 0000000c
3424c609719bSwdenk	   Verifying Checksum ... OK
3425c609719bSwdenk
3426c609719bSwdenk
3427c609719bSwdenkBoot Linux:
3428c609719bSwdenk-----------
3429c609719bSwdenk
3430c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3431c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3432c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3433c609719bSwdenkparameters. You can check and modify this variable using the
3434c609719bSwdenk"printenv" and "setenv" commands:
3435c609719bSwdenk
3436c609719bSwdenk
3437c609719bSwdenk	=> printenv bootargs
3438c609719bSwdenk	bootargs=root=/dev/ram
3439c609719bSwdenk
3440c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3441c609719bSwdenk
3442c609719bSwdenk	=> printenv bootargs
3443c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3444c609719bSwdenk
3445c609719bSwdenk	=> bootm 40020000
3446c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3447c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3448c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3449c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3450c609719bSwdenk	   Load Address: 00000000
3451c609719bSwdenk	   Entry Point:	 0000000c
3452c609719bSwdenk	   Verifying Checksum ... OK
3453c609719bSwdenk	   Uncompressing Kernel Image ... OK
3454c609719bSwdenk	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
3455c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3456c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3457c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3458c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3459c609719bSwdenk	...
3460c609719bSwdenk
346111ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
34627152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3463c609719bSwdenkformat!) to the "bootm" command:
3464c609719bSwdenk
3465c609719bSwdenk	=> imi 40100000 40200000
3466c609719bSwdenk
3467c609719bSwdenk	## Checking Image at 40100000 ...
3468c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3469c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3470c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3471c609719bSwdenk	   Load Address: 00000000
3472c609719bSwdenk	   Entry Point:	 0000000c
3473c609719bSwdenk	   Verifying Checksum ... OK
3474c609719bSwdenk
3475c609719bSwdenk	## Checking Image at 40200000 ...
3476c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3477c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3478c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3479c609719bSwdenk	   Load Address: 00000000
3480c609719bSwdenk	   Entry Point:	 00000000
3481c609719bSwdenk	   Verifying Checksum ... OK
3482c609719bSwdenk
3483c609719bSwdenk	=> bootm 40100000 40200000
3484c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3485c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3486c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3487c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3488c609719bSwdenk	   Load Address: 00000000
3489c609719bSwdenk	   Entry Point:	 0000000c
3490c609719bSwdenk	   Verifying Checksum ... OK
3491c609719bSwdenk	   Uncompressing Kernel Image ... OK
3492c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3493c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3494c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3495c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3496c609719bSwdenk	   Load Address: 00000000
3497c609719bSwdenk	   Entry Point:	 00000000
3498c609719bSwdenk	   Verifying Checksum ... OK
3499c609719bSwdenk	   Loading Ramdisk ... OK
3500c609719bSwdenk	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
3501c609719bSwdenk	Boot arguments: root=/dev/ram
3502c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3503c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3504c609719bSwdenk	...
3505c609719bSwdenk	RAMDISK: Compressed image found at block 0
3506c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3507c609719bSwdenk
3508c609719bSwdenk	bash#
3509c609719bSwdenk
35100267768eSMatthew McClintockBoot Linux and pass a flat device tree:
35110267768eSMatthew McClintock-----------
35120267768eSMatthew McClintock
35130267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
35140267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
35150267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
35160267768eSMatthew McClintockflat device tree:
35170267768eSMatthew McClintock
35180267768eSMatthew McClintock=> print oftaddr
35190267768eSMatthew McClintockoftaddr=0x300000
35200267768eSMatthew McClintock=> print oft
35210267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
35220267768eSMatthew McClintock=> tftp $oftaddr $oft
35230267768eSMatthew McClintockSpeed: 1000, full duplex
35240267768eSMatthew McClintockUsing TSEC0 device
35250267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
35260267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
35270267768eSMatthew McClintockLoad address: 0x300000
35280267768eSMatthew McClintockLoading: #
35290267768eSMatthew McClintockdone
35300267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
35310267768eSMatthew McClintock=> tftp $loadaddr $bootfile
35320267768eSMatthew McClintockSpeed: 1000, full duplex
35330267768eSMatthew McClintockUsing TSEC0 device
35340267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
35350267768eSMatthew McClintockFilename 'uImage'.
35360267768eSMatthew McClintockLoad address: 0x200000
35370267768eSMatthew McClintockLoading:############
35380267768eSMatthew McClintockdone
35390267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
35400267768eSMatthew McClintock=> print loadaddr
35410267768eSMatthew McClintockloadaddr=200000
35420267768eSMatthew McClintock=> print oftaddr
35430267768eSMatthew McClintockoftaddr=0x300000
35440267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
35450267768eSMatthew McClintock## Booting image at 00200000 ...
35460267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
35470267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
35480267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
35490267768eSMatthew McClintock   Load Address: 00000000
35500267768eSMatthew McClintock   Entry Point:	 00000000
35510267768eSMatthew McClintock   Verifying Checksum ... OK
35520267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
35530267768eSMatthew McClintockBooting using flat device tree at 0x300000
35540267768eSMatthew McClintockUsing MPC85xx ADS machine description
35550267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
35560267768eSMatthew McClintock[snip]
35570267768eSMatthew McClintock
35580267768eSMatthew McClintock
35596069ff26SwdenkMore About U-Boot Image Types:
35606069ff26Swdenk------------------------------
35616069ff26Swdenk
35626069ff26SwdenkU-Boot supports the following image types:
35636069ff26Swdenk
35646069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
35656069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
35666069ff26Swdenk	well) you can continue to work in U-Boot after return from
35676069ff26Swdenk	the Standalone Program.
35686069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
35696069ff26Swdenk	will take over control completely. Usually these programs
35706069ff26Swdenk	will install their own set of exception handlers, device
35716069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
35726069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
35736069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
35746069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
35756069ff26Swdenk	being started.
35766069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
35776069ff26Swdenk	(Linux) kernel image and one or more data images like
35786069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
35796069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
35806069ff26Swdenk	server provides just a single image file, but you want to get
35816069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
35826069ff26Swdenk
35836069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
35846069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
35856069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
35866069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
35876069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
35886069ff26Swdenk	a multiple of 4 bytes).
35896069ff26Swdenk
35906069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
35916069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
35926069ff26Swdenk	flash memory.
35936069ff26Swdenk
35946069ff26Swdenk   "Script files" are command sequences that will be executed by
35956069ff26Swdenk	U-Boot's command interpreter; this feature is especially
35966069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
35976069ff26Swdenk	as command interpreter.
35986069ff26Swdenk
3599c609719bSwdenk
3600c609719bSwdenkStandalone HOWTO:
3601c609719bSwdenk=================
3602c609719bSwdenk
3603c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3604c609719bSwdenkrun "standalone" applications, which can use some resources of
3605c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3606c609719bSwdenk
3607c609719bSwdenkTwo simple examples are included with the sources:
3608c609719bSwdenk
3609c609719bSwdenk"Hello World" Demo:
3610c609719bSwdenk-------------------
3611c609719bSwdenk
3612c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3613c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3614c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3615c609719bSwdenklike that:
3616c609719bSwdenk
3617c609719bSwdenk	=> loads
3618c609719bSwdenk	## Ready for S-Record download ...
3619c609719bSwdenk	~>examples/hello_world.srec
3620c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3621c609719bSwdenk	[file transfer complete]
3622c609719bSwdenk	[connected]
3623c609719bSwdenk	## Start Addr = 0x00040004
3624c609719bSwdenk
3625c609719bSwdenk	=> go 40004 Hello World! This is a test.
3626c609719bSwdenk	## Starting application at 0x00040004 ...
3627c609719bSwdenk	Hello World
3628c609719bSwdenk	argc = 7
3629c609719bSwdenk	argv[0] = "40004"
3630c609719bSwdenk	argv[1] = "Hello"
3631c609719bSwdenk	argv[2] = "World!"
3632c609719bSwdenk	argv[3] = "This"
3633c609719bSwdenk	argv[4] = "is"
3634c609719bSwdenk	argv[5] = "a"
3635c609719bSwdenk	argv[6] = "test."
3636c609719bSwdenk	argv[7] = "<NULL>"
3637c609719bSwdenk	Hit any key to exit ...
3638c609719bSwdenk
3639c609719bSwdenk	## Application terminated, rc = 0x0
3640c609719bSwdenk
3641c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3642c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3643c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3644c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3645c609719bSwdenkcharacter, but this is just a demo program. The application can be
3646c609719bSwdenkcontrolled by the following keys:
3647c609719bSwdenk
3648c609719bSwdenk	? - print current values og the CPM Timer registers
3649c609719bSwdenk	b - enable interrupts and start timer
3650c609719bSwdenk	e - stop timer and disable interrupts
3651c609719bSwdenk	q - quit application
3652c609719bSwdenk
3653c609719bSwdenk	=> loads
3654c609719bSwdenk	## Ready for S-Record download ...
3655c609719bSwdenk	~>examples/timer.srec
3656c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3657c609719bSwdenk	[file transfer complete]
3658c609719bSwdenk	[connected]
3659c609719bSwdenk	## Start Addr = 0x00040004
3660c609719bSwdenk
3661c609719bSwdenk	=> go 40004
3662c609719bSwdenk	## Starting application at 0x00040004 ...
3663c609719bSwdenk	TIMERS=0xfff00980
3664c609719bSwdenk	Using timer 1
3665c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3666c609719bSwdenk
3667c609719bSwdenkHit 'b':
3668c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3669c609719bSwdenk	Enabling timer
3670c609719bSwdenkHit '?':
3671c609719bSwdenk	[q, b, e, ?] ........
3672c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3673c609719bSwdenkHit '?':
3674c609719bSwdenk	[q, b, e, ?] .
3675c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3676c609719bSwdenkHit '?':
3677c609719bSwdenk	[q, b, e, ?] .
3678c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3679c609719bSwdenkHit '?':
3680c609719bSwdenk	[q, b, e, ?] .
3681c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3682c609719bSwdenkHit 'e':
3683c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3684c609719bSwdenkHit 'q':
3685c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3686c609719bSwdenk
3687c609719bSwdenk
368885ec0bccSwdenkMinicom warning:
368985ec0bccSwdenk================
369085ec0bccSwdenk
36917152b1d0SwdenkOver time, many people have reported problems when trying to use the
369285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
369385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3694f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
369585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
369685ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
369785ec0bccSwdenk
369852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
369952f52c14Swdenkconfiguration to your "File transfer protocols" section:
370052f52c14Swdenk
370152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
370252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
370352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
370452f52c14Swdenk
370552f52c14Swdenk
3706c609719bSwdenkNetBSD Notes:
3707c609719bSwdenk=============
3708c609719bSwdenk
3709c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3710c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3711c609719bSwdenk
3712c609719bSwdenkBuilding requires a cross environment; it is known to work on
3713c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3714c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3715c609719bSwdenkNote that the cross-powerpc package does not install include files;
3716c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3717c609719bSwdenkmissing.  This file has to be installed and patched manually:
3718c609719bSwdenk
3719c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3720c609719bSwdenk	# mkdir powerpc
3721c609719bSwdenk	# ln -s powerpc machine
3722c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3723c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3724c609719bSwdenk
3725c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3726c609719bSwdenkand U-Boot include files.
3727c609719bSwdenk
3728c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3729c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3730c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3731c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
37322a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3733c609719bSwdenk
3734c609719bSwdenk
3735c609719bSwdenkImplementation Internals:
3736c609719bSwdenk=========================
3737c609719bSwdenk
3738c609719bSwdenkThe following is not intended to be a complete description of every
3739c609719bSwdenkimplementation detail. However, it should help to understand the
3740c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3741c609719bSwdenkhardware.
3742c609719bSwdenk
3743c609719bSwdenk
3744c609719bSwdenkInitial Stack, Global Data:
3745c609719bSwdenk---------------------------
3746c609719bSwdenk
3747c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3748c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3749c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3750c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3751c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3752c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3753c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3754c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3755c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3756c609719bSwdenklocked as (mis-) used as memory, etc.
3757c609719bSwdenk
37587152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
37590668236bSWolfgang Denk	U-Boot mailing list:
376043d9616cSwdenk
376143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
376243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
376343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
376443d9616cSwdenk	...
376543d9616cSwdenk
376643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
376743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
376843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
376943d9616cSwdenk	is that the cache is being used as a temporary supply of
377043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
377111ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
377243d9616cSwdenk	can see how this works by studying the cache architecture and
377343d9616cSwdenk	operation in the architecture and processor-specific manuals.
377443d9616cSwdenk
377543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
377643d9616cSwdenk	is another option for the system designer to use as an
377711ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
377843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
377943d9616cSwdenk	board designers haven't used it for something that would
378043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
378143d9616cSwdenk	used.
378243d9616cSwdenk
37836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
378443d9616cSwdenk	with your processor/board/system design. The default value
378543d9616cSwdenk	you will find in any recent u-boot distribution in
37868a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
378743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
378843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
378943d9616cSwdenk	that are supposed to respond to that address! That code in
379043d9616cSwdenk	start.S has been around a while and should work as is when
379143d9616cSwdenk	you get the config right.
379243d9616cSwdenk
379343d9616cSwdenk	-Chris Hallinan
379443d9616cSwdenk	DS4.COM, Inc.
379543d9616cSwdenk
3796c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3797c609719bSwdenkcode for the initialization procedures:
3798c609719bSwdenk
3799c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3800c609719bSwdenk  to write it.
3801c609719bSwdenk
380211ccc33fSMarcel Ziswiler* Do not use any uninitialized global data (or implicitely initialized
3803c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
38047152b1d0Swdenk  zation is performed later (when relocating to RAM).
3805c609719bSwdenk
3806c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3807c609719bSwdenk  that.
3808c609719bSwdenk
3809c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3810c609719bSwdenknormal global data to share information beween the code. But it
3811c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3812c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3813c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3814c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3815c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3816c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3817c609719bSwdenkreserve for this purpose.
3818c609719bSwdenk
38197152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3820c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3821c609719bSwdenkGCC's implementation.
3822c609719bSwdenk
3823c609719bSwdenkFor PowerPC, the following registers have specific use:
3824c609719bSwdenk	R1:	stack pointer
3825e7670f6cSWolfgang Denk	R2:	reserved for system use
3826c609719bSwdenk	R3-R4:	parameter passing and return values
3827c609719bSwdenk	R5-R10: parameter passing
3828c609719bSwdenk	R13:	small data area pointer
3829c609719bSwdenk	R30:	GOT pointer
3830c609719bSwdenk	R31:	frame pointer
3831c609719bSwdenk
3832c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3833c609719bSwdenk
3834e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
3835c609719bSwdenk
3836c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3837c609719bSwdenk    address of the global data structure is known at compile time),
3838c609719bSwdenk    but it turned out that reserving a register results in somewhat
3839c609719bSwdenk    smaller code - although the code savings are not that big (on
3840c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3841c609719bSwdenk    624 text + 127 data).
3842c609719bSwdenk
38434c58eb55SMike FrysingerOn Blackfin, the normal C ABI (except for P5) is followed as documented here:
38444c58eb55SMike Frysinger	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
38454c58eb55SMike Frysinger
38464c58eb55SMike Frysinger    ==> U-Boot will use P5 to hold a pointer to the global data
38474c58eb55SMike Frysinger
3848c609719bSwdenkOn ARM, the following registers are used:
3849c609719bSwdenk
3850c609719bSwdenk	R0:	function argument word/integer result
3851c609719bSwdenk	R1-R3:	function argument word
3852c609719bSwdenk	R9:	GOT pointer
3853c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3854c609719bSwdenk	R11:	argument (frame) pointer
3855c609719bSwdenk	R12:	temporary workspace
3856c609719bSwdenk	R13:	stack pointer
3857c609719bSwdenk	R14:	link register
3858c609719bSwdenk	R15:	program counter
3859c609719bSwdenk
3860c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3861c609719bSwdenk
3862d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3863d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3864c609719bSwdenk
3865c609719bSwdenkMemory Management:
3866c609719bSwdenk------------------
3867c609719bSwdenk
3868c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3869c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3870c609719bSwdenk
3871c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3872c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3873c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3874c609719bSwdenkphysical memory banks.
3875c609719bSwdenk
3876c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3877c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3878c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3879c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
38806d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
3881c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3882c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3883c609719bSwdenk
3884c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3885c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3886c609719bSwdenk
3887c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3888c609719bSwdenkthis:
3889c609719bSwdenk
3890c609719bSwdenk	0x0000 0000	Exception Vector code
3891c609719bSwdenk	      :
3892c609719bSwdenk	0x0000 1FFF
3893c609719bSwdenk	0x0000 2000	Free for Application Use
3894c609719bSwdenk	      :
3895c609719bSwdenk	      :
3896c609719bSwdenk
3897c609719bSwdenk	      :
3898c609719bSwdenk	      :
3899c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3900c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3901c609719bSwdenk	0x00FC 0000	Malloc Arena
3902c609719bSwdenk	      :
3903c609719bSwdenk	0x00FD FFFF
3904c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3905c609719bSwdenk	...		eventually: LCD or video framebuffer
3906c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3907c609719bSwdenk	0x00FF FFFF	[End of RAM]
3908c609719bSwdenk
3909c609719bSwdenk
3910c609719bSwdenkSystem Initialization:
3911c609719bSwdenk----------------------
3912c609719bSwdenk
3913c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
391411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
3915c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
39167152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3917c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3918c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3919c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3920c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3921c609719bSwdenkthe caches and the SIU.
3922c609719bSwdenk
3923c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3924c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3925c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3926c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3927c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3928c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3929c609719bSwdenkbanks.
3930c609719bSwdenk
3931c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
39327152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3933c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3934c609719bSwdenk0x00000000, with any additional banks following immediately to create
3935c609719bSwdenkcontiguous memory starting from 0.
3936c609719bSwdenk
3937c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3938c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3939c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3940c609719bSwdenkpages, and the final stack is set up.
3941c609719bSwdenk
3942c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3943c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3944c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3945c609719bSwdenknew address in RAM.
3946c609719bSwdenk
3947c609719bSwdenk
3948c609719bSwdenkU-Boot Porting Guide:
3949c609719bSwdenk----------------------
3950c609719bSwdenk
3951c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
39526aff3115Swdenklist, October 2002]
3953c609719bSwdenk
3954c609719bSwdenk
3955c609719bSwdenkint main (int argc, char *argv[])
3956c609719bSwdenk{
3957c609719bSwdenk	sighandler_t no_more_time;
3958c609719bSwdenk
3959c609719bSwdenk	signal (SIGALRM, no_more_time);
3960c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3961c609719bSwdenk
3962c609719bSwdenk	if (available_money > available_manpower) {
3963c609719bSwdenk		pay consultant to port U-Boot;
3964c609719bSwdenk		return 0;
3965c609719bSwdenk	}
3966c609719bSwdenk
3967c609719bSwdenk	Download latest U-Boot source;
3968c609719bSwdenk
39690668236bSWolfgang Denk	Subscribe to u-boot mailing list;
39706aff3115Swdenk
3971c609719bSwdenk	if (clueless) {
3972c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3973c609719bSwdenk	}
3974c609719bSwdenk
3975c609719bSwdenk	while (learning) {
3976c609719bSwdenk		Read the README file in the top level directory;
39777cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3978c609719bSwdenk		Read the source, Luke;
3979c609719bSwdenk	}
3980c609719bSwdenk
3981c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3982c609719bSwdenk		Buy a BDI2000;
3983c609719bSwdenk	} else {
3984c609719bSwdenk		Add a lot of aggravation and time;
3985c609719bSwdenk	}
3986c609719bSwdenk
3987c609719bSwdenk	Create your own board support subdirectory;
3988c609719bSwdenk
39896aff3115Swdenk	Create your own board config file;
39906aff3115Swdenk
3991c609719bSwdenk	while (!running) {
3992c609719bSwdenk		do {
3993c609719bSwdenk			Add / modify source code;
3994c609719bSwdenk		} until (compiles);
3995c609719bSwdenk		Debug;
3996c609719bSwdenk		if (clueless)
3997c609719bSwdenk			email ("Hi, I am having problems...");
3998c609719bSwdenk	}
3999c609719bSwdenk	Send patch file to Wolfgang;
4000c609719bSwdenk
4001c609719bSwdenk	return 0;
4002c609719bSwdenk}
4003c609719bSwdenk
4004c609719bSwdenkvoid no_more_time (int sig)
4005c609719bSwdenk{
4006c609719bSwdenk      hire_a_guru();
4007c609719bSwdenk}
4008c609719bSwdenk
4009c609719bSwdenk
4010c609719bSwdenkCoding Standards:
4011c609719bSwdenk-----------------
4012c609719bSwdenk
4013c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
40142c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
40152c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
40162c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
40172c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
4018c609719bSwdenk
40192c051651SDetlev ZundelSource files originating from a different project (for example the
40202c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
40212c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
40222c051651SDetlev Zundelsources.
40232c051651SDetlev Zundel
40242c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
40252c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
40262c051651SDetlev Zundelin your code.
4027c609719bSwdenk
4028c178d3daSwdenkPlease also stick to the following formatting rules:
4029180d3f74Swdenk- remove any trailing white space
4030180d3f74Swdenk- use TAB characters for indentation, not spaces
4031180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
4032180d3f74Swdenk- do not add more than 2 empty lines to source files
4033180d3f74Swdenk- do not add trailing empty lines to source files
4034180d3f74Swdenk
4035c609719bSwdenkSubmissions which do not conform to the standards may be returned
4036c609719bSwdenkwith a request to reformat the changes.
4037c609719bSwdenk
4038c609719bSwdenk
4039c609719bSwdenkSubmitting Patches:
4040c609719bSwdenk-------------------
4041c609719bSwdenk
4042c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
4043c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
4044c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
4045c609719bSwdenk
40460d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
4047218ca724SWolfgang Denk
40480668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
40490668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
40500668236bSWolfgang Denk
4051c609719bSwdenkWhen you send a patch, please include the following information with
4052c609719bSwdenkit:
4053c609719bSwdenk
4054c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
4055c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
4056c609719bSwdenk  patch actually fixes something.
4057c609719bSwdenk
4058c609719bSwdenk* For new features: a description of the feature and your
4059c609719bSwdenk  implementation.
4060c609719bSwdenk
4061c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
4062c609719bSwdenk
4063c609719bSwdenk* For major contributions, your entry to the CREDITS file
4064c609719bSwdenk
4065c609719bSwdenk* When you add support for a new board, don't forget to add this
4066c609719bSwdenk  board to the MAKEALL script, too.
4067c609719bSwdenk
4068c609719bSwdenk* If your patch adds new configuration options, don't forget to
4069c609719bSwdenk  document these in the README file.
4070c609719bSwdenk
4071218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
4072218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
4073218ca724SWolfgang Denk  "git-format-patch". If you then use "git-send-email" to send it to
4074218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
4075218ca724SWolfgang Denk  with some other mail clients.
4076c609719bSwdenk
4077218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
4078218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
4079218ca724SWolfgang Denk  GNU diff.
40806dff5529Swdenk
4081218ca724SWolfgang Denk  The current directory when running this command shall be the parent
4082218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
4083218ca724SWolfgang Denk  your patch includes sufficient directory information for the
4084218ca724SWolfgang Denk  affected files).
4085218ca724SWolfgang Denk
4086218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
4087218ca724SWolfgang Denk  and compressed attachments must not be used.
4088c609719bSwdenk
408952f52c14Swdenk* If one logical set of modifications affects or creates several
409052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
409152f52c14Swdenk
409252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
409352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
409452f52c14Swdenk
409552f52c14Swdenk
4096c609719bSwdenkNotes:
4097c609719bSwdenk
4098c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
4099c609719bSwdenk  source tree and make sure that no errors or warnings are reported
4100c609719bSwdenk  for any of the boards.
4101c609719bSwdenk
4102c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
4103c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
4104c609719bSwdenk  returned with a request to re-formatting / split it.
4105c609719bSwdenk
4106c609719bSwdenk* If you modify existing code, make sure that your new code does not
4107c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
4108c609719bSwdenk  When adding new features, these should compile conditionally only
4109c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
4110c609719bSwdenk  disabled must not need more memory than the old code without your
4111c609719bSwdenk  modification.
411290dc6704Swdenk
41130668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
41140668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
41150668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
41160668236bSWolfgang Denk  bigger than the size limit should be avoided.
4117