xref: /openbmc/u-boot/README (revision 8e585f02f82c17cc66cd229dbf0fd3066bbbf658)
1c609719bSwdenk#
2151ab83aSwdenk# (C) Copyright 2000 - 2005
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54c609719bSwdenkwho contributed the specific port.
55c609719bSwdenk
56c609719bSwdenk
57c609719bSwdenkWhere to get help:
58c609719bSwdenk==================
59c609719bSwdenk
60c609719bSwdenkIn case you have questions about, problems with or contributions for
61c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
62c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
63c609719bSwdenkprevious traffic on the mailing list - please search the archive
64c609719bSwdenkbefore asking FAQ's. Please see
65c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
66c609719bSwdenk
67c609719bSwdenk
68c609719bSwdenkWhere we come from:
69c609719bSwdenk===================
70c609719bSwdenk
71c609719bSwdenk- start from 8xxrom sources
7224ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73c609719bSwdenk- clean up code
74c609719bSwdenk- make it easier to add custom boards
75c609719bSwdenk- make it possible to add other [PowerPC] CPUs
76c609719bSwdenk- extend functions, especially:
77c609719bSwdenk  * Provide extended interface to Linux boot loader
78c609719bSwdenk  * S-Record download
79c609719bSwdenk  * network boot
80c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8124ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
82c609719bSwdenk- add other CPU families (starting with ARM)
8324ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8424ee89b9Swdenk
8524ee89b9Swdenk
8624ee89b9SwdenkNames and Spelling:
8724ee89b9Swdenk===================
8824ee89b9Swdenk
8924ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9024ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9124ee89b9Swdenkin source files etc.). Example:
9224ee89b9Swdenk
9324ee89b9Swdenk	This is the README file for the U-Boot project.
9424ee89b9Swdenk
9524ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9624ee89b9Swdenk
9724ee89b9Swdenk	include/asm-ppc/u-boot.h
9824ee89b9Swdenk
9924ee89b9Swdenk	#include <asm/u-boot.h>
10024ee89b9Swdenk
10124ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10224ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10324ee89b9Swdenk
10424ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10524ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
106c609719bSwdenk
107c609719bSwdenk
10893f19cc0SwdenkVersioning:
10993f19cc0Swdenk===========
11093f19cc0Swdenk
11193f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11293f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11393f19cc0Swdenksub-version "34", and patchlevel "4".
11493f19cc0Swdenk
11593f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11693f19cc0Swdenkbetween released versions, i. e. officially released versions of
11793f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11893f19cc0Swdenk
11993f19cc0Swdenk
120c609719bSwdenkDirectory Hierarchy:
121c609719bSwdenk====================
122c609719bSwdenk
1237152b1d0Swdenk- board		Board dependent files
1247152b1d0Swdenk- common	Misc architecture independent functions
125c609719bSwdenk- cpu		CPU specific files
126983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
12711dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12811dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
129a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1311d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
13211dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
13311dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1348ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
13572a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
13611dadd54Swdenk  - i386	Files specific to i386 CPUs
13711dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
138983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
139*8e585f02STsiChung Liew  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
14011dadd54Swdenk  - mips	Files specific to MIPS CPUs
141983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
142983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
143983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
144983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
145983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
146983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
147983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14811dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1495c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1500c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
15111dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15211dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15311dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
154c609719bSwdenk- disk		Code for disk drive partition handling
155c609719bSwdenk- doc		Documentation (don't expect too much)
1567152b1d0Swdenk- drivers	Commonly used device drivers
157c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
158c609719bSwdenk- examples	Example code for standalone applications, etc.
159c609719bSwdenk- include	Header Files
16011dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1617b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
16211dadd54Swdenk- lib_generic	Files generic to all	 architectures
16311dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16411dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16511dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16611dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16711dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
168213bf8c8SGerald Van Baren- libfdt 	Library files to support flattened device trees
169c609719bSwdenk- net		Networking code
170c609719bSwdenk- post		Power On Self Test
171c609719bSwdenk- rtc		Real Time Clock drivers
172c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
173c609719bSwdenk
174c609719bSwdenkSoftware Configuration:
175c609719bSwdenk=======================
176c609719bSwdenk
177c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
178c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
179c609719bSwdenk
180c609719bSwdenkThere are two classes of configuration variables:
181c609719bSwdenk
182c609719bSwdenk* Configuration _OPTIONS_:
183c609719bSwdenk  These are selectable by the user and have names beginning with
184c609719bSwdenk  "CONFIG_".
185c609719bSwdenk
186c609719bSwdenk* Configuration _SETTINGS_:
187c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
188c609719bSwdenk  you don't know what you're doing; they have names beginning with
189c609719bSwdenk  "CFG_".
190c609719bSwdenk
191c609719bSwdenkLater we will add a configuration tool - probably similar to or even
192c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
193c609719bSwdenkdo the configuration by hand, which means creating some symbolic
194c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
195c609719bSwdenkas an example here.
196c609719bSwdenk
197c609719bSwdenk
198c609719bSwdenkSelection of Processor Architecture and Board Type:
199c609719bSwdenk---------------------------------------------------
200c609719bSwdenk
201c609719bSwdenkFor all supported boards there are ready-to-use default
202c609719bSwdenkconfigurations available; just type "make <board_name>_config".
203c609719bSwdenk
204c609719bSwdenkExample: For a TQM823L module type:
205c609719bSwdenk
206c609719bSwdenk	cd u-boot
207c609719bSwdenk	make TQM823L_config
208c609719bSwdenk
209c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
210c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
211c609719bSwdenkdirectory according to the instructions in cogent/README.
212c609719bSwdenk
213c609719bSwdenk
214c609719bSwdenkConfiguration Options:
215c609719bSwdenk----------------------
216c609719bSwdenk
217c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
218c609719bSwdenksuch information is kept in a configuration file
219c609719bSwdenk"include/configs/<board_name>.h".
220c609719bSwdenk
221c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
222c609719bSwdenk"include/configs/TQM823L.h".
223c609719bSwdenk
224c609719bSwdenk
2257f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2267f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2277f6c2cbcSwdenkbuild a config tool - later.
2287f6c2cbcSwdenk
2297f6c2cbcSwdenk
230c609719bSwdenkThe following options need to be configured:
231c609719bSwdenk
232c609719bSwdenk- CPU Type:	Define exactly one of
233c609719bSwdenk
234c609719bSwdenk		PowerPC based CPUs:
235c609719bSwdenk		-------------------
236c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2370db5bca8Swdenk	or	CONFIG_MPC5xx
238983fda83Swdenk	or	CONFIG_MPC8220
239c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
24042d1f039Swdenk	or	CONFIG_MPC85xx
241c609719bSwdenk	or	CONFIG_IOP480
242c609719bSwdenk	or	CONFIG_405GP
24312f34241Swdenk	or	CONFIG_405EP
244c609719bSwdenk	or	CONFIG_440
245c609719bSwdenk	or	CONFIG_MPC74xx
24672755c71Swdenk	or	CONFIG_750FX
247c609719bSwdenk
248c609719bSwdenk		ARM based CPUs:
249c609719bSwdenk		---------------
250c609719bSwdenk		CONFIG_SA1110
251c609719bSwdenk		CONFIG_ARM7
252c609719bSwdenk		CONFIG_PXA250
2530b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
254c609719bSwdenk
255*8e585f02STsiChung Liew		ColdFire based CPUs:
256*8e585f02STsiChung Liew		--------------------
257*8e585f02STsiChung Liew		CONFIG_M5329
258*8e585f02STsiChung Liew
259507bbe3eSwdenk		MicroBlaze based CPUs:
260507bbe3eSwdenk		----------------------
261857cad37Swdenk		CONFIG_MICROBLAZE
262507bbe3eSwdenk
2635c952cf0Swdenk		Nios-2 based CPUs:
2645c952cf0Swdenk		----------------------
2655c952cf0Swdenk		CONFIG_NIOS2
2665c952cf0Swdenk
26772a087e0SWolfgang Denk		AVR32 based CPUs:
26872a087e0SWolfgang Denk		----------------------
26972a087e0SWolfgang Denk		CONFIG_AT32AP
270c609719bSwdenk
271c609719bSwdenk- Board Type:	Define exactly one of
272c609719bSwdenk
273c609719bSwdenk		PowerPC based boards:
274c609719bSwdenk		---------------------
275c609719bSwdenk
27676544f80SDetlev Zundel		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
27776544f80SDetlev Zundel		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
27876544f80SDetlev Zundel		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
27976544f80SDetlev Zundel		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
28076544f80SDetlev Zundel		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
28176544f80SDetlev Zundel		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
28276544f80SDetlev Zundel		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
28309e4b0c5SWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
28409e4b0c5SWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
28509e4b0c5SWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
28609e4b0c5SWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
28709e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
28809e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
28909e4b0c5SWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
29009e4b0c5SWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
29109e4b0c5SWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
29209e4b0c5SWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
29309e4b0c5SWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
29409e4b0c5SWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
29509e4b0c5SWolfgang Denk		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
29609e4b0c5SWolfgang Denk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
29709e4b0c5SWolfgang Denk		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
29809e4b0c5SWolfgang Denk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
29909e4b0c5SWolfgang Denk		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
30009e4b0c5SWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
30109e4b0c5SWolfgang Denk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
30209e4b0c5SWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
30309e4b0c5SWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
30409e4b0c5SWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
30509e4b0c5SWolfgang Denk		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
30609e4b0c5SWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
30709e4b0c5SWolfgang Denk		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
30809e4b0c5SWolfgang Denk		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
30909e4b0c5SWolfgang Denk		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
31009e4b0c5SWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
31109e4b0c5SWolfgang Denk		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
31209e4b0c5SWolfgang Denk		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
31309e4b0c5SWolfgang Denk		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
314c609719bSwdenk
315c609719bSwdenk		ARM based boards:
316c609719bSwdenk		-----------------
317c609719bSwdenk
318c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
3190b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
3200b953ffcSMarkus Klotzbuecher		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
3210b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
3220b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
3230b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
3245720df78SHeiko Schocher		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
3255720df78SHeiko Schocher		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
3265720df78SHeiko Schocher		CONFIG_VCMA9
327c609719bSwdenk
328507bbe3eSwdenk		MicroBlaze based boards:
329507bbe3eSwdenk		------------------------
330507bbe3eSwdenk
331507bbe3eSwdenk		CONFIG_SUZAKU
332507bbe3eSwdenk
3335c952cf0Swdenk		Nios-2 based boards:
3345c952cf0Swdenk		------------------------
3355c952cf0Swdenk
3365c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3379cc83378SScott McNutt		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
3385c952cf0Swdenk
3396ccec449SWolfgang Denk		AVR32 based boards:
3406ccec449SWolfgang Denk		-------------------
3416ccec449SWolfgang Denk
3426ccec449SWolfgang Denk		CONFIG_ATSTK1000
3436ccec449SWolfgang Denk
3446ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
3456ccec449SWolfgang Denk		Define exactly one of
3466ccec449SWolfgang Denk		CONFIG_ATSTK1002
3476ccec449SWolfgang Denk
348c609719bSwdenk
349c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
350c609719bSwdenk		Define exactly one of
351c609719bSwdenk		CONFIG_CMA286_60_OLD
352c609719bSwdenk--- FIXME --- not tested yet:
353c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
354c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
355c609719bSwdenk
356c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
357c609719bSwdenk		Define exactly one of
358c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
359c609719bSwdenk
360c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
361c609719bSwdenk		Define one or more of
362c609719bSwdenk		CONFIG_CMA302
363c609719bSwdenk
364c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
365c609719bSwdenk		Define one or more of
366c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
367c609719bSwdenk					  the lcd display every second with
368c609719bSwdenk					  a "rotator" |\-/|\-/
369c609719bSwdenk
3702535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3712535d602Swdenk		CONFIG_ADSTYPE
3722535d602Swdenk		Possible values are:
3732535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
374180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
37554387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
37604a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3772535d602Swdenk
378c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
379c609719bSwdenk		Define exactly one of
380c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
381c609719bSwdenk
38275d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
38366ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
38466ca92a5Swdenk					  get_gclk_freq() cannot work
3855da627a4Swdenk					  e.g. if there is no 32KHz
3865da627a4Swdenk					  reference PIT/RTC clock
38766ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
38866ca92a5Swdenk					  or XTAL/EXTAL)
389c609719bSwdenk
39066ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
39166ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
39266ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
39366ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
39475d1ea7fSwdenk			See doc/README.MPC866
39575d1ea7fSwdenk
39675d1ea7fSwdenk		CFG_MEASURE_CPUCLK
39775d1ea7fSwdenk
39875d1ea7fSwdenk		Define this to measure the actual CPU clock instead
39975d1ea7fSwdenk		of relying on the correctness of the configured
40075d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
40175d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
40275d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
40366ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
40475d1ea7fSwdenk
4050b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4060b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
4070b953ffcSMarkus Klotzbuecher
4080b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4090b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4100b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4110b953ffcSMarkus Klotzbuecher
4120b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
4130b953ffcSMarkus Klotzbuecher
4140b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4150b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4160b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4170b953ffcSMarkus Klotzbuecher		by this value.
4180b953ffcSMarkus Klotzbuecher
4195da627a4Swdenk- Linux Kernel Interface:
420c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
421c609719bSwdenk
422c609719bSwdenk		U-Boot stores all clock information in Hz
423c609719bSwdenk		internally. For binary compatibility with older Linux
424c609719bSwdenk		kernels (which expect the clocks passed in the
425c609719bSwdenk		bd_info data to be in MHz) the environment variable
426c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
427c609719bSwdenk		converts clock data to MHZ before passing it to the
428c609719bSwdenk		Linux kernel.
429c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
430c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
431c609719bSwdenk		default environment.
432c609719bSwdenk
4335da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4345da627a4Swdenk
4355da627a4Swdenk		When transfering memsize parameter to linux, some versions
4365da627a4Swdenk		expect it to be in bytes, others in MB.
4375da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4385da627a4Swdenk
439213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
440f57f70aaSWolfgang Denk
441f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
442213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
443213bf8c8SGerald Van Baren		concepts).
444213bf8c8SGerald Van Baren
445213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
446213bf8c8SGerald Van Baren		 * New libfdt-based support
447213bf8c8SGerald Van Baren		 * Adds the "fdt" command
448213bf8c8SGerald Van Baren		 * The bootm command does _not_ modify the fdt
449213bf8c8SGerald Van Baren
450213bf8c8SGerald Van Baren		CONFIG_OF_FLAT_TREE
451213bf8c8SGerald Van Baren		 * Deprecated, see CONFIG_OF_LIBFDT
452213bf8c8SGerald Van Baren		 * Original ft_build.c-based support
453213bf8c8SGerald Van Baren		 * Automatically modifies the dft as part of the bootm command
454213bf8c8SGerald Van Baren		 * The environment variable "disable_of", when set,
455213bf8c8SGerald Van Baren		     disables this functionality.
456f57f70aaSWolfgang Denk
457f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
458f57f70aaSWolfgang Denk
459f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
460f57f70aaSWolfgang Denk
461f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
462c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
463f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
464c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
465f57f70aaSWolfgang Denk
466e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
467e4f880edSKumar Gala
468213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
469213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
470213bf8c8SGerald Van Baren		     will have a copy of the bd_t.  Space should be
471213bf8c8SGerald Van Baren		     pre-allocated in the dts for the bd_t.
472e4f880edSKumar Gala
473e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
474e4f880edSKumar Gala
475213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
476213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
477213bf8c8SGerald Van Baren		     will have a copy of u-boot's environment variables
478e4f880edSKumar Gala
4794e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4804e253137SKumar Gala
4814e253137SKumar Gala		Board code has addition modification that it wants to make
4824e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4836705d81eSwdenk
4840267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4850267768eSMatthew McClintock
4860267768eSMatthew McClintock		This define fills in the correct boot cpu in the boot
4870267768eSMatthew McClintock		param header, the default value is zero if undefined.
4880267768eSMatthew McClintock
4896705d81eSwdenk- Serial Ports:
4906705d81eSwdenk		CFG_PL010_SERIAL
4916705d81eSwdenk
4926705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4936705d81eSwdenk
4946705d81eSwdenk		CFG_PL011_SERIAL
4956705d81eSwdenk
4966705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4976705d81eSwdenk
4986705d81eSwdenk		CONFIG_PL011_CLOCK
4996705d81eSwdenk
5006705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
5016705d81eSwdenk		the clock speed of the UARTs.
5026705d81eSwdenk
5036705d81eSwdenk		CONFIG_PL01x_PORTS
5046705d81eSwdenk
5056705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5066705d81eSwdenk		define this to a list of base addresses for each (supported)
5076705d81eSwdenk		port. See e.g. include/configs/versatile.h
5086705d81eSwdenk
5096705d81eSwdenk
510c609719bSwdenk- Console Interface:
511c609719bSwdenk		Depending on board, define exactly one serial port
512c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
513c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
514c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
515c609719bSwdenk
516c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
517c609719bSwdenk		port routines must be defined elsewhere
518c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
519c609719bSwdenk
520c609719bSwdenk		CONFIG_CFB_CONSOLE
521c609719bSwdenk		Enables console device for a color framebuffer. Needs following
522c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
523c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
524c609719bSwdenk						(default big endian)
525c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
526c609719bSwdenk						rectangle fill
527c609719bSwdenk						(cf. smiLynxEM)
528c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
529c609719bSwdenk						bit-blit (cf. smiLynxEM)
530c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
531c609719bSwdenk						(cols=pitch)
532c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
533c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
534c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
535c609719bSwdenk						(0-5, cf. cfb_console.c)
536c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
537c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
538c609719bSwdenk						(i.e. i8042_kbd_init())
539c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
540c609719bSwdenk						(i.e. i8042_tstc)
541c609719bSwdenk			VIDEO_GETC_FCT		get char fct
542c609719bSwdenk						(i.e. i8042_getc)
543c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
544c609719bSwdenk						(requires blink timer
545c609719bSwdenk						cf. i8042.c)
546c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
547c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
548c609719bSwdenk						upper right corner
549c609719bSwdenk						(requires CFG_CMD_DATE)
550c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
551c609719bSwdenk						upper left corner
552a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
553a6c7ad2fSwdenk						linux_logo.h for logo.
554a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
555c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
556c609719bSwdenk						addional board info beside
557c609719bSwdenk						the logo
558c609719bSwdenk
559c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
560c609719bSwdenk		default i/o. Serial console can be forced with
561c609719bSwdenk		environment 'console=serial'.
562c609719bSwdenk
563a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
564a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
565a3ad8e26Swdenk		the "silent" environment variable. See
566a3ad8e26Swdenk		doc/README.silent for more information.
567a3ad8e26Swdenk
568c609719bSwdenk- Console Baudrate:
569c609719bSwdenk		CONFIG_BAUDRATE - in bps
570c609719bSwdenk		Select one of the baudrates listed in
571c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5723bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
573c609719bSwdenk
574c609719bSwdenk- Interrupt driven serial port input:
575c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
576c609719bSwdenk
577c609719bSwdenk		PPC405GP only.
578c609719bSwdenk		Use an interrupt handler for receiving data on the
579c609719bSwdenk		serial port. It also enables using hardware handshake
580c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
581c609719bSwdenk		bytes the interrupt driven input buffer should have.
582c609719bSwdenk
583109c0e3aSwdenk		Leave undefined to disable this feature, including
584109c0e3aSwdenk		disable the buffer and hardware handshake.
585c609719bSwdenk
5861d49b1f3Sstroese- Console UART Number:
5871d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5881d49b1f3Sstroese
5890c8721a4SWolfgang Denk		AMCC PPC4xx only.
5901d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5911d49b1f3Sstroese		as default U-Boot console.
5921d49b1f3Sstroese
593c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
594c609719bSwdenk		Delay before automatically booting the default image;
595c609719bSwdenk		set to -1 to disable autoboot.
596c609719bSwdenk
597c609719bSwdenk		See doc/README.autoboot for these options that
598c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
599c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
600c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
601c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
602c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
603c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
604c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
605c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
606c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
607c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
608c609719bSwdenk		CONFIG_RESET_TO_RETRY
609c609719bSwdenk
610c609719bSwdenk- Autoboot Command:
611c609719bSwdenk		CONFIG_BOOTCOMMAND
612c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
613c609719bSwdenk		define a command string that is automatically executed
614c609719bSwdenk		when no character is read on the console interface
615c609719bSwdenk		within "Boot Delay" after reset.
616c609719bSwdenk
617c609719bSwdenk		CONFIG_BOOTARGS
618c609719bSwdenk		This can be used to pass arguments to the bootm
619c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
620c609719bSwdenk		environment value "bootargs".
621c609719bSwdenk
622c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
623c609719bSwdenk		The value of these goes into the environment as
624c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
625c609719bSwdenk		as a convenience, when switching between booting from
626c609719bSwdenk		ram and nfs.
627c609719bSwdenk
628c609719bSwdenk- Pre-Boot Commands:
629c609719bSwdenk		CONFIG_PREBOOT
630c609719bSwdenk
631c609719bSwdenk		When this option is #defined, the existence of the
632c609719bSwdenk		environment variable "preboot" will be checked
633c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
634c609719bSwdenk		countdown and/or running the auto-boot command resp.
635c609719bSwdenk		entering interactive mode.
636c609719bSwdenk
637c609719bSwdenk		This feature is especially useful when "preboot" is
638c609719bSwdenk		automatically generated or modified. For an example
639c609719bSwdenk		see the LWMON board specific code: here "preboot" is
640c609719bSwdenk		modified when the user holds down a certain
641c609719bSwdenk		combination of keys on the (special) keyboard when
642c609719bSwdenk		booting the systems
643c609719bSwdenk
644c609719bSwdenk- Serial Download Echo Mode:
645c609719bSwdenk		CONFIG_LOADS_ECHO
646c609719bSwdenk		If defined to 1, all characters received during a
647c609719bSwdenk		serial download (using the "loads" command) are
648c609719bSwdenk		echoed back. This might be needed by some terminal
649c609719bSwdenk		emulations (like "cu"), but may as well just take
650c609719bSwdenk		time on others. This setting #define's the initial
651c609719bSwdenk		value of the "loads_echo" environment variable.
652c609719bSwdenk
653c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
654c609719bSwdenk		CONFIG_KGDB_BAUDRATE
655c609719bSwdenk		Select one of the baudrates listed in
656c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
657c609719bSwdenk
658c609719bSwdenk- Monitor Functions:
659c609719bSwdenk		CONFIG_COMMANDS
660c609719bSwdenk		Most monitor functions can be selected (or
661c609719bSwdenk		de-selected) by adjusting the definition of
662c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
663c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
664c609719bSwdenk		following values:
665c609719bSwdenk
666c609719bSwdenk		#define enables commands:
667c609719bSwdenk		-------------------------
668c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
66978137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
670c609719bSwdenk		CFG_CMD_BDI	  bdinfo
6716705d81eSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
67278137c3cSwdenk		CFG_CMD_BMP	* BMP support
6736705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
674c609719bSwdenk		CFG_CMD_BOOTD	  bootd
6756705d81eSwdenk		CFG_CMD_CACHE	* icache, dcache
676c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
677c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
6786705d81eSwdenk		CFG_CMD_DHCP	* DHCP support
67978137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
68078137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
6816705d81eSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
682953c5b6fSWolfgang Denk		CFG_CMD_ECHO	  echo arguments
683c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
6846705d81eSwdenk		CFG_CMD_ELF	* bootelf, bootvx
685c609719bSwdenk		CFG_CMD_ENV	  saveenv
686c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
6876705d81eSwdenk		CFG_CMD_FAT	* FAT partition support
6882262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
689c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
690c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
69178137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
692c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
693c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
694c609719bSwdenk		CFG_CMD_IMI	  iminfo
69578137c3cSwdenk		CFG_CMD_IMLS	  List all found images
696c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
697c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6986705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
69978137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
700c609719bSwdenk		CFG_CMD_KGDB	* kgdb
701c609719bSwdenk		CFG_CMD_LOADB	  loadb
702c609719bSwdenk		CFG_CMD_LOADS	  loads
703c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
70456523f12Swdenk				  loop, loopw, mtest
70578137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
7066705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
7076705d81eSwdenk		CFG_CMD_MII	* MII utility commands
70878137c3cSwdenk		CFG_CMD_NAND	* NAND support
709c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
710c609719bSwdenk		CFG_CMD_PCI	* pciinfo
711c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
71278137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
713ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
714c609719bSwdenk		CFG_CMD_REGINFO * Register dump
715c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
7166705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
717c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
71878137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
719b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
720c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
721c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
722c609719bSwdenk		CFG_CMD_USB	* USB support
72378137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
724c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
725a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
726ffc50f9bSMichal Simek		CFG_CMD_FSL	* Microblaze FSL support
727c609719bSwdenk		-----------------------------------------------
728c609719bSwdenk		CFG_CMD_ALL	all
729c609719bSwdenk
73081050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
731c609719bSwdenk				this is includes all commands, except
732c609719bSwdenk				the ones marked with "*" in the list
733c609719bSwdenk				above.
734c609719bSwdenk
735c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
73681050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
737c609719bSwdenk		override the default settings in the respective
738c609719bSwdenk		include file.
739c609719bSwdenk
740c609719bSwdenk		EXAMPLE: If you want all functions except of network
741c609719bSwdenk		support you can write:
742c609719bSwdenk
743c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
744c609719bSwdenk
745213bf8c8SGerald Van Baren	Other Commands:
746213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
747c609719bSwdenk
748c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
749c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
750c609719bSwdenk		what you (and your U-Boot users) are doing. Data
751c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
752c609719bSwdenk		8260 (where accesses to the IMMR region must be
753c609719bSwdenk		uncached), and it cannot be disabled on all other
754c609719bSwdenk		systems where we (mis-) use the data cache to hold an
755c609719bSwdenk		initial stack and some data.
756c609719bSwdenk
757c609719bSwdenk
758c609719bSwdenk		XXX - this list needs to get updated!
759c609719bSwdenk
760c609719bSwdenk- Watchdog:
761c609719bSwdenk		CONFIG_WATCHDOG
762c609719bSwdenk		If this variable is defined, it enables watchdog
7637152b1d0Swdenk		support. There must be support in the platform specific
764c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
765c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
766c609719bSwdenk		register.
767c609719bSwdenk
768c1551ea8Sstroese- U-Boot Version:
769c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
770c1551ea8Sstroese		If this variable is defined, an environment variable
771c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
772c1551ea8Sstroese		version as printed by the "version" command.
773c1551ea8Sstroese		This variable is readonly.
774c1551ea8Sstroese
775c609719bSwdenk- Real-Time Clock:
776c609719bSwdenk
777c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
778c609719bSwdenk		has to be selected, too. Define exactly one of the
779c609719bSwdenk		following options:
780c609719bSwdenk
781c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
782c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
783c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7841cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
785c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7867f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7873bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7884c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
789c609719bSwdenk
790b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
791b37c7e5eSwdenk		must also be configured. See I2C Support, below.
792b37c7e5eSwdenk
793c609719bSwdenk- Timestamp Support:
794c609719bSwdenk
795c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
796c609719bSwdenk		(date and time) of an image is printed by image
797c609719bSwdenk		commands like bootm or iminfo. This option is
798c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
799c609719bSwdenk
800c609719bSwdenk- Partition Support:
801c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
802c609719bSwdenk		and/or CONFIG_ISO_PARTITION
803c609719bSwdenk
804c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
805c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
806c609719bSwdenk		one partition type as well.
807c609719bSwdenk
808c609719bSwdenk- IDE Reset method:
8094d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8104d13cbadSwdenk		board configurations files but used nowhere!
811c609719bSwdenk
8124d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8134d13cbadSwdenk		be performed by calling the function
8144d13cbadSwdenk			ide_set_reset(int reset)
8154d13cbadSwdenk		which has to be defined in a board specific file
816c609719bSwdenk
817c609719bSwdenk- ATAPI Support:
818c609719bSwdenk		CONFIG_ATAPI
819c609719bSwdenk
820c609719bSwdenk		Set this to enable ATAPI support.
821c609719bSwdenk
822c40b2956Swdenk- LBA48 Support
823c40b2956Swdenk		CONFIG_LBA48
824c40b2956Swdenk
825c40b2956Swdenk		Set this to enable support for disks larger than 137GB
826c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
827c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
828c40b2956Swdenk		support disks up to 2.1TB.
829c40b2956Swdenk
830c40b2956Swdenk		CFG_64BIT_LBA:
831c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
832c40b2956Swdenk			Default is 32bit.
833c40b2956Swdenk
834c609719bSwdenk- SCSI Support:
835c609719bSwdenk		At the moment only there is only support for the
836c609719bSwdenk		SYM53C8XX SCSI controller; define
837c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
838c609719bSwdenk
839c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
840c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
841c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
842c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
843c609719bSwdenk		devices.
844c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
845c609719bSwdenk
846c609719bSwdenk- NETWORK Support (PCI):
847682011ffSwdenk		CONFIG_E1000
848682011ffSwdenk		Support for Intel 8254x gigabit chips.
849682011ffSwdenk
850c609719bSwdenk		CONFIG_EEPRO100
851c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
852c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
853c609719bSwdenk		write routine for first time initialisation.
854c609719bSwdenk
855c609719bSwdenk		CONFIG_TULIP
856c609719bSwdenk		Support for Digital 2114x chips.
857c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
858c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
859c609719bSwdenk
860c609719bSwdenk		CONFIG_NATSEMI
861c609719bSwdenk		Support for National dp83815 chips.
862c609719bSwdenk
863c609719bSwdenk		CONFIG_NS8382X
864c609719bSwdenk		Support for National dp8382[01] gigabit chips.
865c609719bSwdenk
86645219c46Swdenk- NETWORK Support (other):
86745219c46Swdenk
86845219c46Swdenk		CONFIG_DRIVER_LAN91C96
86945219c46Swdenk		Support for SMSC's LAN91C96 chips.
87045219c46Swdenk
87145219c46Swdenk			CONFIG_LAN91C96_BASE
87245219c46Swdenk			Define this to hold the physical address
87345219c46Swdenk			of the LAN91C96's I/O space
87445219c46Swdenk
87545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
87645219c46Swdenk			Define this to enable 32 bit addressing
87745219c46Swdenk
878f39748aeSwdenk		CONFIG_DRIVER_SMC91111
879f39748aeSwdenk		Support for SMSC's LAN91C111 chip
880f39748aeSwdenk
881f39748aeSwdenk			CONFIG_SMC91111_BASE
882f39748aeSwdenk			Define this to hold the physical address
883f39748aeSwdenk			of the device (I/O space)
884f39748aeSwdenk
885f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
886f39748aeSwdenk			Define this if data bus is 32 bits
887f39748aeSwdenk
888f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
889f39748aeSwdenk			Define this to use i/o functions instead of macros
890f39748aeSwdenk			(some hardware wont work with macros)
891f39748aeSwdenk
892c609719bSwdenk- USB Support:
893c609719bSwdenk		At the moment only the UHCI host controller is
8944d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
895c609719bSwdenk		CONFIG_USB_UHCI to enable it.
896c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
89730d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
898c609719bSwdenk		storage devices.
899c609719bSwdenk		Note:
900c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
901c609719bSwdenk		(TEAC FD-05PUB).
9024d13cbadSwdenk		MPC5200 USB requires additional defines:
9034d13cbadSwdenk			CONFIG_USB_CLOCK
9044d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
9054d13cbadSwdenk			CONFIG_USB_CONFIG
9064d13cbadSwdenk				for differential drivers: 0x00001000
9074d13cbadSwdenk				for single ended drivers: 0x00005000
9084d13cbadSwdenk
909c609719bSwdenk
91071f95118Swdenk- MMC Support:
91171f95118Swdenk		The MMC controller on the Intel PXA is supported. To
91271f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
91371f95118Swdenk		accessed from the boot prompt by mapping the device
91471f95118Swdenk		to physical memory similar to flash. Command line is
91571f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
91671f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
91771f95118Swdenk
9186705d81eSwdenk- Journaling Flash filesystem support:
9196705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9206705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9216705d81eSwdenk		Define these for a default partition on a NAND device
9226705d81eSwdenk
9236705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
9246705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
9256705d81eSwdenk		Define these for a default partition on a NOR device
9266705d81eSwdenk
9276705d81eSwdenk		CFG_JFFS_CUSTOM_PART
9286705d81eSwdenk		Define this to create an own partition. You have to provide a
9296705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9306705d81eSwdenk
9316705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9326705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
9336705d81eSwdenk		to disable the command chpart. This is the default when you
9346705d81eSwdenk		have not defined a custom partition
9356705d81eSwdenk
936c609719bSwdenk- Keyboard Support:
937c609719bSwdenk		CONFIG_ISA_KEYBOARD
938c609719bSwdenk
939c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
940c609719bSwdenk		support
941c609719bSwdenk
942c609719bSwdenk		CONFIG_I8042_KBD
943c609719bSwdenk		Standard PC keyboard driver with US (is default) and
944c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
945c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
946c609719bSwdenk		for cfb_console. Supports cursor blinking.
947c609719bSwdenk
948c609719bSwdenk- Video support:
949c609719bSwdenk		CONFIG_VIDEO
950c609719bSwdenk
951c609719bSwdenk		Define this to enable video support (for output to
952c609719bSwdenk		video).
953c609719bSwdenk
954c609719bSwdenk		CONFIG_VIDEO_CT69000
955c609719bSwdenk
956c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
957c609719bSwdenk
958c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
959eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
960eeb1b77bSwdenk		video output is selected via environment 'videoout'
961eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
962eeb1b77bSwdenk		assumed.
963c609719bSwdenk
964eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
965eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
966eeb1b77bSwdenk		are possible:
967eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
968eeb1b77bSwdenk		Following standard modes are supported	(* is default):
969eeb1b77bSwdenk
970eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
971eeb1b77bSwdenk		-------------+---------------------------------------------
972eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
973eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
974eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
975eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
976eeb1b77bSwdenk		-------------+---------------------------------------------
977c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
978c609719bSwdenk
979eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
980eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
981eeb1b77bSwdenk
982eeb1b77bSwdenk
983a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
984a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
985a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
986a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
987a6c7ad2fSwdenk
988682011ffSwdenk- Keyboard Support:
989682011ffSwdenk		CONFIG_KEYBOARD
990682011ffSwdenk
991682011ffSwdenk		Define this to enable a custom keyboard support.
992682011ffSwdenk		This simply calls drv_keyboard_init() which must be
993682011ffSwdenk		defined in your board-specific files.
994682011ffSwdenk		The only board using this so far is RBC823.
995a6c7ad2fSwdenk
996c609719bSwdenk- LCD Support:	CONFIG_LCD
997c609719bSwdenk
998c609719bSwdenk		Define this to enable LCD support (for output to LCD
999c609719bSwdenk		display); also select one of the supported displays
1000c609719bSwdenk		by defining one of these:
1001c609719bSwdenk
1002fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1003c609719bSwdenk
1004fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1005c609719bSwdenk
1006fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1007c609719bSwdenk
1008fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1009fd3103bbSwdenk			Active, color, single scan.
1010fd3103bbSwdenk
1011fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1012fd3103bbSwdenk
1013fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1014c609719bSwdenk			Active, color, single scan.
1015c609719bSwdenk
1016c609719bSwdenk		CONFIG_SHARP_16x9
1017c609719bSwdenk
1018c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1019c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1020c609719bSwdenk
1021c609719bSwdenk		CONFIG_SHARP_LQ64D341
1022c609719bSwdenk
1023c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1024c609719bSwdenk			Active, color, single scan.
1025c609719bSwdenk
1026c609719bSwdenk		CONFIG_HLD1045
1027c609719bSwdenk
1028c609719bSwdenk			HLD1045 display, 640x480.
1029c609719bSwdenk			Active, color, single scan.
1030c609719bSwdenk
1031c609719bSwdenk		CONFIG_OPTREX_BW
1032c609719bSwdenk
1033c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1034c609719bSwdenk			or
1035c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1036c609719bSwdenk			or
1037c609719bSwdenk			Hitachi	 SP14Q002
1038c609719bSwdenk
1039c609719bSwdenk			320x240. Black & white.
1040c609719bSwdenk
1041c609719bSwdenk		Normally display is black on white background; define
1042c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1043c609719bSwdenk
10447152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1045d791b1dcSwdenk
1046d791b1dcSwdenk		If this option is set, the environment is checked for
1047d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1048d791b1dcSwdenk		of logo, copyright and system information on the LCD
1049e94d2cd9Swdenk		is suppressed and the BMP image at the address
1050d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1051d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1052d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1053d791b1dcSwdenk		loaded very quickly after power-on.
1054d791b1dcSwdenk
105598f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
105698f4a3dfSStefan Roese
105798f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
105898f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
105998f4a3dfSStefan Roese		splashscreen support or the bmp command.
106098f4a3dfSStefan Roese
1061c29fdfc1Swdenk- Compression support:
1062c29fdfc1Swdenk		CONFIG_BZIP2
1063c29fdfc1Swdenk
1064c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1065c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1066c29fdfc1Swdenk		compressed images are supported.
1067c29fdfc1Swdenk
1068c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1069c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1070c29fdfc1Swdenk		be at least 4MB.
1071d791b1dcSwdenk
107217ea1177Swdenk- MII/PHY support:
107317ea1177Swdenk		CONFIG_PHY_ADDR
107417ea1177Swdenk
107517ea1177Swdenk		The address of PHY on MII bus.
107617ea1177Swdenk
107717ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
107817ea1177Swdenk
107917ea1177Swdenk		The clock frequency of the MII bus
108017ea1177Swdenk
108117ea1177Swdenk		CONFIG_PHY_GIGE
108217ea1177Swdenk
108317ea1177Swdenk		If this option is set, support for speed/duplex
108417ea1177Swdenk		detection of Gigabit PHY is included.
108517ea1177Swdenk
108617ea1177Swdenk		CONFIG_PHY_RESET_DELAY
108717ea1177Swdenk
108817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
108917ea1177Swdenk		reset before any MII register access is possible.
109017ea1177Swdenk		For such PHY, set this option to the usec delay
109117ea1177Swdenk		required. (minimum 300usec for LXT971A)
109217ea1177Swdenk
109317ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
109417ea1177Swdenk
109517ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
109617ea1177Swdenk		command issued before MII status register can be read
109717ea1177Swdenk
1098c609719bSwdenk- Ethernet address:
1099c609719bSwdenk		CONFIG_ETHADDR
1100c609719bSwdenk		CONFIG_ETH2ADDR
1101c609719bSwdenk		CONFIG_ETH3ADDR
1102c609719bSwdenk
1103c609719bSwdenk		Define a default value for ethernet address to use
1104c609719bSwdenk		for the respective ethernet interface, in case this
1105c609719bSwdenk		is not determined automatically.
1106c609719bSwdenk
1107c609719bSwdenk- IP address:
1108c609719bSwdenk		CONFIG_IPADDR
1109c609719bSwdenk
1110c609719bSwdenk		Define a default value for the IP address to use for
1111c609719bSwdenk		the default ethernet interface, in case this is not
1112c609719bSwdenk		determined through e.g. bootp.
1113c609719bSwdenk
1114c609719bSwdenk- Server IP address:
1115c609719bSwdenk		CONFIG_SERVERIP
1116c609719bSwdenk
1117c609719bSwdenk		Defines a default value for theIP address of a TFTP
1118c609719bSwdenk		server to contact when using the "tftboot" command.
1119c609719bSwdenk
1120c609719bSwdenk- BOOTP Recovery Mode:
1121c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1122c609719bSwdenk
1123c609719bSwdenk		If you have many targets in a network that try to
1124c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1125c609719bSwdenk		systems send out BOOTP requests at precisely the same
1126c609719bSwdenk		moment (which would happen for instance at recovery
1127c609719bSwdenk		from a power failure, when all systems will try to
1128c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1129c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1130c609719bSwdenk		inserted before sending out BOOTP requests. The
1131c609719bSwdenk		following delays are insterted then:
1132c609719bSwdenk
1133c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1134c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1135c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1136c609719bSwdenk		4th and following
1137c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1138c609719bSwdenk
1139fe389a82Sstroese- DHCP Advanced Options:
1140fe389a82Sstroese		CONFIG_BOOTP_MASK
1141fe389a82Sstroese
1142fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1143fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1144fe389a82Sstroese
1145fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1146fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1147fe389a82Sstroese		than one DNS serverip is offered to the client.
1148fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1149fe389a82Sstroese		serverip will be stored in the additional environment
1150fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1151fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1152fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1153fe389a82Sstroese
1154fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1155fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1156fe389a82Sstroese		need the hostname of the DHCP requester.
1157fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1158fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1159fe389a82Sstroese		environment variable is passed as option 12 to
1160fe389a82Sstroese		the DHCP server.
1161fe389a82Sstroese
1162a3d991bdSwdenk - CDP Options:
1163a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1164a3d991bdSwdenk
1165a3d991bdSwdenk		The device id used in CDP trigger frames.
1166a3d991bdSwdenk
1167a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1168a3d991bdSwdenk
1169a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1170a3d991bdSwdenk		of the device.
1171a3d991bdSwdenk
1172a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1173a3d991bdSwdenk
1174a3d991bdSwdenk		A printf format string which contains the ascii name of
1175a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1176a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1177a3d991bdSwdenk
1178a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1179a3d991bdSwdenk
1180a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1181a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1182a3d991bdSwdenk
1183a3d991bdSwdenk		CONFIG_CDP_VERSION
1184a3d991bdSwdenk
1185a3d991bdSwdenk		An ascii string containing the version of the software.
1186a3d991bdSwdenk
1187a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1188a3d991bdSwdenk
1189a3d991bdSwdenk		An ascii string containing the name of the platform.
1190a3d991bdSwdenk
1191a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1192a3d991bdSwdenk
1193a3d991bdSwdenk		A 32bit integer sent on the trigger.
1194a3d991bdSwdenk
1195a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1196a3d991bdSwdenk
1197a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1198a3d991bdSwdenk		device in .1 of milliwatts.
1199a3d991bdSwdenk
1200a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1201a3d991bdSwdenk
1202a3d991bdSwdenk		A byte containing the id of the VLAN.
1203a3d991bdSwdenk
1204c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1205c609719bSwdenk
1206c609719bSwdenk		Several configurations allow to display the current
1207c609719bSwdenk		status using a LED. For instance, the LED will blink
1208c609719bSwdenk		fast while running U-Boot code, stop blinking as
1209c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1210c609719bSwdenk		start blinking slow once the Linux kernel is running
1211c609719bSwdenk		(supported by a status LED driver in the Linux
1212c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1213c609719bSwdenk		feature in U-Boot.
1214c609719bSwdenk
1215c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1216c609719bSwdenk
1217c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1218c609719bSwdenk		on those systems that support this (optional)
1219c609719bSwdenk		feature, like the TQM8xxL modules.
1220c609719bSwdenk
1221c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1222c609719bSwdenk
1223b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1224b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1225b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1226c609719bSwdenk
1227b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1228b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1229b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1230b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1231c609719bSwdenk		command line interface.
1232c609719bSwdenk
1233bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1234bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1235bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1236bb99ad6dSBen Warren		deprecated and may disappear in the future.
1237bb99ad6dSBen Warren
1238bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1239c609719bSwdenk
1240b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1241b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1242b37c7e5eSwdenk		support for I2C.
1243c609719bSwdenk
1244b37c7e5eSwdenk		There are several other quantities that must also be
1245b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1246c609719bSwdenk
1247b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1248b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1249b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1250b37c7e5eSwdenk		the cpu's i2c node address).
1251c609719bSwdenk
1252b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1253b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1254b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1255b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1256b37c7e5eSwdenk
1257b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1258b37c7e5eSwdenk
1259b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1260b37c7e5eSwdenk		then the following macros need to be defined (examples are
1261b37c7e5eSwdenk		from include/configs/lwmon.h):
1262c609719bSwdenk
1263c609719bSwdenk		I2C_INIT
1264c609719bSwdenk
1265b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1266c609719bSwdenk		controller or configure ports.
1267c609719bSwdenk
1268b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1269b37c7e5eSwdenk
1270c609719bSwdenk		I2C_PORT
1271c609719bSwdenk
1272c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1273c609719bSwdenk		assumes both bits are on the same port). Valid values
1274c609719bSwdenk		are 0..3 for ports A..D.
1275c609719bSwdenk
1276c609719bSwdenk		I2C_ACTIVE
1277c609719bSwdenk
1278c609719bSwdenk		The code necessary to make the I2C data line active
1279c609719bSwdenk		(driven).  If the data line is open collector, this
1280c609719bSwdenk		define can be null.
1281c609719bSwdenk
1282b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1283b37c7e5eSwdenk
1284c609719bSwdenk		I2C_TRISTATE
1285c609719bSwdenk
1286c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1287c609719bSwdenk		(inactive).  If the data line is open collector, this
1288c609719bSwdenk		define can be null.
1289c609719bSwdenk
1290b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1291b37c7e5eSwdenk
1292c609719bSwdenk		I2C_READ
1293c609719bSwdenk
1294c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1295c609719bSwdenk		FALSE if it is low.
1296c609719bSwdenk
1297b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1298b37c7e5eSwdenk
1299c609719bSwdenk		I2C_SDA(bit)
1300c609719bSwdenk
1301c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1302c609719bSwdenk		is FALSE, it clears it (low).
1303c609719bSwdenk
1304b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1305b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1306b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1307b37c7e5eSwdenk
1308c609719bSwdenk		I2C_SCL(bit)
1309c609719bSwdenk
1310c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1311c609719bSwdenk		is FALSE, it clears it (low).
1312c609719bSwdenk
1313b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1314b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1315b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1316b37c7e5eSwdenk
1317c609719bSwdenk		I2C_DELAY
1318c609719bSwdenk
1319c609719bSwdenk		This delay is invoked four times per clock cycle so this
1320c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1321b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1322b37c7e5eSwdenk		like:
1323b37c7e5eSwdenk
1324b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1325c609719bSwdenk
132647cd00faSwdenk		CFG_I2C_INIT_BOARD
132747cd00faSwdenk
132847cd00faSwdenk		When a board is reset during an i2c bus transfer
132947cd00faSwdenk		chips might think that the current transfer is still
133047cd00faSwdenk		in progress. On some boards it is possible to access
133147cd00faSwdenk		the i2c SCLK line directly, either by using the
133247cd00faSwdenk		processor pin as a GPIO or by having a second pin
133347cd00faSwdenk		connected to the bus. If this option is defined a
133447cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
133547cd00faSwdenk		is run early in the boot sequence.
133647cd00faSwdenk
133717ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
133817ea1177Swdenk
133917ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
134017ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
134117ea1177Swdenk		variable "i2cfast". (see also i2cfast)
134217ea1177Swdenk
1343bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1344bb99ad6dSBen Warren
1345bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1346bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1347bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1348bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1349bb99ad6dSBen Warren
1350bb99ad6dSBen Warren		CFG_I2C_NOPROBES
1351bb99ad6dSBen Warren
1352bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1353bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1354bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1355bb99ad6dSBen Warren		pairs.  Otherwise, specify a 1D array of device addresses
1356bb99ad6dSBen Warren
1357bb99ad6dSBen Warren		e.g.
1358bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1359bb99ad6dSBen Warren			#define CFG_I2C_NOPROBES	{0x50,0x68}
1360bb99ad6dSBen Warren
1361bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1362bb99ad6dSBen Warren
1363bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1364bb99ad6dSBen Warren			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1365bb99ad6dSBen Warren
1366bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1367bb99ad6dSBen Warren
1368be5e6181STimur Tabi		CFG_SPD_BUS_NUM
1369be5e6181STimur Tabi
1370be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1371be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1372be5e6181STimur Tabi
13730dc018ecSStefan Roese		CFG_RTC_BUS_NUM
13740dc018ecSStefan Roese
13750dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
13760dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
13770dc018ecSStefan Roese
13780dc018ecSStefan Roese		CFG_DTT_BUS_NUM
13790dc018ecSStefan Roese
13800dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
13810dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
13820dc018ecSStefan Roese
1383be5e6181STimur Tabi		CONFIG_FSL_I2C
1384be5e6181STimur Tabi
1385be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
1386be5e6181STimur Tabi		drivers/fsl_i2c.c.
1387be5e6181STimur Tabi
1388be5e6181STimur Tabi
1389c609719bSwdenk- SPI Support:	CONFIG_SPI
1390c609719bSwdenk
1391c609719bSwdenk		Enables SPI driver (so far only tested with
1392c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1393c609719bSwdenk		D/As on the SACSng board)
1394c609719bSwdenk
1395c609719bSwdenk		CONFIG_SPI_X
1396c609719bSwdenk
1397c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1398c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1399c609719bSwdenk
1400c609719bSwdenk		CONFIG_SOFT_SPI
1401c609719bSwdenk
1402c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1403c609719bSwdenk		using hardware support. This is a general purpose
1404c609719bSwdenk		driver that only requires three general I/O port pins
1405c609719bSwdenk		(two outputs, one input) to function. If this is
1406c609719bSwdenk		defined, the board configuration must define several
1407c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1408c609719bSwdenk		an example, see include/configs/sacsng.h.
1409c609719bSwdenk
1410c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1411c609719bSwdenk
1412c609719bSwdenk		Specify the number of FPGA devices to support.
1413c609719bSwdenk
1414c609719bSwdenk		CONFIG_FPGA
1415c609719bSwdenk
1416c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1417c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1418c609719bSwdenk
1419c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1420c609719bSwdenk
1421c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1422c609719bSwdenk
1423c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1424c609719bSwdenk
1425c609719bSwdenk		Enable checks on FPGA configuration interface busy
1426c609719bSwdenk		status by the configuration function. This option
1427c609719bSwdenk		will require a board or device specific function to
1428c609719bSwdenk		be written.
1429c609719bSwdenk
1430c609719bSwdenk		CONFIG_FPGA_DELAY
1431c609719bSwdenk
1432c609719bSwdenk		If defined, a function that provides delays in the FPGA
1433c609719bSwdenk		configuration driver.
1434c609719bSwdenk
1435c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1436c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1437c609719bSwdenk
1438c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1439c609719bSwdenk
1440c609719bSwdenk		Check for configuration errors during FPGA bitfile
1441c609719bSwdenk		loading. For example, abort during Virtex II
1442c609719bSwdenk		configuration if the INIT_B line goes low (which
1443c609719bSwdenk		indicated a CRC error).
1444c609719bSwdenk
1445c609719bSwdenk		CFG_FPGA_WAIT_INIT
1446c609719bSwdenk
1447c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1448c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1449c609719bSwdenk		FPGA configuration sequence. The default time is 500
1450c609719bSwdenk		mS.
1451c609719bSwdenk
1452c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1453c609719bSwdenk
1454c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1455c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1456c609719bSwdenk
1457c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1458c609719bSwdenk
1459c609719bSwdenk		Time to wait after FPGA configuration. The default is
1460c609719bSwdenk		200 mS.
1461c609719bSwdenk
1462c609719bSwdenk- Configuration Management:
1463c609719bSwdenk		CONFIG_IDENT_STRING
1464c609719bSwdenk
1465c609719bSwdenk		If defined, this string will be added to the U-Boot
1466c609719bSwdenk		version information (U_BOOT_VERSION)
1467c609719bSwdenk
1468c609719bSwdenk- Vendor Parameter Protection:
1469c609719bSwdenk
1470c609719bSwdenk		U-Boot considers the values of the environment
1471c609719bSwdenk		variables "serial#" (Board Serial Number) and
14727152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1473c609719bSwdenk		are set once by the board vendor / manufacturer, and
1474c609719bSwdenk		protects these variables from casual modification by
1475c609719bSwdenk		the user. Once set, these variables are read-only,
1476c609719bSwdenk		and write or delete attempts are rejected. You can
1477c609719bSwdenk		change this behviour:
1478c609719bSwdenk
1479c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1480c609719bSwdenk		file, the write protection for vendor parameters is
148147cd00faSwdenk		completely disabled. Anybody can change or delete
1482c609719bSwdenk		these parameters.
1483c609719bSwdenk
1484c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1485c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1486c609719bSwdenk		ethernet address is installed in the environment,
1487c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1488c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1489c609719bSwdenk		read-only.]
1490c609719bSwdenk
1491c609719bSwdenk- Protected RAM:
1492c609719bSwdenk		CONFIG_PRAM
1493c609719bSwdenk
1494c609719bSwdenk		Define this variable to enable the reservation of
1495c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1496c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1497c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1498c609719bSwdenk		this default value by defining an environment
1499c609719bSwdenk		variable "pram" to the number of kB you want to
1500c609719bSwdenk		reserve. Note that the board info structure will
1501c609719bSwdenk		still show the full amount of RAM. If pRAM is
1502c609719bSwdenk		reserved, a new environment variable "mem" will
1503c609719bSwdenk		automatically be defined to hold the amount of
1504c609719bSwdenk		remaining RAM in a form that can be passed as boot
1505c609719bSwdenk		argument to Linux, for instance like that:
1506c609719bSwdenk
1507fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1508c609719bSwdenk			saveenv
1509c609719bSwdenk
1510c609719bSwdenk		This way you can tell Linux not to use this memory,
1511c609719bSwdenk		either, which results in a memory region that will
1512c609719bSwdenk		not be affected by reboots.
1513c609719bSwdenk
1514c609719bSwdenk		*WARNING* If your board configuration uses automatic
1515c609719bSwdenk		detection of the RAM size, you must make sure that
1516c609719bSwdenk		this memory test is non-destructive. So far, the
1517c609719bSwdenk		following board configurations are known to be
1518c609719bSwdenk		"pRAM-clean":
1519c609719bSwdenk
1520c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1521c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1522c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1523c609719bSwdenk
1524c609719bSwdenk- Error Recovery:
1525c609719bSwdenk		CONFIG_PANIC_HANG
1526c609719bSwdenk
1527c609719bSwdenk		Define this variable to stop the system in case of a
1528c609719bSwdenk		fatal error, so that you have to reset it manually.
1529c609719bSwdenk		This is probably NOT a good idea for an embedded
1530c609719bSwdenk		system where you want to system to reboot
1531c609719bSwdenk		automatically as fast as possible, but it may be
1532c609719bSwdenk		useful during development since you can try to debug
1533c609719bSwdenk		the conditions that lead to the situation.
1534c609719bSwdenk
1535c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1536c609719bSwdenk
1537c609719bSwdenk		This variable defines the number of retries for
1538c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1539c609719bSwdenk		before giving up the operation. If not defined, a
1540c609719bSwdenk		default value of 5 is used.
1541c609719bSwdenk
1542c609719bSwdenk- Command Interpreter:
15438078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
154404a85b3bSwdenk
154504a85b3bSwdenk		Enable auto completion of commands using TAB.
154604a85b3bSwdenk
15478078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
15488078f1a5SWolfgang Denk		for the "hush" shell.
15498078f1a5SWolfgang Denk
15508078f1a5SWolfgang Denk
1551c609719bSwdenk		CFG_HUSH_PARSER
1552c609719bSwdenk
1553c609719bSwdenk		Define this variable to enable the "hush" shell (from
1554c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1555c609719bSwdenk		powerful command line syntax like
1556c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1557c609719bSwdenk		constructs ("shell scripts").
1558c609719bSwdenk
1559c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1560c609719bSwdenk		with a somewhat smaller memory footprint.
1561c609719bSwdenk
1562c609719bSwdenk
1563c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1564c609719bSwdenk
1565c609719bSwdenk		This defines the secondary prompt string, which is
1566c609719bSwdenk		printed when the command interpreter needs more input
1567c609719bSwdenk		to complete a command. Usually "> ".
1568c609719bSwdenk
1569c609719bSwdenk	Note:
1570c609719bSwdenk
1571c609719bSwdenk		In the current implementation, the local variables
1572c609719bSwdenk		space and global environment variables space are
1573c609719bSwdenk		separated. Local variables are those you define by
15743b57fe0aSwdenk		simply typing `name=value'. To access a local
1575c609719bSwdenk		variable later on, you have write `$name' or
15763b57fe0aSwdenk		`${name}'; to execute the contents of a variable
15773b57fe0aSwdenk		directly type `$name' at the command prompt.
1578c609719bSwdenk
1579c609719bSwdenk		Global environment variables are those you use
1580c609719bSwdenk		setenv/printenv to work with. To run a command stored
1581c609719bSwdenk		in such a variable, you need to use the run command,
1582c609719bSwdenk		and you must not use the '$' sign to access them.
1583c609719bSwdenk
1584c609719bSwdenk		To store commands and special characters in a
1585c609719bSwdenk		variable, please use double quotation marks
1586c609719bSwdenk		surrounding the whole text of the variable, instead
1587c609719bSwdenk		of the backslashes before semicolons and special
1588c609719bSwdenk		symbols.
1589c609719bSwdenk
1590aa0c71acSWolfgang Denk- Commandline Editing and History:
1591aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1592aa0c71acSWolfgang Denk
1593aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1594aa0c71acSWolfgang Denk		commandline input operations
1595aa0c71acSWolfgang Denk
1596a8c7c708Swdenk- Default Environment:
1597c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1598c609719bSwdenk
1599c609719bSwdenk		Define this to contain any number of null terminated
1600c609719bSwdenk		strings (variable = value pairs) that will be part of
16017152b1d0Swdenk		the default environment compiled into the boot image.
16022262cfeeSwdenk
1603c609719bSwdenk		For example, place something like this in your
1604c609719bSwdenk		board's config file:
1605c609719bSwdenk
1606c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1607c609719bSwdenk			"myvar1=value1\0" \
1608c609719bSwdenk			"myvar2=value2\0"
1609c609719bSwdenk
1610c609719bSwdenk		Warning: This method is based on knowledge about the
1611c609719bSwdenk		internal format how the environment is stored by the
16122262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1613c609719bSwdenk		interface! Although it is unlikely that this format
16147152b1d0Swdenk		will change soon, there is no guarantee either.
1615c609719bSwdenk		You better know what you are doing here.
1616c609719bSwdenk
1617c609719bSwdenk		Note: overly (ab)use of the default environment is
1618c609719bSwdenk		discouraged. Make sure to check other ways to preset
1619c609719bSwdenk		the environment like the autoscript function or the
1620c609719bSwdenk		boot command first.
1621c609719bSwdenk
1622a8c7c708Swdenk- DataFlash Support:
16232abbe075Swdenk		CONFIG_HAS_DATAFLASH
16242abbe075Swdenk
16252abbe075Swdenk		Defining this option enables DataFlash features and
16262abbe075Swdenk		allows to read/write in Dataflash via the standard
16272abbe075Swdenk		commands cp, md...
16282abbe075Swdenk
16293f85ce27Swdenk- SystemACE Support:
16303f85ce27Swdenk		CONFIG_SYSTEMACE
16313f85ce27Swdenk
16323f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
16333f85ce27Swdenk		chips attached via some sort of local bus. The address
16343f85ce27Swdenk		of the chip must alsh be defined in the
16353f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
16363f85ce27Swdenk
16373f85ce27Swdenk		#define CONFIG_SYSTEMACE
16383f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
16393f85ce27Swdenk
16403f85ce27Swdenk		When SystemACE support is added, the "ace" device type
16413f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
16423f85ce27Swdenk
1643ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1644ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1645ecb0ccd9SWolfgang Denk
164628cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1647ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
164828cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1649ecb0ccd9SWolfgang Denk		number generator is used.
1650ecb0ccd9SWolfgang Denk
165128cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
165228cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
165328cb9375SWolfgang Denk		defined, the normal port 69 is used.
165428cb9375SWolfgang Denk
165528cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1656ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1657ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1658ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1659ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1660ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1661ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1662ecb0ccd9SWolfgang Denk
1663a8c7c708Swdenk- Show boot progress:
1664c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1665c609719bSwdenk
1666c609719bSwdenk		Defining this option allows to add some board-
1667c609719bSwdenk		specific code (calling a user-provided function
1668c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1669c609719bSwdenk		the system's boot progress on some display (for
1670c609719bSwdenk		example, some LED's) on your board. At the moment,
1671c609719bSwdenk		the following checkpoints are implemented:
1672c609719bSwdenk
1673c609719bSwdenk  Arg	Where			When
1674c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1675c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1676c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1677c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1678c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1679c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1680c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1681c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1682c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1683c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1684c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1685c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1686c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1687c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1688c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1689c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1690c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1691c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1692c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1693c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1694c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1695c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1696c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1697c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1698c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1699c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1700c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1701c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1702c609719bSwdenk
170363e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
170463e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
170563e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
170663e73c9aSwdenk
1707c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1708c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1709c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1710c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1711c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1712c609719bSwdenk
1713c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1714c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1715c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1716c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1717c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1718c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1719c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1720c609719bSwdenk
1721206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1722206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1723206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1724206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1725206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1726206c60cbSwdenk
1727206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1728c609719bSwdenk
1729c609719bSwdenk
1730c609719bSwdenkModem Support:
1731c609719bSwdenk--------------
1732c609719bSwdenk
173385ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1734c609719bSwdenk
1735c609719bSwdenk- Modem support endable:
1736c609719bSwdenk		CONFIG_MODEM_SUPPORT
1737c609719bSwdenk
1738c609719bSwdenk- RTS/CTS Flow control enable:
1739c609719bSwdenk		CONFIG_HWFLOW
1740c609719bSwdenk
1741c609719bSwdenk- Modem debug support:
1742c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1743c609719bSwdenk
1744c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1745c609719bSwdenk		for modem support. Useful only with BDI2000.
1746c609719bSwdenk
1747a8c7c708Swdenk- Interrupt support (PPC):
1748a8c7c708Swdenk
1749a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1750a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1751a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1752a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1753a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1754a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1755a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1756a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1757a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1758a8c7c708Swdenk		general timer_interrupt().
1759a8c7c708Swdenk
1760c609719bSwdenk- General:
1761c609719bSwdenk
1762c609719bSwdenk		In the target system modem support is enabled when a
1763c609719bSwdenk		specific key (key combination) is pressed during
1764c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1765c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1766c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1767c609719bSwdenk		function, returning 1 and thus enabling modem
1768c609719bSwdenk		initialization.
1769c609719bSwdenk
1770c609719bSwdenk		If there are no modem init strings in the
1771c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1772c609719bSwdenk		previous output (banner, info printfs) will be
1773c609719bSwdenk		supressed, though.
1774c609719bSwdenk
1775c609719bSwdenk		See also: doc/README.Modem
1776c609719bSwdenk
1777c609719bSwdenk
1778c609719bSwdenkConfiguration Settings:
1779c609719bSwdenk-----------------------
1780c609719bSwdenk
1781c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1782c609719bSwdenk		undefine this when you're short of memory.
1783c609719bSwdenk
1784c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1785c609719bSwdenk		prompt for user input.
1786c609719bSwdenk
1787c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1788c609719bSwdenk
1789c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1790c609719bSwdenk
1791c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1792c609719bSwdenk
1793c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1794c609719bSwdenk		the application (usually a Linux kernel) when it is
1795c609719bSwdenk		booted
1796c609719bSwdenk
1797c609719bSwdenk- CFG_BAUDRATE_TABLE:
1798c609719bSwdenk		List of legal baudrate settings for this board.
1799c609719bSwdenk
1800c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1801c609719bSwdenk		Suppress display of console information at boot.
1802c609719bSwdenk
1803c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1804c609719bSwdenk		If the board specific function
1805c609719bSwdenk			extern int overwrite_console (void);
1806c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1807c609719bSwdenk		serial port, else the settings in the environment are used.
1808c609719bSwdenk
1809c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1810c609719bSwdenk		Enable the call to overwrite_console().
1811c609719bSwdenk
1812c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1813c609719bSwdenk		Enable overwrite of previous console environment settings.
1814c609719bSwdenk
1815c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1816c609719bSwdenk		Begin and End addresses of the area used by the
1817c609719bSwdenk		simple memory test.
1818c609719bSwdenk
1819c609719bSwdenk- CFG_ALT_MEMTEST:
1820c609719bSwdenk		Enable an alternate, more extensive memory test.
1821c609719bSwdenk
18225f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
18235f535fe1Swdenk		Scratch address used by the alternate memory test
18245f535fe1Swdenk		You only need to set this if address zero isn't writeable
18255f535fe1Swdenk
1826c609719bSwdenk- CFG_TFTP_LOADADDR:
1827c609719bSwdenk		Default load address for network file downloads
1828c609719bSwdenk
1829c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1830c609719bSwdenk		Enable temporary baudrate change while serial download
1831c609719bSwdenk
1832c609719bSwdenk- CFG_SDRAM_BASE:
1833c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1834c609719bSwdenk
1835c609719bSwdenk- CFG_MBIO_BASE:
1836c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1837c609719bSwdenk		Cogent motherboard)
1838c609719bSwdenk
1839c609719bSwdenk- CFG_FLASH_BASE:
1840c609719bSwdenk		Physical start address of Flash memory.
1841c609719bSwdenk
1842c609719bSwdenk- CFG_MONITOR_BASE:
1843c609719bSwdenk		Physical start address of boot monitor code (set by
1844c609719bSwdenk		make config files to be same as the text base address
1845c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1846c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1847c609719bSwdenk
1848c609719bSwdenk- CFG_MONITOR_LEN:
18493b57fe0aSwdenk		Size of memory reserved for monitor code, used to
18503b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
18513b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
18523b57fe0aSwdenk		flash sector.
1853c609719bSwdenk
1854c609719bSwdenk- CFG_MALLOC_LEN:
1855c609719bSwdenk		Size of DRAM reserved for malloc() use.
1856c609719bSwdenk
185715940c9aSStefan Roese- CFG_BOOTM_LEN:
185815940c9aSStefan Roese		Normally compressed uImages are limited to an
185915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
186015940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
186115940c9aSStefan Roese		to adjust this setting to your needs.
1862c609719bSwdenk
1863c609719bSwdenk- CFG_BOOTMAPSZ:
1864c609719bSwdenk		Maximum size of memory mapped by the startup code of
1865c609719bSwdenk		the Linux kernel; all data that must be processed by
1866c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1867c609719bSwdenk		initrd image) must be put below this limit.
1868c609719bSwdenk
1869c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1870c609719bSwdenk		Max number of Flash memory banks
1871c609719bSwdenk
1872c609719bSwdenk- CFG_MAX_FLASH_SECT:
1873c609719bSwdenk		Max number of sectors on a Flash chip
1874c609719bSwdenk
1875c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1876c609719bSwdenk		Timeout for Flash erase operations (in ms)
1877c609719bSwdenk
1878c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1879c609719bSwdenk		Timeout for Flash write operations (in ms)
1880c609719bSwdenk
18818564acf9Swdenk- CFG_FLASH_LOCK_TOUT
18828564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
18838564acf9Swdenk
18848564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
18858564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
18868564acf9Swdenk
18878564acf9Swdenk- CFG_FLASH_PROTECTION
18888564acf9Swdenk		If defined, hardware flash sectors protection is used
18898564acf9Swdenk		instead of U-Boot software protection.
18908564acf9Swdenk
1891c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1892c609719bSwdenk
1893c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1894c609719bSwdenk		without this option such a download has to be
1895c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1896c609719bSwdenk		copy from RAM to flash.
1897c609719bSwdenk
1898c609719bSwdenk		The two-step approach is usually more reliable, since
1899c609719bSwdenk		you can check if the download worked before you erase
1900c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1901c609719bSwdenk		too limited to allow for a tempory copy of the
1902c609719bSwdenk		downloaded image) this option may be very useful.
1903c609719bSwdenk
1904c609719bSwdenk- CFG_FLASH_CFI:
1905c609719bSwdenk		Define if the flash driver uses extra elements in the
19065653fc33Swdenk		common flash structure for storing flash geometry.
19075653fc33Swdenk
19085653fc33Swdenk- CFG_FLASH_CFI_DRIVER
19095653fc33Swdenk		This option also enables the building of the cfi_flash driver
19105653fc33Swdenk		in the drivers directory
191153cf9435Sstroese
19125568e613SStefan Roese- CFG_FLASH_QUIET_TEST
19135568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
19145568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
19155568e613SStefan Roese		is useful, if some of the configured banks are only
19165568e613SStefan Roese		optionally available.
19175568e613SStefan Roese
191853cf9435Sstroese- CFG_RX_ETH_BUFFER:
191953cf9435Sstroese		Defines the number of ethernet receive buffers. On some
192053cf9435Sstroese		ethernet controllers it is recommended to set this value
192153cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
192253cf9435Sstroese		buffers can be full shortly after enabling the interface
192353cf9435Sstroese		on high ethernet traffic.
192453cf9435Sstroese		Defaults to 4 if not defined.
1925c609719bSwdenk
1926c609719bSwdenkThe following definitions that deal with the placement and management
1927c609719bSwdenkof environment data (variable area); in general, we support the
1928c609719bSwdenkfollowing configurations:
1929c609719bSwdenk
1930c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1931c609719bSwdenk
1932c609719bSwdenk	Define this if the environment is in flash memory.
1933c609719bSwdenk
1934c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1935c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1936c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1937c609719bSwdenk	   sector" type flash chips, which have several smaller
1938c609719bSwdenk	   sectors at the start or the end. For instance, such a
1939c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1940c609719bSwdenk	   such a case you would place the environment in one of the
1941c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1942c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1943c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1944c609719bSwdenk	   between U-Boot and the environment.
1945c609719bSwdenk
1946c609719bSwdenk	- CFG_ENV_OFFSET:
1947c609719bSwdenk
1948c609719bSwdenk	   Offset of environment data (variable area) to the
1949c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1950c609719bSwdenk	   type flash chips the second sector can be used: the offset
1951c609719bSwdenk	   for this sector is given here.
1952c609719bSwdenk
1953c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1954c609719bSwdenk
1955c609719bSwdenk	- CFG_ENV_ADDR:
1956c609719bSwdenk
1957c609719bSwdenk	   This is just another way to specify the start address of
1958c609719bSwdenk	   the flash sector containing the environment (instead of
1959c609719bSwdenk	   CFG_ENV_OFFSET).
1960c609719bSwdenk
1961c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1962c609719bSwdenk
1963c609719bSwdenk	   Size of the sector containing the environment.
1964c609719bSwdenk
1965c609719bSwdenk
1966c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1967c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1968c609719bSwdenk	   the environment.
1969c609719bSwdenk
1970c609719bSwdenk	- CFG_ENV_SIZE:
1971c609719bSwdenk
1972c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1973c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1974c609719bSwdenk	   of this flash sector for the environment. This saves
1975c609719bSwdenk	   memory for the RAM copy of the environment.
1976c609719bSwdenk
1977c609719bSwdenk	   It may also save flash memory if you decide to use this
1978c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1979c609719bSwdenk	   since then the remainder of the flash sector could be used
1980c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1981c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1982c609719bSwdenk	   updating the environment in flash makes it always
1983c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1984c609719bSwdenk	   wrong before the contents has been restored from a copy in
1985c609719bSwdenk	   RAM, your target system will be dead.
1986c609719bSwdenk
1987c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1988c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1989c609719bSwdenk
1990c609719bSwdenk	   These settings describe a second storage area used to hold
1991c609719bSwdenk	   a redundand copy of the environment data, so that there is
19923e38691eSwdenk	   a valid backup copy in case there is a power failure during
1993c609719bSwdenk	   a "saveenv" operation.
1994c609719bSwdenk
1995c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1996c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1997c609719bSwdenkaccordingly!
1998c609719bSwdenk
1999c609719bSwdenk
2000c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
2001c609719bSwdenk
2002c609719bSwdenk	Define this if you have some non-volatile memory device
2003c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2004c609719bSwdenk	environment.
2005c609719bSwdenk
2006c609719bSwdenk	- CFG_ENV_ADDR:
2007c609719bSwdenk	- CFG_ENV_SIZE:
2008c609719bSwdenk
2009c609719bSwdenk	  These two #defines are used to determin the memory area you
2010c609719bSwdenk	  want to use for environment. It is assumed that this memory
2011c609719bSwdenk	  can just be read and written to, without any special
2012c609719bSwdenk	  provision.
2013c609719bSwdenk
2014c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2015c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2016c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
2017c609719bSwdenkU-Boot will hang.
2018c609719bSwdenk
2019c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2020c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2021c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2022c609719bSwdenkto save the current settings.
2023c609719bSwdenk
2024c609719bSwdenk
2025c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
2026c609719bSwdenk
2027c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2028c609719bSwdenk	device and a driver for it.
2029c609719bSwdenk
2030c609719bSwdenk	- CFG_ENV_OFFSET:
2031c609719bSwdenk	- CFG_ENV_SIZE:
2032c609719bSwdenk
2033c609719bSwdenk	  These two #defines specify the offset and size of the
2034c609719bSwdenk	  environment area within the total memory of your EEPROM.
2035c609719bSwdenk
2036c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
2037c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2038c609719bSwdenk	  The default address is zero.
2039c609719bSwdenk
2040c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
2041c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2042c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2043c609719bSwdenk	  would require six bits.
2044c609719bSwdenk
2045c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2046c609719bSwdenk	  If defined, the number of milliseconds to delay between
2047c609719bSwdenk	  page writes.	The default is zero milliseconds.
2048c609719bSwdenk
2049c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
2050c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2051c609719bSwdenk	  that this is NOT the chip address length!
2052c609719bSwdenk
20535cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
20545cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
20555cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
20565cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
20575cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
20585cf91d6bSwdenk	  byte chips.
20595cf91d6bSwdenk
20605cf91d6bSwdenk	  Note that we consider the length of the address field to
20615cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
20625cf91d6bSwdenk	  in the chip address.
20635cf91d6bSwdenk
2064c609719bSwdenk	- CFG_EEPROM_SIZE:
2065c609719bSwdenk	  The size in bytes of the EEPROM device.
2066c609719bSwdenk
2067c609719bSwdenk
20685779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
20695779d8d9Swdenk
20705779d8d9Swdenk	Define this if you have a DataFlash memory device which you
20715779d8d9Swdenk	want to use for the environment.
20725779d8d9Swdenk
20735779d8d9Swdenk	- CFG_ENV_OFFSET:
20745779d8d9Swdenk	- CFG_ENV_ADDR:
20755779d8d9Swdenk	- CFG_ENV_SIZE:
20765779d8d9Swdenk
20775779d8d9Swdenk	  These three #defines specify the offset and size of the
20785779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
20795779d8d9Swdenk	  at the specified address.
20805779d8d9Swdenk
208113a5695bSwdenk- CFG_ENV_IS_IN_NAND:
208213a5695bSwdenk
208313a5695bSwdenk	Define this if you have a NAND device which you want to use
208413a5695bSwdenk	for the environment.
208513a5695bSwdenk
208613a5695bSwdenk	- CFG_ENV_OFFSET:
208713a5695bSwdenk	- CFG_ENV_SIZE:
208813a5695bSwdenk
208913a5695bSwdenk	  These two #defines specify the offset and size of the environment
209013a5695bSwdenk	  area within the first NAND device.
20915779d8d9Swdenk
2092e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2093e443c944SMarkus Klotzbuecher
2094e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2095e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2096e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2097e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2098e443c944SMarkus Klotzbuecher
2099e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2100e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2101e443c944SMarkus Klotzbuecher	the NAND devices block size.
2102e443c944SMarkus Klotzbuecher
2103c609719bSwdenk- CFG_SPI_INIT_OFFSET
2104c609719bSwdenk
2105c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2106c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2107c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2108c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2109c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2110c609719bSwdenk	to be a good choice since it makes it far enough from the
2111c609719bSwdenk	start of the data area as well as from the stack pointer.
2112c609719bSwdenk
2113c609719bSwdenkPlease note that the environment is read-only as long as the monitor
2114c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2115c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2116c609719bSwdenkuntil then to read environment variables.
2117c609719bSwdenk
211885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
211985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
212085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
212185ec0bccSwdenknecessary, because the first environment variable we need is the
212285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
212385ec0bccSwdenkhave any device yet where we could complain.]
2124c609719bSwdenk
2125c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2126c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
212785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2128c609719bSwdenk
2129fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2130fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2131fc3e2165Swdenk
2132fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2133fc3e2165Swdenk		      also needs to be defined.
2134fc3e2165Swdenk
2135fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2136fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2137c609719bSwdenk
2138c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2139c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2140c40b2956Swdenk		of 64bit values by using the L quantifier
2141c40b2956Swdenk
2142c40b2956Swdenk- CFG_64BIT_STRTOUL:
2143c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2144c40b2956Swdenk
2145c609719bSwdenkLow Level (hardware related) configuration options:
2146dc7c9a1aSwdenk---------------------------------------------------
2147c609719bSwdenk
2148c609719bSwdenk- CFG_CACHELINE_SIZE:
2149c609719bSwdenk		Cache Line Size of the CPU.
2150c609719bSwdenk
2151c609719bSwdenk- CFG_DEFAULT_IMMR:
2152c609719bSwdenk		Default address of the IMMR after system reset.
21532535d602Swdenk
21542535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
21552535d602Swdenk		and RPXsuper) to be able to adjust the position of
21562535d602Swdenk		the IMMR register after a reset.
2157c609719bSwdenk
21587f6c2cbcSwdenk- Floppy Disk Support:
21597f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
21607f6c2cbcSwdenk
21617f6c2cbcSwdenk		the default drive number (default value 0)
21627f6c2cbcSwdenk
21637f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
21647f6c2cbcSwdenk
21657f6c2cbcSwdenk		defines the spacing between fdc chipset registers
21667f6c2cbcSwdenk		(default value 1)
21677f6c2cbcSwdenk
21687f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
21697f6c2cbcSwdenk
21707f6c2cbcSwdenk		defines the offset of register from address. It
21717f6c2cbcSwdenk		depends on which part of the data bus is connected to
21727f6c2cbcSwdenk		the fdc chipset. (default value 0)
21737f6c2cbcSwdenk
21747f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
21757f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
21767f6c2cbcSwdenk		default value.
21777f6c2cbcSwdenk
21787f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
21797f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
21807f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
21817f6c2cbcSwdenk		source code. It is used to make hardware dependant
21827f6c2cbcSwdenk		initializations.
21837f6c2cbcSwdenk
218425d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
218525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
218625d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2187c609719bSwdenk
2188c609719bSwdenk- CFG_INIT_RAM_ADDR:
2189c609719bSwdenk
21907152b1d0Swdenk		Start address of memory area that can be used for
2191c609719bSwdenk		initial data and stack; please note that this must be
2192c609719bSwdenk		writable memory that is working WITHOUT special
2193c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2194c609719bSwdenk		will become available only after programming the
2195c609719bSwdenk		memory controller and running certain initialization
2196c609719bSwdenk		sequences.
2197c609719bSwdenk
2198c609719bSwdenk		U-Boot uses the following memory types:
2199c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2200c609719bSwdenk		- MPC824X: data cache
2201c609719bSwdenk		- PPC4xx:  data cache
2202c609719bSwdenk
220385ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2204c609719bSwdenk
2205c609719bSwdenk		Offset of the initial data structure in the memory
2206c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
220785ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2208c609719bSwdenk		data is located at the end of the available space
2209c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2210c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2211c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
221285ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2213c609719bSwdenk
2214c609719bSwdenk	Note:
2215c609719bSwdenk		On the MPC824X (or other systems that use the data
2216c609719bSwdenk		cache for initial memory) the address chosen for
2217c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2218c609719bSwdenk		point to an otherwise UNUSED address space between
2219c609719bSwdenk		the top of RAM and the start of the PCI space.
2220c609719bSwdenk
2221c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2222c609719bSwdenk
2223c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2224c609719bSwdenk
2225c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2226c609719bSwdenk
2227c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2228c609719bSwdenk
2229c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2230c609719bSwdenk
2231c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2232c609719bSwdenk
2233c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2234c609719bSwdenk		SDRAM timing
2235c609719bSwdenk
2236c609719bSwdenk- CFG_MAMR_PTA:
2237c609719bSwdenk		periodic timer for refresh
2238c609719bSwdenk
2239c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2240c609719bSwdenk
2241c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2242c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2243c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2244c609719bSwdenk  CFG_BR1_PRELIM:
2245c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2246c609719bSwdenk
2247c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2248c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2249c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2250c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2251c609719bSwdenk
2252c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2253c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2254c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2255c609719bSwdenk		Prescaler definitions (SDRAM timing)
2256c609719bSwdenk
2257c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2258c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2259c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2260c609719bSwdenk
2261c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2262c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2263c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2264c609719bSwdenk
2265c609719bSwdenk- CFG_USE_OSCCLK:
2266c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2267c609719bSwdenk		wrong setting might damage your board. Read
2268c609719bSwdenk		doc/README.MBX before setting this variable!
2269c609719bSwdenk
2270ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2271ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2272ea909b76Swdenk		(Power On Self Tests). This definition overrides
2273ea909b76Swdenk		#define'd default value in commproc.h resp.
2274ea909b76Swdenk		cpm_8260.h.
2275ea909b76Swdenk
22765d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
22775d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
22785d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
22795d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
22805d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
22815d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
22825d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
22835d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
22845d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
22855d232d0eSwdenk
2286bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2287bb99ad6dSBen Warren		Get DDR timing information from an I2C EEPROM.  Common with pluggable
2288bb99ad6dSBen Warren		memory modules such as SODIMMs
2289bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2290bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2291bb99ad6dSBen Warren
2292bb99ad6dSBen Warren- CFG_SPD_BUS_NUM
2293bb99ad6dSBen Warren		If SPD EEPROM is on an I2C bus other than the first one, specify here.
2294bb99ad6dSBen Warren		Note that the value must resolve to something your driver can deal with.
2295bb99ad6dSBen Warren
22962ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
22972ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
22982ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
22992ad6b513STimur Tabi
23002ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
23012ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
23022ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
23032ad6b513STimur Tabi
2304c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2305c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2306c26e454dSwdenk
2307c26e454dSwdenk- CONFIG_FEC[12]_PHY
2308c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
23096e592385Swdenk		to the given FEC; i. e.
2310c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2311c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2312c26e454dSwdenk
2313c26e454dSwdenk		When set to -1, means to probe for first available.
2314c26e454dSwdenk
2315c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2316c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2317c26e454dSwdenk		(so program the FEC to ignore it).
2318c26e454dSwdenk
2319c26e454dSwdenk- CONFIG_RMII
2320c26e454dSwdenk		Enable RMII mode for all FECs.
2321c26e454dSwdenk		Note that this is a global option, we can't
2322c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2323c26e454dSwdenk
23245cf91d6bSwdenk- CONFIG_CRC32_VERIFY
23255cf91d6bSwdenk		Add a verify option to the crc32 command.
23265cf91d6bSwdenk		The syntax is:
23275cf91d6bSwdenk
23285cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
23295cf91d6bSwdenk
23305cf91d6bSwdenk		Where address/count indicate a memory area
23315cf91d6bSwdenk		and crc32 is the correct crc32 which the
23325cf91d6bSwdenk		area should have.
23335cf91d6bSwdenk
233456523f12Swdenk- CONFIG_LOOPW
233556523f12Swdenk		Add the "loopw" memory command. This only takes effect if
233656523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
233756523f12Swdenk
23387b466641Sstroese- CONFIG_MX_CYCLIC
23397b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
23407b466641Sstroese		"md/mw" commands.
23417b466641Sstroese		Examples:
23427b466641Sstroese
23437b466641Sstroese		=> mdc.b 10 4 500
23447b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
23457b466641Sstroese
23467b466641Sstroese		=> mwc.l 100 12345678 10
23477b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
23487b466641Sstroese
23497b466641Sstroese		This only takes effect if the memory commands are activated
23507b466641Sstroese		globally (CFG_CMD_MEM).
23517b466641Sstroese
23528aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
23538aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
23548aa1a2d1Swdenk
23558aa1a2d1Swdenk		[ARM only] If these variables are defined, then
23568aa1a2d1Swdenk		certain low level initializations (like setting up
23578aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
23588aa1a2d1Swdenk		not relocate itself into RAM.
23598aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
23608aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
23618aa1a2d1Swdenk		some other boot loader or by a debugger which
23628aa1a2d1Swdenk		performs these intializations itself.
23638aa1a2d1Swdenk
2364400558b5Swdenk
2365c609719bSwdenkBuilding the Software:
2366c609719bSwdenk======================
2367c609719bSwdenk
2368c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2369c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2370c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2371c609719bSwdenkNetBSD 1.5 on x86).
2372c609719bSwdenk
2373c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2374c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2375c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2376c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2377c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2378c609719bSwdenkchange it to:
2379c609719bSwdenk
2380c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2381c609719bSwdenk
2382c609719bSwdenk
2383c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2384c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2385c609719bSwdenkis done by typing:
2386c609719bSwdenk
2387c609719bSwdenk	make NAME_config
2388c609719bSwdenk
2389c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2390c609719bSwdenkconfigurations; the following names are supported:
2391c609719bSwdenk
23921eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
23931eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2394983fda83Swdenk	Alaska8220_config
23951eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
23961eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
23971eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
23981eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
23991eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2400e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2401e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2402e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2403e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2404e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2405466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2406466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
24074c52783bSroy zang	EBONY_config		mpc7448hpc2_config	SM850_config
24084c52783bSroy zang	ELPT860_config		MPC8260ADS_config	SPD823TS_config
24094c52783bSroy zang	ESTEEM192E_config	MPC8540ADS_config	stxgp3_config
24104c52783bSroy zang	ETX094_config		MPC8540EVAL_config	SXNI855T_config
24114c52783bSroy zang	FADS823_config		NMPC8560ADS_config	TQM823L_config
24124c52783bSroy zang	FADS850SAR_config	NETVIA_config		TQM850L_config
24134c52783bSroy zang	FADS860T_config		omap1510inn_config	TQM855L_config
24144c52783bSroy zang	FPS850L_config		omap1610h2_config	TQM860L_config
24154c52783bSroy zang				omap1610inn_config	walnut_config
24164c52783bSroy zang				omap5912osk_config	Yukon8220_config
24174c52783bSroy zang				omap2420h4_config	ZPC1900_config
241854387ac9Swdenk
2419c609719bSwdenkNote: for some board special configuration names may exist; check if
2420c609719bSwdenk      additional information is available from the board vendor; for
24212729af9dSwdenk      instance, the TQM823L systems are available without (standard)
24222729af9dSwdenk      or with LCD support. You can select such additional "features"
2423c609719bSwdenk      when chosing the configuration, i. e.
2424c609719bSwdenk
24252729af9dSwdenk      make TQM823L_config
24262729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2427c609719bSwdenk
2428c609719bSwdenk      make TQM823L_LCD_config
2429c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2430c609719bSwdenk
2431c609719bSwdenk      etc.
2432c609719bSwdenk
2433c609719bSwdenk
2434c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
24357152b1d0Swdenkimages ready for download to / installation on your system:
2436c609719bSwdenk
2437c609719bSwdenk- "u-boot.bin" is a raw binary image
2438c609719bSwdenk- "u-boot" is an image in ELF binary format
2439c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2440c609719bSwdenk
2441baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2442baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2443baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2444baf31249SMarian Balakowicz
2445baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2446baf31249SMarian Balakowicz
2447baf31249SMarian Balakowicz	make O=/tmp/build distclean
2448baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2449baf31249SMarian Balakowicz	make O=/tmp/build all
2450baf31249SMarian Balakowicz
2451baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2452baf31249SMarian Balakowicz
2453baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2454baf31249SMarian Balakowicz	make distclean
2455baf31249SMarian Balakowicz	make NAME_config
2456baf31249SMarian Balakowicz	make all
2457baf31249SMarian Balakowicz
2458baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2459baf31249SMarian Balakowiczvariable.
2460baf31249SMarian Balakowicz
2461c609719bSwdenk
2462c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2463c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2464c609719bSwdenknative "make".
2465c609719bSwdenk
2466c609719bSwdenk
2467c609719bSwdenkIf the system board that you have is not listed, then you will need
2468c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2469c609719bSwdenksteps:
2470c609719bSwdenk
2471c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
247285ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
247385ec0bccSwdenk    entries as examples. Note that here and at many other places
24747152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
247585ec0bccSwdenk    keep this order.
2476c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
247785ec0bccSwdenk    files you need. In your board directory, you will need at least
247885ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
247985ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
248085ec0bccSwdenk    your board
2481c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2482c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
248385ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2484c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2485c609719bSwdenk    to be installed on your target system.
248685ec0bccSwdenk6.  Debug and solve any problems that might arise.
2487c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2488c609719bSwdenk
2489c609719bSwdenk
2490c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2491c609719bSwdenk==============================================================
2492c609719bSwdenk
2493c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2494c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2495c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2496c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2497c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2498c609719bSwdenk
2499c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2500c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2501c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2502c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2503c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
25047152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2505c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2506c609719bSwdenkMontaVista's Hard Hat Linux you can type
2507c609719bSwdenk
2508c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2509c609719bSwdenk
2510c609719bSwdenkor to build on a native PowerPC system you can type
2511c609719bSwdenk
2512c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2513c609719bSwdenk
2514baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2515baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2516baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2517baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2518baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2519baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2520baf31249SMarian Balakowicz
2521baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2522baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2523baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2524baf31249SMarian Balakowicz
2525baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2526baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2527baf31249SMarian Balakowiczthe whole build process.
2528baf31249SMarian Balakowicz
2529baf31249SMarian Balakowicz
2530c609719bSwdenkSee also "U-Boot Porting Guide" below.
2531c609719bSwdenk
2532c609719bSwdenk
2533c609719bSwdenkMonitor Commands - Overview:
2534c609719bSwdenk============================
2535c609719bSwdenk
2536c609719bSwdenkgo	- start application at address 'addr'
2537c609719bSwdenkrun	- run commands in an environment variable
2538c609719bSwdenkbootm	- boot application image from memory
2539c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2540c609719bSwdenktftpboot- boot image via network using TFTP protocol
2541c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2542c609719bSwdenk	       (and eventually "gatewayip")
2543c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2544c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2545c609719bSwdenkloads	- load S-Record file over serial line
2546c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2547c609719bSwdenkmd	- memory display
2548c609719bSwdenkmm	- memory modify (auto-incrementing)
2549c609719bSwdenknm	- memory modify (constant address)
2550c609719bSwdenkmw	- memory write (fill)
2551c609719bSwdenkcp	- memory copy
2552c609719bSwdenkcmp	- memory compare
2553c609719bSwdenkcrc32	- checksum calculation
2554c609719bSwdenkimd	- i2c memory display
2555c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2556c609719bSwdenkinm	- i2c memory modify (constant address)
2557c609719bSwdenkimw	- i2c memory write (fill)
2558c609719bSwdenkicrc32	- i2c checksum calculation
2559c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2560c609719bSwdenkiloop	- infinite loop on address range
2561c609719bSwdenkisdram	- print SDRAM configuration information
2562c609719bSwdenksspi	- SPI utility commands
2563c609719bSwdenkbase	- print or set address offset
2564c609719bSwdenkprintenv- print environment variables
2565c609719bSwdenksetenv	- set environment variables
2566c609719bSwdenksaveenv - save environment variables to persistent storage
2567c609719bSwdenkprotect - enable or disable FLASH write protection
2568c609719bSwdenkerase	- erase FLASH memory
2569c609719bSwdenkflinfo	- print FLASH memory information
2570c609719bSwdenkbdinfo	- print Board Info structure
2571c609719bSwdenkiminfo	- print header information for application image
2572c609719bSwdenkconinfo - print console devices and informations
2573c609719bSwdenkide	- IDE sub-system
2574c609719bSwdenkloop	- infinite loop on address range
257556523f12Swdenkloopw	- infinite write loop on address range
2576c609719bSwdenkmtest	- simple RAM test
2577c609719bSwdenkicache	- enable or disable instruction cache
2578c609719bSwdenkdcache	- enable or disable data cache
2579c609719bSwdenkreset	- Perform RESET of the CPU
2580c609719bSwdenkecho	- echo args to console
2581c609719bSwdenkversion - print monitor version
2582c609719bSwdenkhelp	- print online help
2583c609719bSwdenk?	- alias for 'help'
2584c609719bSwdenk
2585c609719bSwdenk
2586c609719bSwdenkMonitor Commands - Detailed Description:
2587c609719bSwdenk========================================
2588c609719bSwdenk
2589c609719bSwdenkTODO.
2590c609719bSwdenk
2591c609719bSwdenkFor now: just type "help <command>".
2592c609719bSwdenk
2593c609719bSwdenk
2594c609719bSwdenkEnvironment Variables:
2595c609719bSwdenk======================
2596c609719bSwdenk
2597c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2598c609719bSwdenkcan be made persistent by saving to Flash memory.
2599c609719bSwdenk
2600c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2601c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2602c609719bSwdenkwithout a value can be used to delete a variable from the
2603c609719bSwdenkenvironment. As long as you don't save the environment you are
2604c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2605c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2606c609719bSwdenk
2607c609719bSwdenkSome configuration options can be set using Environment Variables:
2608c609719bSwdenk
2609c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2610c609719bSwdenk
2611c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2612c609719bSwdenk
2613c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2614c609719bSwdenk
2615c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2616c609719bSwdenk
2617c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2618c609719bSwdenk
2619c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2620c609719bSwdenk		  "bootp" will just load perform a lookup of the
2621c609719bSwdenk		  configuration from the BOOTP server, but not try to
2622c609719bSwdenk		  load any image using TFTP
2623c609719bSwdenk
2624c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2625c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2626c609719bSwdenk		  be automatically started (by internally calling
2627c609719bSwdenk		  "bootm")
2628c609719bSwdenk
26294a6fd34bSwdenk		  If set to "no", a standalone image passed to the
26304a6fd34bSwdenk		  "bootm" command will be copied to the load address
26314a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
26324a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
26334a6fd34bSwdenk		  data.
26344a6fd34bSwdenk
263517ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
263617ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
263717ea1177Swdenk		  mode (400kHZ). This environment variable is used in
263817ea1177Swdenk		  initialization code. So, for changes to be effective
263917ea1177Swdenk		  it must be saved and board must be reset.
264017ea1177Swdenk
2641c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2642c609719bSwdenk		  If this variable is not set, initrd images will be
2643c609719bSwdenk		  copied to the highest possible address in RAM; this
2644c609719bSwdenk		  is usually what you want since it allows for
2645c609719bSwdenk		  maximum initrd size. If for some reason you want to
2646c609719bSwdenk		  make sure that the initrd image is loaded below the
2647c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2648c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2649c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2650c609719bSwdenk		  address to use (U-Boot will still check that it
2651c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2652c609719bSwdenk
2653c609719bSwdenk		  For instance, when you have a system with 16 MB
26547152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2655c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2656c609719bSwdenk		  the "bootargs" variable. However, now you must make
26577152b1d0Swdenk		  sure that the initrd image is placed in the first
2658c609719bSwdenk		  12 MB as well - this can be done with
2659c609719bSwdenk
2660c609719bSwdenk		  setenv initrd_high 00c00000
2661c609719bSwdenk
266238b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
266338b99261Swdenk		  indication to U-Boot that all addresses are legal
266438b99261Swdenk		  for the Linux kernel, including addresses in flash
266538b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
266638b99261Swdenk		  ramdisk at all. This may be useful to reduce the
266738b99261Swdenk		  boot time on your system, but requires that this
266838b99261Swdenk		  feature is supported by your Linux kernel.
266938b99261Swdenk
2670c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2671c609719bSwdenk
2672c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2673dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2674c609719bSwdenk
2675c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2676c609719bSwdenk
2677c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2678c609719bSwdenk
2679c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2680c609719bSwdenk
2681c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2682c609719bSwdenk
2683c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2684c609719bSwdenk
2685a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2686a3d991bdSwdenk		  interface is used first.
2687a3d991bdSwdenk
2688a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2689a3d991bdSwdenk		  interface is currently active. For example you
2690a3d991bdSwdenk		  can do the following
2691a3d991bdSwdenk
2692a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2693a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2694a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2695a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2696a3d991bdSwdenk
2697a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2698a3d991bdSwdenk		  either succeed or fail without retrying.
26996e592385Swdenk		  When set to "once" the network operation will
27006e592385Swdenk		  fail when all the available network interfaces
27016e592385Swdenk		  are tried once without success.
2702a3d991bdSwdenk		  Useful on scripts which control the retry operation
2703a3d991bdSwdenk		  themselves.
2704a3d991bdSwdenk
270528cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2706ecb0ccd9SWolfgang Denk		  UDP source port.
2707ecb0ccd9SWolfgang Denk
270828cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
270928cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
271028cb9375SWolfgang Denk
2711a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2712a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2713a3d991bdSwdenk		  VLAN tagged frames.
2714c609719bSwdenk
2715c609719bSwdenkThe following environment variables may be used and automatically
2716c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2717c609719bSwdenkdepending the information provided by your boot server:
2718c609719bSwdenk
2719c609719bSwdenk  bootfile	- see above
2720c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2721fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2722c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2723c609719bSwdenk  hostname	- Target hostname
2724c609719bSwdenk  ipaddr	- see above
2725c609719bSwdenk  netmask	- Subnet Mask
2726c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2727c609719bSwdenk  serverip	- see above
2728c609719bSwdenk
2729c609719bSwdenk
2730c609719bSwdenkThere are two special Environment Variables:
2731c609719bSwdenk
2732c609719bSwdenk  serial#	- contains hardware identification information such
2733c609719bSwdenk		  as type string and/or serial number
2734c609719bSwdenk  ethaddr	- Ethernet address
2735c609719bSwdenk
2736c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2737c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2738c609719bSwdenkonce they have been set once.
2739c609719bSwdenk
2740c609719bSwdenk
2741c1551ea8SstroeseFurther special Environment Variables:
2742c1551ea8Sstroese
2743c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2744c1551ea8Sstroese		  with the "version" command. This variable is
2745c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2746c1551ea8Sstroese
2747c1551ea8Sstroese
2748c609719bSwdenkPlease note that changes to some configuration parameters may take
2749c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2750c609719bSwdenk
2751c609719bSwdenk
2752f07771ccSwdenkCommand Line Parsing:
2753f07771ccSwdenk=====================
2754f07771ccSwdenk
2755f07771ccSwdenkThere are two different command line parsers available with U-Boot:
27567152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2757f07771ccSwdenk
2758f07771ccSwdenkOld, simple command line parser:
2759f07771ccSwdenk--------------------------------
2760f07771ccSwdenk
2761f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2762f07771ccSwdenk- several commands on one line, separated by ';'
2763fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2764f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2765f07771ccSwdenk  for example:
2766fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2767f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2768f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2769f07771ccSwdenk
2770f07771ccSwdenkHush shell:
2771f07771ccSwdenk-----------
2772f07771ccSwdenk
2773f07771ccSwdenk- similar to Bourne shell, with control structures like
2774f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2775f07771ccSwdenk  until...do...done, ...
2776f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2777f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2778f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2779f07771ccSwdenk  command
2780f07771ccSwdenk
2781f07771ccSwdenkGeneral rules:
2782f07771ccSwdenk--------------
2783f07771ccSwdenk
2784f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2785f07771ccSwdenk    command) contains several commands separated by semicolon, and
2786f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2787f07771ccSwdenk    executed anyway.
2788f07771ccSwdenk
2789f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2790f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2791f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2792f07771ccSwdenk    variables are not executed.
2793f07771ccSwdenk
2794c609719bSwdenkNote for Redundant Ethernet Interfaces:
2795c609719bSwdenk=======================================
2796c609719bSwdenk
27977152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2798c609719bSwdenksuch configurations and is capable of automatic selection of a
27997152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2800c609719bSwdenk
2801c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2802c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2803c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2804c609719bSwdenk
2805c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2806c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2807c609719bSwdenkding setting in the environment; if the corresponding environment
2808c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2809c609719bSwdenk
2810c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2811c609719bSwdenk  environment, the SROM's address is used.
2812c609719bSwdenk
2813c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2814c609719bSwdenk  environment exists, then the value from the environment variable is
2815c609719bSwdenk  used.
2816c609719bSwdenk
2817c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2818c609719bSwdenk  both addresses are the same, this MAC address is used.
2819c609719bSwdenk
2820c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2821c609719bSwdenk  addresses differ, the value from the environment is used and a
2822c609719bSwdenk  warning is printed.
2823c609719bSwdenk
2824c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2825c609719bSwdenk  is raised.
2826c609719bSwdenk
2827c609719bSwdenk
2828c609719bSwdenkImage Formats:
2829c609719bSwdenk==============
2830c609719bSwdenk
2831c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2832c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2833c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2834c609719bSwdenkdefines the following image properties:
2835c609719bSwdenk
2836c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2837c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
28387f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
28391f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
28407b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
28413d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
28427b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2843c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2844c609719bSwdenk* Load Address
2845c609719bSwdenk* Entry Point
2846c609719bSwdenk* Image Name
2847c609719bSwdenk* Image Timestamp
2848c609719bSwdenk
2849c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2850c609719bSwdenkand the data portions of the image are secured against corruption by
2851c609719bSwdenkCRC32 checksums.
2852c609719bSwdenk
2853c609719bSwdenk
2854c609719bSwdenkLinux Support:
2855c609719bSwdenk==============
2856c609719bSwdenk
2857c609719bSwdenkAlthough U-Boot should support any OS or standalone application
28587152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2859c609719bSwdenkU-Boot.
2860c609719bSwdenk
2861c609719bSwdenkU-Boot includes many features that so far have been part of some
2862c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2863c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2864c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
28657152b1d0Swdenkserves several purposes:
2866c609719bSwdenk
2867c609719bSwdenk- the same features can be used for other OS or standalone
2868c609719bSwdenk  applications (for instance: using compressed images to reduce the
2869c609719bSwdenk  Flash memory footprint)
2870c609719bSwdenk
2871c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
28727152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2873c609719bSwdenk
2874c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2875c609719bSwdenk  images; of course this also means that different kernel images can
2876c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2877c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2878c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2879c609719bSwdenk  software is easier now.
2880c609719bSwdenk
2881c609719bSwdenk
2882c609719bSwdenkLinux HOWTO:
2883c609719bSwdenk============
2884c609719bSwdenk
2885c609719bSwdenkPorting Linux to U-Boot based systems:
2886c609719bSwdenk---------------------------------------
2887c609719bSwdenk
2888c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2889c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2890c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2891c609719bSwdenkLinux :-).
2892c609719bSwdenk
2893c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2894c609719bSwdenk
2895c609719bSwdenkJust make sure your machine specific header file (for instance
2896c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2897c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2898c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2899c609719bSwdenkU-Boot configuration in CFG_IMMR.
2900c609719bSwdenk
2901c609719bSwdenk
2902c609719bSwdenkConfiguring the Linux kernel:
2903c609719bSwdenk-----------------------------
2904c609719bSwdenk
2905c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2906c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2907c609719bSwdenk
2908c609719bSwdenk
2909c609719bSwdenkBuilding a Linux Image:
2910c609719bSwdenk-----------------------
2911c609719bSwdenk
291224ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
291324ee89b9Swdenknot used. If you use recent kernel source, a new build target
291424ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
291524ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
291624ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
291724ee89b9Swdenk100% compatible format.
2918c609719bSwdenk
2919c609719bSwdenkExample:
2920c609719bSwdenk
2921c609719bSwdenk	make TQM850L_config
2922c609719bSwdenk	make oldconfig
2923c609719bSwdenk	make dep
292424ee89b9Swdenk	make uImage
2925c609719bSwdenk
292624ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
292724ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
292824ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2929c609719bSwdenk
293024ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
293124ee89b9Swdenk
293224ee89b9Swdenk* convert the kernel into a raw binary image:
293324ee89b9Swdenk
293424ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
293524ee89b9Swdenk				 -R .note -R .comment \
293624ee89b9Swdenk				 -S vmlinux linux.bin
293724ee89b9Swdenk
293824ee89b9Swdenk* compress the binary image:
293924ee89b9Swdenk
294024ee89b9Swdenk	gzip -9 linux.bin
294124ee89b9Swdenk
294224ee89b9Swdenk* package compressed binary image for U-Boot:
294324ee89b9Swdenk
294424ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
294524ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
294624ee89b9Swdenk		-d linux.bin.gz uImage
294724ee89b9Swdenk
294824ee89b9Swdenk
294924ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
295024ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
295124ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
295224ee89b9Swdenkbyte header containing information about target architecture,
295324ee89b9Swdenkoperating system, image type, compression method, entry points, time
295424ee89b9Swdenkstamp, CRC32 checksums, etc.
295524ee89b9Swdenk
295624ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
295724ee89b9Swdenkprint the header information, or to build new images.
2958c609719bSwdenk
2959c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2960c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2961c609719bSwdenkchecksum verification:
2962c609719bSwdenk
2963c609719bSwdenk	tools/mkimage -l image
2964c609719bSwdenk	  -l ==> list image header information
2965c609719bSwdenk
2966c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2967c609719bSwdenkfrom a "data file" which is used as image payload:
2968c609719bSwdenk
2969c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2970c609719bSwdenk		      -n name -d data_file image
2971c609719bSwdenk	  -A ==> set architecture to 'arch'
2972c609719bSwdenk	  -O ==> set operating system to 'os'
2973c609719bSwdenk	  -T ==> set image type to 'type'
2974c609719bSwdenk	  -C ==> set compression type 'comp'
2975c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2976c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2977c609719bSwdenk	  -n ==> set image name to 'name'
2978c609719bSwdenk	  -d ==> use image data from 'datafile'
2979c609719bSwdenk
298069459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
298169459791Swdenkaddress (0x00000000), but the entry point address depends on the
298269459791Swdenkkernel version:
2983c609719bSwdenk
2984c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
298524ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2986c609719bSwdenk
2987c609719bSwdenkSo a typical call to build a U-Boot image would read:
2988c609719bSwdenk
298924ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
299024ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
299124ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
299224ee89b9Swdenk	> examples/uImage.TQM850L
299324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2994c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2995c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2996c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2997c609719bSwdenk	Load Address: 0x00000000
299824ee89b9Swdenk	Entry Point:  0x00000000
2999c609719bSwdenk
3000c609719bSwdenkTo verify the contents of the image (or check for corruption):
3001c609719bSwdenk
300224ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
300324ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3004c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3005c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3006c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3007c609719bSwdenk	Load Address: 0x00000000
300824ee89b9Swdenk	Entry Point:  0x00000000
3009c609719bSwdenk
3010c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3011c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3012c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3013c609719bSwdenkneed to be uncompressed:
3014c609719bSwdenk
301524ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
301624ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
301724ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
301824ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
301924ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
302024ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3021c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3022c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3023c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3024c609719bSwdenk	Load Address: 0x00000000
302524ee89b9Swdenk	Entry Point:  0x00000000
3026c609719bSwdenk
3027c609719bSwdenk
3028c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3029c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3030c609719bSwdenk
3031c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3032c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3033c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3034c609719bSwdenk	Image Name:   Simple Ramdisk Image
3035c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3036c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3037c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3038c609719bSwdenk	Load Address: 0x00000000
3039c609719bSwdenk	Entry Point:  0x00000000
3040c609719bSwdenk
3041c609719bSwdenk
3042c609719bSwdenkInstalling a Linux Image:
3043c609719bSwdenk-------------------------
3044c609719bSwdenk
3045c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3046c609719bSwdenkyou must convert the image to S-Record format:
3047c609719bSwdenk
3048c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3049c609719bSwdenk
3050c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3051c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3052c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3053c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3054c609719bSwdenkcommand.
3055c609719bSwdenk
3056c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3057c609719bSwdenkTQM8xxL is in the first Flash bank):
3058c609719bSwdenk
3059c609719bSwdenk	=> erase 40100000 401FFFFF
3060c609719bSwdenk
3061c609719bSwdenk	.......... done
3062c609719bSwdenk	Erased 8 sectors
3063c609719bSwdenk
3064c609719bSwdenk	=> loads 40100000
3065c609719bSwdenk	## Ready for S-Record download ...
3066c609719bSwdenk	~>examples/image.srec
3067c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3068c609719bSwdenk	...
3069c609719bSwdenk	15989 15990 15991 15992
3070c609719bSwdenk	[file transfer complete]
3071c609719bSwdenk	[connected]
3072c609719bSwdenk	## Start Addr = 0x00000000
3073c609719bSwdenk
3074c609719bSwdenk
3075c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3076c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
3077c609719bSwdenkcorruption happened:
3078c609719bSwdenk
3079c609719bSwdenk	=> imi 40100000
3080c609719bSwdenk
3081c609719bSwdenk	## Checking Image at 40100000 ...
3082c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3083c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3084c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3085c609719bSwdenk	   Load Address: 00000000
3086c609719bSwdenk	   Entry Point:	 0000000c
3087c609719bSwdenk	   Verifying Checksum ... OK
3088c609719bSwdenk
3089c609719bSwdenk
3090c609719bSwdenkBoot Linux:
3091c609719bSwdenk-----------
3092c609719bSwdenk
3093c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3094c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3095c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3096c609719bSwdenkparameters. You can check and modify this variable using the
3097c609719bSwdenk"printenv" and "setenv" commands:
3098c609719bSwdenk
3099c609719bSwdenk
3100c609719bSwdenk	=> printenv bootargs
3101c609719bSwdenk	bootargs=root=/dev/ram
3102c609719bSwdenk
3103c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3104c609719bSwdenk
3105c609719bSwdenk	=> printenv bootargs
3106c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3107c609719bSwdenk
3108c609719bSwdenk	=> bootm 40020000
3109c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3110c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3111c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3112c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3113c609719bSwdenk	   Load Address: 00000000
3114c609719bSwdenk	   Entry Point:	 0000000c
3115c609719bSwdenk	   Verifying Checksum ... OK
3116c609719bSwdenk	   Uncompressing Kernel Image ... OK
3117c609719bSwdenk	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
3118c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3119c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3120c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3121c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3122c609719bSwdenk	...
3123c609719bSwdenk
3124c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
31257152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3126c609719bSwdenkformat!) to the "bootm" command:
3127c609719bSwdenk
3128c609719bSwdenk	=> imi 40100000 40200000
3129c609719bSwdenk
3130c609719bSwdenk	## Checking Image at 40100000 ...
3131c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3132c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3133c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3134c609719bSwdenk	   Load Address: 00000000
3135c609719bSwdenk	   Entry Point:	 0000000c
3136c609719bSwdenk	   Verifying Checksum ... OK
3137c609719bSwdenk
3138c609719bSwdenk	## Checking Image at 40200000 ...
3139c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3140c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3141c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3142c609719bSwdenk	   Load Address: 00000000
3143c609719bSwdenk	   Entry Point:	 00000000
3144c609719bSwdenk	   Verifying Checksum ... OK
3145c609719bSwdenk
3146c609719bSwdenk	=> bootm 40100000 40200000
3147c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3148c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3149c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3150c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3151c609719bSwdenk	   Load Address: 00000000
3152c609719bSwdenk	   Entry Point:	 0000000c
3153c609719bSwdenk	   Verifying Checksum ... OK
3154c609719bSwdenk	   Uncompressing Kernel Image ... OK
3155c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3156c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3157c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3158c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3159c609719bSwdenk	   Load Address: 00000000
3160c609719bSwdenk	   Entry Point:	 00000000
3161c609719bSwdenk	   Verifying Checksum ... OK
3162c609719bSwdenk	   Loading Ramdisk ... OK
3163c609719bSwdenk	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
3164c609719bSwdenk	Boot arguments: root=/dev/ram
3165c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3166c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3167c609719bSwdenk	...
3168c609719bSwdenk	RAMDISK: Compressed image found at block 0
3169c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3170c609719bSwdenk
3171c609719bSwdenk	bash#
3172c609719bSwdenk
31730267768eSMatthew McClintockBoot Linux and pass a flat device tree:
31740267768eSMatthew McClintock-----------
31750267768eSMatthew McClintock
31760267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
31770267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
31780267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
31790267768eSMatthew McClintockflat device tree:
31800267768eSMatthew McClintock
31810267768eSMatthew McClintock=> print oftaddr
31820267768eSMatthew McClintockoftaddr=0x300000
31830267768eSMatthew McClintock=> print oft
31840267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
31850267768eSMatthew McClintock=> tftp $oftaddr $oft
31860267768eSMatthew McClintockSpeed: 1000, full duplex
31870267768eSMatthew McClintockUsing TSEC0 device
31880267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
31890267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
31900267768eSMatthew McClintockLoad address: 0x300000
31910267768eSMatthew McClintockLoading: #
31920267768eSMatthew McClintockdone
31930267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
31940267768eSMatthew McClintock=> tftp $loadaddr $bootfile
31950267768eSMatthew McClintockSpeed: 1000, full duplex
31960267768eSMatthew McClintockUsing TSEC0 device
31970267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
31980267768eSMatthew McClintockFilename 'uImage'.
31990267768eSMatthew McClintockLoad address: 0x200000
32000267768eSMatthew McClintockLoading:############
32010267768eSMatthew McClintockdone
32020267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
32030267768eSMatthew McClintock=> print loadaddr
32040267768eSMatthew McClintockloadaddr=200000
32050267768eSMatthew McClintock=> print oftaddr
32060267768eSMatthew McClintockoftaddr=0x300000
32070267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
32080267768eSMatthew McClintock## Booting image at 00200000 ...
32090267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
32100267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
32110267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
32120267768eSMatthew McClintock   Load Address: 00000000
32130267768eSMatthew McClintock   Entry Point:	 00000000
32140267768eSMatthew McClintock   Verifying Checksum ... OK
32150267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
32160267768eSMatthew McClintockBooting using flat device tree at 0x300000
32170267768eSMatthew McClintockUsing MPC85xx ADS machine description
32180267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
32190267768eSMatthew McClintock[snip]
32200267768eSMatthew McClintock
32210267768eSMatthew McClintock
32226069ff26SwdenkMore About U-Boot Image Types:
32236069ff26Swdenk------------------------------
32246069ff26Swdenk
32256069ff26SwdenkU-Boot supports the following image types:
32266069ff26Swdenk
32276069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
32286069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
32296069ff26Swdenk	well) you can continue to work in U-Boot after return from
32306069ff26Swdenk	the Standalone Program.
32316069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
32326069ff26Swdenk	will take over control completely. Usually these programs
32336069ff26Swdenk	will install their own set of exception handlers, device
32346069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
32356069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
32366069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
32376069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
32386069ff26Swdenk	being started.
32396069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
32406069ff26Swdenk	(Linux) kernel image and one or more data images like
32416069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
32426069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
32436069ff26Swdenk	server provides just a single image file, but you want to get
32446069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
32456069ff26Swdenk
32466069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
32476069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
32486069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
32496069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
32506069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
32516069ff26Swdenk	a multiple of 4 bytes).
32526069ff26Swdenk
32536069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
32546069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
32556069ff26Swdenk	flash memory.
32566069ff26Swdenk
32576069ff26Swdenk   "Script files" are command sequences that will be executed by
32586069ff26Swdenk	U-Boot's command interpreter; this feature is especially
32596069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
32606069ff26Swdenk	as command interpreter.
32616069ff26Swdenk
3262c609719bSwdenk
3263c609719bSwdenkStandalone HOWTO:
3264c609719bSwdenk=================
3265c609719bSwdenk
3266c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3267c609719bSwdenkrun "standalone" applications, which can use some resources of
3268c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3269c609719bSwdenk
3270c609719bSwdenkTwo simple examples are included with the sources:
3271c609719bSwdenk
3272c609719bSwdenk"Hello World" Demo:
3273c609719bSwdenk-------------------
3274c609719bSwdenk
3275c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3276c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3277c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3278c609719bSwdenklike that:
3279c609719bSwdenk
3280c609719bSwdenk	=> loads
3281c609719bSwdenk	## Ready for S-Record download ...
3282c609719bSwdenk	~>examples/hello_world.srec
3283c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3284c609719bSwdenk	[file transfer complete]
3285c609719bSwdenk	[connected]
3286c609719bSwdenk	## Start Addr = 0x00040004
3287c609719bSwdenk
3288c609719bSwdenk	=> go 40004 Hello World! This is a test.
3289c609719bSwdenk	## Starting application at 0x00040004 ...
3290c609719bSwdenk	Hello World
3291c609719bSwdenk	argc = 7
3292c609719bSwdenk	argv[0] = "40004"
3293c609719bSwdenk	argv[1] = "Hello"
3294c609719bSwdenk	argv[2] = "World!"
3295c609719bSwdenk	argv[3] = "This"
3296c609719bSwdenk	argv[4] = "is"
3297c609719bSwdenk	argv[5] = "a"
3298c609719bSwdenk	argv[6] = "test."
3299c609719bSwdenk	argv[7] = "<NULL>"
3300c609719bSwdenk	Hit any key to exit ...
3301c609719bSwdenk
3302c609719bSwdenk	## Application terminated, rc = 0x0
3303c609719bSwdenk
3304c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3305c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3306c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3307c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3308c609719bSwdenkcharacter, but this is just a demo program. The application can be
3309c609719bSwdenkcontrolled by the following keys:
3310c609719bSwdenk
3311c609719bSwdenk	? - print current values og the CPM Timer registers
3312c609719bSwdenk	b - enable interrupts and start timer
3313c609719bSwdenk	e - stop timer and disable interrupts
3314c609719bSwdenk	q - quit application
3315c609719bSwdenk
3316c609719bSwdenk	=> loads
3317c609719bSwdenk	## Ready for S-Record download ...
3318c609719bSwdenk	~>examples/timer.srec
3319c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3320c609719bSwdenk	[file transfer complete]
3321c609719bSwdenk	[connected]
3322c609719bSwdenk	## Start Addr = 0x00040004
3323c609719bSwdenk
3324c609719bSwdenk	=> go 40004
3325c609719bSwdenk	## Starting application at 0x00040004 ...
3326c609719bSwdenk	TIMERS=0xfff00980
3327c609719bSwdenk	Using timer 1
3328c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3329c609719bSwdenk
3330c609719bSwdenkHit 'b':
3331c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3332c609719bSwdenk	Enabling timer
3333c609719bSwdenkHit '?':
3334c609719bSwdenk	[q, b, e, ?] ........
3335c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3336c609719bSwdenkHit '?':
3337c609719bSwdenk	[q, b, e, ?] .
3338c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3339c609719bSwdenkHit '?':
3340c609719bSwdenk	[q, b, e, ?] .
3341c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3342c609719bSwdenkHit '?':
3343c609719bSwdenk	[q, b, e, ?] .
3344c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3345c609719bSwdenkHit 'e':
3346c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3347c609719bSwdenkHit 'q':
3348c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3349c609719bSwdenk
3350c609719bSwdenk
335185ec0bccSwdenkMinicom warning:
335285ec0bccSwdenk================
335385ec0bccSwdenk
33547152b1d0SwdenkOver time, many people have reported problems when trying to use the
335585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
335685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3357f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
335885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
335985ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
336085ec0bccSwdenk
336152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
336252f52c14Swdenkconfiguration to your "File transfer protocols" section:
336352f52c14Swdenk
336452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
336552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
336652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
336752f52c14Swdenk
336852f52c14Swdenk
3369c609719bSwdenkNetBSD Notes:
3370c609719bSwdenk=============
3371c609719bSwdenk
3372c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3373c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3374c609719bSwdenk
3375c609719bSwdenkBuilding requires a cross environment; it is known to work on
3376c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3377c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3378c609719bSwdenkNote that the cross-powerpc package does not install include files;
3379c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3380c609719bSwdenkmissing.  This file has to be installed and patched manually:
3381c609719bSwdenk
3382c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3383c609719bSwdenk	# mkdir powerpc
3384c609719bSwdenk	# ln -s powerpc machine
3385c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3386c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3387c609719bSwdenk
3388c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3389c609719bSwdenkand U-Boot include files.
3390c609719bSwdenk
3391c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3392c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3393c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3394c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
33952a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3396c609719bSwdenk
3397c609719bSwdenk
3398c609719bSwdenkImplementation Internals:
3399c609719bSwdenk=========================
3400c609719bSwdenk
3401c609719bSwdenkThe following is not intended to be a complete description of every
3402c609719bSwdenkimplementation detail. However, it should help to understand the
3403c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3404c609719bSwdenkhardware.
3405c609719bSwdenk
3406c609719bSwdenk
3407c609719bSwdenkInitial Stack, Global Data:
3408c609719bSwdenk---------------------------
3409c609719bSwdenk
3410c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3411c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3412c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3413c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3414c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3415c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3416c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3417c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3418c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3419c609719bSwdenklocked as (mis-) used as memory, etc.
3420c609719bSwdenk
34217152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
342243d9616cSwdenk	u-boot-users mailing list:
342343d9616cSwdenk
342443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
342543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
342643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
342743d9616cSwdenk	...
342843d9616cSwdenk
342943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
343043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
343143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
343243d9616cSwdenk	is that the cache is being used as a temporary supply of
343343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
343443d9616cSwdenk	beyond the scope of this list to expain the details, but you
343543d9616cSwdenk	can see how this works by studying the cache architecture and
343643d9616cSwdenk	operation in the architecture and processor-specific manuals.
343743d9616cSwdenk
343843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
343943d9616cSwdenk	is another option for the system designer to use as an
344043d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
344143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
344243d9616cSwdenk	board designers haven't used it for something that would
344343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
344443d9616cSwdenk	used.
344543d9616cSwdenk
344643d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
344743d9616cSwdenk	with your processor/board/system design. The default value
344843d9616cSwdenk	you will find in any recent u-boot distribution in
34498a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
345043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
345143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
345243d9616cSwdenk	that are supposed to respond to that address! That code in
345343d9616cSwdenk	start.S has been around a while and should work as is when
345443d9616cSwdenk	you get the config right.
345543d9616cSwdenk
345643d9616cSwdenk	-Chris Hallinan
345743d9616cSwdenk	DS4.COM, Inc.
345843d9616cSwdenk
3459c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3460c609719bSwdenkcode for the initialization procedures:
3461c609719bSwdenk
3462c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3463c609719bSwdenk  to write it.
3464c609719bSwdenk
3465c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3466c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
34677152b1d0Swdenk  zation is performed later (when relocating to RAM).
3468c609719bSwdenk
3469c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3470c609719bSwdenk  that.
3471c609719bSwdenk
3472c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3473c609719bSwdenknormal global data to share information beween the code. But it
3474c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3475c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3476c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3477c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3478c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3479c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3480c609719bSwdenkreserve for this purpose.
3481c609719bSwdenk
34827152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3483c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3484c609719bSwdenkGCC's implementation.
3485c609719bSwdenk
3486c609719bSwdenkFor PowerPC, the following registers have specific use:
3487c609719bSwdenk	R1:	stack pointer
3488c609719bSwdenk	R2:	TOC pointer
3489c609719bSwdenk	R3-R4:	parameter passing and return values
3490c609719bSwdenk	R5-R10: parameter passing
3491c609719bSwdenk	R13:	small data area pointer
3492c609719bSwdenk	R30:	GOT pointer
3493c609719bSwdenk	R31:	frame pointer
3494c609719bSwdenk
3495c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3496c609719bSwdenk
3497c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3498c609719bSwdenk
3499c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3500c609719bSwdenk    address of the global data structure is known at compile time),
3501c609719bSwdenk    but it turned out that reserving a register results in somewhat
3502c609719bSwdenk    smaller code - although the code savings are not that big (on
3503c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3504c609719bSwdenk    624 text + 127 data).
3505c609719bSwdenk
3506c609719bSwdenkOn ARM, the following registers are used:
3507c609719bSwdenk
3508c609719bSwdenk	R0:	function argument word/integer result
3509c609719bSwdenk	R1-R3:	function argument word
3510c609719bSwdenk	R9:	GOT pointer
3511c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3512c609719bSwdenk	R11:	argument (frame) pointer
3513c609719bSwdenk	R12:	temporary workspace
3514c609719bSwdenk	R13:	stack pointer
3515c609719bSwdenk	R14:	link register
3516c609719bSwdenk	R15:	program counter
3517c609719bSwdenk
3518c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3519c609719bSwdenk
3520d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3521d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3522c609719bSwdenk
3523c609719bSwdenkMemory Management:
3524c609719bSwdenk------------------
3525c609719bSwdenk
3526c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3527c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3528c609719bSwdenk
3529c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3530c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3531c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3532c609719bSwdenkphysical memory banks.
3533c609719bSwdenk
3534c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3535c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3536c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3537c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3538c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3539c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3540c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3541c609719bSwdenk
3542c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3543c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3544c609719bSwdenk
3545c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3546c609719bSwdenkthis:
3547c609719bSwdenk
3548c609719bSwdenk	0x0000 0000	Exception Vector code
3549c609719bSwdenk	      :
3550c609719bSwdenk	0x0000 1FFF
3551c609719bSwdenk	0x0000 2000	Free for Application Use
3552c609719bSwdenk	      :
3553c609719bSwdenk	      :
3554c609719bSwdenk
3555c609719bSwdenk	      :
3556c609719bSwdenk	      :
3557c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3558c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3559c609719bSwdenk	0x00FC 0000	Malloc Arena
3560c609719bSwdenk	      :
3561c609719bSwdenk	0x00FD FFFF
3562c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3563c609719bSwdenk	...		eventually: LCD or video framebuffer
3564c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3565c609719bSwdenk	0x00FF FFFF	[End of RAM]
3566c609719bSwdenk
3567c609719bSwdenk
3568c609719bSwdenkSystem Initialization:
3569c609719bSwdenk----------------------
3570c609719bSwdenk
3571c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3572c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3573c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
35747152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3575c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3576c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3577c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3578c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3579c609719bSwdenkthe caches and the SIU.
3580c609719bSwdenk
3581c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3582c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3583c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3584c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3585c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3586c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3587c609719bSwdenkbanks.
3588c609719bSwdenk
3589c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
35907152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3591c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3592c609719bSwdenk0x00000000, with any additional banks following immediately to create
3593c609719bSwdenkcontiguous memory starting from 0.
3594c609719bSwdenk
3595c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3596c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3597c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3598c609719bSwdenkpages, and the final stack is set up.
3599c609719bSwdenk
3600c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3601c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3602c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3603c609719bSwdenknew address in RAM.
3604c609719bSwdenk
3605c609719bSwdenk
3606c609719bSwdenkU-Boot Porting Guide:
3607c609719bSwdenk----------------------
3608c609719bSwdenk
3609c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
36106aff3115Swdenklist, October 2002]
3611c609719bSwdenk
3612c609719bSwdenk
3613c609719bSwdenkint main (int argc, char *argv[])
3614c609719bSwdenk{
3615c609719bSwdenk	sighandler_t no_more_time;
3616c609719bSwdenk
3617c609719bSwdenk	signal (SIGALRM, no_more_time);
3618c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3619c609719bSwdenk
3620c609719bSwdenk	if (available_money > available_manpower) {
3621c609719bSwdenk		pay consultant to port U-Boot;
3622c609719bSwdenk		return 0;
3623c609719bSwdenk	}
3624c609719bSwdenk
3625c609719bSwdenk	Download latest U-Boot source;
3626c609719bSwdenk
36276aff3115Swdenk	Subscribe to u-boot-users mailing list;
36286aff3115Swdenk
3629c609719bSwdenk	if (clueless) {
3630c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3631c609719bSwdenk	}
3632c609719bSwdenk
3633c609719bSwdenk	while (learning) {
3634c609719bSwdenk		Read the README file in the top level directory;
36357cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3636c609719bSwdenk		Read the source, Luke;
3637c609719bSwdenk	}
3638c609719bSwdenk
3639c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3640c609719bSwdenk		Buy a BDI2000;
3641c609719bSwdenk	} else {
3642c609719bSwdenk		Add a lot of aggravation and time;
3643c609719bSwdenk	}
3644c609719bSwdenk
3645c609719bSwdenk	Create your own board support subdirectory;
3646c609719bSwdenk
36476aff3115Swdenk	Create your own board config file;
36486aff3115Swdenk
3649c609719bSwdenk	while (!running) {
3650c609719bSwdenk		do {
3651c609719bSwdenk			Add / modify source code;
3652c609719bSwdenk		} until (compiles);
3653c609719bSwdenk		Debug;
3654c609719bSwdenk		if (clueless)
3655c609719bSwdenk			email ("Hi, I am having problems...");
3656c609719bSwdenk	}
3657c609719bSwdenk	Send patch file to Wolfgang;
3658c609719bSwdenk
3659c609719bSwdenk	return 0;
3660c609719bSwdenk}
3661c609719bSwdenk
3662c609719bSwdenkvoid no_more_time (int sig)
3663c609719bSwdenk{
3664c609719bSwdenk      hire_a_guru();
3665c609719bSwdenk}
3666c609719bSwdenk
3667c609719bSwdenk
3668c609719bSwdenkCoding Standards:
3669c609719bSwdenk-----------------
3670c609719bSwdenk
3671c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
36722c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
36732c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
36742c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
36752c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3676c609719bSwdenk
36772c051651SDetlev ZundelSource files originating from a different project (for example the
36782c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
36792c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
36802c051651SDetlev Zundelsources.
36812c051651SDetlev Zundel
36822c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
36832c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
36842c051651SDetlev Zundelin your code.
3685c609719bSwdenk
3686c178d3daSwdenkPlease also stick to the following formatting rules:
3687180d3f74Swdenk- remove any trailing white space
3688180d3f74Swdenk- use TAB characters for indentation, not spaces
3689180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3690180d3f74Swdenk- do not add more than 2 empty lines to source files
3691180d3f74Swdenk- do not add trailing empty lines to source files
3692180d3f74Swdenk
3693c609719bSwdenkSubmissions which do not conform to the standards may be returned
3694c609719bSwdenkwith a request to reformat the changes.
3695c609719bSwdenk
3696c609719bSwdenk
3697c609719bSwdenkSubmitting Patches:
3698c609719bSwdenk-------------------
3699c609719bSwdenk
3700c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3701c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3702c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3703c609719bSwdenk
370490dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3705c609719bSwdenk
3706c609719bSwdenkWhen you send a patch, please include the following information with
3707c609719bSwdenkit:
3708c609719bSwdenk
3709c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3710c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3711c609719bSwdenk  patch actually fixes something.
3712c609719bSwdenk
3713c609719bSwdenk* For new features: a description of the feature and your
3714c609719bSwdenk  implementation.
3715c609719bSwdenk
3716c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3717c609719bSwdenk
3718c609719bSwdenk* For major contributions, your entry to the CREDITS file
3719c609719bSwdenk
3720c609719bSwdenk* When you add support for a new board, don't forget to add this
3721c609719bSwdenk  board to the MAKEALL script, too.
3722c609719bSwdenk
3723c609719bSwdenk* If your patch adds new configuration options, don't forget to
3724c609719bSwdenk  document these in the README file.
3725c609719bSwdenk
3726c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3727c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3728c609719bSwdenk  version of diff does not support these options, then get the latest
3729c609719bSwdenk  version of GNU diff.
3730c609719bSwdenk
37316dff5529Swdenk  The current directory when running this command shall be the top
37326dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
37336dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
37346dff5529Swdenk  directory information for the affected files).
37356dff5529Swdenk
3736c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3737c609719bSwdenk  gzipped text.
3738c609719bSwdenk
373952f52c14Swdenk* If one logical set of modifications affects or creates several
374052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
374152f52c14Swdenk
374252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
374352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
374452f52c14Swdenk
374552f52c14Swdenk
3746c609719bSwdenkNotes:
3747c609719bSwdenk
3748c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3749c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3750c609719bSwdenk  for any of the boards.
3751c609719bSwdenk
3752c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3753c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3754c609719bSwdenk  returned with a request to re-formatting / split it.
3755c609719bSwdenk
3756c609719bSwdenk* If you modify existing code, make sure that your new code does not
3757c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3758c609719bSwdenk  When adding new features, these should compile conditionally only
3759c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3760c609719bSwdenk  disabled must not need more memory than the old code without your
3761c609719bSwdenk  modification.
376290dc6704Swdenk
376390dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
376490dc6704Swdenk  u-boot-users mailing list. Compression may help.
3765