xref: /openbmc/u-boot/README (revision 5c952cf0245421feb4644f2e71487c0b2e1dbd13)
1c609719bSwdenk#
23a473b2aSwdenk# (C) Copyright 2000 - 2004
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
2824ee89b9SwdenkEmbedded boards based on PowerPC and ARM processors, which can be
2924ee89b9Swdenkinstalled in a boot ROM and used to initialize and test the hardware
3024ee89b9Swdenkor to download and run application code.
31c609719bSwdenk
32c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3324ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3424ee89b9Swdenkheader files in common, and special provision has been made to
35c609719bSwdenksupport booting of Linux images.
36c609719bSwdenk
37c609719bSwdenkSome attention has been paid to make this software easily
38c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
39c609719bSwdenkimplemented with the same call interface, so that it's very easy to
40c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
41c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
42c609719bSwdenkload and run it dynamically.
43c609719bSwdenk
44c609719bSwdenk
45c609719bSwdenkStatus:
46c609719bSwdenk=======
47c609719bSwdenk
48c609719bSwdenkIn general, all boards for which a configuration option exists in the
49c609719bSwdenkMakefile have been tested to some extent and can be considered
50c609719bSwdenk"working". In fact, many of them are used in production systems.
51c609719bSwdenk
52c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
53c609719bSwdenkwho contributed the specific port.
54c609719bSwdenk
55c609719bSwdenk
56c609719bSwdenkWhere to get help:
57c609719bSwdenk==================
58c609719bSwdenk
59c609719bSwdenkIn case you have questions about, problems with or contributions for
60c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
61c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
62c609719bSwdenkprevious traffic on the mailing list - please search the archive
63c609719bSwdenkbefore asking FAQ's. Please see
64c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
65c609719bSwdenk
66c609719bSwdenk
67c609719bSwdenkWhere we come from:
68c609719bSwdenk===================
69c609719bSwdenk
70c609719bSwdenk- start from 8xxrom sources
7124ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
72c609719bSwdenk- clean up code
73c609719bSwdenk- make it easier to add custom boards
74c609719bSwdenk- make it possible to add other [PowerPC] CPUs
75c609719bSwdenk- extend functions, especially:
76c609719bSwdenk  * Provide extended interface to Linux boot loader
77c609719bSwdenk  * S-Record download
78c609719bSwdenk  * network boot
79c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8024ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
81c609719bSwdenk- add other CPU families (starting with ARM)
8224ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8324ee89b9Swdenk
8424ee89b9Swdenk
8524ee89b9SwdenkNames and Spelling:
8624ee89b9Swdenk===================
8724ee89b9Swdenk
8824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
8924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9024ee89b9Swdenkin source files etc.). Example:
9124ee89b9Swdenk
9224ee89b9Swdenk	This is the README file for the U-Boot project.
9324ee89b9Swdenk
9424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9524ee89b9Swdenk
9624ee89b9Swdenk	include/asm-ppc/u-boot.h
9724ee89b9Swdenk
9824ee89b9Swdenk	#include <asm/u-boot.h>
9924ee89b9Swdenk
10024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10224ee89b9Swdenk
10324ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10424ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
105c609719bSwdenk
106c609719bSwdenk
10793f19cc0SwdenkVersioning:
10893f19cc0Swdenk===========
10993f19cc0Swdenk
11093f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11193f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11293f19cc0Swdenksub-version "34", and patchlevel "4".
11393f19cc0Swdenk
11493f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11593f19cc0Swdenkbetween released versions, i. e. officially released versions of
11693f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11793f19cc0Swdenk
11893f19cc0Swdenk
119c609719bSwdenkDirectory Hierarchy:
120c609719bSwdenk====================
121c609719bSwdenk
1227152b1d0Swdenk- board		Board dependent files
1237152b1d0Swdenk- common	Misc architecture independent functions
124c609719bSwdenk- cpu		CPU specific files
12511dadd54Swdenk  - 74xx_7xx	Files specific to Motorola MPC74xx and 7xx CPUs
12611dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12711dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
1281d9f4105Swdenk    - imx	Files specific to Motorola MC9328 i.MX CPUs
1291d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
13011dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
13111dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
13211dadd54Swdenk  - at91rm9200	Files specific to Atmel AT91RM9200 CPUs
13311dadd54Swdenk  - i386	Files specific to i386 CPUs
13411dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
13511dadd54Swdenk  - mcf52x2	Files specific to Motorola ColdFire MCF52x2 CPUs
13611dadd54Swdenk  - mips	Files specific to MIPS CPUs
13711dadd54Swdenk  - mpc5xx	Files specific to Motorola MPC5xx  CPUs
13811dadd54Swdenk  - mpc5xxx	Files specific to Motorola MPC5xxx CPUs
13911dadd54Swdenk  - mpc8xx	Files specific to Motorola MPC8xx  CPUs
14011dadd54Swdenk  - mpc824x	Files specific to Motorola MPC824x CPUs
14111dadd54Swdenk  - mpc8260	Files specific to Motorola MPC8260 CPUs
14211dadd54Swdenk  - mpc85xx	Files specific to Motorola MPC85xx CPUs
14311dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
144*5c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
14511dadd54Swdenk  - ppc4xx	Files specific to IBM PowerPC 4xx CPUs
14611dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
14711dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
14811dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
149c609719bSwdenk- disk		Code for disk drive partition handling
150c609719bSwdenk- doc		Documentation (don't expect too much)
1517152b1d0Swdenk- drivers	Commonly used device drivers
152c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
153c609719bSwdenk- examples	Example code for standalone applications, etc.
154c609719bSwdenk- include	Header Files
15511dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
15611dadd54Swdenk- lib_generic	Files generic to all	 architectures
15711dadd54Swdenk- lib_i386	Files generic to i386	 architecture
15811dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
15911dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16011dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16111dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
162c609719bSwdenk- net		Networking code
163c609719bSwdenk- post		Power On Self Test
164c609719bSwdenk- rtc		Real Time Clock drivers
165c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
166c609719bSwdenk
167c609719bSwdenkSoftware Configuration:
168c609719bSwdenk=======================
169c609719bSwdenk
170c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
171c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
172c609719bSwdenk
173c609719bSwdenkThere are two classes of configuration variables:
174c609719bSwdenk
175c609719bSwdenk* Configuration _OPTIONS_:
176c609719bSwdenk  These are selectable by the user and have names beginning with
177c609719bSwdenk  "CONFIG_".
178c609719bSwdenk
179c609719bSwdenk* Configuration _SETTINGS_:
180c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
181c609719bSwdenk  you don't know what you're doing; they have names beginning with
182c609719bSwdenk  "CFG_".
183c609719bSwdenk
184c609719bSwdenkLater we will add a configuration tool - probably similar to or even
185c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
186c609719bSwdenkdo the configuration by hand, which means creating some symbolic
187c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
188c609719bSwdenkas an example here.
189c609719bSwdenk
190c609719bSwdenk
191c609719bSwdenkSelection of Processor Architecture and Board Type:
192c609719bSwdenk---------------------------------------------------
193c609719bSwdenk
194c609719bSwdenkFor all supported boards there are ready-to-use default
195c609719bSwdenkconfigurations available; just type "make <board_name>_config".
196c609719bSwdenk
197c609719bSwdenkExample: For a TQM823L module type:
198c609719bSwdenk
199c609719bSwdenk	cd u-boot
200c609719bSwdenk	make TQM823L_config
201c609719bSwdenk
202c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
203c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
204c609719bSwdenkdirectory according to the instructions in cogent/README.
205c609719bSwdenk
206c609719bSwdenk
207c609719bSwdenkConfiguration Options:
208c609719bSwdenk----------------------
209c609719bSwdenk
210c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
211c609719bSwdenksuch information is kept in a configuration file
212c609719bSwdenk"include/configs/<board_name>.h".
213c609719bSwdenk
214c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
215c609719bSwdenk"include/configs/TQM823L.h".
216c609719bSwdenk
217c609719bSwdenk
2187f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2197f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2207f6c2cbcSwdenkbuild a config tool - later.
2217f6c2cbcSwdenk
2227f6c2cbcSwdenk
223c609719bSwdenkThe following options need to be configured:
224c609719bSwdenk
225c609719bSwdenk- CPU Type:	Define exactly one of
226c609719bSwdenk
227c609719bSwdenk		PowerPC based CPUs:
228c609719bSwdenk		-------------------
229c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2300db5bca8Swdenk	or	CONFIG_MPC5xx
231c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23242d1f039Swdenk	or	CONFIG_MPC85xx
233c609719bSwdenk	or	CONFIG_IOP480
234c609719bSwdenk	or	CONFIG_405GP
23512f34241Swdenk	or	CONFIG_405EP
236c609719bSwdenk	or	CONFIG_440
237c609719bSwdenk	or	CONFIG_MPC74xx
23872755c71Swdenk	or	CONFIG_750FX
239c609719bSwdenk
240c609719bSwdenk		ARM based CPUs:
241c609719bSwdenk		---------------
242c609719bSwdenk		CONFIG_SA1110
243c609719bSwdenk		CONFIG_ARM7
244c609719bSwdenk		CONFIG_PXA250
245c609719bSwdenk
246507bbe3eSwdenk		MicroBlaze based CPUs:
247507bbe3eSwdenk		----------------------
248857cad37Swdenk		CONFIG_MICROBLAZE
249507bbe3eSwdenk
250*5c952cf0Swdenk		Nios-2 based CPUs:
251*5c952cf0Swdenk		----------------------
252*5c952cf0Swdenk		CONFIG_NIOS2
253*5c952cf0Swdenk
254c609719bSwdenk
255c609719bSwdenk- Board Type:	Define exactly one of
256c609719bSwdenk
257c609719bSwdenk		PowerPC based boards:
258c609719bSwdenk		---------------------
259c609719bSwdenk
26017ea1177Swdenk		CONFIG_ADCIOP		CONFIG_GEN860T		CONFIG_PCI405
26117ea1177Swdenk		CONFIG_ADS860		CONFIG_GENIETV		CONFIG_PCIPPC2
26217ea1177Swdenk		CONFIG_AMX860		CONFIG_GTH		CONFIG_PCIPPC6
26317ea1177Swdenk		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
26417ea1177Swdenk		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
26517ea1177Swdenk		CONFIG_c2mon		CONFIG_hymod		CONFIG_PM826
26617ea1177Swdenk		CONFIG_CANBT		CONFIG_IAD210		CONFIG_ppmc8260
26717ea1177Swdenk		CONFIG_CCM		CONFIG_ICU862		CONFIG_QS823
26817ea1177Swdenk		CONFIG_CMI		CONFIG_IP860		CONFIG_QS850
26917ea1177Swdenk		CONFIG_cogent_mpc8260	CONFIG_IPHASE4539	CONFIG_QS860T
27017ea1177Swdenk		CONFIG_cogent_mpc8xx	CONFIG_IVML24		CONFIG_RBC823
27117ea1177Swdenk		CONFIG_CPCI405		CONFIG_IVML24_128	CONFIG_RPXClassic
27217ea1177Swdenk		CONFIG_CPCI4052		CONFIG_IVML24_256	CONFIG_RPXlite
27317ea1177Swdenk		CONFIG_CPCIISER4	CONFIG_IVMS8		CONFIG_RPXsuper
27417ea1177Swdenk		CONFIG_CPU86		CONFIG_IVMS8_128	CONFIG_rsdproto
27517ea1177Swdenk		CONFIG_CRAYL1		CONFIG_IVMS8_256	CONFIG_sacsng
27617ea1177Swdenk		CONFIG_CSB272		CONFIG_JSE		CONFIG_Sandpoint8240
27717ea1177Swdenk		CONFIG_CU824		CONFIG_LANTEC		CONFIG_Sandpoint8245
27817ea1177Swdenk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8260
2798b07a110Swdenk		CONFIG_DB64360		CONFIG_MBX		CONFIG_sbc8560
2808b07a110Swdenk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SM850
2818b07a110Swdenk		CONFIG_DU405		CONFIG_MHPC		CONFIG_SPD823TS
2828b07a110Swdenk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_STXGP3
2838b07a110Swdenk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_SXNI855T
2848b07a110Swdenk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM823L
2858b07a110Swdenk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM8260
2868b07a110Swdenk		CONFIG_ep8260		CONFIG_MPC8560ADS	CONFIG_TQM850L
2878b07a110Swdenk		CONFIG_ERIC		CONFIG_MUSENKI		CONFIG_TQM855L
2888b07a110Swdenk		CONFIG_ESTEEM192E	CONFIG_MVS1		CONFIG_TQM860L
2898b07a110Swdenk		CONFIG_ETX094		CONFIG_NETPHONE		CONFIG_TTTech
2908b07a110Swdenk		CONFIG_EVB64260		CONFIG_NETTA		CONFIG_UTX8245
2918b07a110Swdenk		CONFIG_FADS823		CONFIG_NETVIA		CONFIG_V37
2928b07a110Swdenk		CONFIG_FADS850SAR	CONFIG_NX823		CONFIG_W7OLMC
2938b07a110Swdenk		CONFIG_FADS860T		CONFIG_OCRTC		CONFIG_W7OLMG
2948b07a110Swdenk		CONFIG_FLAGADM		CONFIG_ORSG		CONFIG_WALNUT405
2958b07a110Swdenk		CONFIG_FPS850L		CONFIG_OXC		CONFIG_ZPC1900
2968b07a110Swdenk		CONFIG_FPS860L					CONFIG_ZUMA
297c609719bSwdenk
298c609719bSwdenk		ARM based boards:
299c609719bSwdenk		-----------------
300c609719bSwdenk
301b8c83181Swdenk		CONFIG_AT91RM9200DK,		CONFIG_CERF250,		CONFIG_DNP1110,
302b8c83181Swdenk		CONFIG_EP7312,			CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
303b8c83181Swdenk		CONFIG_IMPA7,		CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
304b8c83181Swdenk		CONFIG_LART,			CONFIG_LPD7A400		CONFIG_LUBBOCK,
305b8c83181Swdenk		CONFIG_OSK_OMAP5912,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
306b8c83181Swdenk		CONFIG_SMDK2400,		CONFIG_SMDK2410,	CONFIG_TRAB,
307b8c83181Swdenk		CONFIG_VCMA9
308c609719bSwdenk
309507bbe3eSwdenk		MicroBlaze based boards:
310507bbe3eSwdenk		------------------------
311507bbe3eSwdenk
312507bbe3eSwdenk		CONFIG_SUZAKU
313507bbe3eSwdenk
314*5c952cf0Swdenk		Nios-2 based boards:
315*5c952cf0Swdenk		------------------------
316*5c952cf0Swdenk
317*5c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
318*5c952cf0Swdenk
319c609719bSwdenk
320c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
321c609719bSwdenk		Define exactly one of
322c609719bSwdenk		CONFIG_CMA286_60_OLD
323c609719bSwdenk--- FIXME --- not tested yet:
324c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
325c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
326c609719bSwdenk
327c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
328c609719bSwdenk		Define exactly one of
329c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
330c609719bSwdenk
331c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
332c609719bSwdenk		Define one or more of
333c609719bSwdenk		CONFIG_CMA302
334c609719bSwdenk
335c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
336c609719bSwdenk		Define one or more of
337c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
338c609719bSwdenk					  the lcd display every second with
339c609719bSwdenk					  a "rotator" |\-/|\-/
340c609719bSwdenk
3412535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3422535d602Swdenk		CONFIG_ADSTYPE
3432535d602Swdenk		Possible values are:
3442535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
345180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
34654387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
34704a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3482535d602Swdenk
349c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
350c609719bSwdenk		Define exactly one of
351c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
352c609719bSwdenk
35375d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
35466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
35566ca92a5Swdenk					  get_gclk_freq() cannot work
3565da627a4Swdenk					  e.g. if there is no 32KHz
3575da627a4Swdenk					  reference PIT/RTC clock
35866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
35966ca92a5Swdenk					  or XTAL/EXTAL)
360c609719bSwdenk
36166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
36266ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
36366ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
36466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
36575d1ea7fSwdenk			See doc/README.MPC866
36675d1ea7fSwdenk
36775d1ea7fSwdenk		CFG_MEASURE_CPUCLK
36875d1ea7fSwdenk
36975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
37075d1ea7fSwdenk		of relying on the correctness of the configured
37175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
37275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
37375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
37466ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
37575d1ea7fSwdenk
3765da627a4Swdenk- Linux Kernel Interface:
377c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
378c609719bSwdenk
379c609719bSwdenk		U-Boot stores all clock information in Hz
380c609719bSwdenk		internally. For binary compatibility with older Linux
381c609719bSwdenk		kernels (which expect the clocks passed in the
382c609719bSwdenk		bd_info data to be in MHz) the environment variable
383c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
384c609719bSwdenk		converts clock data to MHZ before passing it to the
385c609719bSwdenk		Linux kernel.
386c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
387c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
388c609719bSwdenk		default environment.
389c609719bSwdenk
3905da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
3915da627a4Swdenk
3925da627a4Swdenk		When transfering memsize parameter to linux, some versions
3935da627a4Swdenk		expect it to be in bytes, others in MB.
3945da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
3955da627a4Swdenk
3966705d81eSwdenk- Serial Ports:
3976705d81eSwdenk		CFG_PL010_SERIAL
3986705d81eSwdenk
3996705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4006705d81eSwdenk
4016705d81eSwdenk		CFG_PL011_SERIAL
4026705d81eSwdenk
4036705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4046705d81eSwdenk
4056705d81eSwdenk		CONFIG_PL011_CLOCK
4066705d81eSwdenk
4076705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4086705d81eSwdenk		the clock speed of the UARTs.
4096705d81eSwdenk
4106705d81eSwdenk		CONFIG_PL01x_PORTS
4116705d81eSwdenk
4126705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
4136705d81eSwdenk		define this to a list of base addresses for each (supported)
4146705d81eSwdenk		port. See e.g. include/configs/versatile.h
4156705d81eSwdenk
4166705d81eSwdenk
417c609719bSwdenk- Console Interface:
418c609719bSwdenk		Depending on board, define exactly one serial port
419c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
420c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
421c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
422c609719bSwdenk
423c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
424c609719bSwdenk		port routines must be defined elsewhere
425c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
426c609719bSwdenk
427c609719bSwdenk		CONFIG_CFB_CONSOLE
428c609719bSwdenk		Enables console device for a color framebuffer. Needs following
429c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
430c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
431c609719bSwdenk						(default big endian)
432c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
433c609719bSwdenk						rectangle fill
434c609719bSwdenk						(cf. smiLynxEM)
435c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
436c609719bSwdenk						bit-blit (cf. smiLynxEM)
437c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
438c609719bSwdenk						(cols=pitch)
439c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
440c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
441c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
442c609719bSwdenk						(0-5, cf. cfb_console.c)
443c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
444c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
445c609719bSwdenk						(i.e. i8042_kbd_init())
446c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
447c609719bSwdenk						(i.e. i8042_tstc)
448c609719bSwdenk			VIDEO_GETC_FCT		get char fct
449c609719bSwdenk						(i.e. i8042_getc)
450c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
451c609719bSwdenk						(requires blink timer
452c609719bSwdenk						cf. i8042.c)
453c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
454c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
455c609719bSwdenk						upper right corner
456c609719bSwdenk						(requires CFG_CMD_DATE)
457c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
458c609719bSwdenk						upper left corner
459a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
460a6c7ad2fSwdenk						linux_logo.h for logo.
461a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
462c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
463c609719bSwdenk						addional board info beside
464c609719bSwdenk						the logo
465c609719bSwdenk
466c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
467c609719bSwdenk		default i/o. Serial console can be forced with
468c609719bSwdenk		environment 'console=serial'.
469c609719bSwdenk
470a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
471a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
472a3ad8e26Swdenk		the "silent" environment variable. See
473a3ad8e26Swdenk		doc/README.silent for more information.
474a3ad8e26Swdenk
475c609719bSwdenk- Console Baudrate:
476c609719bSwdenk		CONFIG_BAUDRATE - in bps
477c609719bSwdenk		Select one of the baudrates listed in
478c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
4793bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
480c609719bSwdenk
481c609719bSwdenk- Interrupt driven serial port input:
482c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
483c609719bSwdenk
484c609719bSwdenk		PPC405GP only.
485c609719bSwdenk		Use an interrupt handler for receiving data on the
486c609719bSwdenk		serial port. It also enables using hardware handshake
487c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
488c609719bSwdenk		bytes the interrupt driven input buffer should have.
489c609719bSwdenk
490109c0e3aSwdenk		Leave undefined to disable this feature, including
491109c0e3aSwdenk		disable the buffer and hardware handshake.
492c609719bSwdenk
4931d49b1f3Sstroese- Console UART Number:
4941d49b1f3Sstroese		CONFIG_UART1_CONSOLE
4951d49b1f3Sstroese
4961d49b1f3Sstroese		IBM PPC4xx only.
4971d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
4981d49b1f3Sstroese		as default U-Boot console.
4991d49b1f3Sstroese
500c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
501c609719bSwdenk		Delay before automatically booting the default image;
502c609719bSwdenk		set to -1 to disable autoboot.
503c609719bSwdenk
504c609719bSwdenk		See doc/README.autoboot for these options that
505c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
506c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
507c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
508c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
509c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
510c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
511c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
512c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
513c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
514c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
515c609719bSwdenk		CONFIG_RESET_TO_RETRY
516c609719bSwdenk
517c609719bSwdenk- Autoboot Command:
518c609719bSwdenk		CONFIG_BOOTCOMMAND
519c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
520c609719bSwdenk		define a command string that is automatically executed
521c609719bSwdenk		when no character is read on the console interface
522c609719bSwdenk		within "Boot Delay" after reset.
523c609719bSwdenk
524c609719bSwdenk		CONFIG_BOOTARGS
525c609719bSwdenk		This can be used to pass arguments to the bootm
526c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
527c609719bSwdenk		environment value "bootargs".
528c609719bSwdenk
529c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
530c609719bSwdenk		The value of these goes into the environment as
531c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
532c609719bSwdenk		as a convenience, when switching between booting from
533c609719bSwdenk		ram and nfs.
534c609719bSwdenk
535c609719bSwdenk- Pre-Boot Commands:
536c609719bSwdenk		CONFIG_PREBOOT
537c609719bSwdenk
538c609719bSwdenk		When this option is #defined, the existence of the
539c609719bSwdenk		environment variable "preboot" will be checked
540c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
541c609719bSwdenk		countdown and/or running the auto-boot command resp.
542c609719bSwdenk		entering interactive mode.
543c609719bSwdenk
544c609719bSwdenk		This feature is especially useful when "preboot" is
545c609719bSwdenk		automatically generated or modified. For an example
546c609719bSwdenk		see the LWMON board specific code: here "preboot" is
547c609719bSwdenk		modified when the user holds down a certain
548c609719bSwdenk		combination of keys on the (special) keyboard when
549c609719bSwdenk		booting the systems
550c609719bSwdenk
551c609719bSwdenk- Serial Download Echo Mode:
552c609719bSwdenk		CONFIG_LOADS_ECHO
553c609719bSwdenk		If defined to 1, all characters received during a
554c609719bSwdenk		serial download (using the "loads" command) are
555c609719bSwdenk		echoed back. This might be needed by some terminal
556c609719bSwdenk		emulations (like "cu"), but may as well just take
557c609719bSwdenk		time on others. This setting #define's the initial
558c609719bSwdenk		value of the "loads_echo" environment variable.
559c609719bSwdenk
560c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
561c609719bSwdenk		CONFIG_KGDB_BAUDRATE
562c609719bSwdenk		Select one of the baudrates listed in
563c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
564c609719bSwdenk
565c609719bSwdenk- Monitor Functions:
566c609719bSwdenk		CONFIG_COMMANDS
567c609719bSwdenk		Most monitor functions can be selected (or
568c609719bSwdenk		de-selected) by adjusting the definition of
569c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
570c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
571c609719bSwdenk		following values:
572c609719bSwdenk
573c609719bSwdenk		#define enables commands:
574c609719bSwdenk		-------------------------
575c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
57678137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
577c609719bSwdenk		CFG_CMD_BDI	  bdinfo
5786705d81eSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
57978137c3cSwdenk		CFG_CMD_BMP	* BMP support
5806705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
581c609719bSwdenk		CFG_CMD_BOOTD	  bootd
5826705d81eSwdenk		CFG_CMD_CACHE	* icache, dcache
583c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
584c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
5856705d81eSwdenk		CFG_CMD_DHCP	* DHCP support
58678137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
58778137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
5886705d81eSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
589c609719bSwdenk		CFG_CMD_ECHO	* echo arguments
590c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
5916705d81eSwdenk		CFG_CMD_ELF	* bootelf, bootvx
592c609719bSwdenk		CFG_CMD_ENV	  saveenv
593c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
5946705d81eSwdenk		CFG_CMD_FAT	* FAT partition support
5952262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
596c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
597c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
59878137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
599c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
600c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
601c609719bSwdenk		CFG_CMD_IMI	  iminfo
60278137c3cSwdenk		CFG_CMD_IMLS	  List all found images
603c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
604c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6056705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
60678137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
607c609719bSwdenk		CFG_CMD_KGDB	* kgdb
608c609719bSwdenk		CFG_CMD_LOADB	  loadb
609c609719bSwdenk		CFG_CMD_LOADS	  loads
610c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
61156523f12Swdenk				  loop, loopw, mtest
61278137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
6136705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
6146705d81eSwdenk		CFG_CMD_MII	* MII utility commands
61578137c3cSwdenk		CFG_CMD_NAND	* NAND support
616c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
617c609719bSwdenk		CFG_CMD_PCI	* pciinfo
618c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
61978137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
620ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
621c609719bSwdenk		CFG_CMD_REGINFO * Register dump
622c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
6236705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
624c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
62578137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
626c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
627c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
628c609719bSwdenk		CFG_CMD_USB	* USB support
62978137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
630c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
631a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
632c609719bSwdenk		-----------------------------------------------
633c609719bSwdenk		CFG_CMD_ALL	all
634c609719bSwdenk
63581050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
636c609719bSwdenk				this is includes all commands, except
637c609719bSwdenk				the ones marked with "*" in the list
638c609719bSwdenk				above.
639c609719bSwdenk
640c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
64181050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
642c609719bSwdenk		override the default settings in the respective
643c609719bSwdenk		include file.
644c609719bSwdenk
645c609719bSwdenk		EXAMPLE: If you want all functions except of network
646c609719bSwdenk		support you can write:
647c609719bSwdenk
648c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
649c609719bSwdenk
650c609719bSwdenk
651c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
652c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
653c609719bSwdenk		what you (and your U-Boot users) are doing. Data
654c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
655c609719bSwdenk		8260 (where accesses to the IMMR region must be
656c609719bSwdenk		uncached), and it cannot be disabled on all other
657c609719bSwdenk		systems where we (mis-) use the data cache to hold an
658c609719bSwdenk		initial stack and some data.
659c609719bSwdenk
660c609719bSwdenk
661c609719bSwdenk		XXX - this list needs to get updated!
662c609719bSwdenk
663c609719bSwdenk- Watchdog:
664c609719bSwdenk		CONFIG_WATCHDOG
665c609719bSwdenk		If this variable is defined, it enables watchdog
6667152b1d0Swdenk		support. There must be support in the platform specific
667c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
668c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
669c609719bSwdenk		register.
670c609719bSwdenk
671c1551ea8Sstroese- U-Boot Version:
672c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
673c1551ea8Sstroese		If this variable is defined, an environment variable
674c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
675c1551ea8Sstroese		version as printed by the "version" command.
676c1551ea8Sstroese		This variable is readonly.
677c1551ea8Sstroese
678c609719bSwdenk- Real-Time Clock:
679c609719bSwdenk
680c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
681c609719bSwdenk		has to be selected, too. Define exactly one of the
682c609719bSwdenk		following options:
683c609719bSwdenk
684c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
685c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
686c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
6871cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
688c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
6897f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
6903bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
6914c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
692c609719bSwdenk
693b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
694b37c7e5eSwdenk		must also be configured. See I2C Support, below.
695b37c7e5eSwdenk
696c609719bSwdenk- Timestamp Support:
697c609719bSwdenk
698c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
699c609719bSwdenk		(date and time) of an image is printed by image
700c609719bSwdenk		commands like bootm or iminfo. This option is
701c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
702c609719bSwdenk
703c609719bSwdenk- Partition Support:
704c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
705c609719bSwdenk		and/or CONFIG_ISO_PARTITION
706c609719bSwdenk
707c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
708c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
709c609719bSwdenk		one partition type as well.
710c609719bSwdenk
711c609719bSwdenk- IDE Reset method:
7124d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7134d13cbadSwdenk		board configurations files but used nowhere!
714c609719bSwdenk
7154d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7164d13cbadSwdenk		be performed by calling the function
7174d13cbadSwdenk			ide_set_reset(int reset)
7184d13cbadSwdenk		which has to be defined in a board specific file
719c609719bSwdenk
720c609719bSwdenk- ATAPI Support:
721c609719bSwdenk		CONFIG_ATAPI
722c609719bSwdenk
723c609719bSwdenk		Set this to enable ATAPI support.
724c609719bSwdenk
725c40b2956Swdenk- LBA48 Support
726c40b2956Swdenk		CONFIG_LBA48
727c40b2956Swdenk
728c40b2956Swdenk		Set this to enable support for disks larger than 137GB
729c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
730c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
731c40b2956Swdenk		support disks up to 2.1TB.
732c40b2956Swdenk
733c40b2956Swdenk		CFG_64BIT_LBA:
734c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
735c40b2956Swdenk			Default is 32bit.
736c40b2956Swdenk
737c609719bSwdenk- SCSI Support:
738c609719bSwdenk		At the moment only there is only support for the
739c609719bSwdenk		SYM53C8XX SCSI controller; define
740c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
741c609719bSwdenk
742c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
743c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
744c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
745c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
746c609719bSwdenk		devices.
747c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
748c609719bSwdenk
749c609719bSwdenk- NETWORK Support (PCI):
750682011ffSwdenk		CONFIG_E1000
751682011ffSwdenk		Support for Intel 8254x gigabit chips.
752682011ffSwdenk
753c609719bSwdenk		CONFIG_EEPRO100
754c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
755c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
756c609719bSwdenk		write routine for first time initialisation.
757c609719bSwdenk
758c609719bSwdenk		CONFIG_TULIP
759c609719bSwdenk		Support for Digital 2114x chips.
760c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
761c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
762c609719bSwdenk
763c609719bSwdenk		CONFIG_NATSEMI
764c609719bSwdenk		Support for National dp83815 chips.
765c609719bSwdenk
766c609719bSwdenk		CONFIG_NS8382X
767c609719bSwdenk		Support for National dp8382[01] gigabit chips.
768c609719bSwdenk
76945219c46Swdenk- NETWORK Support (other):
77045219c46Swdenk
77145219c46Swdenk		CONFIG_DRIVER_LAN91C96
77245219c46Swdenk		Support for SMSC's LAN91C96 chips.
77345219c46Swdenk
77445219c46Swdenk			CONFIG_LAN91C96_BASE
77545219c46Swdenk			Define this to hold the physical address
77645219c46Swdenk			of the LAN91C96's I/O space
77745219c46Swdenk
77845219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
77945219c46Swdenk			Define this to enable 32 bit addressing
78045219c46Swdenk
781f39748aeSwdenk		CONFIG_DRIVER_SMC91111
782f39748aeSwdenk		Support for SMSC's LAN91C111 chip
783f39748aeSwdenk
784f39748aeSwdenk			CONFIG_SMC91111_BASE
785f39748aeSwdenk			Define this to hold the physical address
786f39748aeSwdenk			of the device (I/O space)
787f39748aeSwdenk
788f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
789f39748aeSwdenk			Define this if data bus is 32 bits
790f39748aeSwdenk
791f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
792f39748aeSwdenk			Define this to use i/o functions instead of macros
793f39748aeSwdenk			(some hardware wont work with macros)
794f39748aeSwdenk
795c609719bSwdenk- USB Support:
796c609719bSwdenk		At the moment only the UHCI host controller is
7974d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
798c609719bSwdenk		CONFIG_USB_UHCI to enable it.
799c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
80030d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
801c609719bSwdenk		storage devices.
802c609719bSwdenk		Note:
803c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
804c609719bSwdenk		(TEAC FD-05PUB).
8054d13cbadSwdenk		MPC5200 USB requires additional defines:
8064d13cbadSwdenk			CONFIG_USB_CLOCK
8074d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8084d13cbadSwdenk			CONFIG_USB_CONFIG
8094d13cbadSwdenk				for differential drivers: 0x00001000
8104d13cbadSwdenk				for single ended drivers: 0x00005000
8114d13cbadSwdenk
812c609719bSwdenk
81371f95118Swdenk- MMC Support:
81471f95118Swdenk		The MMC controller on the Intel PXA is supported. To
81571f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
81671f95118Swdenk		accessed from the boot prompt by mapping the device
81771f95118Swdenk		to physical memory similar to flash. Command line is
81871f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
81971f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
82071f95118Swdenk
8216705d81eSwdenk- Journaling Flash filesystem support:
8226705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8236705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8246705d81eSwdenk		Define these for a default partition on a NAND device
8256705d81eSwdenk
8266705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8276705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8286705d81eSwdenk		Define these for a default partition on a NOR device
8296705d81eSwdenk
8306705d81eSwdenk		CFG_JFFS_CUSTOM_PART
8316705d81eSwdenk		Define this to create an own partition. You have to provide a
8326705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
8336705d81eSwdenk
8346705d81eSwdenk		If you define only one JFFS2 partition you may also want to
8356705d81eSwdenk		#define CFG_JFFS_SINGLE_PART    1
8366705d81eSwdenk		to disable the command chpart. This is the default when you
8376705d81eSwdenk		have not defined a custom partition
8386705d81eSwdenk
839c609719bSwdenk- Keyboard Support:
840c609719bSwdenk		CONFIG_ISA_KEYBOARD
841c609719bSwdenk
842c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
843c609719bSwdenk		support
844c609719bSwdenk
845c609719bSwdenk		CONFIG_I8042_KBD
846c609719bSwdenk		Standard PC keyboard driver with US (is default) and
847c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
848c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
849c609719bSwdenk		for cfb_console. Supports cursor blinking.
850c609719bSwdenk
851c609719bSwdenk- Video support:
852c609719bSwdenk		CONFIG_VIDEO
853c609719bSwdenk
854c609719bSwdenk		Define this to enable video support (for output to
855c609719bSwdenk		video).
856c609719bSwdenk
857c609719bSwdenk		CONFIG_VIDEO_CT69000
858c609719bSwdenk
859c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
860c609719bSwdenk
861c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
862eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
863eeb1b77bSwdenk		video output is selected via environment 'videoout'
864eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
865eeb1b77bSwdenk		assumed.
866c609719bSwdenk
867eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
868eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
869eeb1b77bSwdenk		are possible:
870eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
871eeb1b77bSwdenk		Following standard modes are supported	(* is default):
872eeb1b77bSwdenk
873eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
874eeb1b77bSwdenk		-------------+---------------------------------------------
875eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
876eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
877eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
878eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
879eeb1b77bSwdenk		-------------+---------------------------------------------
880c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
881c609719bSwdenk
882eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
883eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
884eeb1b77bSwdenk
885eeb1b77bSwdenk
886a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
887a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
888a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
889a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
890a6c7ad2fSwdenk
891682011ffSwdenk- Keyboard Support:
892682011ffSwdenk		CONFIG_KEYBOARD
893682011ffSwdenk
894682011ffSwdenk		Define this to enable a custom keyboard support.
895682011ffSwdenk		This simply calls drv_keyboard_init() which must be
896682011ffSwdenk		defined in your board-specific files.
897682011ffSwdenk		The only board using this so far is RBC823.
898a6c7ad2fSwdenk
899c609719bSwdenk- LCD Support:	CONFIG_LCD
900c609719bSwdenk
901c609719bSwdenk		Define this to enable LCD support (for output to LCD
902c609719bSwdenk		display); also select one of the supported displays
903c609719bSwdenk		by defining one of these:
904c609719bSwdenk
905fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
906c609719bSwdenk
907fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
908c609719bSwdenk
909fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
910c609719bSwdenk
911fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
912fd3103bbSwdenk			Active, color, single scan.
913fd3103bbSwdenk
914fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
915fd3103bbSwdenk
916fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
917c609719bSwdenk			Active, color, single scan.
918c609719bSwdenk
919c609719bSwdenk		CONFIG_SHARP_16x9
920c609719bSwdenk
921c609719bSwdenk			Sharp 320x240. Active, color, single scan.
922c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
923c609719bSwdenk
924c609719bSwdenk		CONFIG_SHARP_LQ64D341
925c609719bSwdenk
926c609719bSwdenk			Sharp LQ64D341 display, 640x480.
927c609719bSwdenk			Active, color, single scan.
928c609719bSwdenk
929c609719bSwdenk		CONFIG_HLD1045
930c609719bSwdenk
931c609719bSwdenk			HLD1045 display, 640x480.
932c609719bSwdenk			Active, color, single scan.
933c609719bSwdenk
934c609719bSwdenk		CONFIG_OPTREX_BW
935c609719bSwdenk
936c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
937c609719bSwdenk			or
938c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
939c609719bSwdenk			or
940c609719bSwdenk			Hitachi	 SP14Q002
941c609719bSwdenk
942c609719bSwdenk			320x240. Black & white.
943c609719bSwdenk
944c609719bSwdenk		Normally display is black on white background; define
945c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
946c609719bSwdenk
9477152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
948d791b1dcSwdenk
949d791b1dcSwdenk		If this option is set, the environment is checked for
950d791b1dcSwdenk		a variable "splashimage". If found, the usual display
951d791b1dcSwdenk		of logo, copyright and system information on the LCD
952e94d2cd9Swdenk		is suppressed and the BMP image at the address
953d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
954d791b1dcSwdenk		console is redirected to the "nulldev", too. This
955d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
956d791b1dcSwdenk		loaded very quickly after power-on.
957d791b1dcSwdenk
958c29fdfc1Swdenk- Compression support:
959c29fdfc1Swdenk		CONFIG_BZIP2
960c29fdfc1Swdenk
961c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
962c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
963c29fdfc1Swdenk		compressed images are supported.
964c29fdfc1Swdenk
965c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
966c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
967c29fdfc1Swdenk		be at least 4MB.
968d791b1dcSwdenk
96917ea1177Swdenk- MII/PHY support:
97017ea1177Swdenk		CONFIG_PHY_ADDR
97117ea1177Swdenk
97217ea1177Swdenk		The address of PHY on MII bus.
97317ea1177Swdenk
97417ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
97517ea1177Swdenk
97617ea1177Swdenk		The clock frequency of the MII bus
97717ea1177Swdenk
97817ea1177Swdenk		CONFIG_PHY_GIGE
97917ea1177Swdenk
98017ea1177Swdenk		If this option is set, support for speed/duplex
98117ea1177Swdenk		detection of Gigabit PHY is included.
98217ea1177Swdenk
98317ea1177Swdenk		CONFIG_PHY_RESET_DELAY
98417ea1177Swdenk
98517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
98617ea1177Swdenk		reset before any MII register access is possible.
98717ea1177Swdenk		For such PHY, set this option to the usec delay
98817ea1177Swdenk		required. (minimum 300usec for LXT971A)
98917ea1177Swdenk
99017ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
99117ea1177Swdenk
99217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
99317ea1177Swdenk		command issued before MII status register can be read
99417ea1177Swdenk
995c609719bSwdenk- Ethernet address:
996c609719bSwdenk		CONFIG_ETHADDR
997c609719bSwdenk		CONFIG_ETH2ADDR
998c609719bSwdenk		CONFIG_ETH3ADDR
999c609719bSwdenk
1000c609719bSwdenk		Define a default value for ethernet address to use
1001c609719bSwdenk		for the respective ethernet interface, in case this
1002c609719bSwdenk		is not determined automatically.
1003c609719bSwdenk
1004c609719bSwdenk- IP address:
1005c609719bSwdenk		CONFIG_IPADDR
1006c609719bSwdenk
1007c609719bSwdenk		Define a default value for the IP address to use for
1008c609719bSwdenk		the default ethernet interface, in case this is not
1009c609719bSwdenk		determined through e.g. bootp.
1010c609719bSwdenk
1011c609719bSwdenk- Server IP address:
1012c609719bSwdenk		CONFIG_SERVERIP
1013c609719bSwdenk
1014c609719bSwdenk		Defines a default value for theIP address of a TFTP
1015c609719bSwdenk		server to contact when using the "tftboot" command.
1016c609719bSwdenk
1017c609719bSwdenk- BOOTP Recovery Mode:
1018c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1019c609719bSwdenk
1020c609719bSwdenk		If you have many targets in a network that try to
1021c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1022c609719bSwdenk		systems send out BOOTP requests at precisely the same
1023c609719bSwdenk		moment (which would happen for instance at recovery
1024c609719bSwdenk		from a power failure, when all systems will try to
1025c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1026c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1027c609719bSwdenk		inserted before sending out BOOTP requests. The
1028c609719bSwdenk		following delays are insterted then:
1029c609719bSwdenk
1030c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1031c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1032c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1033c609719bSwdenk		4th and following
1034c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1035c609719bSwdenk
1036fe389a82Sstroese- DHCP Advanced Options:
1037fe389a82Sstroese		CONFIG_BOOTP_MASK
1038fe389a82Sstroese
1039fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1040fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1041fe389a82Sstroese
1042fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1043fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1044fe389a82Sstroese		than one DNS serverip is offered to the client.
1045fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1046fe389a82Sstroese		serverip will be stored in the additional environment
1047fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1048fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1049fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1050fe389a82Sstroese
1051fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1052fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1053fe389a82Sstroese		need the hostname of the DHCP requester.
1054fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1055fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1056fe389a82Sstroese		environment variable is passed as option 12 to
1057fe389a82Sstroese		the DHCP server.
1058fe389a82Sstroese
1059a3d991bdSwdenk - CDP Options:
1060a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1061a3d991bdSwdenk
1062a3d991bdSwdenk		The device id used in CDP trigger frames.
1063a3d991bdSwdenk
1064a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1065a3d991bdSwdenk
1066a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1067a3d991bdSwdenk		of the device.
1068a3d991bdSwdenk
1069a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1070a3d991bdSwdenk
1071a3d991bdSwdenk		A printf format string which contains the ascii name of
1072a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1073a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1074a3d991bdSwdenk
1075a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1076a3d991bdSwdenk
1077a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1078a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1079a3d991bdSwdenk
1080a3d991bdSwdenk		CONFIG_CDP_VERSION
1081a3d991bdSwdenk
1082a3d991bdSwdenk		An ascii string containing the version of the software.
1083a3d991bdSwdenk
1084a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1085a3d991bdSwdenk
1086a3d991bdSwdenk		An ascii string containing the name of the platform.
1087a3d991bdSwdenk
1088a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1089a3d991bdSwdenk
1090a3d991bdSwdenk		A 32bit integer sent on the trigger.
1091a3d991bdSwdenk
1092a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1093a3d991bdSwdenk
1094a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1095a3d991bdSwdenk		device in .1 of milliwatts.
1096a3d991bdSwdenk
1097a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1098a3d991bdSwdenk
1099a3d991bdSwdenk		A byte containing the id of the VLAN.
1100a3d991bdSwdenk
1101c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1102c609719bSwdenk
1103c609719bSwdenk		Several configurations allow to display the current
1104c609719bSwdenk		status using a LED. For instance, the LED will blink
1105c609719bSwdenk		fast while running U-Boot code, stop blinking as
1106c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1107c609719bSwdenk		start blinking slow once the Linux kernel is running
1108c609719bSwdenk		(supported by a status LED driver in the Linux
1109c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1110c609719bSwdenk		feature in U-Boot.
1111c609719bSwdenk
1112c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1113c609719bSwdenk
1114c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1115c609719bSwdenk		on those systems that support this (optional)
1116c609719bSwdenk		feature, like the TQM8xxL modules.
1117c609719bSwdenk
1118c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1119c609719bSwdenk
1120b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1121b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1122b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1123c609719bSwdenk
1124b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1125b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1126b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1127b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1128c609719bSwdenk		command line interface.
1129c609719bSwdenk
1130b37c7e5eSwdenk		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1131c609719bSwdenk
1132b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1133b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1134b37c7e5eSwdenk		support for I2C.
1135c609719bSwdenk
1136b37c7e5eSwdenk		There are several other quantities that must also be
1137b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1138c609719bSwdenk
1139b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1140b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1141b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1142b37c7e5eSwdenk		the cpu's i2c node address).
1143c609719bSwdenk
1144b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1145b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1146b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1147b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1148b37c7e5eSwdenk
1149b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1150b37c7e5eSwdenk
1151b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1152b37c7e5eSwdenk		then the following macros need to be defined (examples are
1153b37c7e5eSwdenk		from include/configs/lwmon.h):
1154c609719bSwdenk
1155c609719bSwdenk		I2C_INIT
1156c609719bSwdenk
1157b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1158c609719bSwdenk		controller or configure ports.
1159c609719bSwdenk
1160b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1161b37c7e5eSwdenk
1162c609719bSwdenk		I2C_PORT
1163c609719bSwdenk
1164c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1165c609719bSwdenk		assumes both bits are on the same port). Valid values
1166c609719bSwdenk		are 0..3 for ports A..D.
1167c609719bSwdenk
1168c609719bSwdenk		I2C_ACTIVE
1169c609719bSwdenk
1170c609719bSwdenk		The code necessary to make the I2C data line active
1171c609719bSwdenk		(driven).  If the data line is open collector, this
1172c609719bSwdenk		define can be null.
1173c609719bSwdenk
1174b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1175b37c7e5eSwdenk
1176c609719bSwdenk		I2C_TRISTATE
1177c609719bSwdenk
1178c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1179c609719bSwdenk		(inactive).  If the data line is open collector, this
1180c609719bSwdenk		define can be null.
1181c609719bSwdenk
1182b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1183b37c7e5eSwdenk
1184c609719bSwdenk		I2C_READ
1185c609719bSwdenk
1186c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1187c609719bSwdenk		FALSE if it is low.
1188c609719bSwdenk
1189b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1190b37c7e5eSwdenk
1191c609719bSwdenk		I2C_SDA(bit)
1192c609719bSwdenk
1193c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1194c609719bSwdenk		is FALSE, it clears it (low).
1195c609719bSwdenk
1196b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1197b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1198b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1199b37c7e5eSwdenk
1200c609719bSwdenk		I2C_SCL(bit)
1201c609719bSwdenk
1202c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1203c609719bSwdenk		is FALSE, it clears it (low).
1204c609719bSwdenk
1205b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1206b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1207b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1208b37c7e5eSwdenk
1209c609719bSwdenk		I2C_DELAY
1210c609719bSwdenk
1211c609719bSwdenk		This delay is invoked four times per clock cycle so this
1212c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1213b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1214b37c7e5eSwdenk		like:
1215b37c7e5eSwdenk
1216b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1217c609719bSwdenk
121847cd00faSwdenk		CFG_I2C_INIT_BOARD
121947cd00faSwdenk
122047cd00faSwdenk		When a board is reset during an i2c bus transfer
122147cd00faSwdenk		chips might think that the current transfer is still
122247cd00faSwdenk		in progress. On some boards it is possible to access
122347cd00faSwdenk		the i2c SCLK line directly, either by using the
122447cd00faSwdenk		processor pin as a GPIO or by having a second pin
122547cd00faSwdenk		connected to the bus. If this option is defined a
122647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
122747cd00faSwdenk		is run early in the boot sequence.
122847cd00faSwdenk
122917ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
123017ea1177Swdenk
123117ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
123217ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
123317ea1177Swdenk		variable "i2cfast". (see also i2cfast)
123417ea1177Swdenk
1235c609719bSwdenk- SPI Support:	CONFIG_SPI
1236c609719bSwdenk
1237c609719bSwdenk		Enables SPI driver (so far only tested with
1238c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1239c609719bSwdenk		D/As on the SACSng board)
1240c609719bSwdenk
1241c609719bSwdenk		CONFIG_SPI_X
1242c609719bSwdenk
1243c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1244c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1245c609719bSwdenk
1246c609719bSwdenk		CONFIG_SOFT_SPI
1247c609719bSwdenk
1248c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1249c609719bSwdenk		using hardware support. This is a general purpose
1250c609719bSwdenk		driver that only requires three general I/O port pins
1251c609719bSwdenk		(two outputs, one input) to function. If this is
1252c609719bSwdenk		defined, the board configuration must define several
1253c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1254c609719bSwdenk		an example, see include/configs/sacsng.h.
1255c609719bSwdenk
1256c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1257c609719bSwdenk
1258c609719bSwdenk		Specify the number of FPGA devices to support.
1259c609719bSwdenk
1260c609719bSwdenk		CONFIG_FPGA
1261c609719bSwdenk
1262c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1263c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1264c609719bSwdenk
1265c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1266c609719bSwdenk
1267c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1268c609719bSwdenk
1269c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1270c609719bSwdenk
1271c609719bSwdenk		Enable checks on FPGA configuration interface busy
1272c609719bSwdenk		status by the configuration function. This option
1273c609719bSwdenk		will require a board or device specific function to
1274c609719bSwdenk		be written.
1275c609719bSwdenk
1276c609719bSwdenk		CONFIG_FPGA_DELAY
1277c609719bSwdenk
1278c609719bSwdenk		If defined, a function that provides delays in the FPGA
1279c609719bSwdenk		configuration driver.
1280c609719bSwdenk
1281c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1282c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1283c609719bSwdenk
1284c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1285c609719bSwdenk
1286c609719bSwdenk		Check for configuration errors during FPGA bitfile
1287c609719bSwdenk		loading. For example, abort during Virtex II
1288c609719bSwdenk		configuration if the INIT_B line goes low (which
1289c609719bSwdenk		indicated a CRC error).
1290c609719bSwdenk
1291c609719bSwdenk		CFG_FPGA_WAIT_INIT
1292c609719bSwdenk
1293c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1294c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1295c609719bSwdenk		FPGA configuration sequence. The default time is 500
1296c609719bSwdenk		mS.
1297c609719bSwdenk
1298c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1299c609719bSwdenk
1300c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1301c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1302c609719bSwdenk
1303c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1304c609719bSwdenk
1305c609719bSwdenk		Time to wait after FPGA configuration. The default is
1306c609719bSwdenk		200 mS.
1307c609719bSwdenk
1308c609719bSwdenk- Configuration Management:
1309c609719bSwdenk		CONFIG_IDENT_STRING
1310c609719bSwdenk
1311c609719bSwdenk		If defined, this string will be added to the U-Boot
1312c609719bSwdenk		version information (U_BOOT_VERSION)
1313c609719bSwdenk
1314c609719bSwdenk- Vendor Parameter Protection:
1315c609719bSwdenk
1316c609719bSwdenk		U-Boot considers the values of the environment
1317c609719bSwdenk		variables "serial#" (Board Serial Number) and
13187152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1319c609719bSwdenk		are set once by the board vendor / manufacturer, and
1320c609719bSwdenk		protects these variables from casual modification by
1321c609719bSwdenk		the user. Once set, these variables are read-only,
1322c609719bSwdenk		and write or delete attempts are rejected. You can
1323c609719bSwdenk		change this behviour:
1324c609719bSwdenk
1325c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1326c609719bSwdenk		file, the write protection for vendor parameters is
132747cd00faSwdenk		completely disabled. Anybody can change or delete
1328c609719bSwdenk		these parameters.
1329c609719bSwdenk
1330c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1331c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1332c609719bSwdenk		ethernet address is installed in the environment,
1333c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1334c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1335c609719bSwdenk		read-only.]
1336c609719bSwdenk
1337c609719bSwdenk- Protected RAM:
1338c609719bSwdenk		CONFIG_PRAM
1339c609719bSwdenk
1340c609719bSwdenk		Define this variable to enable the reservation of
1341c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1342c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1343c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1344c609719bSwdenk		this default value by defining an environment
1345c609719bSwdenk		variable "pram" to the number of kB you want to
1346c609719bSwdenk		reserve. Note that the board info structure will
1347c609719bSwdenk		still show the full amount of RAM. If pRAM is
1348c609719bSwdenk		reserved, a new environment variable "mem" will
1349c609719bSwdenk		automatically be defined to hold the amount of
1350c609719bSwdenk		remaining RAM in a form that can be passed as boot
1351c609719bSwdenk		argument to Linux, for instance like that:
1352c609719bSwdenk
1353c609719bSwdenk			setenv bootargs ... mem=\$(mem)
1354c609719bSwdenk			saveenv
1355c609719bSwdenk
1356c609719bSwdenk		This way you can tell Linux not to use this memory,
1357c609719bSwdenk		either, which results in a memory region that will
1358c609719bSwdenk		not be affected by reboots.
1359c609719bSwdenk
1360c609719bSwdenk		*WARNING* If your board configuration uses automatic
1361c609719bSwdenk		detection of the RAM size, you must make sure that
1362c609719bSwdenk		this memory test is non-destructive. So far, the
1363c609719bSwdenk		following board configurations are known to be
1364c609719bSwdenk		"pRAM-clean":
1365c609719bSwdenk
1366c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1367c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1368c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1369c609719bSwdenk
1370c609719bSwdenk- Error Recovery:
1371c609719bSwdenk		CONFIG_PANIC_HANG
1372c609719bSwdenk
1373c609719bSwdenk		Define this variable to stop the system in case of a
1374c609719bSwdenk		fatal error, so that you have to reset it manually.
1375c609719bSwdenk		This is probably NOT a good idea for an embedded
1376c609719bSwdenk		system where you want to system to reboot
1377c609719bSwdenk		automatically as fast as possible, but it may be
1378c609719bSwdenk		useful during development since you can try to debug
1379c609719bSwdenk		the conditions that lead to the situation.
1380c609719bSwdenk
1381c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1382c609719bSwdenk
1383c609719bSwdenk		This variable defines the number of retries for
1384c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1385c609719bSwdenk		before giving up the operation. If not defined, a
1386c609719bSwdenk		default value of 5 is used.
1387c609719bSwdenk
1388c609719bSwdenk- Command Interpreter:
138904a85b3bSwdenk		CFG_AUTO_COMPLETE
139004a85b3bSwdenk
139104a85b3bSwdenk		Enable auto completion of commands using TAB.
139204a85b3bSwdenk
1393c609719bSwdenk		CFG_HUSH_PARSER
1394c609719bSwdenk
1395c609719bSwdenk		Define this variable to enable the "hush" shell (from
1396c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1397c609719bSwdenk		powerful command line syntax like
1398c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1399c609719bSwdenk		constructs ("shell scripts").
1400c609719bSwdenk
1401c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1402c609719bSwdenk		with a somewhat smaller memory footprint.
1403c609719bSwdenk
1404c609719bSwdenk
1405c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1406c609719bSwdenk
1407c609719bSwdenk		This defines the secondary prompt string, which is
1408c609719bSwdenk		printed when the command interpreter needs more input
1409c609719bSwdenk		to complete a command. Usually "> ".
1410c609719bSwdenk
1411c609719bSwdenk	Note:
1412c609719bSwdenk
1413c609719bSwdenk		In the current implementation, the local variables
1414c609719bSwdenk		space and global environment variables space are
1415c609719bSwdenk		separated. Local variables are those you define by
14163b57fe0aSwdenk		simply typing `name=value'. To access a local
1417c609719bSwdenk		variable later on, you have write `$name' or
14183b57fe0aSwdenk		`${name}'; to execute the contents of a variable
14193b57fe0aSwdenk		directly type `$name' at the command prompt.
1420c609719bSwdenk
1421c609719bSwdenk		Global environment variables are those you use
1422c609719bSwdenk		setenv/printenv to work with. To run a command stored
1423c609719bSwdenk		in such a variable, you need to use the run command,
1424c609719bSwdenk		and you must not use the '$' sign to access them.
1425c609719bSwdenk
1426c609719bSwdenk		To store commands and special characters in a
1427c609719bSwdenk		variable, please use double quotation marks
1428c609719bSwdenk		surrounding the whole text of the variable, instead
1429c609719bSwdenk		of the backslashes before semicolons and special
1430c609719bSwdenk		symbols.
1431c609719bSwdenk
1432a8c7c708Swdenk- Default Environment:
1433c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1434c609719bSwdenk
1435c609719bSwdenk		Define this to contain any number of null terminated
1436c609719bSwdenk		strings (variable = value pairs) that will be part of
14377152b1d0Swdenk		the default environment compiled into the boot image.
14382262cfeeSwdenk
1439c609719bSwdenk		For example, place something like this in your
1440c609719bSwdenk		board's config file:
1441c609719bSwdenk
1442c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1443c609719bSwdenk			"myvar1=value1\0" \
1444c609719bSwdenk			"myvar2=value2\0"
1445c609719bSwdenk
1446c609719bSwdenk		Warning: This method is based on knowledge about the
1447c609719bSwdenk		internal format how the environment is stored by the
14482262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1449c609719bSwdenk		interface! Although it is unlikely that this format
14507152b1d0Swdenk		will change soon, there is no guarantee either.
1451c609719bSwdenk		You better know what you are doing here.
1452c609719bSwdenk
1453c609719bSwdenk		Note: overly (ab)use of the default environment is
1454c609719bSwdenk		discouraged. Make sure to check other ways to preset
1455c609719bSwdenk		the environment like the autoscript function or the
1456c609719bSwdenk		boot command first.
1457c609719bSwdenk
1458a8c7c708Swdenk- DataFlash Support:
14592abbe075Swdenk		CONFIG_HAS_DATAFLASH
14602abbe075Swdenk
14612abbe075Swdenk		Defining this option enables DataFlash features and
14622abbe075Swdenk		allows to read/write in Dataflash via the standard
14632abbe075Swdenk		commands cp, md...
14642abbe075Swdenk
14653f85ce27Swdenk- SystemACE Support:
14663f85ce27Swdenk		CONFIG_SYSTEMACE
14673f85ce27Swdenk
14683f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
14693f85ce27Swdenk		chips attached via some sort of local bus. The address
14703f85ce27Swdenk		of the chip must alsh be defined in the
14713f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
14723f85ce27Swdenk
14733f85ce27Swdenk		#define CONFIG_SYSTEMACE
14743f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
14753f85ce27Swdenk
14763f85ce27Swdenk		When SystemACE support is added, the "ace" device type
14773f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
14783f85ce27Swdenk
1479a8c7c708Swdenk- Show boot progress:
1480c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1481c609719bSwdenk
1482c609719bSwdenk		Defining this option allows to add some board-
1483c609719bSwdenk		specific code (calling a user-provided function
1484c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1485c609719bSwdenk		the system's boot progress on some display (for
1486c609719bSwdenk		example, some LED's) on your board. At the moment,
1487c609719bSwdenk		the following checkpoints are implemented:
1488c609719bSwdenk
1489c609719bSwdenk  Arg	Where			When
1490c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1491c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1492c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1493c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1494c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1495c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1496c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1497c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1498c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1499c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1500c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1501c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1502c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1503c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1504c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1505c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1506c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1507c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1508c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1509c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1510c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1511c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1512c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1513c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1514c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1515c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1516c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1517c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1518c609719bSwdenk
151963e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
152063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
152163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
152263e73c9aSwdenk
1523c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1524c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1525c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1526c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1527c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1528c609719bSwdenk
1529c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1530c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1531c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1532c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1533c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1534c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1535c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1536c609719bSwdenk
1537206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1538206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1539206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1540206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1541206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1542206c60cbSwdenk
1543206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1544c609719bSwdenk
1545c609719bSwdenk
1546c609719bSwdenkModem Support:
1547c609719bSwdenk--------------
1548c609719bSwdenk
154985ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1550c609719bSwdenk
1551c609719bSwdenk- Modem support endable:
1552c609719bSwdenk		CONFIG_MODEM_SUPPORT
1553c609719bSwdenk
1554c609719bSwdenk- RTS/CTS Flow control enable:
1555c609719bSwdenk		CONFIG_HWFLOW
1556c609719bSwdenk
1557c609719bSwdenk- Modem debug support:
1558c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1559c609719bSwdenk
1560c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1561c609719bSwdenk		for modem support. Useful only with BDI2000.
1562c609719bSwdenk
1563a8c7c708Swdenk- Interrupt support (PPC):
1564a8c7c708Swdenk
1565a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1566a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1567a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1568a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1569a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1570a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1571a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1572a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1573a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1574a8c7c708Swdenk		general timer_interrupt().
1575a8c7c708Swdenk
1576c609719bSwdenk- General:
1577c609719bSwdenk
1578c609719bSwdenk		In the target system modem support is enabled when a
1579c609719bSwdenk		specific key (key combination) is pressed during
1580c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1581c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1582c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1583c609719bSwdenk		function, returning 1 and thus enabling modem
1584c609719bSwdenk		initialization.
1585c609719bSwdenk
1586c609719bSwdenk		If there are no modem init strings in the
1587c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1588c609719bSwdenk		previous output (banner, info printfs) will be
1589c609719bSwdenk		supressed, though.
1590c609719bSwdenk
1591c609719bSwdenk		See also: doc/README.Modem
1592c609719bSwdenk
1593c609719bSwdenk
1594c609719bSwdenkConfiguration Settings:
1595c609719bSwdenk-----------------------
1596c609719bSwdenk
1597c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1598c609719bSwdenk		undefine this when you're short of memory.
1599c609719bSwdenk
1600c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1601c609719bSwdenk		prompt for user input.
1602c609719bSwdenk
1603c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1604c609719bSwdenk
1605c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1606c609719bSwdenk
1607c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1608c609719bSwdenk
1609c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1610c609719bSwdenk		the application (usually a Linux kernel) when it is
1611c609719bSwdenk		booted
1612c609719bSwdenk
1613c609719bSwdenk- CFG_BAUDRATE_TABLE:
1614c609719bSwdenk		List of legal baudrate settings for this board.
1615c609719bSwdenk
1616c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1617c609719bSwdenk		Suppress display of console information at boot.
1618c609719bSwdenk
1619c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1620c609719bSwdenk		If the board specific function
1621c609719bSwdenk			extern int overwrite_console (void);
1622c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1623c609719bSwdenk		serial port, else the settings in the environment are used.
1624c609719bSwdenk
1625c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1626c609719bSwdenk		Enable the call to overwrite_console().
1627c609719bSwdenk
1628c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1629c609719bSwdenk		Enable overwrite of previous console environment settings.
1630c609719bSwdenk
1631c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1632c609719bSwdenk		Begin and End addresses of the area used by the
1633c609719bSwdenk		simple memory test.
1634c609719bSwdenk
1635c609719bSwdenk- CFG_ALT_MEMTEST:
1636c609719bSwdenk		Enable an alternate, more extensive memory test.
1637c609719bSwdenk
16385f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
16395f535fe1Swdenk		Scratch address used by the alternate memory test
16405f535fe1Swdenk		You only need to set this if address zero isn't writeable
16415f535fe1Swdenk
1642c609719bSwdenk- CFG_TFTP_LOADADDR:
1643c609719bSwdenk		Default load address for network file downloads
1644c609719bSwdenk
1645c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1646c609719bSwdenk		Enable temporary baudrate change while serial download
1647c609719bSwdenk
1648c609719bSwdenk- CFG_SDRAM_BASE:
1649c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1650c609719bSwdenk
1651c609719bSwdenk- CFG_MBIO_BASE:
1652c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1653c609719bSwdenk		Cogent motherboard)
1654c609719bSwdenk
1655c609719bSwdenk- CFG_FLASH_BASE:
1656c609719bSwdenk		Physical start address of Flash memory.
1657c609719bSwdenk
1658c609719bSwdenk- CFG_MONITOR_BASE:
1659c609719bSwdenk		Physical start address of boot monitor code (set by
1660c609719bSwdenk		make config files to be same as the text base address
1661c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1662c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1663c609719bSwdenk
1664c609719bSwdenk- CFG_MONITOR_LEN:
16653b57fe0aSwdenk		Size of memory reserved for monitor code, used to
16663b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
16673b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
16683b57fe0aSwdenk		flash sector.
1669c609719bSwdenk
1670c609719bSwdenk- CFG_MALLOC_LEN:
1671c609719bSwdenk		Size of DRAM reserved for malloc() use.
1672c609719bSwdenk
1673c609719bSwdenk- CFG_BOOTMAPSZ:
1674c609719bSwdenk		Maximum size of memory mapped by the startup code of
1675c609719bSwdenk		the Linux kernel; all data that must be processed by
1676c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1677c609719bSwdenk		initrd image) must be put below this limit.
1678c609719bSwdenk
1679c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1680c609719bSwdenk		Max number of Flash memory banks
1681c609719bSwdenk
1682c609719bSwdenk- CFG_MAX_FLASH_SECT:
1683c609719bSwdenk		Max number of sectors on a Flash chip
1684c609719bSwdenk
1685c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1686c609719bSwdenk		Timeout for Flash erase operations (in ms)
1687c609719bSwdenk
1688c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1689c609719bSwdenk		Timeout for Flash write operations (in ms)
1690c609719bSwdenk
16918564acf9Swdenk- CFG_FLASH_LOCK_TOUT
16928564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
16938564acf9Swdenk
16948564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
16958564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
16968564acf9Swdenk
16978564acf9Swdenk- CFG_FLASH_PROTECTION
16988564acf9Swdenk		If defined, hardware flash sectors protection is used
16998564acf9Swdenk		instead of U-Boot software protection.
17008564acf9Swdenk
1701c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1702c609719bSwdenk
1703c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1704c609719bSwdenk		without this option such a download has to be
1705c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1706c609719bSwdenk		copy from RAM to flash.
1707c609719bSwdenk
1708c609719bSwdenk		The two-step approach is usually more reliable, since
1709c609719bSwdenk		you can check if the download worked before you erase
1710c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1711c609719bSwdenk		too limited to allow for a tempory copy of the
1712c609719bSwdenk		downloaded image) this option may be very useful.
1713c609719bSwdenk
1714c609719bSwdenk- CFG_FLASH_CFI:
1715c609719bSwdenk		Define if the flash driver uses extra elements in the
17165653fc33Swdenk		common flash structure for storing flash geometry.
17175653fc33Swdenk
17185653fc33Swdenk- CFG_FLASH_CFI_DRIVER
17195653fc33Swdenk		This option also enables the building of the cfi_flash driver
17205653fc33Swdenk		in the drivers directory
172153cf9435Sstroese
172253cf9435Sstroese- CFG_RX_ETH_BUFFER:
172353cf9435Sstroese		Defines the number of ethernet receive buffers. On some
172453cf9435Sstroese		ethernet controllers it is recommended to set this value
172553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
172653cf9435Sstroese		buffers can be full shortly after enabling the interface
172753cf9435Sstroese		on high ethernet traffic.
172853cf9435Sstroese		Defaults to 4 if not defined.
1729c609719bSwdenk
1730c609719bSwdenkThe following definitions that deal with the placement and management
1731c609719bSwdenkof environment data (variable area); in general, we support the
1732c609719bSwdenkfollowing configurations:
1733c609719bSwdenk
1734c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1735c609719bSwdenk
1736c609719bSwdenk	Define this if the environment is in flash memory.
1737c609719bSwdenk
1738c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1739c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1740c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1741c609719bSwdenk	   sector" type flash chips, which have several smaller
1742c609719bSwdenk	   sectors at the start or the end. For instance, such a
1743c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1744c609719bSwdenk	   such a case you would place the environment in one of the
1745c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1746c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1747c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1748c609719bSwdenk	   between U-Boot and the environment.
1749c609719bSwdenk
1750c609719bSwdenk	- CFG_ENV_OFFSET:
1751c609719bSwdenk
1752c609719bSwdenk	   Offset of environment data (variable area) to the
1753c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1754c609719bSwdenk	   type flash chips the second sector can be used: the offset
1755c609719bSwdenk	   for this sector is given here.
1756c609719bSwdenk
1757c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1758c609719bSwdenk
1759c609719bSwdenk	- CFG_ENV_ADDR:
1760c609719bSwdenk
1761c609719bSwdenk	   This is just another way to specify the start address of
1762c609719bSwdenk	   the flash sector containing the environment (instead of
1763c609719bSwdenk	   CFG_ENV_OFFSET).
1764c609719bSwdenk
1765c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1766c609719bSwdenk
1767c609719bSwdenk	   Size of the sector containing the environment.
1768c609719bSwdenk
1769c609719bSwdenk
1770c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1771c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1772c609719bSwdenk	   the environment.
1773c609719bSwdenk
1774c609719bSwdenk	- CFG_ENV_SIZE:
1775c609719bSwdenk
1776c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1777c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1778c609719bSwdenk	   of this flash sector for the environment. This saves
1779c609719bSwdenk	   memory for the RAM copy of the environment.
1780c609719bSwdenk
1781c609719bSwdenk	   It may also save flash memory if you decide to use this
1782c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1783c609719bSwdenk	   since then the remainder of the flash sector could be used
1784c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1785c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1786c609719bSwdenk	   updating the environment in flash makes it always
1787c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1788c609719bSwdenk	   wrong before the contents has been restored from a copy in
1789c609719bSwdenk	   RAM, your target system will be dead.
1790c609719bSwdenk
1791c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1792c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1793c609719bSwdenk
1794c609719bSwdenk	   These settings describe a second storage area used to hold
1795c609719bSwdenk	   a redundand copy of the environment data, so that there is
17963e38691eSwdenk	   a valid backup copy in case there is a power failure during
1797c609719bSwdenk	   a "saveenv" operation.
1798c609719bSwdenk
1799c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1800c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1801c609719bSwdenkaccordingly!
1802c609719bSwdenk
1803c609719bSwdenk
1804c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1805c609719bSwdenk
1806c609719bSwdenk	Define this if you have some non-volatile memory device
1807c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1808c609719bSwdenk	environment.
1809c609719bSwdenk
1810c609719bSwdenk	- CFG_ENV_ADDR:
1811c609719bSwdenk	- CFG_ENV_SIZE:
1812c609719bSwdenk
1813c609719bSwdenk	  These two #defines are used to determin the memory area you
1814c609719bSwdenk	  want to use for environment. It is assumed that this memory
1815c609719bSwdenk	  can just be read and written to, without any special
1816c609719bSwdenk	  provision.
1817c609719bSwdenk
1818c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
1819c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
1820c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
1821c609719bSwdenkU-Boot will hang.
1822c609719bSwdenk
1823c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
1824c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
1825c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
1826c609719bSwdenkto save the current settings.
1827c609719bSwdenk
1828c609719bSwdenk
1829c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
1830c609719bSwdenk
1831c609719bSwdenk	Use this if you have an EEPROM or similar serial access
1832c609719bSwdenk	device and a driver for it.
1833c609719bSwdenk
1834c609719bSwdenk	- CFG_ENV_OFFSET:
1835c609719bSwdenk	- CFG_ENV_SIZE:
1836c609719bSwdenk
1837c609719bSwdenk	  These two #defines specify the offset and size of the
1838c609719bSwdenk	  environment area within the total memory of your EEPROM.
1839c609719bSwdenk
1840c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
1841c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
1842c609719bSwdenk	  The default address is zero.
1843c609719bSwdenk
1844c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
1845c609719bSwdenk	  If defined, the number of bits used to address bytes in a
1846c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
1847c609719bSwdenk	  would require six bits.
1848c609719bSwdenk
1849c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1850c609719bSwdenk	  If defined, the number of milliseconds to delay between
1851c609719bSwdenk	  page writes.	The default is zero milliseconds.
1852c609719bSwdenk
1853c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
1854c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
1855c609719bSwdenk	  that this is NOT the chip address length!
1856c609719bSwdenk
18575cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
18585cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
18595cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
18605cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
18615cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
18625cf91d6bSwdenk	  byte chips.
18635cf91d6bSwdenk
18645cf91d6bSwdenk	  Note that we consider the length of the address field to
18655cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
18665cf91d6bSwdenk	  in the chip address.
18675cf91d6bSwdenk
1868c609719bSwdenk	- CFG_EEPROM_SIZE:
1869c609719bSwdenk	  The size in bytes of the EEPROM device.
1870c609719bSwdenk
1871c609719bSwdenk
18725779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
18735779d8d9Swdenk
18745779d8d9Swdenk	Define this if you have a DataFlash memory device which you
18755779d8d9Swdenk	want to use for the environment.
18765779d8d9Swdenk
18775779d8d9Swdenk	- CFG_ENV_OFFSET:
18785779d8d9Swdenk	- CFG_ENV_ADDR:
18795779d8d9Swdenk	- CFG_ENV_SIZE:
18805779d8d9Swdenk
18815779d8d9Swdenk	  These three #defines specify the offset and size of the
18825779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
18835779d8d9Swdenk	  at the specified address.
18845779d8d9Swdenk
188513a5695bSwdenk- CFG_ENV_IS_IN_NAND:
188613a5695bSwdenk
188713a5695bSwdenk	Define this if you have a NAND device which you want to use
188813a5695bSwdenk	for the environment.
188913a5695bSwdenk
189013a5695bSwdenk	- CFG_ENV_OFFSET:
189113a5695bSwdenk	- CFG_ENV_SIZE:
189213a5695bSwdenk
189313a5695bSwdenk	  These two #defines specify the offset and size of the environment
189413a5695bSwdenk	  area within the first NAND device.
18955779d8d9Swdenk
1896c609719bSwdenk- CFG_SPI_INIT_OFFSET
1897c609719bSwdenk
1898c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
1899c609719bSwdenk	area is used at an early stage (ROM part) if the environment
1900c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
1901c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
1902c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
1903c609719bSwdenk	to be a good choice since it makes it far enough from the
1904c609719bSwdenk	start of the data area as well as from the stack pointer.
1905c609719bSwdenk
1906c609719bSwdenkPlease note that the environment is read-only as long as the monitor
1907c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
1908c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
1909c609719bSwdenkuntil then to read environment variables.
1910c609719bSwdenk
191185ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
191285ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
191385ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
191485ec0bccSwdenknecessary, because the first environment variable we need is the
191585ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
191685ec0bccSwdenkhave any device yet where we could complain.]
1917c609719bSwdenk
1918c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
1919c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
192085ec0bccSwdenkuse the "saveenv" command to store a valid environment.
1921c609719bSwdenk
1922fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
1923fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
1924fc3e2165Swdenk
1925fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
1926fc3e2165Swdenk		      also needs to be defined.
1927fc3e2165Swdenk
1928fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
1929fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
1930c609719bSwdenk
1931c40b2956Swdenk- CFG_64BIT_VSPRINTF:
1932c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
1933c40b2956Swdenk		of 64bit values by using the L quantifier
1934c40b2956Swdenk
1935c40b2956Swdenk- CFG_64BIT_STRTOUL:
1936c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
1937c40b2956Swdenk
1938c609719bSwdenkLow Level (hardware related) configuration options:
1939dc7c9a1aSwdenk---------------------------------------------------
1940c609719bSwdenk
1941c609719bSwdenk- CFG_CACHELINE_SIZE:
1942c609719bSwdenk		Cache Line Size of the CPU.
1943c609719bSwdenk
1944c609719bSwdenk- CFG_DEFAULT_IMMR:
1945c609719bSwdenk		Default address of the IMMR after system reset.
19462535d602Swdenk
19472535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
19482535d602Swdenk		and RPXsuper) to be able to adjust the position of
19492535d602Swdenk		the IMMR register after a reset.
1950c609719bSwdenk
19517f6c2cbcSwdenk- Floppy Disk Support:
19527f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
19537f6c2cbcSwdenk
19547f6c2cbcSwdenk		the default drive number (default value 0)
19557f6c2cbcSwdenk
19567f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
19577f6c2cbcSwdenk
19587f6c2cbcSwdenk		defines the spacing between fdc chipset registers
19597f6c2cbcSwdenk		(default value 1)
19607f6c2cbcSwdenk
19617f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
19627f6c2cbcSwdenk
19637f6c2cbcSwdenk		defines the offset of register from address. It
19647f6c2cbcSwdenk		depends on which part of the data bus is connected to
19657f6c2cbcSwdenk		the fdc chipset. (default value 0)
19667f6c2cbcSwdenk
19677f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
19687f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
19697f6c2cbcSwdenk		default value.
19707f6c2cbcSwdenk
19717f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
19727f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
19737f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
19747f6c2cbcSwdenk		source code. It is used to make hardware dependant
19757f6c2cbcSwdenk		initializations.
19767f6c2cbcSwdenk
1977c609719bSwdenk- CFG_IMMR:	Physical address of the Internal Memory Mapped
1978c609719bSwdenk		Register; DO NOT CHANGE! (11-4)
1979c609719bSwdenk		[MPC8xx systems only]
1980c609719bSwdenk
1981c609719bSwdenk- CFG_INIT_RAM_ADDR:
1982c609719bSwdenk
19837152b1d0Swdenk		Start address of memory area that can be used for
1984c609719bSwdenk		initial data and stack; please note that this must be
1985c609719bSwdenk		writable memory that is working WITHOUT special
1986c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
1987c609719bSwdenk		will become available only after programming the
1988c609719bSwdenk		memory controller and running certain initialization
1989c609719bSwdenk		sequences.
1990c609719bSwdenk
1991c609719bSwdenk		U-Boot uses the following memory types:
1992c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
1993c609719bSwdenk		- MPC824X: data cache
1994c609719bSwdenk		- PPC4xx:  data cache
1995c609719bSwdenk
199685ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
1997c609719bSwdenk
1998c609719bSwdenk		Offset of the initial data structure in the memory
1999c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
200085ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2001c609719bSwdenk		data is located at the end of the available space
2002c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2003c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2004c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
200585ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2006c609719bSwdenk
2007c609719bSwdenk	Note:
2008c609719bSwdenk		On the MPC824X (or other systems that use the data
2009c609719bSwdenk		cache for initial memory) the address chosen for
2010c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2011c609719bSwdenk		point to an otherwise UNUSED address space between
2012c609719bSwdenk		the top of RAM and the start of the PCI space.
2013c609719bSwdenk
2014c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2015c609719bSwdenk
2016c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2017c609719bSwdenk
2018c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2019c609719bSwdenk
2020c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2021c609719bSwdenk
2022c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2023c609719bSwdenk
2024c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2025c609719bSwdenk
2026c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2027c609719bSwdenk		SDRAM timing
2028c609719bSwdenk
2029c609719bSwdenk- CFG_MAMR_PTA:
2030c609719bSwdenk		periodic timer for refresh
2031c609719bSwdenk
2032c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2033c609719bSwdenk
2034c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2035c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2036c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2037c609719bSwdenk  CFG_BR1_PRELIM:
2038c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2039c609719bSwdenk
2040c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2041c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2042c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2043c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2044c609719bSwdenk
2045c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2046c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2047c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2048c609719bSwdenk		Prescaler definitions (SDRAM timing)
2049c609719bSwdenk
2050c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2051c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2052c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2053c609719bSwdenk
2054c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2055c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2056c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2057c609719bSwdenk
2058c609719bSwdenk- CFG_USE_OSCCLK:
2059c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2060c609719bSwdenk		wrong setting might damage your board. Read
2061c609719bSwdenk		doc/README.MBX before setting this variable!
2062c609719bSwdenk
2063ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2064ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2065ea909b76Swdenk		(Power On Self Tests). This definition overrides
2066ea909b76Swdenk		#define'd default value in commproc.h resp.
2067ea909b76Swdenk		cpm_8260.h.
2068ea909b76Swdenk
20695d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
20705d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
20715d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
20725d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
20735d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
20745d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
20755d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
20765d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
20775d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
20785d232d0eSwdenk
2079c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2080c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2081c26e454dSwdenk
2082c26e454dSwdenk- CONFIG_FEC[12]_PHY
2083c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
20846e592385Swdenk		to the given FEC; i. e.
2085c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2086c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2087c26e454dSwdenk
2088c26e454dSwdenk		When set to -1, means to probe for first available.
2089c26e454dSwdenk
2090c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2091c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2092c26e454dSwdenk		(so program the FEC to ignore it).
2093c26e454dSwdenk
2094c26e454dSwdenk- CONFIG_RMII
2095c26e454dSwdenk		Enable RMII mode for all FECs.
2096c26e454dSwdenk		Note that this is a global option, we can't
2097c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2098c26e454dSwdenk
20995cf91d6bSwdenk- CONFIG_CRC32_VERIFY
21005cf91d6bSwdenk		Add a verify option to the crc32 command.
21015cf91d6bSwdenk		The syntax is:
21025cf91d6bSwdenk
21035cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
21045cf91d6bSwdenk
21055cf91d6bSwdenk		Where address/count indicate a memory area
21065cf91d6bSwdenk		and crc32 is the correct crc32 which the
21075cf91d6bSwdenk		area should have.
21085cf91d6bSwdenk
210956523f12Swdenk- CONFIG_LOOPW
211056523f12Swdenk		Add the "loopw" memory command. This only takes effect if
211156523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
211256523f12Swdenk
2113c609719bSwdenkBuilding the Software:
2114c609719bSwdenk======================
2115c609719bSwdenk
2116c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2117c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2118c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2119c609719bSwdenkNetBSD 1.5 on x86).
2120c609719bSwdenk
2121c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2122c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2123c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2124c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2125c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2126c609719bSwdenkchange it to:
2127c609719bSwdenk
2128c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2129c609719bSwdenk
2130c609719bSwdenk
2131c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2132c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2133c609719bSwdenkis done by typing:
2134c609719bSwdenk
2135c609719bSwdenk	make NAME_config
2136c609719bSwdenk
2137c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2138c609719bSwdenkconfigurations; the following names are supported:
2139c609719bSwdenk
21401eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
21411eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
21421eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
21431eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
21441eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
21451eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
21461eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2147e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2148e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2149e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2150e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2151e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2152466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2153466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
21548b07a110Swdenk	EBONY_config		MPC8260ADS_config	SM850_config
21558b07a110Swdenk	ELPT860_config		MPC8540ADS_config	SPD823TS_config
21568b07a110Swdenk	ESTEEM192E_config	MPC8560ADS_config	stxgp3_config
21578b07a110Swdenk	ETX094_config		NETVIA_config		SXNI855T_config
21588b07a110Swdenk	FADS823_config		omap1510inn_config	TQM823L_config
21598b07a110Swdenk	FADS850SAR_config	omap1610h2_config	TQM850L_config
21608b07a110Swdenk	FADS860T_config		omap1610inn_config	TQM855L_config
21618b07a110Swdenk	FPS850L_config		omap5912osk_config	TQM860L_config
21628b07a110Swdenk							WALNUT405_config
21638b07a110Swdenk							ZPC1900_config
216454387ac9Swdenk
2165c609719bSwdenkNote: for some board special configuration names may exist; check if
2166c609719bSwdenk      additional information is available from the board vendor; for
21672729af9dSwdenk      instance, the TQM823L systems are available without (standard)
21682729af9dSwdenk      or with LCD support. You can select such additional "features"
2169c609719bSwdenk      when chosing the configuration, i. e.
2170c609719bSwdenk
21712729af9dSwdenk      make TQM823L_config
21722729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2173c609719bSwdenk
2174c609719bSwdenk      make TQM823L_LCD_config
2175c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2176c609719bSwdenk
2177c609719bSwdenk      etc.
2178c609719bSwdenk
2179c609719bSwdenk
2180c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
21817152b1d0Swdenkimages ready for download to / installation on your system:
2182c609719bSwdenk
2183c609719bSwdenk- "u-boot.bin" is a raw binary image
2184c609719bSwdenk- "u-boot" is an image in ELF binary format
2185c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2186c609719bSwdenk
2187c609719bSwdenk
2188c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2189c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2190c609719bSwdenknative "make".
2191c609719bSwdenk
2192c609719bSwdenk
2193c609719bSwdenkIf the system board that you have is not listed, then you will need
2194c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2195c609719bSwdenksteps:
2196c609719bSwdenk
2197c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
219885ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
219985ec0bccSwdenk    entries as examples. Note that here and at many other places
22007152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
220185ec0bccSwdenk    keep this order.
2202c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
220385ec0bccSwdenk    files you need. In your board directory, you will need at least
220485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
220585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
220685ec0bccSwdenk    your board
2207c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2208c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
220985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2210c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2211c609719bSwdenk    to be installed on your target system.
221285ec0bccSwdenk6.  Debug and solve any problems that might arise.
2213c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2214c609719bSwdenk
2215c609719bSwdenk
2216c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2217c609719bSwdenk==============================================================
2218c609719bSwdenk
2219c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2220c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2221c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2222c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2223c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2224c609719bSwdenk
2225c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2226c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2227c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2228c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2229c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
22307152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2231c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2232c609719bSwdenkMontaVista's Hard Hat Linux you can type
2233c609719bSwdenk
2234c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2235c609719bSwdenk
2236c609719bSwdenkor to build on a native PowerPC system you can type
2237c609719bSwdenk
2238c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2239c609719bSwdenk
2240c609719bSwdenkSee also "U-Boot Porting Guide" below.
2241c609719bSwdenk
2242c609719bSwdenk
2243c609719bSwdenkMonitor Commands - Overview:
2244c609719bSwdenk============================
2245c609719bSwdenk
2246c609719bSwdenkgo	- start application at address 'addr'
2247c609719bSwdenkrun	- run commands in an environment variable
2248c609719bSwdenkbootm	- boot application image from memory
2249c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2250c609719bSwdenktftpboot- boot image via network using TFTP protocol
2251c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2252c609719bSwdenk	       (and eventually "gatewayip")
2253c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2254c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2255c609719bSwdenkloads	- load S-Record file over serial line
2256c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2257c609719bSwdenkmd	- memory display
2258c609719bSwdenkmm	- memory modify (auto-incrementing)
2259c609719bSwdenknm	- memory modify (constant address)
2260c609719bSwdenkmw	- memory write (fill)
2261c609719bSwdenkcp	- memory copy
2262c609719bSwdenkcmp	- memory compare
2263c609719bSwdenkcrc32	- checksum calculation
2264c609719bSwdenkimd	- i2c memory display
2265c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2266c609719bSwdenkinm	- i2c memory modify (constant address)
2267c609719bSwdenkimw	- i2c memory write (fill)
2268c609719bSwdenkicrc32	- i2c checksum calculation
2269c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2270c609719bSwdenkiloop	- infinite loop on address range
2271c609719bSwdenkisdram	- print SDRAM configuration information
2272c609719bSwdenksspi	- SPI utility commands
2273c609719bSwdenkbase	- print or set address offset
2274c609719bSwdenkprintenv- print environment variables
2275c609719bSwdenksetenv	- set environment variables
2276c609719bSwdenksaveenv - save environment variables to persistent storage
2277c609719bSwdenkprotect - enable or disable FLASH write protection
2278c609719bSwdenkerase	- erase FLASH memory
2279c609719bSwdenkflinfo	- print FLASH memory information
2280c609719bSwdenkbdinfo	- print Board Info structure
2281c609719bSwdenkiminfo	- print header information for application image
2282c609719bSwdenkconinfo - print console devices and informations
2283c609719bSwdenkide	- IDE sub-system
2284c609719bSwdenkloop	- infinite loop on address range
228556523f12Swdenkloopw	- infinite write loop on address range
2286c609719bSwdenkmtest	- simple RAM test
2287c609719bSwdenkicache	- enable or disable instruction cache
2288c609719bSwdenkdcache	- enable or disable data cache
2289c609719bSwdenkreset	- Perform RESET of the CPU
2290c609719bSwdenkecho	- echo args to console
2291c609719bSwdenkversion - print monitor version
2292c609719bSwdenkhelp	- print online help
2293c609719bSwdenk?	- alias for 'help'
2294c609719bSwdenk
2295c609719bSwdenk
2296c609719bSwdenkMonitor Commands - Detailed Description:
2297c609719bSwdenk========================================
2298c609719bSwdenk
2299c609719bSwdenkTODO.
2300c609719bSwdenk
2301c609719bSwdenkFor now: just type "help <command>".
2302c609719bSwdenk
2303c609719bSwdenk
2304c609719bSwdenkEnvironment Variables:
2305c609719bSwdenk======================
2306c609719bSwdenk
2307c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2308c609719bSwdenkcan be made persistent by saving to Flash memory.
2309c609719bSwdenk
2310c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2311c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2312c609719bSwdenkwithout a value can be used to delete a variable from the
2313c609719bSwdenkenvironment. As long as you don't save the environment you are
2314c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2315c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2316c609719bSwdenk
2317c609719bSwdenkSome configuration options can be set using Environment Variables:
2318c609719bSwdenk
2319c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2320c609719bSwdenk
2321c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2322c609719bSwdenk
2323c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2324c609719bSwdenk
2325c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2326c609719bSwdenk
2327c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2328c609719bSwdenk
2329c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2330c609719bSwdenk		  "bootp" will just load perform a lookup of the
2331c609719bSwdenk		  configuration from the BOOTP server, but not try to
2332c609719bSwdenk		  load any image using TFTP
2333c609719bSwdenk
2334c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2335c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2336c609719bSwdenk		  be automatically started (by internally calling
2337c609719bSwdenk		  "bootm")
2338c609719bSwdenk
23394a6fd34bSwdenk		  If set to "no", a standalone image passed to the
23404a6fd34bSwdenk		  "bootm" command will be copied to the load address
23414a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
23424a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
23434a6fd34bSwdenk		  data.
23444a6fd34bSwdenk
234517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
234617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
234717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
234817ea1177Swdenk		  initialization code. So, for changes to be effective
234917ea1177Swdenk		  it must be saved and board must be reset.
235017ea1177Swdenk
2351c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2352c609719bSwdenk		  If this variable is not set, initrd images will be
2353c609719bSwdenk		  copied to the highest possible address in RAM; this
2354c609719bSwdenk		  is usually what you want since it allows for
2355c609719bSwdenk		  maximum initrd size. If for some reason you want to
2356c609719bSwdenk		  make sure that the initrd image is loaded below the
2357c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2358c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2359c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2360c609719bSwdenk		  address to use (U-Boot will still check that it
2361c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2362c609719bSwdenk
2363c609719bSwdenk		  For instance, when you have a system with 16 MB
23647152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2365c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2366c609719bSwdenk		  the "bootargs" variable. However, now you must make
23677152b1d0Swdenk		  sure that the initrd image is placed in the first
2368c609719bSwdenk		  12 MB as well - this can be done with
2369c609719bSwdenk
2370c609719bSwdenk		  setenv initrd_high 00c00000
2371c609719bSwdenk
237238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
237338b99261Swdenk		  indication to U-Boot that all addresses are legal
237438b99261Swdenk		  for the Linux kernel, including addresses in flash
237538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
237638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
237738b99261Swdenk		  boot time on your system, but requires that this
237838b99261Swdenk		  feature is supported by your Linux kernel.
237938b99261Swdenk
2380c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2381c609719bSwdenk
2382c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2383dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2384c609719bSwdenk
2385c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2386c609719bSwdenk
2387c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2388c609719bSwdenk
2389c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2390c609719bSwdenk
2391c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2392c609719bSwdenk
2393c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2394c609719bSwdenk
2395a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2396a3d991bdSwdenk		  interface is used first.
2397a3d991bdSwdenk
2398a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2399a3d991bdSwdenk		  interface is currently active. For example you
2400a3d991bdSwdenk		  can do the following
2401a3d991bdSwdenk
2402a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2403a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2404a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2405a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2406a3d991bdSwdenk
2407a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2408a3d991bdSwdenk		  either succeed or fail without retrying.
24096e592385Swdenk		  When set to "once" the network operation will
24106e592385Swdenk		  fail when all the available network interfaces
24116e592385Swdenk		  are tried once without success.
2412a3d991bdSwdenk		  Useful on scripts which control the retry operation
2413a3d991bdSwdenk		  themselves.
2414a3d991bdSwdenk
2415a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2416a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2417a3d991bdSwdenk		  VLAN tagged frames.
2418c609719bSwdenk
2419c609719bSwdenkThe following environment variables may be used and automatically
2420c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2421c609719bSwdenkdepending the information provided by your boot server:
2422c609719bSwdenk
2423c609719bSwdenk  bootfile	- see above
2424c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2425fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2426c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2427c609719bSwdenk  hostname	- Target hostname
2428c609719bSwdenk  ipaddr	- see above
2429c609719bSwdenk  netmask	- Subnet Mask
2430c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2431c609719bSwdenk  serverip	- see above
2432c609719bSwdenk
2433c609719bSwdenk
2434c609719bSwdenkThere are two special Environment Variables:
2435c609719bSwdenk
2436c609719bSwdenk  serial#	- contains hardware identification information such
2437c609719bSwdenk		  as type string and/or serial number
2438c609719bSwdenk  ethaddr	- Ethernet address
2439c609719bSwdenk
2440c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2441c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2442c609719bSwdenkonce they have been set once.
2443c609719bSwdenk
2444c609719bSwdenk
2445c1551ea8SstroeseFurther special Environment Variables:
2446c1551ea8Sstroese
2447c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2448c1551ea8Sstroese		  with the "version" command. This variable is
2449c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2450c1551ea8Sstroese
2451c1551ea8Sstroese
2452c609719bSwdenkPlease note that changes to some configuration parameters may take
2453c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2454c609719bSwdenk
2455c609719bSwdenk
2456f07771ccSwdenkCommand Line Parsing:
2457f07771ccSwdenk=====================
2458f07771ccSwdenk
2459f07771ccSwdenkThere are two different command line parsers available with U-Boot:
24607152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2461f07771ccSwdenk
2462f07771ccSwdenkOld, simple command line parser:
2463f07771ccSwdenk--------------------------------
2464f07771ccSwdenk
2465f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2466f07771ccSwdenk- several commands on one line, separated by ';'
2467f07771ccSwdenk- variable substitution using "... $(name) ..." syntax
2468f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2469f07771ccSwdenk  for example:
2470f07771ccSwdenk	setenv bootcmd bootm \$(address)
2471f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2472f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2473f07771ccSwdenk
2474f07771ccSwdenkHush shell:
2475f07771ccSwdenk-----------
2476f07771ccSwdenk
2477f07771ccSwdenk- similar to Bourne shell, with control structures like
2478f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2479f07771ccSwdenk  until...do...done, ...
2480f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2481f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2482f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2483f07771ccSwdenk  command
2484f07771ccSwdenk
2485f07771ccSwdenkGeneral rules:
2486f07771ccSwdenk--------------
2487f07771ccSwdenk
2488f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2489f07771ccSwdenk    command) contains several commands separated by semicolon, and
2490f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2491f07771ccSwdenk    executed anyway.
2492f07771ccSwdenk
2493f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2494f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2495f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2496f07771ccSwdenk    variables are not executed.
2497f07771ccSwdenk
2498c609719bSwdenkNote for Redundant Ethernet Interfaces:
2499c609719bSwdenk=======================================
2500c609719bSwdenk
25017152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2502c609719bSwdenksuch configurations and is capable of automatic selection of a
25037152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2504c609719bSwdenk
2505c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2506c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2507c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2508c609719bSwdenk
2509c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2510c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2511c609719bSwdenkding setting in the environment; if the corresponding environment
2512c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2513c609719bSwdenk
2514c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2515c609719bSwdenk  environment, the SROM's address is used.
2516c609719bSwdenk
2517c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2518c609719bSwdenk  environment exists, then the value from the environment variable is
2519c609719bSwdenk  used.
2520c609719bSwdenk
2521c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2522c609719bSwdenk  both addresses are the same, this MAC address is used.
2523c609719bSwdenk
2524c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2525c609719bSwdenk  addresses differ, the value from the environment is used and a
2526c609719bSwdenk  warning is printed.
2527c609719bSwdenk
2528c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2529c609719bSwdenk  is raised.
2530c609719bSwdenk
2531c609719bSwdenk
2532c609719bSwdenkImage Formats:
2533c609719bSwdenk==============
2534c609719bSwdenk
2535c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2536c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2537c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2538c609719bSwdenkdefines the following image properties:
2539c609719bSwdenk
2540c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2541c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
25427f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
25431f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2544c609719bSwdenk* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
25453d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
25463d1e8a9dSwdenk  Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
2547c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2548c609719bSwdenk* Load Address
2549c609719bSwdenk* Entry Point
2550c609719bSwdenk* Image Name
2551c609719bSwdenk* Image Timestamp
2552c609719bSwdenk
2553c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2554c609719bSwdenkand the data portions of the image are secured against corruption by
2555c609719bSwdenkCRC32 checksums.
2556c609719bSwdenk
2557c609719bSwdenk
2558c609719bSwdenkLinux Support:
2559c609719bSwdenk==============
2560c609719bSwdenk
2561c609719bSwdenkAlthough U-Boot should support any OS or standalone application
25627152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2563c609719bSwdenkU-Boot.
2564c609719bSwdenk
2565c609719bSwdenkU-Boot includes many features that so far have been part of some
2566c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2567c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2568c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
25697152b1d0Swdenkserves several purposes:
2570c609719bSwdenk
2571c609719bSwdenk- the same features can be used for other OS or standalone
2572c609719bSwdenk  applications (for instance: using compressed images to reduce the
2573c609719bSwdenk  Flash memory footprint)
2574c609719bSwdenk
2575c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
25767152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2577c609719bSwdenk
2578c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2579c609719bSwdenk  images; of course this also means that different kernel images can
2580c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2581c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2582c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2583c609719bSwdenk  software is easier now.
2584c609719bSwdenk
2585c609719bSwdenk
2586c609719bSwdenkLinux HOWTO:
2587c609719bSwdenk============
2588c609719bSwdenk
2589c609719bSwdenkPorting Linux to U-Boot based systems:
2590c609719bSwdenk---------------------------------------
2591c609719bSwdenk
2592c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2593c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2594c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2595c609719bSwdenkLinux :-).
2596c609719bSwdenk
2597c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2598c609719bSwdenk
2599c609719bSwdenkJust make sure your machine specific header file (for instance
2600c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2601c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2602c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2603c609719bSwdenkU-Boot configuration in CFG_IMMR.
2604c609719bSwdenk
2605c609719bSwdenk
2606c609719bSwdenkConfiguring the Linux kernel:
2607c609719bSwdenk-----------------------------
2608c609719bSwdenk
2609c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2610c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2611c609719bSwdenk
2612c609719bSwdenk
2613c609719bSwdenkBuilding a Linux Image:
2614c609719bSwdenk-----------------------
2615c609719bSwdenk
261624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
261724ee89b9Swdenknot used. If you use recent kernel source, a new build target
261824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
261924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
262024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
262124ee89b9Swdenk100% compatible format.
2622c609719bSwdenk
2623c609719bSwdenkExample:
2624c609719bSwdenk
2625c609719bSwdenk	make TQM850L_config
2626c609719bSwdenk	make oldconfig
2627c609719bSwdenk	make dep
262824ee89b9Swdenk	make uImage
2629c609719bSwdenk
263024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
263124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
263224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2633c609719bSwdenk
263424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
263524ee89b9Swdenk
263624ee89b9Swdenk* convert the kernel into a raw binary image:
263724ee89b9Swdenk
263824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
263924ee89b9Swdenk				 -R .note -R .comment \
264024ee89b9Swdenk				 -S vmlinux linux.bin
264124ee89b9Swdenk
264224ee89b9Swdenk* compress the binary image:
264324ee89b9Swdenk
264424ee89b9Swdenk	gzip -9 linux.bin
264524ee89b9Swdenk
264624ee89b9Swdenk* package compressed binary image for U-Boot:
264724ee89b9Swdenk
264824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
264924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
265024ee89b9Swdenk		-d linux.bin.gz uImage
265124ee89b9Swdenk
265224ee89b9Swdenk
265324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
265424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
265524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
265624ee89b9Swdenkbyte header containing information about target architecture,
265724ee89b9Swdenkoperating system, image type, compression method, entry points, time
265824ee89b9Swdenkstamp, CRC32 checksums, etc.
265924ee89b9Swdenk
266024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
266124ee89b9Swdenkprint the header information, or to build new images.
2662c609719bSwdenk
2663c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2664c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2665c609719bSwdenkchecksum verification:
2666c609719bSwdenk
2667c609719bSwdenk	tools/mkimage -l image
2668c609719bSwdenk	  -l ==> list image header information
2669c609719bSwdenk
2670c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2671c609719bSwdenkfrom a "data file" which is used as image payload:
2672c609719bSwdenk
2673c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2674c609719bSwdenk		      -n name -d data_file image
2675c609719bSwdenk	  -A ==> set architecture to 'arch'
2676c609719bSwdenk	  -O ==> set operating system to 'os'
2677c609719bSwdenk	  -T ==> set image type to 'type'
2678c609719bSwdenk	  -C ==> set compression type 'comp'
2679c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2680c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2681c609719bSwdenk	  -n ==> set image name to 'name'
2682c609719bSwdenk	  -d ==> use image data from 'datafile'
2683c609719bSwdenk
268469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
268569459791Swdenkaddress (0x00000000), but the entry point address depends on the
268669459791Swdenkkernel version:
2687c609719bSwdenk
2688c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
268924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2690c609719bSwdenk
2691c609719bSwdenkSo a typical call to build a U-Boot image would read:
2692c609719bSwdenk
269324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
269424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
269524ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
269624ee89b9Swdenk	> examples/uImage.TQM850L
269724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2698c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2699c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2700c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2701c609719bSwdenk	Load Address: 0x00000000
270224ee89b9Swdenk	Entry Point:  0x00000000
2703c609719bSwdenk
2704c609719bSwdenkTo verify the contents of the image (or check for corruption):
2705c609719bSwdenk
270624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
270724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2708c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2709c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2710c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2711c609719bSwdenk	Load Address: 0x00000000
271224ee89b9Swdenk	Entry Point:  0x00000000
2713c609719bSwdenk
2714c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
2715c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
2716c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
2717c609719bSwdenkneed to be uncompressed:
2718c609719bSwdenk
271924ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
272024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
272124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
272224ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
272324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
272424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2725c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2726c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
2727c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2728c609719bSwdenk	Load Address: 0x00000000
272924ee89b9Swdenk	Entry Point:  0x00000000
2730c609719bSwdenk
2731c609719bSwdenk
2732c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
2733c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
2734c609719bSwdenk
2735c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
2736c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
2737c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2738c609719bSwdenk	Image Name:   Simple Ramdisk Image
2739c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
2740c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2741c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2742c609719bSwdenk	Load Address: 0x00000000
2743c609719bSwdenk	Entry Point:  0x00000000
2744c609719bSwdenk
2745c609719bSwdenk
2746c609719bSwdenkInstalling a Linux Image:
2747c609719bSwdenk-------------------------
2748c609719bSwdenk
2749c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
2750c609719bSwdenkyou must convert the image to S-Record format:
2751c609719bSwdenk
2752c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
2753c609719bSwdenk
2754c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
2755c609719bSwdenkimage header, so the resulting S-Record file will be relative to
2756c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
2757c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
2758c609719bSwdenkcommand.
2759c609719bSwdenk
2760c609719bSwdenkExample: install the image to address 0x40100000 (which on the
2761c609719bSwdenkTQM8xxL is in the first Flash bank):
2762c609719bSwdenk
2763c609719bSwdenk	=> erase 40100000 401FFFFF
2764c609719bSwdenk
2765c609719bSwdenk	.......... done
2766c609719bSwdenk	Erased 8 sectors
2767c609719bSwdenk
2768c609719bSwdenk	=> loads 40100000
2769c609719bSwdenk	## Ready for S-Record download ...
2770c609719bSwdenk	~>examples/image.srec
2771c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2772c609719bSwdenk	...
2773c609719bSwdenk	15989 15990 15991 15992
2774c609719bSwdenk	[file transfer complete]
2775c609719bSwdenk	[connected]
2776c609719bSwdenk	## Start Addr = 0x00000000
2777c609719bSwdenk
2778c609719bSwdenk
2779c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
2780c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
2781c609719bSwdenkcorruption happened:
2782c609719bSwdenk
2783c609719bSwdenk	=> imi 40100000
2784c609719bSwdenk
2785c609719bSwdenk	## Checking Image at 40100000 ...
2786c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2787c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2788c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2789c609719bSwdenk	   Load Address: 00000000
2790c609719bSwdenk	   Entry Point:	 0000000c
2791c609719bSwdenk	   Verifying Checksum ... OK
2792c609719bSwdenk
2793c609719bSwdenk
2794c609719bSwdenkBoot Linux:
2795c609719bSwdenk-----------
2796c609719bSwdenk
2797c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
2798c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
2799c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
2800c609719bSwdenkparameters. You can check and modify this variable using the
2801c609719bSwdenk"printenv" and "setenv" commands:
2802c609719bSwdenk
2803c609719bSwdenk
2804c609719bSwdenk	=> printenv bootargs
2805c609719bSwdenk	bootargs=root=/dev/ram
2806c609719bSwdenk
2807c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2808c609719bSwdenk
2809c609719bSwdenk	=> printenv bootargs
2810c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2811c609719bSwdenk
2812c609719bSwdenk	=> bootm 40020000
2813c609719bSwdenk	## Booting Linux kernel at 40020000 ...
2814c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
2815c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2816c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
2817c609719bSwdenk	   Load Address: 00000000
2818c609719bSwdenk	   Entry Point:	 0000000c
2819c609719bSwdenk	   Verifying Checksum ... OK
2820c609719bSwdenk	   Uncompressing Kernel Image ... OK
2821c609719bSwdenk	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
2822c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2823c609719bSwdenk	time_init: decrementer frequency = 187500000/60
2824c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
2825c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
2826c609719bSwdenk	...
2827c609719bSwdenk
2828c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
28297152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
2830c609719bSwdenkformat!) to the "bootm" command:
2831c609719bSwdenk
2832c609719bSwdenk	=> imi 40100000 40200000
2833c609719bSwdenk
2834c609719bSwdenk	## Checking Image at 40100000 ...
2835c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2836c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2837c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2838c609719bSwdenk	   Load Address: 00000000
2839c609719bSwdenk	   Entry Point:	 0000000c
2840c609719bSwdenk	   Verifying Checksum ... OK
2841c609719bSwdenk
2842c609719bSwdenk	## Checking Image at 40200000 ...
2843c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
2844c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2845c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2846c609719bSwdenk	   Load Address: 00000000
2847c609719bSwdenk	   Entry Point:	 00000000
2848c609719bSwdenk	   Verifying Checksum ... OK
2849c609719bSwdenk
2850c609719bSwdenk	=> bootm 40100000 40200000
2851c609719bSwdenk	## Booting Linux kernel at 40100000 ...
2852c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2853c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2854c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2855c609719bSwdenk	   Load Address: 00000000
2856c609719bSwdenk	   Entry Point:	 0000000c
2857c609719bSwdenk	   Verifying Checksum ... OK
2858c609719bSwdenk	   Uncompressing Kernel Image ... OK
2859c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
2860c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
2861c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
2862c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
2863c609719bSwdenk	   Load Address: 00000000
2864c609719bSwdenk	   Entry Point:	 00000000
2865c609719bSwdenk	   Verifying Checksum ... OK
2866c609719bSwdenk	   Loading Ramdisk ... OK
2867c609719bSwdenk	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
2868c609719bSwdenk	Boot arguments: root=/dev/ram
2869c609719bSwdenk	time_init: decrementer frequency = 187500000/60
2870c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
2871c609719bSwdenk	...
2872c609719bSwdenk	RAMDISK: Compressed image found at block 0
2873c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
2874c609719bSwdenk
2875c609719bSwdenk	bash#
2876c609719bSwdenk
28776069ff26SwdenkMore About U-Boot Image Types:
28786069ff26Swdenk------------------------------
28796069ff26Swdenk
28806069ff26SwdenkU-Boot supports the following image types:
28816069ff26Swdenk
28826069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
28836069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
28846069ff26Swdenk	well) you can continue to work in U-Boot after return from
28856069ff26Swdenk	the Standalone Program.
28866069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
28876069ff26Swdenk	will take over control completely. Usually these programs
28886069ff26Swdenk	will install their own set of exception handlers, device
28896069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
28906069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
28916069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
28926069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
28936069ff26Swdenk	being started.
28946069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
28956069ff26Swdenk	(Linux) kernel image and one or more data images like
28966069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
28976069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
28986069ff26Swdenk	server provides just a single image file, but you want to get
28996069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
29006069ff26Swdenk
29016069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
29026069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
29036069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
29046069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
29056069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
29066069ff26Swdenk	a multiple of 4 bytes).
29076069ff26Swdenk
29086069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
29096069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
29106069ff26Swdenk	flash memory.
29116069ff26Swdenk
29126069ff26Swdenk   "Script files" are command sequences that will be executed by
29136069ff26Swdenk	U-Boot's command interpreter; this feature is especially
29146069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
29156069ff26Swdenk	as command interpreter.
29166069ff26Swdenk
2917c609719bSwdenk
2918c609719bSwdenkStandalone HOWTO:
2919c609719bSwdenk=================
2920c609719bSwdenk
2921c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
2922c609719bSwdenkrun "standalone" applications, which can use some resources of
2923c609719bSwdenkU-Boot like console I/O functions or interrupt services.
2924c609719bSwdenk
2925c609719bSwdenkTwo simple examples are included with the sources:
2926c609719bSwdenk
2927c609719bSwdenk"Hello World" Demo:
2928c609719bSwdenk-------------------
2929c609719bSwdenk
2930c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
2931c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
2932c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
2933c609719bSwdenklike that:
2934c609719bSwdenk
2935c609719bSwdenk	=> loads
2936c609719bSwdenk	## Ready for S-Record download ...
2937c609719bSwdenk	~>examples/hello_world.srec
2938c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
2939c609719bSwdenk	[file transfer complete]
2940c609719bSwdenk	[connected]
2941c609719bSwdenk	## Start Addr = 0x00040004
2942c609719bSwdenk
2943c609719bSwdenk	=> go 40004 Hello World! This is a test.
2944c609719bSwdenk	## Starting application at 0x00040004 ...
2945c609719bSwdenk	Hello World
2946c609719bSwdenk	argc = 7
2947c609719bSwdenk	argv[0] = "40004"
2948c609719bSwdenk	argv[1] = "Hello"
2949c609719bSwdenk	argv[2] = "World!"
2950c609719bSwdenk	argv[3] = "This"
2951c609719bSwdenk	argv[4] = "is"
2952c609719bSwdenk	argv[5] = "a"
2953c609719bSwdenk	argv[6] = "test."
2954c609719bSwdenk	argv[7] = "<NULL>"
2955c609719bSwdenk	Hit any key to exit ...
2956c609719bSwdenk
2957c609719bSwdenk	## Application terminated, rc = 0x0
2958c609719bSwdenk
2959c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
2960c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
2961c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
2962c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
2963c609719bSwdenkcharacter, but this is just a demo program. The application can be
2964c609719bSwdenkcontrolled by the following keys:
2965c609719bSwdenk
2966c609719bSwdenk	? - print current values og the CPM Timer registers
2967c609719bSwdenk	b - enable interrupts and start timer
2968c609719bSwdenk	e - stop timer and disable interrupts
2969c609719bSwdenk	q - quit application
2970c609719bSwdenk
2971c609719bSwdenk	=> loads
2972c609719bSwdenk	## Ready for S-Record download ...
2973c609719bSwdenk	~>examples/timer.srec
2974c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
2975c609719bSwdenk	[file transfer complete]
2976c609719bSwdenk	[connected]
2977c609719bSwdenk	## Start Addr = 0x00040004
2978c609719bSwdenk
2979c609719bSwdenk	=> go 40004
2980c609719bSwdenk	## Starting application at 0x00040004 ...
2981c609719bSwdenk	TIMERS=0xfff00980
2982c609719bSwdenk	Using timer 1
2983c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
2984c609719bSwdenk
2985c609719bSwdenkHit 'b':
2986c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
2987c609719bSwdenk	Enabling timer
2988c609719bSwdenkHit '?':
2989c609719bSwdenk	[q, b, e, ?] ........
2990c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
2991c609719bSwdenkHit '?':
2992c609719bSwdenk	[q, b, e, ?] .
2993c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
2994c609719bSwdenkHit '?':
2995c609719bSwdenk	[q, b, e, ?] .
2996c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
2997c609719bSwdenkHit '?':
2998c609719bSwdenk	[q, b, e, ?] .
2999c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3000c609719bSwdenkHit 'e':
3001c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3002c609719bSwdenkHit 'q':
3003c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3004c609719bSwdenk
3005c609719bSwdenk
300685ec0bccSwdenkMinicom warning:
300785ec0bccSwdenk================
300885ec0bccSwdenk
30097152b1d0SwdenkOver time, many people have reported problems when trying to use the
301085ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
301185ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3012f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
301385ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
301485ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
301585ec0bccSwdenk
301652f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
301752f52c14Swdenkconfiguration to your "File transfer protocols" section:
301852f52c14Swdenk
301952f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
302052f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
302152f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
302252f52c14Swdenk
302352f52c14Swdenk
3024c609719bSwdenkNetBSD Notes:
3025c609719bSwdenk=============
3026c609719bSwdenk
3027c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3028c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3029c609719bSwdenk
3030c609719bSwdenkBuilding requires a cross environment; it is known to work on
3031c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3032c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3033c609719bSwdenkNote that the cross-powerpc package does not install include files;
3034c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3035c609719bSwdenkmissing.  This file has to be installed and patched manually:
3036c609719bSwdenk
3037c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3038c609719bSwdenk	# mkdir powerpc
3039c609719bSwdenk	# ln -s powerpc machine
3040c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3041c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3042c609719bSwdenk
3043c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3044c609719bSwdenkand U-Boot include files.
3045c609719bSwdenk
3046c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3047c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3048c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3049c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
3050c609719bSwdenkmeantime, send mail to bruno@exet-ag.de and/or wd@denx.de for
3051c609719bSwdenkdetails.
3052c609719bSwdenk
3053c609719bSwdenk
3054c609719bSwdenkImplementation Internals:
3055c609719bSwdenk=========================
3056c609719bSwdenk
3057c609719bSwdenkThe following is not intended to be a complete description of every
3058c609719bSwdenkimplementation detail. However, it should help to understand the
3059c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3060c609719bSwdenkhardware.
3061c609719bSwdenk
3062c609719bSwdenk
3063c609719bSwdenkInitial Stack, Global Data:
3064c609719bSwdenk---------------------------
3065c609719bSwdenk
3066c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3067c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3068c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3069c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3070c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3071c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3072c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3073c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3074c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3075c609719bSwdenklocked as (mis-) used as memory, etc.
3076c609719bSwdenk
30777152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
307843d9616cSwdenk	u-boot-users mailing list:
307943d9616cSwdenk
308043d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
308143d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
308243d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
308343d9616cSwdenk	...
308443d9616cSwdenk
308543d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
308643d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
308743d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
308843d9616cSwdenk	is that the cache is being used as a temporary supply of
308943d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
309043d9616cSwdenk	beyond the scope of this list to expain the details, but you
309143d9616cSwdenk	can see how this works by studying the cache architecture and
309243d9616cSwdenk	operation in the architecture and processor-specific manuals.
309343d9616cSwdenk
309443d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
309543d9616cSwdenk	is another option for the system designer to use as an
309643d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
309743d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
309843d9616cSwdenk	board designers haven't used it for something that would
309943d9616cSwdenk	cause you grief during the initial boot! It is frequently not
310043d9616cSwdenk	used.
310143d9616cSwdenk
310243d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
310343d9616cSwdenk	with your processor/board/system design. The default value
310443d9616cSwdenk	you will find in any recent u-boot distribution in
310543d9616cSwdenk	Walnut405.h should work for you. I'd set it to a value larger
310643d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
310743d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
310843d9616cSwdenk	that are supposed to respond to that address! That code in
310943d9616cSwdenk	start.S has been around a while and should work as is when
311043d9616cSwdenk	you get the config right.
311143d9616cSwdenk
311243d9616cSwdenk	-Chris Hallinan
311343d9616cSwdenk	DS4.COM, Inc.
311443d9616cSwdenk
3115c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3116c609719bSwdenkcode for the initialization procedures:
3117c609719bSwdenk
3118c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3119c609719bSwdenk  to write it.
3120c609719bSwdenk
3121c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3122c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
31237152b1d0Swdenk  zation is performed later (when relocating to RAM).
3124c609719bSwdenk
3125c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3126c609719bSwdenk  that.
3127c609719bSwdenk
3128c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3129c609719bSwdenknormal global data to share information beween the code. But it
3130c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3131c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3132c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3133c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3134c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3135c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3136c609719bSwdenkreserve for this purpose.
3137c609719bSwdenk
31387152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3139c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3140c609719bSwdenkGCC's implementation.
3141c609719bSwdenk
3142c609719bSwdenkFor PowerPC, the following registers have specific use:
3143c609719bSwdenk	R1:	stack pointer
3144c609719bSwdenk	R2:	TOC pointer
3145c609719bSwdenk	R3-R4:	parameter passing and return values
3146c609719bSwdenk	R5-R10: parameter passing
3147c609719bSwdenk	R13:	small data area pointer
3148c609719bSwdenk	R30:	GOT pointer
3149c609719bSwdenk	R31:	frame pointer
3150c609719bSwdenk
3151c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3152c609719bSwdenk
3153c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3154c609719bSwdenk
3155c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3156c609719bSwdenk    address of the global data structure is known at compile time),
3157c609719bSwdenk    but it turned out that reserving a register results in somewhat
3158c609719bSwdenk    smaller code - although the code savings are not that big (on
3159c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3160c609719bSwdenk    624 text + 127 data).
3161c609719bSwdenk
3162c609719bSwdenkOn ARM, the following registers are used:
3163c609719bSwdenk
3164c609719bSwdenk	R0:	function argument word/integer result
3165c609719bSwdenk	R1-R3:	function argument word
3166c609719bSwdenk	R9:	GOT pointer
3167c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3168c609719bSwdenk	R11:	argument (frame) pointer
3169c609719bSwdenk	R12:	temporary workspace
3170c609719bSwdenk	R13:	stack pointer
3171c609719bSwdenk	R14:	link register
3172c609719bSwdenk	R15:	program counter
3173c609719bSwdenk
3174c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3175c609719bSwdenk
3176c609719bSwdenk
3177c609719bSwdenkMemory Management:
3178c609719bSwdenk------------------
3179c609719bSwdenk
3180c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3181c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3182c609719bSwdenk
3183c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3184c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3185c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3186c609719bSwdenkphysical memory banks.
3187c609719bSwdenk
3188c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3189c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3190c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3191c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3192c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3193c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3194c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3195c609719bSwdenk
3196c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3197c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3198c609719bSwdenk
3199c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3200c609719bSwdenkthis:
3201c609719bSwdenk
3202c609719bSwdenk	0x0000 0000	Exception Vector code
3203c609719bSwdenk	      :
3204c609719bSwdenk	0x0000 1FFF
3205c609719bSwdenk	0x0000 2000	Free for Application Use
3206c609719bSwdenk	      :
3207c609719bSwdenk	      :
3208c609719bSwdenk
3209c609719bSwdenk	      :
3210c609719bSwdenk	      :
3211c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3212c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3213c609719bSwdenk	0x00FC 0000	Malloc Arena
3214c609719bSwdenk	      :
3215c609719bSwdenk	0x00FD FFFF
3216c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3217c609719bSwdenk	...		eventually: LCD or video framebuffer
3218c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3219c609719bSwdenk	0x00FF FFFF	[End of RAM]
3220c609719bSwdenk
3221c609719bSwdenk
3222c609719bSwdenkSystem Initialization:
3223c609719bSwdenk----------------------
3224c609719bSwdenk
3225c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3226c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3227c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
32287152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3229c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3230c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3231c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3232c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3233c609719bSwdenkthe caches and the SIU.
3234c609719bSwdenk
3235c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3236c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3237c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3238c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3239c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3240c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3241c609719bSwdenkbanks.
3242c609719bSwdenk
3243c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
32447152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3245c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3246c609719bSwdenk0x00000000, with any additional banks following immediately to create
3247c609719bSwdenkcontiguous memory starting from 0.
3248c609719bSwdenk
3249c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3250c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3251c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3252c609719bSwdenkpages, and the final stack is set up.
3253c609719bSwdenk
3254c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3255c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3256c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3257c609719bSwdenknew address in RAM.
3258c609719bSwdenk
3259c609719bSwdenk
3260c609719bSwdenkU-Boot Porting Guide:
3261c609719bSwdenk----------------------
3262c609719bSwdenk
3263c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
32646aff3115Swdenklist, October 2002]
3265c609719bSwdenk
3266c609719bSwdenk
3267c609719bSwdenkint main (int argc, char *argv[])
3268c609719bSwdenk{
3269c609719bSwdenk	sighandler_t no_more_time;
3270c609719bSwdenk
3271c609719bSwdenk	signal (SIGALRM, no_more_time);
3272c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3273c609719bSwdenk
3274c609719bSwdenk	if (available_money > available_manpower) {
3275c609719bSwdenk		pay consultant to port U-Boot;
3276c609719bSwdenk		return 0;
3277c609719bSwdenk	}
3278c609719bSwdenk
3279c609719bSwdenk	Download latest U-Boot source;
3280c609719bSwdenk
32816aff3115Swdenk	Subscribe to u-boot-users mailing list;
32826aff3115Swdenk
3283c609719bSwdenk	if (clueless) {
3284c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3285c609719bSwdenk	}
3286c609719bSwdenk
3287c609719bSwdenk	while (learning) {
3288c609719bSwdenk		Read the README file in the top level directory;
32897cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3290c609719bSwdenk		Read the source, Luke;
3291c609719bSwdenk	}
3292c609719bSwdenk
3293c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3294c609719bSwdenk		Buy a BDI2000;
3295c609719bSwdenk	} else {
3296c609719bSwdenk		Add a lot of aggravation and time;
3297c609719bSwdenk	}
3298c609719bSwdenk
3299c609719bSwdenk	Create your own board support subdirectory;
3300c609719bSwdenk
33016aff3115Swdenk	Create your own board config file;
33026aff3115Swdenk
3303c609719bSwdenk	while (!running) {
3304c609719bSwdenk		do {
3305c609719bSwdenk			Add / modify source code;
3306c609719bSwdenk		} until (compiles);
3307c609719bSwdenk		Debug;
3308c609719bSwdenk		if (clueless)
3309c609719bSwdenk			email ("Hi, I am having problems...");
3310c609719bSwdenk	}
3311c609719bSwdenk	Send patch file to Wolfgang;
3312c609719bSwdenk
3313c609719bSwdenk	return 0;
3314c609719bSwdenk}
3315c609719bSwdenk
3316c609719bSwdenkvoid no_more_time (int sig)
3317c609719bSwdenk{
3318c609719bSwdenk      hire_a_guru();
3319c609719bSwdenk}
3320c609719bSwdenk
3321c609719bSwdenk
3322c609719bSwdenkCoding Standards:
3323c609719bSwdenk-----------------
3324c609719bSwdenk
3325c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
3326c609719bSwdenkcoding style; see the file "Documentation/CodingStyle" in your Linux
3327c609719bSwdenkkernel source directory.
3328c609719bSwdenk
3329c609719bSwdenkPlease note that U-Boot is implemented in C (and to some small parts
3330c609719bSwdenkin Assembler); no C++ is used, so please do not use C++ style
3331c609719bSwdenkcomments (//) in your code.
3332c609719bSwdenk
3333c178d3daSwdenkPlease also stick to the following formatting rules:
3334180d3f74Swdenk- remove any trailing white space
3335180d3f74Swdenk- use TAB characters for indentation, not spaces
3336180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3337180d3f74Swdenk- do not add more than 2 empty lines to source files
3338180d3f74Swdenk- do not add trailing empty lines to source files
3339180d3f74Swdenk
3340c609719bSwdenkSubmissions which do not conform to the standards may be returned
3341c609719bSwdenkwith a request to reformat the changes.
3342c609719bSwdenk
3343c609719bSwdenk
3344c609719bSwdenkSubmitting Patches:
3345c609719bSwdenk-------------------
3346c609719bSwdenk
3347c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3348c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3349c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3350c609719bSwdenk
3351c609719bSwdenk
3352c609719bSwdenkWhen you send a patch, please include the following information with
3353c609719bSwdenkit:
3354c609719bSwdenk
3355c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3356c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3357c609719bSwdenk  patch actually fixes something.
3358c609719bSwdenk
3359c609719bSwdenk* For new features: a description of the feature and your
3360c609719bSwdenk  implementation.
3361c609719bSwdenk
3362c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3363c609719bSwdenk
3364c609719bSwdenk* For major contributions, your entry to the CREDITS file
3365c609719bSwdenk
3366c609719bSwdenk* When you add support for a new board, don't forget to add this
3367c609719bSwdenk  board to the MAKEALL script, too.
3368c609719bSwdenk
3369c609719bSwdenk* If your patch adds new configuration options, don't forget to
3370c609719bSwdenk  document these in the README file.
3371c609719bSwdenk
3372c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3373c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3374c609719bSwdenk  version of diff does not support these options, then get the latest
3375c609719bSwdenk  version of GNU diff.
3376c609719bSwdenk
33776dff5529Swdenk  The current directory when running this command shall be the top
33786dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
33796dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
33806dff5529Swdenk  directory information for the affected files).
33816dff5529Swdenk
3382c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3383c609719bSwdenk  gzipped text.
3384c609719bSwdenk
338552f52c14Swdenk* If one logical set of modifications affects or creates several
338652f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
338752f52c14Swdenk
338852f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
338952f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
339052f52c14Swdenk
339152f52c14Swdenk
3392c609719bSwdenkNotes:
3393c609719bSwdenk
3394c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3395c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3396c609719bSwdenk  for any of the boards.
3397c609719bSwdenk
3398c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3399c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3400c609719bSwdenk  returned with a request to re-formatting / split it.
3401c609719bSwdenk
3402c609719bSwdenk* If you modify existing code, make sure that your new code does not
3403c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3404c609719bSwdenk  When adding new features, these should compile conditionally only
3405c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3406c609719bSwdenk  disabled must not need more memory than the old code without your
3407c609719bSwdenk  modification.
3408