xref: /openbmc/u-boot/README (revision 213bf8c822de8eecaf69860684469cdaba2e9e6a)
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
13911dadd54Swdenk  - mips	Files specific to MIPS CPUs
140983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
141983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
142983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
143983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
144983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
145983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
146983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14711dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1485c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1490c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
15011dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15111dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15211dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
153c609719bSwdenk- disk		Code for disk drive partition handling
154c609719bSwdenk- doc		Documentation (don't expect too much)
1557152b1d0Swdenk- drivers	Commonly used device drivers
156c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
157c609719bSwdenk- examples	Example code for standalone applications, etc.
158c609719bSwdenk- include	Header Files
15911dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1607b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
16111dadd54Swdenk- lib_generic	Files generic to all	 architectures
16211dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16311dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16411dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16511dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16611dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
167*213bf8c8SGerald Van Baren- libfdt 	Library files to support flattened device trees
168c609719bSwdenk- net		Networking code
169c609719bSwdenk- post		Power On Self Test
170c609719bSwdenk- rtc		Real Time Clock drivers
171c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
172c609719bSwdenk
173c609719bSwdenkSoftware Configuration:
174c609719bSwdenk=======================
175c609719bSwdenk
176c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
177c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
178c609719bSwdenk
179c609719bSwdenkThere are two classes of configuration variables:
180c609719bSwdenk
181c609719bSwdenk* Configuration _OPTIONS_:
182c609719bSwdenk  These are selectable by the user and have names beginning with
183c609719bSwdenk  "CONFIG_".
184c609719bSwdenk
185c609719bSwdenk* Configuration _SETTINGS_:
186c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
187c609719bSwdenk  you don't know what you're doing; they have names beginning with
188c609719bSwdenk  "CFG_".
189c609719bSwdenk
190c609719bSwdenkLater we will add a configuration tool - probably similar to or even
191c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
192c609719bSwdenkdo the configuration by hand, which means creating some symbolic
193c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
194c609719bSwdenkas an example here.
195c609719bSwdenk
196c609719bSwdenk
197c609719bSwdenkSelection of Processor Architecture and Board Type:
198c609719bSwdenk---------------------------------------------------
199c609719bSwdenk
200c609719bSwdenkFor all supported boards there are ready-to-use default
201c609719bSwdenkconfigurations available; just type "make <board_name>_config".
202c609719bSwdenk
203c609719bSwdenkExample: For a TQM823L module type:
204c609719bSwdenk
205c609719bSwdenk	cd u-boot
206c609719bSwdenk	make TQM823L_config
207c609719bSwdenk
208c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
209c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
210c609719bSwdenkdirectory according to the instructions in cogent/README.
211c609719bSwdenk
212c609719bSwdenk
213c609719bSwdenkConfiguration Options:
214c609719bSwdenk----------------------
215c609719bSwdenk
216c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
217c609719bSwdenksuch information is kept in a configuration file
218c609719bSwdenk"include/configs/<board_name>.h".
219c609719bSwdenk
220c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
221c609719bSwdenk"include/configs/TQM823L.h".
222c609719bSwdenk
223c609719bSwdenk
2247f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2257f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2267f6c2cbcSwdenkbuild a config tool - later.
2277f6c2cbcSwdenk
2287f6c2cbcSwdenk
229c609719bSwdenkThe following options need to be configured:
230c609719bSwdenk
231c609719bSwdenk- CPU Type:	Define exactly one of
232c609719bSwdenk
233c609719bSwdenk		PowerPC based CPUs:
234c609719bSwdenk		-------------------
235c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2360db5bca8Swdenk	or	CONFIG_MPC5xx
237983fda83Swdenk	or	CONFIG_MPC8220
238c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23942d1f039Swdenk	or	CONFIG_MPC85xx
240c609719bSwdenk	or	CONFIG_IOP480
241c609719bSwdenk	or	CONFIG_405GP
24212f34241Swdenk	or	CONFIG_405EP
243c609719bSwdenk	or	CONFIG_440
244c609719bSwdenk	or	CONFIG_MPC74xx
24572755c71Swdenk	or	CONFIG_750FX
246c609719bSwdenk
247c609719bSwdenk		ARM based CPUs:
248c609719bSwdenk		---------------
249c609719bSwdenk		CONFIG_SA1110
250c609719bSwdenk		CONFIG_ARM7
251c609719bSwdenk		CONFIG_PXA250
2520b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
253c609719bSwdenk
254507bbe3eSwdenk		MicroBlaze based CPUs:
255507bbe3eSwdenk		----------------------
256857cad37Swdenk		CONFIG_MICROBLAZE
257507bbe3eSwdenk
2585c952cf0Swdenk		Nios-2 based CPUs:
2595c952cf0Swdenk		----------------------
2605c952cf0Swdenk		CONFIG_NIOS2
2615c952cf0Swdenk
26272a087e0SWolfgang Denk		AVR32 based CPUs:
26372a087e0SWolfgang Denk		----------------------
26472a087e0SWolfgang Denk		CONFIG_AT32AP
265c609719bSwdenk
266c609719bSwdenk- Board Type:	Define exactly one of
267c609719bSwdenk
268c609719bSwdenk		PowerPC based boards:
269c609719bSwdenk		---------------------
270c609719bSwdenk
27176544f80SDetlev Zundel		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
27276544f80SDetlev Zundel		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
27376544f80SDetlev Zundel		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
27476544f80SDetlev Zundel		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
27576544f80SDetlev Zundel		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
27676544f80SDetlev Zundel		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
27776544f80SDetlev Zundel		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
27809e4b0c5SWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
27909e4b0c5SWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
28009e4b0c5SWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
28109e4b0c5SWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
28209e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
28309e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
28409e4b0c5SWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
28509e4b0c5SWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
28609e4b0c5SWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
28709e4b0c5SWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
28809e4b0c5SWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
28909e4b0c5SWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
29009e4b0c5SWolfgang Denk		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
29109e4b0c5SWolfgang Denk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
29209e4b0c5SWolfgang Denk		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
29309e4b0c5SWolfgang Denk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
29409e4b0c5SWolfgang Denk		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
29509e4b0c5SWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
29609e4b0c5SWolfgang Denk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
29709e4b0c5SWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
29809e4b0c5SWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
29909e4b0c5SWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
30009e4b0c5SWolfgang Denk		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
30109e4b0c5SWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
30209e4b0c5SWolfgang Denk		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
30309e4b0c5SWolfgang Denk		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
30409e4b0c5SWolfgang Denk		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
30509e4b0c5SWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
30609e4b0c5SWolfgang Denk		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
30709e4b0c5SWolfgang Denk		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
30809e4b0c5SWolfgang Denk		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
309c609719bSwdenk
310c609719bSwdenk		ARM based boards:
311c609719bSwdenk		-----------------
312c609719bSwdenk
313c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
3140b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
3150b953ffcSMarkus Klotzbuecher		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
3160b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
3170b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
3180b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
3195720df78SHeiko Schocher		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
3205720df78SHeiko Schocher		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
3215720df78SHeiko Schocher		CONFIG_VCMA9
322c609719bSwdenk
323507bbe3eSwdenk		MicroBlaze based boards:
324507bbe3eSwdenk		------------------------
325507bbe3eSwdenk
326507bbe3eSwdenk		CONFIG_SUZAKU
327507bbe3eSwdenk
3285c952cf0Swdenk		Nios-2 based boards:
3295c952cf0Swdenk		------------------------
3305c952cf0Swdenk
3315c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3329cc83378SScott McNutt		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
3335c952cf0Swdenk
3346ccec449SWolfgang Denk		AVR32 based boards:
3356ccec449SWolfgang Denk		-------------------
3366ccec449SWolfgang Denk
3376ccec449SWolfgang Denk		CONFIG_ATSTK1000
3386ccec449SWolfgang Denk
3396ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
3406ccec449SWolfgang Denk		Define exactly one of
3416ccec449SWolfgang Denk		CONFIG_ATSTK1002
3426ccec449SWolfgang Denk
343c609719bSwdenk
344c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
345c609719bSwdenk		Define exactly one of
346c609719bSwdenk		CONFIG_CMA286_60_OLD
347c609719bSwdenk--- FIXME --- not tested yet:
348c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
349c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
350c609719bSwdenk
351c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
352c609719bSwdenk		Define exactly one of
353c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
354c609719bSwdenk
355c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
356c609719bSwdenk		Define one or more of
357c609719bSwdenk		CONFIG_CMA302
358c609719bSwdenk
359c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
360c609719bSwdenk		Define one or more of
361c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
362c609719bSwdenk					  the lcd display every second with
363c609719bSwdenk					  a "rotator" |\-/|\-/
364c609719bSwdenk
3652535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3662535d602Swdenk		CONFIG_ADSTYPE
3672535d602Swdenk		Possible values are:
3682535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
369180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
37054387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
37104a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3722535d602Swdenk
373c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
374c609719bSwdenk		Define exactly one of
375c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
376c609719bSwdenk
37775d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
37866ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
37966ca92a5Swdenk					  get_gclk_freq() cannot work
3805da627a4Swdenk					  e.g. if there is no 32KHz
3815da627a4Swdenk					  reference PIT/RTC clock
38266ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
38366ca92a5Swdenk					  or XTAL/EXTAL)
384c609719bSwdenk
38566ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
38666ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
38766ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
38866ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
38975d1ea7fSwdenk			See doc/README.MPC866
39075d1ea7fSwdenk
39175d1ea7fSwdenk		CFG_MEASURE_CPUCLK
39275d1ea7fSwdenk
39375d1ea7fSwdenk		Define this to measure the actual CPU clock instead
39475d1ea7fSwdenk		of relying on the correctness of the configured
39575d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
39675d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
39775d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
39866ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
39975d1ea7fSwdenk
4000b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4010b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
4020b953ffcSMarkus Klotzbuecher
4030b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4040b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4050b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4060b953ffcSMarkus Klotzbuecher
4070b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
4080b953ffcSMarkus Klotzbuecher
4090b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4100b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4110b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4120b953ffcSMarkus Klotzbuecher		by this value.
4130b953ffcSMarkus Klotzbuecher
4145da627a4Swdenk- Linux Kernel Interface:
415c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
416c609719bSwdenk
417c609719bSwdenk		U-Boot stores all clock information in Hz
418c609719bSwdenk		internally. For binary compatibility with older Linux
419c609719bSwdenk		kernels (which expect the clocks passed in the
420c609719bSwdenk		bd_info data to be in MHz) the environment variable
421c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
422c609719bSwdenk		converts clock data to MHZ before passing it to the
423c609719bSwdenk		Linux kernel.
424c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
425c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
426c609719bSwdenk		default environment.
427c609719bSwdenk
4285da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4295da627a4Swdenk
4305da627a4Swdenk		When transfering memsize parameter to linux, some versions
4315da627a4Swdenk		expect it to be in bytes, others in MB.
4325da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4335da627a4Swdenk
434*213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
435f57f70aaSWolfgang Denk
436f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
437*213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
438*213bf8c8SGerald Van Baren		concepts).
439*213bf8c8SGerald Van Baren
440*213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
441*213bf8c8SGerald Van Baren		 * New libfdt-based support
442*213bf8c8SGerald Van Baren		 * Adds the "fdt" command
443*213bf8c8SGerald Van Baren		 * The bootm command does _not_ modify the fdt
444*213bf8c8SGerald Van Baren
445*213bf8c8SGerald Van Baren		CONFIG_OF_FLAT_TREE
446*213bf8c8SGerald Van Baren		 * Deprecated, see CONFIG_OF_LIBFDT
447*213bf8c8SGerald Van Baren		 * Original ft_build.c-based support
448*213bf8c8SGerald Van Baren		 * Automatically modifies the dft as part of the bootm command
449*213bf8c8SGerald Van Baren		 * The environment variable "disable_of", when set,
450*213bf8c8SGerald Van Baren		     disables this functionality.
451f57f70aaSWolfgang Denk
452f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
453f57f70aaSWolfgang Denk
454f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
455f57f70aaSWolfgang Denk
456f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
457c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
458f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
459c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
460f57f70aaSWolfgang Denk
461e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
462e4f880edSKumar Gala
463*213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
464*213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
465*213bf8c8SGerald Van Baren		     will have a copy of the bd_t.  Space should be
466*213bf8c8SGerald Van Baren		     pre-allocated in the dts for the bd_t.
467e4f880edSKumar Gala
468e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
469e4f880edSKumar Gala
470*213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
471*213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
472*213bf8c8SGerald Van Baren		     will have a copy of u-boot's environment variables
473e4f880edSKumar Gala
4744e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4754e253137SKumar Gala
4764e253137SKumar Gala		Board code has addition modification that it wants to make
4774e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4786705d81eSwdenk
4790267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4800267768eSMatthew McClintock
4810267768eSMatthew McClintock		This define fills in the correct boot cpu in the boot
4820267768eSMatthew McClintock		param header, the default value is zero if undefined.
4830267768eSMatthew McClintock
4846705d81eSwdenk- Serial Ports:
4856705d81eSwdenk		CFG_PL010_SERIAL
4866705d81eSwdenk
4876705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4886705d81eSwdenk
4896705d81eSwdenk		CFG_PL011_SERIAL
4906705d81eSwdenk
4916705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4926705d81eSwdenk
4936705d81eSwdenk		CONFIG_PL011_CLOCK
4946705d81eSwdenk
4956705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4966705d81eSwdenk		the clock speed of the UARTs.
4976705d81eSwdenk
4986705d81eSwdenk		CONFIG_PL01x_PORTS
4996705d81eSwdenk
5006705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5016705d81eSwdenk		define this to a list of base addresses for each (supported)
5026705d81eSwdenk		port. See e.g. include/configs/versatile.h
5036705d81eSwdenk
5046705d81eSwdenk
505c609719bSwdenk- Console Interface:
506c609719bSwdenk		Depending on board, define exactly one serial port
507c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
508c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
509c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
510c609719bSwdenk
511c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
512c609719bSwdenk		port routines must be defined elsewhere
513c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
514c609719bSwdenk
515c609719bSwdenk		CONFIG_CFB_CONSOLE
516c609719bSwdenk		Enables console device for a color framebuffer. Needs following
517c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
518c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
519c609719bSwdenk						(default big endian)
520c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
521c609719bSwdenk						rectangle fill
522c609719bSwdenk						(cf. smiLynxEM)
523c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
524c609719bSwdenk						bit-blit (cf. smiLynxEM)
525c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
526c609719bSwdenk						(cols=pitch)
527c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
528c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
529c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
530c609719bSwdenk						(0-5, cf. cfb_console.c)
531c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
532c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
533c609719bSwdenk						(i.e. i8042_kbd_init())
534c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
535c609719bSwdenk						(i.e. i8042_tstc)
536c609719bSwdenk			VIDEO_GETC_FCT		get char fct
537c609719bSwdenk						(i.e. i8042_getc)
538c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
539c609719bSwdenk						(requires blink timer
540c609719bSwdenk						cf. i8042.c)
541c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
542c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
543c609719bSwdenk						upper right corner
544c609719bSwdenk						(requires CFG_CMD_DATE)
545c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
546c609719bSwdenk						upper left corner
547a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
548a6c7ad2fSwdenk						linux_logo.h for logo.
549a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
550c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
551c609719bSwdenk						addional board info beside
552c609719bSwdenk						the logo
553c609719bSwdenk
554c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
555c609719bSwdenk		default i/o. Serial console can be forced with
556c609719bSwdenk		environment 'console=serial'.
557c609719bSwdenk
558a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
559a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
560a3ad8e26Swdenk		the "silent" environment variable. See
561a3ad8e26Swdenk		doc/README.silent for more information.
562a3ad8e26Swdenk
563c609719bSwdenk- Console Baudrate:
564c609719bSwdenk		CONFIG_BAUDRATE - in bps
565c609719bSwdenk		Select one of the baudrates listed in
566c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5673bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
568c609719bSwdenk
569c609719bSwdenk- Interrupt driven serial port input:
570c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
571c609719bSwdenk
572c609719bSwdenk		PPC405GP only.
573c609719bSwdenk		Use an interrupt handler for receiving data on the
574c609719bSwdenk		serial port. It also enables using hardware handshake
575c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
576c609719bSwdenk		bytes the interrupt driven input buffer should have.
577c609719bSwdenk
578109c0e3aSwdenk		Leave undefined to disable this feature, including
579109c0e3aSwdenk		disable the buffer and hardware handshake.
580c609719bSwdenk
5811d49b1f3Sstroese- Console UART Number:
5821d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5831d49b1f3Sstroese
5840c8721a4SWolfgang Denk		AMCC PPC4xx only.
5851d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5861d49b1f3Sstroese		as default U-Boot console.
5871d49b1f3Sstroese
588c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
589c609719bSwdenk		Delay before automatically booting the default image;
590c609719bSwdenk		set to -1 to disable autoboot.
591c609719bSwdenk
592c609719bSwdenk		See doc/README.autoboot for these options that
593c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
594c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
595c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
596c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
597c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
598c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
599c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
600c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
601c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
602c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
603c609719bSwdenk		CONFIG_RESET_TO_RETRY
604c609719bSwdenk
605c609719bSwdenk- Autoboot Command:
606c609719bSwdenk		CONFIG_BOOTCOMMAND
607c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
608c609719bSwdenk		define a command string that is automatically executed
609c609719bSwdenk		when no character is read on the console interface
610c609719bSwdenk		within "Boot Delay" after reset.
611c609719bSwdenk
612c609719bSwdenk		CONFIG_BOOTARGS
613c609719bSwdenk		This can be used to pass arguments to the bootm
614c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
615c609719bSwdenk		environment value "bootargs".
616c609719bSwdenk
617c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
618c609719bSwdenk		The value of these goes into the environment as
619c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
620c609719bSwdenk		as a convenience, when switching between booting from
621c609719bSwdenk		ram and nfs.
622c609719bSwdenk
623c609719bSwdenk- Pre-Boot Commands:
624c609719bSwdenk		CONFIG_PREBOOT
625c609719bSwdenk
626c609719bSwdenk		When this option is #defined, the existence of the
627c609719bSwdenk		environment variable "preboot" will be checked
628c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
629c609719bSwdenk		countdown and/or running the auto-boot command resp.
630c609719bSwdenk		entering interactive mode.
631c609719bSwdenk
632c609719bSwdenk		This feature is especially useful when "preboot" is
633c609719bSwdenk		automatically generated or modified. For an example
634c609719bSwdenk		see the LWMON board specific code: here "preboot" is
635c609719bSwdenk		modified when the user holds down a certain
636c609719bSwdenk		combination of keys on the (special) keyboard when
637c609719bSwdenk		booting the systems
638c609719bSwdenk
639c609719bSwdenk- Serial Download Echo Mode:
640c609719bSwdenk		CONFIG_LOADS_ECHO
641c609719bSwdenk		If defined to 1, all characters received during a
642c609719bSwdenk		serial download (using the "loads" command) are
643c609719bSwdenk		echoed back. This might be needed by some terminal
644c609719bSwdenk		emulations (like "cu"), but may as well just take
645c609719bSwdenk		time on others. This setting #define's the initial
646c609719bSwdenk		value of the "loads_echo" environment variable.
647c609719bSwdenk
648c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
649c609719bSwdenk		CONFIG_KGDB_BAUDRATE
650c609719bSwdenk		Select one of the baudrates listed in
651c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
652c609719bSwdenk
653c609719bSwdenk- Monitor Functions:
654c609719bSwdenk		CONFIG_COMMANDS
655c609719bSwdenk		Most monitor functions can be selected (or
656c609719bSwdenk		de-selected) by adjusting the definition of
657c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
658c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
659c609719bSwdenk		following values:
660c609719bSwdenk
661c609719bSwdenk		#define enables commands:
662c609719bSwdenk		-------------------------
663c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
66478137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
665c609719bSwdenk		CFG_CMD_BDI	  bdinfo
6666705d81eSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
66778137c3cSwdenk		CFG_CMD_BMP	* BMP support
6686705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
669c609719bSwdenk		CFG_CMD_BOOTD	  bootd
6706705d81eSwdenk		CFG_CMD_CACHE	* icache, dcache
671c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
672c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
6736705d81eSwdenk		CFG_CMD_DHCP	* DHCP support
67478137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
67578137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
6766705d81eSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
677953c5b6fSWolfgang Denk		CFG_CMD_ECHO	  echo arguments
678c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
6796705d81eSwdenk		CFG_CMD_ELF	* bootelf, bootvx
680c609719bSwdenk		CFG_CMD_ENV	  saveenv
681c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
6826705d81eSwdenk		CFG_CMD_FAT	* FAT partition support
6832262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
684c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
685c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
68678137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
687c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
688c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
689c609719bSwdenk		CFG_CMD_IMI	  iminfo
69078137c3cSwdenk		CFG_CMD_IMLS	  List all found images
691c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
692c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6936705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
69478137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
695c609719bSwdenk		CFG_CMD_KGDB	* kgdb
696c609719bSwdenk		CFG_CMD_LOADB	  loadb
697c609719bSwdenk		CFG_CMD_LOADS	  loads
698c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
69956523f12Swdenk				  loop, loopw, mtest
70078137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
7016705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
7026705d81eSwdenk		CFG_CMD_MII	* MII utility commands
70378137c3cSwdenk		CFG_CMD_NAND	* NAND support
704c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
705c609719bSwdenk		CFG_CMD_PCI	* pciinfo
706c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
70778137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
708ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
709c609719bSwdenk		CFG_CMD_REGINFO * Register dump
710c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
7116705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
712c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
71378137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
714b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
715c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
716c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
717c609719bSwdenk		CFG_CMD_USB	* USB support
71878137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
719c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
720a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
721c609719bSwdenk		-----------------------------------------------
722c609719bSwdenk		CFG_CMD_ALL	all
723c609719bSwdenk
72481050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
725c609719bSwdenk				this is includes all commands, except
726c609719bSwdenk				the ones marked with "*" in the list
727c609719bSwdenk				above.
728c609719bSwdenk
729c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
73081050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
731c609719bSwdenk		override the default settings in the respective
732c609719bSwdenk		include file.
733c609719bSwdenk
734c609719bSwdenk		EXAMPLE: If you want all functions except of network
735c609719bSwdenk		support you can write:
736c609719bSwdenk
737c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
738c609719bSwdenk
739*213bf8c8SGerald Van Baren	Other Commands:
740*213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
741c609719bSwdenk
742c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
743c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
744c609719bSwdenk		what you (and your U-Boot users) are doing. Data
745c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
746c609719bSwdenk		8260 (where accesses to the IMMR region must be
747c609719bSwdenk		uncached), and it cannot be disabled on all other
748c609719bSwdenk		systems where we (mis-) use the data cache to hold an
749c609719bSwdenk		initial stack and some data.
750c609719bSwdenk
751c609719bSwdenk
752c609719bSwdenk		XXX - this list needs to get updated!
753c609719bSwdenk
754c609719bSwdenk- Watchdog:
755c609719bSwdenk		CONFIG_WATCHDOG
756c609719bSwdenk		If this variable is defined, it enables watchdog
7577152b1d0Swdenk		support. There must be support in the platform specific
758c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
759c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
760c609719bSwdenk		register.
761c609719bSwdenk
762c1551ea8Sstroese- U-Boot Version:
763c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
764c1551ea8Sstroese		If this variable is defined, an environment variable
765c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
766c1551ea8Sstroese		version as printed by the "version" command.
767c1551ea8Sstroese		This variable is readonly.
768c1551ea8Sstroese
769c609719bSwdenk- Real-Time Clock:
770c609719bSwdenk
771c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
772c609719bSwdenk		has to be selected, too. Define exactly one of the
773c609719bSwdenk		following options:
774c609719bSwdenk
775c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
776c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
777c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7781cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
779c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7807f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7813bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7824c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
783c609719bSwdenk
784b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
785b37c7e5eSwdenk		must also be configured. See I2C Support, below.
786b37c7e5eSwdenk
787c609719bSwdenk- Timestamp Support:
788c609719bSwdenk
789c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
790c609719bSwdenk		(date and time) of an image is printed by image
791c609719bSwdenk		commands like bootm or iminfo. This option is
792c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
793c609719bSwdenk
794c609719bSwdenk- Partition Support:
795c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
796c609719bSwdenk		and/or CONFIG_ISO_PARTITION
797c609719bSwdenk
798c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
799c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
800c609719bSwdenk		one partition type as well.
801c609719bSwdenk
802c609719bSwdenk- IDE Reset method:
8034d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8044d13cbadSwdenk		board configurations files but used nowhere!
805c609719bSwdenk
8064d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8074d13cbadSwdenk		be performed by calling the function
8084d13cbadSwdenk			ide_set_reset(int reset)
8094d13cbadSwdenk		which has to be defined in a board specific file
810c609719bSwdenk
811c609719bSwdenk- ATAPI Support:
812c609719bSwdenk		CONFIG_ATAPI
813c609719bSwdenk
814c609719bSwdenk		Set this to enable ATAPI support.
815c609719bSwdenk
816c40b2956Swdenk- LBA48 Support
817c40b2956Swdenk		CONFIG_LBA48
818c40b2956Swdenk
819c40b2956Swdenk		Set this to enable support for disks larger than 137GB
820c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
821c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
822c40b2956Swdenk		support disks up to 2.1TB.
823c40b2956Swdenk
824c40b2956Swdenk		CFG_64BIT_LBA:
825c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
826c40b2956Swdenk			Default is 32bit.
827c40b2956Swdenk
828c609719bSwdenk- SCSI Support:
829c609719bSwdenk		At the moment only there is only support for the
830c609719bSwdenk		SYM53C8XX SCSI controller; define
831c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
832c609719bSwdenk
833c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
834c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
835c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
836c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
837c609719bSwdenk		devices.
838c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
839c609719bSwdenk
840c609719bSwdenk- NETWORK Support (PCI):
841682011ffSwdenk		CONFIG_E1000
842682011ffSwdenk		Support for Intel 8254x gigabit chips.
843682011ffSwdenk
844c609719bSwdenk		CONFIG_EEPRO100
845c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
846c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
847c609719bSwdenk		write routine for first time initialisation.
848c609719bSwdenk
849c609719bSwdenk		CONFIG_TULIP
850c609719bSwdenk		Support for Digital 2114x chips.
851c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
852c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
853c609719bSwdenk
854c609719bSwdenk		CONFIG_NATSEMI
855c609719bSwdenk		Support for National dp83815 chips.
856c609719bSwdenk
857c609719bSwdenk		CONFIG_NS8382X
858c609719bSwdenk		Support for National dp8382[01] gigabit chips.
859c609719bSwdenk
86045219c46Swdenk- NETWORK Support (other):
86145219c46Swdenk
86245219c46Swdenk		CONFIG_DRIVER_LAN91C96
86345219c46Swdenk		Support for SMSC's LAN91C96 chips.
86445219c46Swdenk
86545219c46Swdenk			CONFIG_LAN91C96_BASE
86645219c46Swdenk			Define this to hold the physical address
86745219c46Swdenk			of the LAN91C96's I/O space
86845219c46Swdenk
86945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
87045219c46Swdenk			Define this to enable 32 bit addressing
87145219c46Swdenk
872f39748aeSwdenk		CONFIG_DRIVER_SMC91111
873f39748aeSwdenk		Support for SMSC's LAN91C111 chip
874f39748aeSwdenk
875f39748aeSwdenk			CONFIG_SMC91111_BASE
876f39748aeSwdenk			Define this to hold the physical address
877f39748aeSwdenk			of the device (I/O space)
878f39748aeSwdenk
879f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
880f39748aeSwdenk			Define this if data bus is 32 bits
881f39748aeSwdenk
882f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
883f39748aeSwdenk			Define this to use i/o functions instead of macros
884f39748aeSwdenk			(some hardware wont work with macros)
885f39748aeSwdenk
886c609719bSwdenk- USB Support:
887c609719bSwdenk		At the moment only the UHCI host controller is
8884d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
889c609719bSwdenk		CONFIG_USB_UHCI to enable it.
890c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
89130d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
892c609719bSwdenk		storage devices.
893c609719bSwdenk		Note:
894c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
895c609719bSwdenk		(TEAC FD-05PUB).
8964d13cbadSwdenk		MPC5200 USB requires additional defines:
8974d13cbadSwdenk			CONFIG_USB_CLOCK
8984d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8994d13cbadSwdenk			CONFIG_USB_CONFIG
9004d13cbadSwdenk				for differential drivers: 0x00001000
9014d13cbadSwdenk				for single ended drivers: 0x00005000
9024d13cbadSwdenk
903c609719bSwdenk
90471f95118Swdenk- MMC Support:
90571f95118Swdenk		The MMC controller on the Intel PXA is supported. To
90671f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
90771f95118Swdenk		accessed from the boot prompt by mapping the device
90871f95118Swdenk		to physical memory similar to flash. Command line is
90971f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
91071f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
91171f95118Swdenk
9126705d81eSwdenk- Journaling Flash filesystem support:
9136705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9146705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9156705d81eSwdenk		Define these for a default partition on a NAND device
9166705d81eSwdenk
9176705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
9186705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
9196705d81eSwdenk		Define these for a default partition on a NOR device
9206705d81eSwdenk
9216705d81eSwdenk		CFG_JFFS_CUSTOM_PART
9226705d81eSwdenk		Define this to create an own partition. You have to provide a
9236705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9246705d81eSwdenk
9256705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9266705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
9276705d81eSwdenk		to disable the command chpart. This is the default when you
9286705d81eSwdenk		have not defined a custom partition
9296705d81eSwdenk
930c609719bSwdenk- Keyboard Support:
931c609719bSwdenk		CONFIG_ISA_KEYBOARD
932c609719bSwdenk
933c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
934c609719bSwdenk		support
935c609719bSwdenk
936c609719bSwdenk		CONFIG_I8042_KBD
937c609719bSwdenk		Standard PC keyboard driver with US (is default) and
938c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
939c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
940c609719bSwdenk		for cfb_console. Supports cursor blinking.
941c609719bSwdenk
942c609719bSwdenk- Video support:
943c609719bSwdenk		CONFIG_VIDEO
944c609719bSwdenk
945c609719bSwdenk		Define this to enable video support (for output to
946c609719bSwdenk		video).
947c609719bSwdenk
948c609719bSwdenk		CONFIG_VIDEO_CT69000
949c609719bSwdenk
950c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
951c609719bSwdenk
952c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
953eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
954eeb1b77bSwdenk		video output is selected via environment 'videoout'
955eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
956eeb1b77bSwdenk		assumed.
957c609719bSwdenk
958eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
959eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
960eeb1b77bSwdenk		are possible:
961eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
962eeb1b77bSwdenk		Following standard modes are supported	(* is default):
963eeb1b77bSwdenk
964eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
965eeb1b77bSwdenk		-------------+---------------------------------------------
966eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
967eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
968eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
969eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
970eeb1b77bSwdenk		-------------+---------------------------------------------
971c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
972c609719bSwdenk
973eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
974eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
975eeb1b77bSwdenk
976eeb1b77bSwdenk
977a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
978a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
979a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
980a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
981a6c7ad2fSwdenk
982682011ffSwdenk- Keyboard Support:
983682011ffSwdenk		CONFIG_KEYBOARD
984682011ffSwdenk
985682011ffSwdenk		Define this to enable a custom keyboard support.
986682011ffSwdenk		This simply calls drv_keyboard_init() which must be
987682011ffSwdenk		defined in your board-specific files.
988682011ffSwdenk		The only board using this so far is RBC823.
989a6c7ad2fSwdenk
990c609719bSwdenk- LCD Support:	CONFIG_LCD
991c609719bSwdenk
992c609719bSwdenk		Define this to enable LCD support (for output to LCD
993c609719bSwdenk		display); also select one of the supported displays
994c609719bSwdenk		by defining one of these:
995c609719bSwdenk
996fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
997c609719bSwdenk
998fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
999c609719bSwdenk
1000fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1001c609719bSwdenk
1002fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1003fd3103bbSwdenk			Active, color, single scan.
1004fd3103bbSwdenk
1005fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1006fd3103bbSwdenk
1007fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1008c609719bSwdenk			Active, color, single scan.
1009c609719bSwdenk
1010c609719bSwdenk		CONFIG_SHARP_16x9
1011c609719bSwdenk
1012c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1013c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1014c609719bSwdenk
1015c609719bSwdenk		CONFIG_SHARP_LQ64D341
1016c609719bSwdenk
1017c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1018c609719bSwdenk			Active, color, single scan.
1019c609719bSwdenk
1020c609719bSwdenk		CONFIG_HLD1045
1021c609719bSwdenk
1022c609719bSwdenk			HLD1045 display, 640x480.
1023c609719bSwdenk			Active, color, single scan.
1024c609719bSwdenk
1025c609719bSwdenk		CONFIG_OPTREX_BW
1026c609719bSwdenk
1027c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1028c609719bSwdenk			or
1029c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1030c609719bSwdenk			or
1031c609719bSwdenk			Hitachi	 SP14Q002
1032c609719bSwdenk
1033c609719bSwdenk			320x240. Black & white.
1034c609719bSwdenk
1035c609719bSwdenk		Normally display is black on white background; define
1036c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1037c609719bSwdenk
10387152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1039d791b1dcSwdenk
1040d791b1dcSwdenk		If this option is set, the environment is checked for
1041d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1042d791b1dcSwdenk		of logo, copyright and system information on the LCD
1043e94d2cd9Swdenk		is suppressed and the BMP image at the address
1044d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1045d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1046d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1047d791b1dcSwdenk		loaded very quickly after power-on.
1048d791b1dcSwdenk
104998f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
105098f4a3dfSStefan Roese
105198f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
105298f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
105398f4a3dfSStefan Roese		splashscreen support or the bmp command.
105498f4a3dfSStefan Roese
1055c29fdfc1Swdenk- Compression support:
1056c29fdfc1Swdenk		CONFIG_BZIP2
1057c29fdfc1Swdenk
1058c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1059c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1060c29fdfc1Swdenk		compressed images are supported.
1061c29fdfc1Swdenk
1062c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1063c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1064c29fdfc1Swdenk		be at least 4MB.
1065d791b1dcSwdenk
106617ea1177Swdenk- MII/PHY support:
106717ea1177Swdenk		CONFIG_PHY_ADDR
106817ea1177Swdenk
106917ea1177Swdenk		The address of PHY on MII bus.
107017ea1177Swdenk
107117ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
107217ea1177Swdenk
107317ea1177Swdenk		The clock frequency of the MII bus
107417ea1177Swdenk
107517ea1177Swdenk		CONFIG_PHY_GIGE
107617ea1177Swdenk
107717ea1177Swdenk		If this option is set, support for speed/duplex
107817ea1177Swdenk		detection of Gigabit PHY is included.
107917ea1177Swdenk
108017ea1177Swdenk		CONFIG_PHY_RESET_DELAY
108117ea1177Swdenk
108217ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
108317ea1177Swdenk		reset before any MII register access is possible.
108417ea1177Swdenk		For such PHY, set this option to the usec delay
108517ea1177Swdenk		required. (minimum 300usec for LXT971A)
108617ea1177Swdenk
108717ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
108817ea1177Swdenk
108917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
109017ea1177Swdenk		command issued before MII status register can be read
109117ea1177Swdenk
1092c609719bSwdenk- Ethernet address:
1093c609719bSwdenk		CONFIG_ETHADDR
1094c609719bSwdenk		CONFIG_ETH2ADDR
1095c609719bSwdenk		CONFIG_ETH3ADDR
1096c609719bSwdenk
1097c609719bSwdenk		Define a default value for ethernet address to use
1098c609719bSwdenk		for the respective ethernet interface, in case this
1099c609719bSwdenk		is not determined automatically.
1100c609719bSwdenk
1101c609719bSwdenk- IP address:
1102c609719bSwdenk		CONFIG_IPADDR
1103c609719bSwdenk
1104c609719bSwdenk		Define a default value for the IP address to use for
1105c609719bSwdenk		the default ethernet interface, in case this is not
1106c609719bSwdenk		determined through e.g. bootp.
1107c609719bSwdenk
1108c609719bSwdenk- Server IP address:
1109c609719bSwdenk		CONFIG_SERVERIP
1110c609719bSwdenk
1111c609719bSwdenk		Defines a default value for theIP address of a TFTP
1112c609719bSwdenk		server to contact when using the "tftboot" command.
1113c609719bSwdenk
1114c609719bSwdenk- BOOTP Recovery Mode:
1115c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1116c609719bSwdenk
1117c609719bSwdenk		If you have many targets in a network that try to
1118c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1119c609719bSwdenk		systems send out BOOTP requests at precisely the same
1120c609719bSwdenk		moment (which would happen for instance at recovery
1121c609719bSwdenk		from a power failure, when all systems will try to
1122c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1123c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1124c609719bSwdenk		inserted before sending out BOOTP requests. The
1125c609719bSwdenk		following delays are insterted then:
1126c609719bSwdenk
1127c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1128c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1129c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1130c609719bSwdenk		4th and following
1131c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1132c609719bSwdenk
1133fe389a82Sstroese- DHCP Advanced Options:
1134fe389a82Sstroese		CONFIG_BOOTP_MASK
1135fe389a82Sstroese
1136fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1137fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1138fe389a82Sstroese
1139fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1140fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1141fe389a82Sstroese		than one DNS serverip is offered to the client.
1142fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1143fe389a82Sstroese		serverip will be stored in the additional environment
1144fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1145fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1146fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1147fe389a82Sstroese
1148fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1149fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1150fe389a82Sstroese		need the hostname of the DHCP requester.
1151fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1152fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1153fe389a82Sstroese		environment variable is passed as option 12 to
1154fe389a82Sstroese		the DHCP server.
1155fe389a82Sstroese
1156a3d991bdSwdenk - CDP Options:
1157a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1158a3d991bdSwdenk
1159a3d991bdSwdenk		The device id used in CDP trigger frames.
1160a3d991bdSwdenk
1161a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1162a3d991bdSwdenk
1163a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1164a3d991bdSwdenk		of the device.
1165a3d991bdSwdenk
1166a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1167a3d991bdSwdenk
1168a3d991bdSwdenk		A printf format string which contains the ascii name of
1169a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1170a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1171a3d991bdSwdenk
1172a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1173a3d991bdSwdenk
1174a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1175a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1176a3d991bdSwdenk
1177a3d991bdSwdenk		CONFIG_CDP_VERSION
1178a3d991bdSwdenk
1179a3d991bdSwdenk		An ascii string containing the version of the software.
1180a3d991bdSwdenk
1181a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1182a3d991bdSwdenk
1183a3d991bdSwdenk		An ascii string containing the name of the platform.
1184a3d991bdSwdenk
1185a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1186a3d991bdSwdenk
1187a3d991bdSwdenk		A 32bit integer sent on the trigger.
1188a3d991bdSwdenk
1189a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1190a3d991bdSwdenk
1191a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1192a3d991bdSwdenk		device in .1 of milliwatts.
1193a3d991bdSwdenk
1194a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1195a3d991bdSwdenk
1196a3d991bdSwdenk		A byte containing the id of the VLAN.
1197a3d991bdSwdenk
1198c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1199c609719bSwdenk
1200c609719bSwdenk		Several configurations allow to display the current
1201c609719bSwdenk		status using a LED. For instance, the LED will blink
1202c609719bSwdenk		fast while running U-Boot code, stop blinking as
1203c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1204c609719bSwdenk		start blinking slow once the Linux kernel is running
1205c609719bSwdenk		(supported by a status LED driver in the Linux
1206c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1207c609719bSwdenk		feature in U-Boot.
1208c609719bSwdenk
1209c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1210c609719bSwdenk
1211c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1212c609719bSwdenk		on those systems that support this (optional)
1213c609719bSwdenk		feature, like the TQM8xxL modules.
1214c609719bSwdenk
1215c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1216c609719bSwdenk
1217b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1218b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1219b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1220c609719bSwdenk
1221b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1222b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1223b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1224b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1225c609719bSwdenk		command line interface.
1226c609719bSwdenk
1227bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1228bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1229bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1230bb99ad6dSBen Warren		deprecated and may disappear in the future.
1231bb99ad6dSBen Warren
1232bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1233c609719bSwdenk
1234b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1235b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1236b37c7e5eSwdenk		support for I2C.
1237c609719bSwdenk
1238b37c7e5eSwdenk		There are several other quantities that must also be
1239b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1240c609719bSwdenk
1241b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1242b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1243b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1244b37c7e5eSwdenk		the cpu's i2c node address).
1245c609719bSwdenk
1246b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1247b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1248b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1249b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1250b37c7e5eSwdenk
1251b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1252b37c7e5eSwdenk
1253b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1254b37c7e5eSwdenk		then the following macros need to be defined (examples are
1255b37c7e5eSwdenk		from include/configs/lwmon.h):
1256c609719bSwdenk
1257c609719bSwdenk		I2C_INIT
1258c609719bSwdenk
1259b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1260c609719bSwdenk		controller or configure ports.
1261c609719bSwdenk
1262b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1263b37c7e5eSwdenk
1264c609719bSwdenk		I2C_PORT
1265c609719bSwdenk
1266c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1267c609719bSwdenk		assumes both bits are on the same port). Valid values
1268c609719bSwdenk		are 0..3 for ports A..D.
1269c609719bSwdenk
1270c609719bSwdenk		I2C_ACTIVE
1271c609719bSwdenk
1272c609719bSwdenk		The code necessary to make the I2C data line active
1273c609719bSwdenk		(driven).  If the data line is open collector, this
1274c609719bSwdenk		define can be null.
1275c609719bSwdenk
1276b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1277b37c7e5eSwdenk
1278c609719bSwdenk		I2C_TRISTATE
1279c609719bSwdenk
1280c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1281c609719bSwdenk		(inactive).  If the data line is open collector, this
1282c609719bSwdenk		define can be null.
1283c609719bSwdenk
1284b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1285b37c7e5eSwdenk
1286c609719bSwdenk		I2C_READ
1287c609719bSwdenk
1288c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1289c609719bSwdenk		FALSE if it is low.
1290c609719bSwdenk
1291b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1292b37c7e5eSwdenk
1293c609719bSwdenk		I2C_SDA(bit)
1294c609719bSwdenk
1295c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1296c609719bSwdenk		is FALSE, it clears it (low).
1297c609719bSwdenk
1298b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1299b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1300b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1301b37c7e5eSwdenk
1302c609719bSwdenk		I2C_SCL(bit)
1303c609719bSwdenk
1304c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1305c609719bSwdenk		is FALSE, it clears it (low).
1306c609719bSwdenk
1307b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1308b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1309b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1310b37c7e5eSwdenk
1311c609719bSwdenk		I2C_DELAY
1312c609719bSwdenk
1313c609719bSwdenk		This delay is invoked four times per clock cycle so this
1314c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1315b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1316b37c7e5eSwdenk		like:
1317b37c7e5eSwdenk
1318b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1319c609719bSwdenk
132047cd00faSwdenk		CFG_I2C_INIT_BOARD
132147cd00faSwdenk
132247cd00faSwdenk		When a board is reset during an i2c bus transfer
132347cd00faSwdenk		chips might think that the current transfer is still
132447cd00faSwdenk		in progress. On some boards it is possible to access
132547cd00faSwdenk		the i2c SCLK line directly, either by using the
132647cd00faSwdenk		processor pin as a GPIO or by having a second pin
132747cd00faSwdenk		connected to the bus. If this option is defined a
132847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
132947cd00faSwdenk		is run early in the boot sequence.
133047cd00faSwdenk
133117ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
133217ea1177Swdenk
133317ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
133417ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
133517ea1177Swdenk		variable "i2cfast". (see also i2cfast)
133617ea1177Swdenk
1337bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1338bb99ad6dSBen Warren
1339bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1340bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1341bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1342bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1343bb99ad6dSBen Warren
1344bb99ad6dSBen Warren		CFG_I2C_NOPROBES
1345bb99ad6dSBen Warren
1346bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1347bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1348bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1349bb99ad6dSBen Warren		pairs.  Otherwise, specify a 1D array of device addresses
1350bb99ad6dSBen Warren
1351bb99ad6dSBen Warren		e.g.
1352bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1353bb99ad6dSBen Warren			#define CFG_I2C_NOPROBES	{0x50,0x68}
1354bb99ad6dSBen Warren
1355bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1356bb99ad6dSBen Warren
1357bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1358bb99ad6dSBen Warren			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1359bb99ad6dSBen Warren
1360bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1361bb99ad6dSBen Warren
1362be5e6181STimur Tabi		CFG_SPD_BUS_NUM
1363be5e6181STimur Tabi
1364be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1365be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1366be5e6181STimur Tabi
13670dc018ecSStefan Roese		CFG_RTC_BUS_NUM
13680dc018ecSStefan Roese
13690dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
13700dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
13710dc018ecSStefan Roese
13720dc018ecSStefan Roese		CFG_DTT_BUS_NUM
13730dc018ecSStefan Roese
13740dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
13750dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
13760dc018ecSStefan Roese
1377be5e6181STimur Tabi		CONFIG_FSL_I2C
1378be5e6181STimur Tabi
1379be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
1380be5e6181STimur Tabi		drivers/fsl_i2c.c.
1381be5e6181STimur Tabi
1382be5e6181STimur Tabi
1383c609719bSwdenk- SPI Support:	CONFIG_SPI
1384c609719bSwdenk
1385c609719bSwdenk		Enables SPI driver (so far only tested with
1386c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1387c609719bSwdenk		D/As on the SACSng board)
1388c609719bSwdenk
1389c609719bSwdenk		CONFIG_SPI_X
1390c609719bSwdenk
1391c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1392c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1393c609719bSwdenk
1394c609719bSwdenk		CONFIG_SOFT_SPI
1395c609719bSwdenk
1396c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1397c609719bSwdenk		using hardware support. This is a general purpose
1398c609719bSwdenk		driver that only requires three general I/O port pins
1399c609719bSwdenk		(two outputs, one input) to function. If this is
1400c609719bSwdenk		defined, the board configuration must define several
1401c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1402c609719bSwdenk		an example, see include/configs/sacsng.h.
1403c609719bSwdenk
1404c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1405c609719bSwdenk
1406c609719bSwdenk		Specify the number of FPGA devices to support.
1407c609719bSwdenk
1408c609719bSwdenk		CONFIG_FPGA
1409c609719bSwdenk
1410c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1411c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1412c609719bSwdenk
1413c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1414c609719bSwdenk
1415c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1416c609719bSwdenk
1417c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1418c609719bSwdenk
1419c609719bSwdenk		Enable checks on FPGA configuration interface busy
1420c609719bSwdenk		status by the configuration function. This option
1421c609719bSwdenk		will require a board or device specific function to
1422c609719bSwdenk		be written.
1423c609719bSwdenk
1424c609719bSwdenk		CONFIG_FPGA_DELAY
1425c609719bSwdenk
1426c609719bSwdenk		If defined, a function that provides delays in the FPGA
1427c609719bSwdenk		configuration driver.
1428c609719bSwdenk
1429c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1430c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1431c609719bSwdenk
1432c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1433c609719bSwdenk
1434c609719bSwdenk		Check for configuration errors during FPGA bitfile
1435c609719bSwdenk		loading. For example, abort during Virtex II
1436c609719bSwdenk		configuration if the INIT_B line goes low (which
1437c609719bSwdenk		indicated a CRC error).
1438c609719bSwdenk
1439c609719bSwdenk		CFG_FPGA_WAIT_INIT
1440c609719bSwdenk
1441c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1442c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1443c609719bSwdenk		FPGA configuration sequence. The default time is 500
1444c609719bSwdenk		mS.
1445c609719bSwdenk
1446c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1447c609719bSwdenk
1448c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1449c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1450c609719bSwdenk
1451c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1452c609719bSwdenk
1453c609719bSwdenk		Time to wait after FPGA configuration. The default is
1454c609719bSwdenk		200 mS.
1455c609719bSwdenk
1456c609719bSwdenk- Configuration Management:
1457c609719bSwdenk		CONFIG_IDENT_STRING
1458c609719bSwdenk
1459c609719bSwdenk		If defined, this string will be added to the U-Boot
1460c609719bSwdenk		version information (U_BOOT_VERSION)
1461c609719bSwdenk
1462c609719bSwdenk- Vendor Parameter Protection:
1463c609719bSwdenk
1464c609719bSwdenk		U-Boot considers the values of the environment
1465c609719bSwdenk		variables "serial#" (Board Serial Number) and
14667152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1467c609719bSwdenk		are set once by the board vendor / manufacturer, and
1468c609719bSwdenk		protects these variables from casual modification by
1469c609719bSwdenk		the user. Once set, these variables are read-only,
1470c609719bSwdenk		and write or delete attempts are rejected. You can
1471c609719bSwdenk		change this behviour:
1472c609719bSwdenk
1473c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1474c609719bSwdenk		file, the write protection for vendor parameters is
147547cd00faSwdenk		completely disabled. Anybody can change or delete
1476c609719bSwdenk		these parameters.
1477c609719bSwdenk
1478c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1479c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1480c609719bSwdenk		ethernet address is installed in the environment,
1481c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1482c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1483c609719bSwdenk		read-only.]
1484c609719bSwdenk
1485c609719bSwdenk- Protected RAM:
1486c609719bSwdenk		CONFIG_PRAM
1487c609719bSwdenk
1488c609719bSwdenk		Define this variable to enable the reservation of
1489c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1490c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1491c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1492c609719bSwdenk		this default value by defining an environment
1493c609719bSwdenk		variable "pram" to the number of kB you want to
1494c609719bSwdenk		reserve. Note that the board info structure will
1495c609719bSwdenk		still show the full amount of RAM. If pRAM is
1496c609719bSwdenk		reserved, a new environment variable "mem" will
1497c609719bSwdenk		automatically be defined to hold the amount of
1498c609719bSwdenk		remaining RAM in a form that can be passed as boot
1499c609719bSwdenk		argument to Linux, for instance like that:
1500c609719bSwdenk
1501fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1502c609719bSwdenk			saveenv
1503c609719bSwdenk
1504c609719bSwdenk		This way you can tell Linux not to use this memory,
1505c609719bSwdenk		either, which results in a memory region that will
1506c609719bSwdenk		not be affected by reboots.
1507c609719bSwdenk
1508c609719bSwdenk		*WARNING* If your board configuration uses automatic
1509c609719bSwdenk		detection of the RAM size, you must make sure that
1510c609719bSwdenk		this memory test is non-destructive. So far, the
1511c609719bSwdenk		following board configurations are known to be
1512c609719bSwdenk		"pRAM-clean":
1513c609719bSwdenk
1514c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1515c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1516c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1517c609719bSwdenk
1518c609719bSwdenk- Error Recovery:
1519c609719bSwdenk		CONFIG_PANIC_HANG
1520c609719bSwdenk
1521c609719bSwdenk		Define this variable to stop the system in case of a
1522c609719bSwdenk		fatal error, so that you have to reset it manually.
1523c609719bSwdenk		This is probably NOT a good idea for an embedded
1524c609719bSwdenk		system where you want to system to reboot
1525c609719bSwdenk		automatically as fast as possible, but it may be
1526c609719bSwdenk		useful during development since you can try to debug
1527c609719bSwdenk		the conditions that lead to the situation.
1528c609719bSwdenk
1529c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1530c609719bSwdenk
1531c609719bSwdenk		This variable defines the number of retries for
1532c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1533c609719bSwdenk		before giving up the operation. If not defined, a
1534c609719bSwdenk		default value of 5 is used.
1535c609719bSwdenk
1536c609719bSwdenk- Command Interpreter:
15378078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
153804a85b3bSwdenk
153904a85b3bSwdenk		Enable auto completion of commands using TAB.
154004a85b3bSwdenk
15418078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
15428078f1a5SWolfgang Denk		for the "hush" shell.
15438078f1a5SWolfgang Denk
15448078f1a5SWolfgang Denk
1545c609719bSwdenk		CFG_HUSH_PARSER
1546c609719bSwdenk
1547c609719bSwdenk		Define this variable to enable the "hush" shell (from
1548c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1549c609719bSwdenk		powerful command line syntax like
1550c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1551c609719bSwdenk		constructs ("shell scripts").
1552c609719bSwdenk
1553c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1554c609719bSwdenk		with a somewhat smaller memory footprint.
1555c609719bSwdenk
1556c609719bSwdenk
1557c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1558c609719bSwdenk
1559c609719bSwdenk		This defines the secondary prompt string, which is
1560c609719bSwdenk		printed when the command interpreter needs more input
1561c609719bSwdenk		to complete a command. Usually "> ".
1562c609719bSwdenk
1563c609719bSwdenk	Note:
1564c609719bSwdenk
1565c609719bSwdenk		In the current implementation, the local variables
1566c609719bSwdenk		space and global environment variables space are
1567c609719bSwdenk		separated. Local variables are those you define by
15683b57fe0aSwdenk		simply typing `name=value'. To access a local
1569c609719bSwdenk		variable later on, you have write `$name' or
15703b57fe0aSwdenk		`${name}'; to execute the contents of a variable
15713b57fe0aSwdenk		directly type `$name' at the command prompt.
1572c609719bSwdenk
1573c609719bSwdenk		Global environment variables are those you use
1574c609719bSwdenk		setenv/printenv to work with. To run a command stored
1575c609719bSwdenk		in such a variable, you need to use the run command,
1576c609719bSwdenk		and you must not use the '$' sign to access them.
1577c609719bSwdenk
1578c609719bSwdenk		To store commands and special characters in a
1579c609719bSwdenk		variable, please use double quotation marks
1580c609719bSwdenk		surrounding the whole text of the variable, instead
1581c609719bSwdenk		of the backslashes before semicolons and special
1582c609719bSwdenk		symbols.
1583c609719bSwdenk
1584aa0c71acSWolfgang Denk- Commandline Editing and History:
1585aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1586aa0c71acSWolfgang Denk
1587aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1588aa0c71acSWolfgang Denk		commandline input operations
1589aa0c71acSWolfgang Denk
1590a8c7c708Swdenk- Default Environment:
1591c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1592c609719bSwdenk
1593c609719bSwdenk		Define this to contain any number of null terminated
1594c609719bSwdenk		strings (variable = value pairs) that will be part of
15957152b1d0Swdenk		the default environment compiled into the boot image.
15962262cfeeSwdenk
1597c609719bSwdenk		For example, place something like this in your
1598c609719bSwdenk		board's config file:
1599c609719bSwdenk
1600c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1601c609719bSwdenk			"myvar1=value1\0" \
1602c609719bSwdenk			"myvar2=value2\0"
1603c609719bSwdenk
1604c609719bSwdenk		Warning: This method is based on knowledge about the
1605c609719bSwdenk		internal format how the environment is stored by the
16062262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1607c609719bSwdenk		interface! Although it is unlikely that this format
16087152b1d0Swdenk		will change soon, there is no guarantee either.
1609c609719bSwdenk		You better know what you are doing here.
1610c609719bSwdenk
1611c609719bSwdenk		Note: overly (ab)use of the default environment is
1612c609719bSwdenk		discouraged. Make sure to check other ways to preset
1613c609719bSwdenk		the environment like the autoscript function or the
1614c609719bSwdenk		boot command first.
1615c609719bSwdenk
1616a8c7c708Swdenk- DataFlash Support:
16172abbe075Swdenk		CONFIG_HAS_DATAFLASH
16182abbe075Swdenk
16192abbe075Swdenk		Defining this option enables DataFlash features and
16202abbe075Swdenk		allows to read/write in Dataflash via the standard
16212abbe075Swdenk		commands cp, md...
16222abbe075Swdenk
16233f85ce27Swdenk- SystemACE Support:
16243f85ce27Swdenk		CONFIG_SYSTEMACE
16253f85ce27Swdenk
16263f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
16273f85ce27Swdenk		chips attached via some sort of local bus. The address
16283f85ce27Swdenk		of the chip must alsh be defined in the
16293f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
16303f85ce27Swdenk
16313f85ce27Swdenk		#define CONFIG_SYSTEMACE
16323f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
16333f85ce27Swdenk
16343f85ce27Swdenk		When SystemACE support is added, the "ace" device type
16353f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
16363f85ce27Swdenk
1637ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1638ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1639ecb0ccd9SWolfgang Denk
164028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1641ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
164228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1643ecb0ccd9SWolfgang Denk		number generator is used.
1644ecb0ccd9SWolfgang Denk
164528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
164628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
164728cb9375SWolfgang Denk		defined, the normal port 69 is used.
164828cb9375SWolfgang Denk
164928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1650ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1651ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1652ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1653ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1654ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1655ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1656ecb0ccd9SWolfgang Denk
1657a8c7c708Swdenk- Show boot progress:
1658c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1659c609719bSwdenk
1660c609719bSwdenk		Defining this option allows to add some board-
1661c609719bSwdenk		specific code (calling a user-provided function
1662c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1663c609719bSwdenk		the system's boot progress on some display (for
1664c609719bSwdenk		example, some LED's) on your board. At the moment,
1665c609719bSwdenk		the following checkpoints are implemented:
1666c609719bSwdenk
1667c609719bSwdenk  Arg	Where			When
1668c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1669c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1670c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1671c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1672c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1673c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1674c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1675c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1676c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1677c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1678c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1679c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1680c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1681c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1682c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1683c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1684c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1685c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1686c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1687c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1688c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1689c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1690c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1691c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1692c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1693c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1694c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1695c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1696c609719bSwdenk
169763e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
169863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
169963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
170063e73c9aSwdenk
1701c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1702c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1703c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1704c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1705c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1706c609719bSwdenk
1707c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1708c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1709c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1710c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1711c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1712c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1713c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1714c609719bSwdenk
1715206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1716206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1717206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1718206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1719206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1720206c60cbSwdenk
1721206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1722c609719bSwdenk
1723c609719bSwdenk
1724c609719bSwdenkModem Support:
1725c609719bSwdenk--------------
1726c609719bSwdenk
172785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1728c609719bSwdenk
1729c609719bSwdenk- Modem support endable:
1730c609719bSwdenk		CONFIG_MODEM_SUPPORT
1731c609719bSwdenk
1732c609719bSwdenk- RTS/CTS Flow control enable:
1733c609719bSwdenk		CONFIG_HWFLOW
1734c609719bSwdenk
1735c609719bSwdenk- Modem debug support:
1736c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1737c609719bSwdenk
1738c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1739c609719bSwdenk		for modem support. Useful only with BDI2000.
1740c609719bSwdenk
1741a8c7c708Swdenk- Interrupt support (PPC):
1742a8c7c708Swdenk
1743a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1744a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1745a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1746a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1747a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1748a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1749a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1750a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1751a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1752a8c7c708Swdenk		general timer_interrupt().
1753a8c7c708Swdenk
1754c609719bSwdenk- General:
1755c609719bSwdenk
1756c609719bSwdenk		In the target system modem support is enabled when a
1757c609719bSwdenk		specific key (key combination) is pressed during
1758c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1759c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1760c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1761c609719bSwdenk		function, returning 1 and thus enabling modem
1762c609719bSwdenk		initialization.
1763c609719bSwdenk
1764c609719bSwdenk		If there are no modem init strings in the
1765c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1766c609719bSwdenk		previous output (banner, info printfs) will be
1767c609719bSwdenk		supressed, though.
1768c609719bSwdenk
1769c609719bSwdenk		See also: doc/README.Modem
1770c609719bSwdenk
1771c609719bSwdenk
1772c609719bSwdenkConfiguration Settings:
1773c609719bSwdenk-----------------------
1774c609719bSwdenk
1775c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1776c609719bSwdenk		undefine this when you're short of memory.
1777c609719bSwdenk
1778c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1779c609719bSwdenk		prompt for user input.
1780c609719bSwdenk
1781c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1782c609719bSwdenk
1783c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1784c609719bSwdenk
1785c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1786c609719bSwdenk
1787c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1788c609719bSwdenk		the application (usually a Linux kernel) when it is
1789c609719bSwdenk		booted
1790c609719bSwdenk
1791c609719bSwdenk- CFG_BAUDRATE_TABLE:
1792c609719bSwdenk		List of legal baudrate settings for this board.
1793c609719bSwdenk
1794c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1795c609719bSwdenk		Suppress display of console information at boot.
1796c609719bSwdenk
1797c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1798c609719bSwdenk		If the board specific function
1799c609719bSwdenk			extern int overwrite_console (void);
1800c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1801c609719bSwdenk		serial port, else the settings in the environment are used.
1802c609719bSwdenk
1803c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1804c609719bSwdenk		Enable the call to overwrite_console().
1805c609719bSwdenk
1806c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1807c609719bSwdenk		Enable overwrite of previous console environment settings.
1808c609719bSwdenk
1809c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1810c609719bSwdenk		Begin and End addresses of the area used by the
1811c609719bSwdenk		simple memory test.
1812c609719bSwdenk
1813c609719bSwdenk- CFG_ALT_MEMTEST:
1814c609719bSwdenk		Enable an alternate, more extensive memory test.
1815c609719bSwdenk
18165f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
18175f535fe1Swdenk		Scratch address used by the alternate memory test
18185f535fe1Swdenk		You only need to set this if address zero isn't writeable
18195f535fe1Swdenk
1820c609719bSwdenk- CFG_TFTP_LOADADDR:
1821c609719bSwdenk		Default load address for network file downloads
1822c609719bSwdenk
1823c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1824c609719bSwdenk		Enable temporary baudrate change while serial download
1825c609719bSwdenk
1826c609719bSwdenk- CFG_SDRAM_BASE:
1827c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1828c609719bSwdenk
1829c609719bSwdenk- CFG_MBIO_BASE:
1830c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1831c609719bSwdenk		Cogent motherboard)
1832c609719bSwdenk
1833c609719bSwdenk- CFG_FLASH_BASE:
1834c609719bSwdenk		Physical start address of Flash memory.
1835c609719bSwdenk
1836c609719bSwdenk- CFG_MONITOR_BASE:
1837c609719bSwdenk		Physical start address of boot monitor code (set by
1838c609719bSwdenk		make config files to be same as the text base address
1839c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1840c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1841c609719bSwdenk
1842c609719bSwdenk- CFG_MONITOR_LEN:
18433b57fe0aSwdenk		Size of memory reserved for monitor code, used to
18443b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
18453b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
18463b57fe0aSwdenk		flash sector.
1847c609719bSwdenk
1848c609719bSwdenk- CFG_MALLOC_LEN:
1849c609719bSwdenk		Size of DRAM reserved for malloc() use.
1850c609719bSwdenk
185115940c9aSStefan Roese- CFG_BOOTM_LEN:
185215940c9aSStefan Roese		Normally compressed uImages are limited to an
185315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
185415940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
185515940c9aSStefan Roese		to adjust this setting to your needs.
1856c609719bSwdenk
1857c609719bSwdenk- CFG_BOOTMAPSZ:
1858c609719bSwdenk		Maximum size of memory mapped by the startup code of
1859c609719bSwdenk		the Linux kernel; all data that must be processed by
1860c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1861c609719bSwdenk		initrd image) must be put below this limit.
1862c609719bSwdenk
1863c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1864c609719bSwdenk		Max number of Flash memory banks
1865c609719bSwdenk
1866c609719bSwdenk- CFG_MAX_FLASH_SECT:
1867c609719bSwdenk		Max number of sectors on a Flash chip
1868c609719bSwdenk
1869c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1870c609719bSwdenk		Timeout for Flash erase operations (in ms)
1871c609719bSwdenk
1872c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1873c609719bSwdenk		Timeout for Flash write operations (in ms)
1874c609719bSwdenk
18758564acf9Swdenk- CFG_FLASH_LOCK_TOUT
18768564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
18778564acf9Swdenk
18788564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
18798564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
18808564acf9Swdenk
18818564acf9Swdenk- CFG_FLASH_PROTECTION
18828564acf9Swdenk		If defined, hardware flash sectors protection is used
18838564acf9Swdenk		instead of U-Boot software protection.
18848564acf9Swdenk
1885c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1886c609719bSwdenk
1887c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1888c609719bSwdenk		without this option such a download has to be
1889c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1890c609719bSwdenk		copy from RAM to flash.
1891c609719bSwdenk
1892c609719bSwdenk		The two-step approach is usually more reliable, since
1893c609719bSwdenk		you can check if the download worked before you erase
1894c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1895c609719bSwdenk		too limited to allow for a tempory copy of the
1896c609719bSwdenk		downloaded image) this option may be very useful.
1897c609719bSwdenk
1898c609719bSwdenk- CFG_FLASH_CFI:
1899c609719bSwdenk		Define if the flash driver uses extra elements in the
19005653fc33Swdenk		common flash structure for storing flash geometry.
19015653fc33Swdenk
19025653fc33Swdenk- CFG_FLASH_CFI_DRIVER
19035653fc33Swdenk		This option also enables the building of the cfi_flash driver
19045653fc33Swdenk		in the drivers directory
190553cf9435Sstroese
19065568e613SStefan Roese- CFG_FLASH_QUIET_TEST
19075568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
19085568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
19095568e613SStefan Roese		is useful, if some of the configured banks are only
19105568e613SStefan Roese		optionally available.
19115568e613SStefan Roese
191253cf9435Sstroese- CFG_RX_ETH_BUFFER:
191353cf9435Sstroese		Defines the number of ethernet receive buffers. On some
191453cf9435Sstroese		ethernet controllers it is recommended to set this value
191553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
191653cf9435Sstroese		buffers can be full shortly after enabling the interface
191753cf9435Sstroese		on high ethernet traffic.
191853cf9435Sstroese		Defaults to 4 if not defined.
1919c609719bSwdenk
1920c609719bSwdenkThe following definitions that deal with the placement and management
1921c609719bSwdenkof environment data (variable area); in general, we support the
1922c609719bSwdenkfollowing configurations:
1923c609719bSwdenk
1924c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1925c609719bSwdenk
1926c609719bSwdenk	Define this if the environment is in flash memory.
1927c609719bSwdenk
1928c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1929c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1930c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1931c609719bSwdenk	   sector" type flash chips, which have several smaller
1932c609719bSwdenk	   sectors at the start or the end. For instance, such a
1933c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1934c609719bSwdenk	   such a case you would place the environment in one of the
1935c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1936c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1937c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1938c609719bSwdenk	   between U-Boot and the environment.
1939c609719bSwdenk
1940c609719bSwdenk	- CFG_ENV_OFFSET:
1941c609719bSwdenk
1942c609719bSwdenk	   Offset of environment data (variable area) to the
1943c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1944c609719bSwdenk	   type flash chips the second sector can be used: the offset
1945c609719bSwdenk	   for this sector is given here.
1946c609719bSwdenk
1947c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1948c609719bSwdenk
1949c609719bSwdenk	- CFG_ENV_ADDR:
1950c609719bSwdenk
1951c609719bSwdenk	   This is just another way to specify the start address of
1952c609719bSwdenk	   the flash sector containing the environment (instead of
1953c609719bSwdenk	   CFG_ENV_OFFSET).
1954c609719bSwdenk
1955c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1956c609719bSwdenk
1957c609719bSwdenk	   Size of the sector containing the environment.
1958c609719bSwdenk
1959c609719bSwdenk
1960c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1961c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1962c609719bSwdenk	   the environment.
1963c609719bSwdenk
1964c609719bSwdenk	- CFG_ENV_SIZE:
1965c609719bSwdenk
1966c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1967c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1968c609719bSwdenk	   of this flash sector for the environment. This saves
1969c609719bSwdenk	   memory for the RAM copy of the environment.
1970c609719bSwdenk
1971c609719bSwdenk	   It may also save flash memory if you decide to use this
1972c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1973c609719bSwdenk	   since then the remainder of the flash sector could be used
1974c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1975c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1976c609719bSwdenk	   updating the environment in flash makes it always
1977c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1978c609719bSwdenk	   wrong before the contents has been restored from a copy in
1979c609719bSwdenk	   RAM, your target system will be dead.
1980c609719bSwdenk
1981c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1982c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1983c609719bSwdenk
1984c609719bSwdenk	   These settings describe a second storage area used to hold
1985c609719bSwdenk	   a redundand copy of the environment data, so that there is
19863e38691eSwdenk	   a valid backup copy in case there is a power failure during
1987c609719bSwdenk	   a "saveenv" operation.
1988c609719bSwdenk
1989c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1990c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1991c609719bSwdenkaccordingly!
1992c609719bSwdenk
1993c609719bSwdenk
1994c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1995c609719bSwdenk
1996c609719bSwdenk	Define this if you have some non-volatile memory device
1997c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1998c609719bSwdenk	environment.
1999c609719bSwdenk
2000c609719bSwdenk	- CFG_ENV_ADDR:
2001c609719bSwdenk	- CFG_ENV_SIZE:
2002c609719bSwdenk
2003c609719bSwdenk	  These two #defines are used to determin the memory area you
2004c609719bSwdenk	  want to use for environment. It is assumed that this memory
2005c609719bSwdenk	  can just be read and written to, without any special
2006c609719bSwdenk	  provision.
2007c609719bSwdenk
2008c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2009c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2010c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
2011c609719bSwdenkU-Boot will hang.
2012c609719bSwdenk
2013c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2014c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2015c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2016c609719bSwdenkto save the current settings.
2017c609719bSwdenk
2018c609719bSwdenk
2019c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
2020c609719bSwdenk
2021c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2022c609719bSwdenk	device and a driver for it.
2023c609719bSwdenk
2024c609719bSwdenk	- CFG_ENV_OFFSET:
2025c609719bSwdenk	- CFG_ENV_SIZE:
2026c609719bSwdenk
2027c609719bSwdenk	  These two #defines specify the offset and size of the
2028c609719bSwdenk	  environment area within the total memory of your EEPROM.
2029c609719bSwdenk
2030c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
2031c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2032c609719bSwdenk	  The default address is zero.
2033c609719bSwdenk
2034c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
2035c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2036c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2037c609719bSwdenk	  would require six bits.
2038c609719bSwdenk
2039c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2040c609719bSwdenk	  If defined, the number of milliseconds to delay between
2041c609719bSwdenk	  page writes.	The default is zero milliseconds.
2042c609719bSwdenk
2043c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
2044c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2045c609719bSwdenk	  that this is NOT the chip address length!
2046c609719bSwdenk
20475cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
20485cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
20495cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
20505cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
20515cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
20525cf91d6bSwdenk	  byte chips.
20535cf91d6bSwdenk
20545cf91d6bSwdenk	  Note that we consider the length of the address field to
20555cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
20565cf91d6bSwdenk	  in the chip address.
20575cf91d6bSwdenk
2058c609719bSwdenk	- CFG_EEPROM_SIZE:
2059c609719bSwdenk	  The size in bytes of the EEPROM device.
2060c609719bSwdenk
2061c609719bSwdenk
20625779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
20635779d8d9Swdenk
20645779d8d9Swdenk	Define this if you have a DataFlash memory device which you
20655779d8d9Swdenk	want to use for the environment.
20665779d8d9Swdenk
20675779d8d9Swdenk	- CFG_ENV_OFFSET:
20685779d8d9Swdenk	- CFG_ENV_ADDR:
20695779d8d9Swdenk	- CFG_ENV_SIZE:
20705779d8d9Swdenk
20715779d8d9Swdenk	  These three #defines specify the offset and size of the
20725779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
20735779d8d9Swdenk	  at the specified address.
20745779d8d9Swdenk
207513a5695bSwdenk- CFG_ENV_IS_IN_NAND:
207613a5695bSwdenk
207713a5695bSwdenk	Define this if you have a NAND device which you want to use
207813a5695bSwdenk	for the environment.
207913a5695bSwdenk
208013a5695bSwdenk	- CFG_ENV_OFFSET:
208113a5695bSwdenk	- CFG_ENV_SIZE:
208213a5695bSwdenk
208313a5695bSwdenk	  These two #defines specify the offset and size of the environment
208413a5695bSwdenk	  area within the first NAND device.
20855779d8d9Swdenk
2086e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2087e443c944SMarkus Klotzbuecher
2088e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2089e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2090e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2091e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2092e443c944SMarkus Klotzbuecher
2093e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2094e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2095e443c944SMarkus Klotzbuecher	the NAND devices block size.
2096e443c944SMarkus Klotzbuecher
2097c609719bSwdenk- CFG_SPI_INIT_OFFSET
2098c609719bSwdenk
2099c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2100c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2101c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2102c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2103c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2104c609719bSwdenk	to be a good choice since it makes it far enough from the
2105c609719bSwdenk	start of the data area as well as from the stack pointer.
2106c609719bSwdenk
2107c609719bSwdenkPlease note that the environment is read-only as long as the monitor
2108c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2109c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2110c609719bSwdenkuntil then to read environment variables.
2111c609719bSwdenk
211285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
211385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
211485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
211585ec0bccSwdenknecessary, because the first environment variable we need is the
211685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
211785ec0bccSwdenkhave any device yet where we could complain.]
2118c609719bSwdenk
2119c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2120c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
212185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2122c609719bSwdenk
2123fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2124fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2125fc3e2165Swdenk
2126fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2127fc3e2165Swdenk		      also needs to be defined.
2128fc3e2165Swdenk
2129fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2130fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2131c609719bSwdenk
2132c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2133c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2134c40b2956Swdenk		of 64bit values by using the L quantifier
2135c40b2956Swdenk
2136c40b2956Swdenk- CFG_64BIT_STRTOUL:
2137c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2138c40b2956Swdenk
2139c609719bSwdenkLow Level (hardware related) configuration options:
2140dc7c9a1aSwdenk---------------------------------------------------
2141c609719bSwdenk
2142c609719bSwdenk- CFG_CACHELINE_SIZE:
2143c609719bSwdenk		Cache Line Size of the CPU.
2144c609719bSwdenk
2145c609719bSwdenk- CFG_DEFAULT_IMMR:
2146c609719bSwdenk		Default address of the IMMR after system reset.
21472535d602Swdenk
21482535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
21492535d602Swdenk		and RPXsuper) to be able to adjust the position of
21502535d602Swdenk		the IMMR register after a reset.
2151c609719bSwdenk
21527f6c2cbcSwdenk- Floppy Disk Support:
21537f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
21547f6c2cbcSwdenk
21557f6c2cbcSwdenk		the default drive number (default value 0)
21567f6c2cbcSwdenk
21577f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
21587f6c2cbcSwdenk
21597f6c2cbcSwdenk		defines the spacing between fdc chipset registers
21607f6c2cbcSwdenk		(default value 1)
21617f6c2cbcSwdenk
21627f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
21637f6c2cbcSwdenk
21647f6c2cbcSwdenk		defines the offset of register from address. It
21657f6c2cbcSwdenk		depends on which part of the data bus is connected to
21667f6c2cbcSwdenk		the fdc chipset. (default value 0)
21677f6c2cbcSwdenk
21687f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
21697f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
21707f6c2cbcSwdenk		default value.
21717f6c2cbcSwdenk
21727f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
21737f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
21747f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
21757f6c2cbcSwdenk		source code. It is used to make hardware dependant
21767f6c2cbcSwdenk		initializations.
21777f6c2cbcSwdenk
217825d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
217925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
218025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2181c609719bSwdenk
2182c609719bSwdenk- CFG_INIT_RAM_ADDR:
2183c609719bSwdenk
21847152b1d0Swdenk		Start address of memory area that can be used for
2185c609719bSwdenk		initial data and stack; please note that this must be
2186c609719bSwdenk		writable memory that is working WITHOUT special
2187c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2188c609719bSwdenk		will become available only after programming the
2189c609719bSwdenk		memory controller and running certain initialization
2190c609719bSwdenk		sequences.
2191c609719bSwdenk
2192c609719bSwdenk		U-Boot uses the following memory types:
2193c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2194c609719bSwdenk		- MPC824X: data cache
2195c609719bSwdenk		- PPC4xx:  data cache
2196c609719bSwdenk
219785ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2198c609719bSwdenk
2199c609719bSwdenk		Offset of the initial data structure in the memory
2200c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
220185ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2202c609719bSwdenk		data is located at the end of the available space
2203c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2204c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2205c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
220685ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2207c609719bSwdenk
2208c609719bSwdenk	Note:
2209c609719bSwdenk		On the MPC824X (or other systems that use the data
2210c609719bSwdenk		cache for initial memory) the address chosen for
2211c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2212c609719bSwdenk		point to an otherwise UNUSED address space between
2213c609719bSwdenk		the top of RAM and the start of the PCI space.
2214c609719bSwdenk
2215c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2216c609719bSwdenk
2217c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2218c609719bSwdenk
2219c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2220c609719bSwdenk
2221c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2222c609719bSwdenk
2223c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2224c609719bSwdenk
2225c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2226c609719bSwdenk
2227c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2228c609719bSwdenk		SDRAM timing
2229c609719bSwdenk
2230c609719bSwdenk- CFG_MAMR_PTA:
2231c609719bSwdenk		periodic timer for refresh
2232c609719bSwdenk
2233c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2234c609719bSwdenk
2235c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2236c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2237c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2238c609719bSwdenk  CFG_BR1_PRELIM:
2239c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2240c609719bSwdenk
2241c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2242c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2243c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2244c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2245c609719bSwdenk
2246c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2247c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2248c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2249c609719bSwdenk		Prescaler definitions (SDRAM timing)
2250c609719bSwdenk
2251c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2252c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2253c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2254c609719bSwdenk
2255c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2256c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2257c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2258c609719bSwdenk
2259c609719bSwdenk- CFG_USE_OSCCLK:
2260c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2261c609719bSwdenk		wrong setting might damage your board. Read
2262c609719bSwdenk		doc/README.MBX before setting this variable!
2263c609719bSwdenk
2264ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2265ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2266ea909b76Swdenk		(Power On Self Tests). This definition overrides
2267ea909b76Swdenk		#define'd default value in commproc.h resp.
2268ea909b76Swdenk		cpm_8260.h.
2269ea909b76Swdenk
22705d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
22715d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
22725d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
22735d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
22745d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
22755d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
22765d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
22775d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
22785d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
22795d232d0eSwdenk
2280bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2281bb99ad6dSBen Warren		Get DDR timing information from an I2C EEPROM.  Common with pluggable
2282bb99ad6dSBen Warren		memory modules such as SODIMMs
2283bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2284bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2285bb99ad6dSBen Warren
2286bb99ad6dSBen Warren- CFG_SPD_BUS_NUM
2287bb99ad6dSBen Warren		If SPD EEPROM is on an I2C bus other than the first one, specify here.
2288bb99ad6dSBen Warren		Note that the value must resolve to something your driver can deal with.
2289bb99ad6dSBen Warren
22902ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
22912ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
22922ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
22932ad6b513STimur Tabi
22942ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
22952ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
22962ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
22972ad6b513STimur Tabi
2298c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2299c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2300c26e454dSwdenk
2301c26e454dSwdenk- CONFIG_FEC[12]_PHY
2302c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
23036e592385Swdenk		to the given FEC; i. e.
2304c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2305c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2306c26e454dSwdenk
2307c26e454dSwdenk		When set to -1, means to probe for first available.
2308c26e454dSwdenk
2309c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2310c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2311c26e454dSwdenk		(so program the FEC to ignore it).
2312c26e454dSwdenk
2313c26e454dSwdenk- CONFIG_RMII
2314c26e454dSwdenk		Enable RMII mode for all FECs.
2315c26e454dSwdenk		Note that this is a global option, we can't
2316c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2317c26e454dSwdenk
23185cf91d6bSwdenk- CONFIG_CRC32_VERIFY
23195cf91d6bSwdenk		Add a verify option to the crc32 command.
23205cf91d6bSwdenk		The syntax is:
23215cf91d6bSwdenk
23225cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
23235cf91d6bSwdenk
23245cf91d6bSwdenk		Where address/count indicate a memory area
23255cf91d6bSwdenk		and crc32 is the correct crc32 which the
23265cf91d6bSwdenk		area should have.
23275cf91d6bSwdenk
232856523f12Swdenk- CONFIG_LOOPW
232956523f12Swdenk		Add the "loopw" memory command. This only takes effect if
233056523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
233156523f12Swdenk
23327b466641Sstroese- CONFIG_MX_CYCLIC
23337b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
23347b466641Sstroese		"md/mw" commands.
23357b466641Sstroese		Examples:
23367b466641Sstroese
23377b466641Sstroese		=> mdc.b 10 4 500
23387b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
23397b466641Sstroese
23407b466641Sstroese		=> mwc.l 100 12345678 10
23417b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
23427b466641Sstroese
23437b466641Sstroese		This only takes effect if the memory commands are activated
23447b466641Sstroese		globally (CFG_CMD_MEM).
23457b466641Sstroese
23468aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
23478aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
23488aa1a2d1Swdenk
23498aa1a2d1Swdenk		[ARM only] If these variables are defined, then
23508aa1a2d1Swdenk		certain low level initializations (like setting up
23518aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
23528aa1a2d1Swdenk		not relocate itself into RAM.
23538aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
23548aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
23558aa1a2d1Swdenk		some other boot loader or by a debugger which
23568aa1a2d1Swdenk		performs these intializations itself.
23578aa1a2d1Swdenk
2358400558b5Swdenk
2359c609719bSwdenkBuilding the Software:
2360c609719bSwdenk======================
2361c609719bSwdenk
2362c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2363c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2364c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2365c609719bSwdenkNetBSD 1.5 on x86).
2366c609719bSwdenk
2367c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2368c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2369c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2370c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2371c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2372c609719bSwdenkchange it to:
2373c609719bSwdenk
2374c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2375c609719bSwdenk
2376c609719bSwdenk
2377c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2378c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2379c609719bSwdenkis done by typing:
2380c609719bSwdenk
2381c609719bSwdenk	make NAME_config
2382c609719bSwdenk
2383c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2384c609719bSwdenkconfigurations; the following names are supported:
2385c609719bSwdenk
23861eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
23871eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2388983fda83Swdenk	Alaska8220_config
23891eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
23901eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
23911eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
23921eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
23931eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2394e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2395e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2396e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2397e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2398e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2399466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2400466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
24018b07a110Swdenk	EBONY_config		MPC8260ADS_config	SM850_config
24028b07a110Swdenk	ELPT860_config		MPC8540ADS_config	SPD823TS_config
2403b0e32949SLunsheng Wang	ESTEEM192E_config	MPC8540EVAL_config	stxgp3_config
2404b0e32949SLunsheng Wang	ETX094_config		MPC8560ADS_config	SXNI855T_config
2405b0e32949SLunsheng Wang	FADS823_config		NETVIA_config		TQM823L_config
2406b0e32949SLunsheng Wang	FADS850SAR_config	omap1510inn_config	TQM850L_config
2407b0e32949SLunsheng Wang	FADS860T_config		omap1610h2_config	TQM855L_config
2408b0e32949SLunsheng Wang	FPS850L_config		omap1610inn_config	TQM860L_config
24094b1d95d9SJon Loeliger				omap5912osk_config	walnut_config
2410b0e32949SLunsheng Wang				omap2420h4_config	Yukon8220_config
24118b07a110Swdenk							ZPC1900_config
241254387ac9Swdenk
2413c609719bSwdenkNote: for some board special configuration names may exist; check if
2414c609719bSwdenk      additional information is available from the board vendor; for
24152729af9dSwdenk      instance, the TQM823L systems are available without (standard)
24162729af9dSwdenk      or with LCD support. You can select such additional "features"
2417c609719bSwdenk      when chosing the configuration, i. e.
2418c609719bSwdenk
24192729af9dSwdenk      make TQM823L_config
24202729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2421c609719bSwdenk
2422c609719bSwdenk      make TQM823L_LCD_config
2423c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2424c609719bSwdenk
2425c609719bSwdenk      etc.
2426c609719bSwdenk
2427c609719bSwdenk
2428c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
24297152b1d0Swdenkimages ready for download to / installation on your system:
2430c609719bSwdenk
2431c609719bSwdenk- "u-boot.bin" is a raw binary image
2432c609719bSwdenk- "u-boot" is an image in ELF binary format
2433c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2434c609719bSwdenk
2435baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2436baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2437baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2438baf31249SMarian Balakowicz
2439baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2440baf31249SMarian Balakowicz
2441baf31249SMarian Balakowicz	make O=/tmp/build distclean
2442baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2443baf31249SMarian Balakowicz	make O=/tmp/build all
2444baf31249SMarian Balakowicz
2445baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2446baf31249SMarian Balakowicz
2447baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2448baf31249SMarian Balakowicz	make distclean
2449baf31249SMarian Balakowicz	make NAME_config
2450baf31249SMarian Balakowicz	make all
2451baf31249SMarian Balakowicz
2452baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2453baf31249SMarian Balakowiczvariable.
2454baf31249SMarian Balakowicz
2455c609719bSwdenk
2456c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2457c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2458c609719bSwdenknative "make".
2459c609719bSwdenk
2460c609719bSwdenk
2461c609719bSwdenkIf the system board that you have is not listed, then you will need
2462c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2463c609719bSwdenksteps:
2464c609719bSwdenk
2465c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
246685ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
246785ec0bccSwdenk    entries as examples. Note that here and at many other places
24687152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
246985ec0bccSwdenk    keep this order.
2470c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
247185ec0bccSwdenk    files you need. In your board directory, you will need at least
247285ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
247385ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
247485ec0bccSwdenk    your board
2475c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2476c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
247785ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2478c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2479c609719bSwdenk    to be installed on your target system.
248085ec0bccSwdenk6.  Debug and solve any problems that might arise.
2481c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2482c609719bSwdenk
2483c609719bSwdenk
2484c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2485c609719bSwdenk==============================================================
2486c609719bSwdenk
2487c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2488c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2489c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2490c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2491c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2492c609719bSwdenk
2493c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2494c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2495c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2496c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2497c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
24987152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2499c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2500c609719bSwdenkMontaVista's Hard Hat Linux you can type
2501c609719bSwdenk
2502c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2503c609719bSwdenk
2504c609719bSwdenkor to build on a native PowerPC system you can type
2505c609719bSwdenk
2506c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2507c609719bSwdenk
2508baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2509baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2510baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2511baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2512baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2513baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2514baf31249SMarian Balakowicz
2515baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2516baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2517baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2518baf31249SMarian Balakowicz
2519baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2520baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2521baf31249SMarian Balakowiczthe whole build process.
2522baf31249SMarian Balakowicz
2523baf31249SMarian Balakowicz
2524c609719bSwdenkSee also "U-Boot Porting Guide" below.
2525c609719bSwdenk
2526c609719bSwdenk
2527c609719bSwdenkMonitor Commands - Overview:
2528c609719bSwdenk============================
2529c609719bSwdenk
2530c609719bSwdenkgo	- start application at address 'addr'
2531c609719bSwdenkrun	- run commands in an environment variable
2532c609719bSwdenkbootm	- boot application image from memory
2533c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2534c609719bSwdenktftpboot- boot image via network using TFTP protocol
2535c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2536c609719bSwdenk	       (and eventually "gatewayip")
2537c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2538c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2539c609719bSwdenkloads	- load S-Record file over serial line
2540c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2541c609719bSwdenkmd	- memory display
2542c609719bSwdenkmm	- memory modify (auto-incrementing)
2543c609719bSwdenknm	- memory modify (constant address)
2544c609719bSwdenkmw	- memory write (fill)
2545c609719bSwdenkcp	- memory copy
2546c609719bSwdenkcmp	- memory compare
2547c609719bSwdenkcrc32	- checksum calculation
2548c609719bSwdenkimd	- i2c memory display
2549c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2550c609719bSwdenkinm	- i2c memory modify (constant address)
2551c609719bSwdenkimw	- i2c memory write (fill)
2552c609719bSwdenkicrc32	- i2c checksum calculation
2553c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2554c609719bSwdenkiloop	- infinite loop on address range
2555c609719bSwdenkisdram	- print SDRAM configuration information
2556c609719bSwdenksspi	- SPI utility commands
2557c609719bSwdenkbase	- print or set address offset
2558c609719bSwdenkprintenv- print environment variables
2559c609719bSwdenksetenv	- set environment variables
2560c609719bSwdenksaveenv - save environment variables to persistent storage
2561c609719bSwdenkprotect - enable or disable FLASH write protection
2562c609719bSwdenkerase	- erase FLASH memory
2563c609719bSwdenkflinfo	- print FLASH memory information
2564c609719bSwdenkbdinfo	- print Board Info structure
2565c609719bSwdenkiminfo	- print header information for application image
2566c609719bSwdenkconinfo - print console devices and informations
2567c609719bSwdenkide	- IDE sub-system
2568c609719bSwdenkloop	- infinite loop on address range
256956523f12Swdenkloopw	- infinite write loop on address range
2570c609719bSwdenkmtest	- simple RAM test
2571c609719bSwdenkicache	- enable or disable instruction cache
2572c609719bSwdenkdcache	- enable or disable data cache
2573c609719bSwdenkreset	- Perform RESET of the CPU
2574c609719bSwdenkecho	- echo args to console
2575c609719bSwdenkversion - print monitor version
2576c609719bSwdenkhelp	- print online help
2577c609719bSwdenk?	- alias for 'help'
2578c609719bSwdenk
2579c609719bSwdenk
2580c609719bSwdenkMonitor Commands - Detailed Description:
2581c609719bSwdenk========================================
2582c609719bSwdenk
2583c609719bSwdenkTODO.
2584c609719bSwdenk
2585c609719bSwdenkFor now: just type "help <command>".
2586c609719bSwdenk
2587c609719bSwdenk
2588c609719bSwdenkEnvironment Variables:
2589c609719bSwdenk======================
2590c609719bSwdenk
2591c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2592c609719bSwdenkcan be made persistent by saving to Flash memory.
2593c609719bSwdenk
2594c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2595c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2596c609719bSwdenkwithout a value can be used to delete a variable from the
2597c609719bSwdenkenvironment. As long as you don't save the environment you are
2598c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2599c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2600c609719bSwdenk
2601c609719bSwdenkSome configuration options can be set using Environment Variables:
2602c609719bSwdenk
2603c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2604c609719bSwdenk
2605c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2606c609719bSwdenk
2607c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2608c609719bSwdenk
2609c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2610c609719bSwdenk
2611c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2612c609719bSwdenk
2613c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2614c609719bSwdenk		  "bootp" will just load perform a lookup of the
2615c609719bSwdenk		  configuration from the BOOTP server, but not try to
2616c609719bSwdenk		  load any image using TFTP
2617c609719bSwdenk
2618c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2619c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2620c609719bSwdenk		  be automatically started (by internally calling
2621c609719bSwdenk		  "bootm")
2622c609719bSwdenk
26234a6fd34bSwdenk		  If set to "no", a standalone image passed to the
26244a6fd34bSwdenk		  "bootm" command will be copied to the load address
26254a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
26264a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
26274a6fd34bSwdenk		  data.
26284a6fd34bSwdenk
262917ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
263017ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
263117ea1177Swdenk		  mode (400kHZ). This environment variable is used in
263217ea1177Swdenk		  initialization code. So, for changes to be effective
263317ea1177Swdenk		  it must be saved and board must be reset.
263417ea1177Swdenk
2635c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2636c609719bSwdenk		  If this variable is not set, initrd images will be
2637c609719bSwdenk		  copied to the highest possible address in RAM; this
2638c609719bSwdenk		  is usually what you want since it allows for
2639c609719bSwdenk		  maximum initrd size. If for some reason you want to
2640c609719bSwdenk		  make sure that the initrd image is loaded below the
2641c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2642c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2643c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2644c609719bSwdenk		  address to use (U-Boot will still check that it
2645c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2646c609719bSwdenk
2647c609719bSwdenk		  For instance, when you have a system with 16 MB
26487152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2649c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2650c609719bSwdenk		  the "bootargs" variable. However, now you must make
26517152b1d0Swdenk		  sure that the initrd image is placed in the first
2652c609719bSwdenk		  12 MB as well - this can be done with
2653c609719bSwdenk
2654c609719bSwdenk		  setenv initrd_high 00c00000
2655c609719bSwdenk
265638b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
265738b99261Swdenk		  indication to U-Boot that all addresses are legal
265838b99261Swdenk		  for the Linux kernel, including addresses in flash
265938b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
266038b99261Swdenk		  ramdisk at all. This may be useful to reduce the
266138b99261Swdenk		  boot time on your system, but requires that this
266238b99261Swdenk		  feature is supported by your Linux kernel.
266338b99261Swdenk
2664c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2665c609719bSwdenk
2666c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2667dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2668c609719bSwdenk
2669c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2670c609719bSwdenk
2671c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2672c609719bSwdenk
2673c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2674c609719bSwdenk
2675c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2676c609719bSwdenk
2677c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2678c609719bSwdenk
2679a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2680a3d991bdSwdenk		  interface is used first.
2681a3d991bdSwdenk
2682a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2683a3d991bdSwdenk		  interface is currently active. For example you
2684a3d991bdSwdenk		  can do the following
2685a3d991bdSwdenk
2686a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2687a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2688a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2689a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2690a3d991bdSwdenk
2691a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2692a3d991bdSwdenk		  either succeed or fail without retrying.
26936e592385Swdenk		  When set to "once" the network operation will
26946e592385Swdenk		  fail when all the available network interfaces
26956e592385Swdenk		  are tried once without success.
2696a3d991bdSwdenk		  Useful on scripts which control the retry operation
2697a3d991bdSwdenk		  themselves.
2698a3d991bdSwdenk
269928cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2700ecb0ccd9SWolfgang Denk		  UDP source port.
2701ecb0ccd9SWolfgang Denk
270228cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
270328cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
270428cb9375SWolfgang Denk
2705a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2706a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2707a3d991bdSwdenk		  VLAN tagged frames.
2708c609719bSwdenk
2709c609719bSwdenkThe following environment variables may be used and automatically
2710c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2711c609719bSwdenkdepending the information provided by your boot server:
2712c609719bSwdenk
2713c609719bSwdenk  bootfile	- see above
2714c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2715fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2716c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2717c609719bSwdenk  hostname	- Target hostname
2718c609719bSwdenk  ipaddr	- see above
2719c609719bSwdenk  netmask	- Subnet Mask
2720c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2721c609719bSwdenk  serverip	- see above
2722c609719bSwdenk
2723c609719bSwdenk
2724c609719bSwdenkThere are two special Environment Variables:
2725c609719bSwdenk
2726c609719bSwdenk  serial#	- contains hardware identification information such
2727c609719bSwdenk		  as type string and/or serial number
2728c609719bSwdenk  ethaddr	- Ethernet address
2729c609719bSwdenk
2730c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2731c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2732c609719bSwdenkonce they have been set once.
2733c609719bSwdenk
2734c609719bSwdenk
2735c1551ea8SstroeseFurther special Environment Variables:
2736c1551ea8Sstroese
2737c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2738c1551ea8Sstroese		  with the "version" command. This variable is
2739c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2740c1551ea8Sstroese
2741c1551ea8Sstroese
2742c609719bSwdenkPlease note that changes to some configuration parameters may take
2743c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2744c609719bSwdenk
2745c609719bSwdenk
2746f07771ccSwdenkCommand Line Parsing:
2747f07771ccSwdenk=====================
2748f07771ccSwdenk
2749f07771ccSwdenkThere are two different command line parsers available with U-Boot:
27507152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2751f07771ccSwdenk
2752f07771ccSwdenkOld, simple command line parser:
2753f07771ccSwdenk--------------------------------
2754f07771ccSwdenk
2755f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2756f07771ccSwdenk- several commands on one line, separated by ';'
2757fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2758f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2759f07771ccSwdenk  for example:
2760fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2761f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2762f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2763f07771ccSwdenk
2764f07771ccSwdenkHush shell:
2765f07771ccSwdenk-----------
2766f07771ccSwdenk
2767f07771ccSwdenk- similar to Bourne shell, with control structures like
2768f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2769f07771ccSwdenk  until...do...done, ...
2770f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2771f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2772f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2773f07771ccSwdenk  command
2774f07771ccSwdenk
2775f07771ccSwdenkGeneral rules:
2776f07771ccSwdenk--------------
2777f07771ccSwdenk
2778f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2779f07771ccSwdenk    command) contains several commands separated by semicolon, and
2780f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2781f07771ccSwdenk    executed anyway.
2782f07771ccSwdenk
2783f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2784f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2785f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2786f07771ccSwdenk    variables are not executed.
2787f07771ccSwdenk
2788c609719bSwdenkNote for Redundant Ethernet Interfaces:
2789c609719bSwdenk=======================================
2790c609719bSwdenk
27917152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2792c609719bSwdenksuch configurations and is capable of automatic selection of a
27937152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2794c609719bSwdenk
2795c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2796c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2797c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2798c609719bSwdenk
2799c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2800c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2801c609719bSwdenkding setting in the environment; if the corresponding environment
2802c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2803c609719bSwdenk
2804c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2805c609719bSwdenk  environment, the SROM's address is used.
2806c609719bSwdenk
2807c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2808c609719bSwdenk  environment exists, then the value from the environment variable is
2809c609719bSwdenk  used.
2810c609719bSwdenk
2811c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2812c609719bSwdenk  both addresses are the same, this MAC address is used.
2813c609719bSwdenk
2814c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2815c609719bSwdenk  addresses differ, the value from the environment is used and a
2816c609719bSwdenk  warning is printed.
2817c609719bSwdenk
2818c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2819c609719bSwdenk  is raised.
2820c609719bSwdenk
2821c609719bSwdenk
2822c609719bSwdenkImage Formats:
2823c609719bSwdenk==============
2824c609719bSwdenk
2825c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2826c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2827c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2828c609719bSwdenkdefines the following image properties:
2829c609719bSwdenk
2830c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2831c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
28327f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
28331f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
28347b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
28353d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
28367b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2837c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2838c609719bSwdenk* Load Address
2839c609719bSwdenk* Entry Point
2840c609719bSwdenk* Image Name
2841c609719bSwdenk* Image Timestamp
2842c609719bSwdenk
2843c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2844c609719bSwdenkand the data portions of the image are secured against corruption by
2845c609719bSwdenkCRC32 checksums.
2846c609719bSwdenk
2847c609719bSwdenk
2848c609719bSwdenkLinux Support:
2849c609719bSwdenk==============
2850c609719bSwdenk
2851c609719bSwdenkAlthough U-Boot should support any OS or standalone application
28527152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2853c609719bSwdenkU-Boot.
2854c609719bSwdenk
2855c609719bSwdenkU-Boot includes many features that so far have been part of some
2856c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2857c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2858c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
28597152b1d0Swdenkserves several purposes:
2860c609719bSwdenk
2861c609719bSwdenk- the same features can be used for other OS or standalone
2862c609719bSwdenk  applications (for instance: using compressed images to reduce the
2863c609719bSwdenk  Flash memory footprint)
2864c609719bSwdenk
2865c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
28667152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2867c609719bSwdenk
2868c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2869c609719bSwdenk  images; of course this also means that different kernel images can
2870c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2871c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2872c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2873c609719bSwdenk  software is easier now.
2874c609719bSwdenk
2875c609719bSwdenk
2876c609719bSwdenkLinux HOWTO:
2877c609719bSwdenk============
2878c609719bSwdenk
2879c609719bSwdenkPorting Linux to U-Boot based systems:
2880c609719bSwdenk---------------------------------------
2881c609719bSwdenk
2882c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2883c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2884c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2885c609719bSwdenkLinux :-).
2886c609719bSwdenk
2887c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2888c609719bSwdenk
2889c609719bSwdenkJust make sure your machine specific header file (for instance
2890c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2891c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2892c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2893c609719bSwdenkU-Boot configuration in CFG_IMMR.
2894c609719bSwdenk
2895c609719bSwdenk
2896c609719bSwdenkConfiguring the Linux kernel:
2897c609719bSwdenk-----------------------------
2898c609719bSwdenk
2899c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2900c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2901c609719bSwdenk
2902c609719bSwdenk
2903c609719bSwdenkBuilding a Linux Image:
2904c609719bSwdenk-----------------------
2905c609719bSwdenk
290624ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
290724ee89b9Swdenknot used. If you use recent kernel source, a new build target
290824ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
290924ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
291024ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
291124ee89b9Swdenk100% compatible format.
2912c609719bSwdenk
2913c609719bSwdenkExample:
2914c609719bSwdenk
2915c609719bSwdenk	make TQM850L_config
2916c609719bSwdenk	make oldconfig
2917c609719bSwdenk	make dep
291824ee89b9Swdenk	make uImage
2919c609719bSwdenk
292024ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
292124ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
292224ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2923c609719bSwdenk
292424ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
292524ee89b9Swdenk
292624ee89b9Swdenk* convert the kernel into a raw binary image:
292724ee89b9Swdenk
292824ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
292924ee89b9Swdenk				 -R .note -R .comment \
293024ee89b9Swdenk				 -S vmlinux linux.bin
293124ee89b9Swdenk
293224ee89b9Swdenk* compress the binary image:
293324ee89b9Swdenk
293424ee89b9Swdenk	gzip -9 linux.bin
293524ee89b9Swdenk
293624ee89b9Swdenk* package compressed binary image for U-Boot:
293724ee89b9Swdenk
293824ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
293924ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
294024ee89b9Swdenk		-d linux.bin.gz uImage
294124ee89b9Swdenk
294224ee89b9Swdenk
294324ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
294424ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
294524ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
294624ee89b9Swdenkbyte header containing information about target architecture,
294724ee89b9Swdenkoperating system, image type, compression method, entry points, time
294824ee89b9Swdenkstamp, CRC32 checksums, etc.
294924ee89b9Swdenk
295024ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
295124ee89b9Swdenkprint the header information, or to build new images.
2952c609719bSwdenk
2953c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2954c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2955c609719bSwdenkchecksum verification:
2956c609719bSwdenk
2957c609719bSwdenk	tools/mkimage -l image
2958c609719bSwdenk	  -l ==> list image header information
2959c609719bSwdenk
2960c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2961c609719bSwdenkfrom a "data file" which is used as image payload:
2962c609719bSwdenk
2963c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2964c609719bSwdenk		      -n name -d data_file image
2965c609719bSwdenk	  -A ==> set architecture to 'arch'
2966c609719bSwdenk	  -O ==> set operating system to 'os'
2967c609719bSwdenk	  -T ==> set image type to 'type'
2968c609719bSwdenk	  -C ==> set compression type 'comp'
2969c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2970c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2971c609719bSwdenk	  -n ==> set image name to 'name'
2972c609719bSwdenk	  -d ==> use image data from 'datafile'
2973c609719bSwdenk
297469459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
297569459791Swdenkaddress (0x00000000), but the entry point address depends on the
297669459791Swdenkkernel version:
2977c609719bSwdenk
2978c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
297924ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2980c609719bSwdenk
2981c609719bSwdenkSo a typical call to build a U-Boot image would read:
2982c609719bSwdenk
298324ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
298424ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
298524ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
298624ee89b9Swdenk	> examples/uImage.TQM850L
298724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2988c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2989c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2990c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2991c609719bSwdenk	Load Address: 0x00000000
299224ee89b9Swdenk	Entry Point:  0x00000000
2993c609719bSwdenk
2994c609719bSwdenkTo verify the contents of the image (or check for corruption):
2995c609719bSwdenk
299624ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
299724ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2998c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2999c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3000c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3001c609719bSwdenk	Load Address: 0x00000000
300224ee89b9Swdenk	Entry Point:  0x00000000
3003c609719bSwdenk
3004c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3005c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3006c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3007c609719bSwdenkneed to be uncompressed:
3008c609719bSwdenk
300924ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
301024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
301124ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
301224ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
301324ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
301424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3015c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3016c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3017c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3018c609719bSwdenk	Load Address: 0x00000000
301924ee89b9Swdenk	Entry Point:  0x00000000
3020c609719bSwdenk
3021c609719bSwdenk
3022c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3023c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3024c609719bSwdenk
3025c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3026c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3027c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3028c609719bSwdenk	Image Name:   Simple Ramdisk Image
3029c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3030c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3031c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3032c609719bSwdenk	Load Address: 0x00000000
3033c609719bSwdenk	Entry Point:  0x00000000
3034c609719bSwdenk
3035c609719bSwdenk
3036c609719bSwdenkInstalling a Linux Image:
3037c609719bSwdenk-------------------------
3038c609719bSwdenk
3039c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3040c609719bSwdenkyou must convert the image to S-Record format:
3041c609719bSwdenk
3042c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3043c609719bSwdenk
3044c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3045c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3046c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3047c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3048c609719bSwdenkcommand.
3049c609719bSwdenk
3050c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3051c609719bSwdenkTQM8xxL is in the first Flash bank):
3052c609719bSwdenk
3053c609719bSwdenk	=> erase 40100000 401FFFFF
3054c609719bSwdenk
3055c609719bSwdenk	.......... done
3056c609719bSwdenk	Erased 8 sectors
3057c609719bSwdenk
3058c609719bSwdenk	=> loads 40100000
3059c609719bSwdenk	## Ready for S-Record download ...
3060c609719bSwdenk	~>examples/image.srec
3061c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3062c609719bSwdenk	...
3063c609719bSwdenk	15989 15990 15991 15992
3064c609719bSwdenk	[file transfer complete]
3065c609719bSwdenk	[connected]
3066c609719bSwdenk	## Start Addr = 0x00000000
3067c609719bSwdenk
3068c609719bSwdenk
3069c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3070c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
3071c609719bSwdenkcorruption happened:
3072c609719bSwdenk
3073c609719bSwdenk	=> imi 40100000
3074c609719bSwdenk
3075c609719bSwdenk	## Checking Image at 40100000 ...
3076c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3077c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3078c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3079c609719bSwdenk	   Load Address: 00000000
3080c609719bSwdenk	   Entry Point:	 0000000c
3081c609719bSwdenk	   Verifying Checksum ... OK
3082c609719bSwdenk
3083c609719bSwdenk
3084c609719bSwdenkBoot Linux:
3085c609719bSwdenk-----------
3086c609719bSwdenk
3087c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3088c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3089c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3090c609719bSwdenkparameters. You can check and modify this variable using the
3091c609719bSwdenk"printenv" and "setenv" commands:
3092c609719bSwdenk
3093c609719bSwdenk
3094c609719bSwdenk	=> printenv bootargs
3095c609719bSwdenk	bootargs=root=/dev/ram
3096c609719bSwdenk
3097c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3098c609719bSwdenk
3099c609719bSwdenk	=> printenv bootargs
3100c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3101c609719bSwdenk
3102c609719bSwdenk	=> bootm 40020000
3103c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3104c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3105c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3106c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3107c609719bSwdenk	   Load Address: 00000000
3108c609719bSwdenk	   Entry Point:	 0000000c
3109c609719bSwdenk	   Verifying Checksum ... OK
3110c609719bSwdenk	   Uncompressing Kernel Image ... OK
3111c609719bSwdenk	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
3112c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3113c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3114c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3115c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3116c609719bSwdenk	...
3117c609719bSwdenk
3118c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
31197152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3120c609719bSwdenkformat!) to the "bootm" command:
3121c609719bSwdenk
3122c609719bSwdenk	=> imi 40100000 40200000
3123c609719bSwdenk
3124c609719bSwdenk	## Checking Image at 40100000 ...
3125c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3126c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3127c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3128c609719bSwdenk	   Load Address: 00000000
3129c609719bSwdenk	   Entry Point:	 0000000c
3130c609719bSwdenk	   Verifying Checksum ... OK
3131c609719bSwdenk
3132c609719bSwdenk	## Checking Image at 40200000 ...
3133c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3134c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3135c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3136c609719bSwdenk	   Load Address: 00000000
3137c609719bSwdenk	   Entry Point:	 00000000
3138c609719bSwdenk	   Verifying Checksum ... OK
3139c609719bSwdenk
3140c609719bSwdenk	=> bootm 40100000 40200000
3141c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3142c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3143c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3144c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3145c609719bSwdenk	   Load Address: 00000000
3146c609719bSwdenk	   Entry Point:	 0000000c
3147c609719bSwdenk	   Verifying Checksum ... OK
3148c609719bSwdenk	   Uncompressing Kernel Image ... OK
3149c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3150c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3151c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3152c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3153c609719bSwdenk	   Load Address: 00000000
3154c609719bSwdenk	   Entry Point:	 00000000
3155c609719bSwdenk	   Verifying Checksum ... OK
3156c609719bSwdenk	   Loading Ramdisk ... OK
3157c609719bSwdenk	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
3158c609719bSwdenk	Boot arguments: root=/dev/ram
3159c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3160c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3161c609719bSwdenk	...
3162c609719bSwdenk	RAMDISK: Compressed image found at block 0
3163c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3164c609719bSwdenk
3165c609719bSwdenk	bash#
3166c609719bSwdenk
31670267768eSMatthew McClintockBoot Linux and pass a flat device tree:
31680267768eSMatthew McClintock-----------
31690267768eSMatthew McClintock
31700267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
31710267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
31720267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
31730267768eSMatthew McClintockflat device tree:
31740267768eSMatthew McClintock
31750267768eSMatthew McClintock=> print oftaddr
31760267768eSMatthew McClintockoftaddr=0x300000
31770267768eSMatthew McClintock=> print oft
31780267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
31790267768eSMatthew McClintock=> tftp $oftaddr $oft
31800267768eSMatthew McClintockSpeed: 1000, full duplex
31810267768eSMatthew McClintockUsing TSEC0 device
31820267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
31830267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
31840267768eSMatthew McClintockLoad address: 0x300000
31850267768eSMatthew McClintockLoading: #
31860267768eSMatthew McClintockdone
31870267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
31880267768eSMatthew McClintock=> tftp $loadaddr $bootfile
31890267768eSMatthew McClintockSpeed: 1000, full duplex
31900267768eSMatthew McClintockUsing TSEC0 device
31910267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
31920267768eSMatthew McClintockFilename 'uImage'.
31930267768eSMatthew McClintockLoad address: 0x200000
31940267768eSMatthew McClintockLoading:############
31950267768eSMatthew McClintockdone
31960267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
31970267768eSMatthew McClintock=> print loadaddr
31980267768eSMatthew McClintockloadaddr=200000
31990267768eSMatthew McClintock=> print oftaddr
32000267768eSMatthew McClintockoftaddr=0x300000
32010267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
32020267768eSMatthew McClintock## Booting image at 00200000 ...
32030267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
32040267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
32050267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
32060267768eSMatthew McClintock   Load Address: 00000000
32070267768eSMatthew McClintock   Entry Point:	 00000000
32080267768eSMatthew McClintock   Verifying Checksum ... OK
32090267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
32100267768eSMatthew McClintockBooting using flat device tree at 0x300000
32110267768eSMatthew McClintockUsing MPC85xx ADS machine description
32120267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
32130267768eSMatthew McClintock[snip]
32140267768eSMatthew McClintock
32150267768eSMatthew McClintock
32166069ff26SwdenkMore About U-Boot Image Types:
32176069ff26Swdenk------------------------------
32186069ff26Swdenk
32196069ff26SwdenkU-Boot supports the following image types:
32206069ff26Swdenk
32216069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
32226069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
32236069ff26Swdenk	well) you can continue to work in U-Boot after return from
32246069ff26Swdenk	the Standalone Program.
32256069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
32266069ff26Swdenk	will take over control completely. Usually these programs
32276069ff26Swdenk	will install their own set of exception handlers, device
32286069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
32296069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
32306069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
32316069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
32326069ff26Swdenk	being started.
32336069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
32346069ff26Swdenk	(Linux) kernel image and one or more data images like
32356069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
32366069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
32376069ff26Swdenk	server provides just a single image file, but you want to get
32386069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
32396069ff26Swdenk
32406069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
32416069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
32426069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
32436069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
32446069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
32456069ff26Swdenk	a multiple of 4 bytes).
32466069ff26Swdenk
32476069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
32486069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
32496069ff26Swdenk	flash memory.
32506069ff26Swdenk
32516069ff26Swdenk   "Script files" are command sequences that will be executed by
32526069ff26Swdenk	U-Boot's command interpreter; this feature is especially
32536069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
32546069ff26Swdenk	as command interpreter.
32556069ff26Swdenk
3256c609719bSwdenk
3257c609719bSwdenkStandalone HOWTO:
3258c609719bSwdenk=================
3259c609719bSwdenk
3260c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3261c609719bSwdenkrun "standalone" applications, which can use some resources of
3262c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3263c609719bSwdenk
3264c609719bSwdenkTwo simple examples are included with the sources:
3265c609719bSwdenk
3266c609719bSwdenk"Hello World" Demo:
3267c609719bSwdenk-------------------
3268c609719bSwdenk
3269c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3270c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3271c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3272c609719bSwdenklike that:
3273c609719bSwdenk
3274c609719bSwdenk	=> loads
3275c609719bSwdenk	## Ready for S-Record download ...
3276c609719bSwdenk	~>examples/hello_world.srec
3277c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3278c609719bSwdenk	[file transfer complete]
3279c609719bSwdenk	[connected]
3280c609719bSwdenk	## Start Addr = 0x00040004
3281c609719bSwdenk
3282c609719bSwdenk	=> go 40004 Hello World! This is a test.
3283c609719bSwdenk	## Starting application at 0x00040004 ...
3284c609719bSwdenk	Hello World
3285c609719bSwdenk	argc = 7
3286c609719bSwdenk	argv[0] = "40004"
3287c609719bSwdenk	argv[1] = "Hello"
3288c609719bSwdenk	argv[2] = "World!"
3289c609719bSwdenk	argv[3] = "This"
3290c609719bSwdenk	argv[4] = "is"
3291c609719bSwdenk	argv[5] = "a"
3292c609719bSwdenk	argv[6] = "test."
3293c609719bSwdenk	argv[7] = "<NULL>"
3294c609719bSwdenk	Hit any key to exit ...
3295c609719bSwdenk
3296c609719bSwdenk	## Application terminated, rc = 0x0
3297c609719bSwdenk
3298c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3299c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3300c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3301c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3302c609719bSwdenkcharacter, but this is just a demo program. The application can be
3303c609719bSwdenkcontrolled by the following keys:
3304c609719bSwdenk
3305c609719bSwdenk	? - print current values og the CPM Timer registers
3306c609719bSwdenk	b - enable interrupts and start timer
3307c609719bSwdenk	e - stop timer and disable interrupts
3308c609719bSwdenk	q - quit application
3309c609719bSwdenk
3310c609719bSwdenk	=> loads
3311c609719bSwdenk	## Ready for S-Record download ...
3312c609719bSwdenk	~>examples/timer.srec
3313c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3314c609719bSwdenk	[file transfer complete]
3315c609719bSwdenk	[connected]
3316c609719bSwdenk	## Start Addr = 0x00040004
3317c609719bSwdenk
3318c609719bSwdenk	=> go 40004
3319c609719bSwdenk	## Starting application at 0x00040004 ...
3320c609719bSwdenk	TIMERS=0xfff00980
3321c609719bSwdenk	Using timer 1
3322c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3323c609719bSwdenk
3324c609719bSwdenkHit 'b':
3325c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3326c609719bSwdenk	Enabling timer
3327c609719bSwdenkHit '?':
3328c609719bSwdenk	[q, b, e, ?] ........
3329c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3330c609719bSwdenkHit '?':
3331c609719bSwdenk	[q, b, e, ?] .
3332c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3333c609719bSwdenkHit '?':
3334c609719bSwdenk	[q, b, e, ?] .
3335c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3336c609719bSwdenkHit '?':
3337c609719bSwdenk	[q, b, e, ?] .
3338c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3339c609719bSwdenkHit 'e':
3340c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3341c609719bSwdenkHit 'q':
3342c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3343c609719bSwdenk
3344c609719bSwdenk
334585ec0bccSwdenkMinicom warning:
334685ec0bccSwdenk================
334785ec0bccSwdenk
33487152b1d0SwdenkOver time, many people have reported problems when trying to use the
334985ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
335085ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3351f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
335285ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
335385ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
335485ec0bccSwdenk
335552f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
335652f52c14Swdenkconfiguration to your "File transfer protocols" section:
335752f52c14Swdenk
335852f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
335952f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
336052f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
336152f52c14Swdenk
336252f52c14Swdenk
3363c609719bSwdenkNetBSD Notes:
3364c609719bSwdenk=============
3365c609719bSwdenk
3366c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3367c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3368c609719bSwdenk
3369c609719bSwdenkBuilding requires a cross environment; it is known to work on
3370c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3371c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3372c609719bSwdenkNote that the cross-powerpc package does not install include files;
3373c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3374c609719bSwdenkmissing.  This file has to be installed and patched manually:
3375c609719bSwdenk
3376c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3377c609719bSwdenk	# mkdir powerpc
3378c609719bSwdenk	# ln -s powerpc machine
3379c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3380c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3381c609719bSwdenk
3382c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3383c609719bSwdenkand U-Boot include files.
3384c609719bSwdenk
3385c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3386c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3387c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3388c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
33892a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3390c609719bSwdenk
3391c609719bSwdenk
3392c609719bSwdenkImplementation Internals:
3393c609719bSwdenk=========================
3394c609719bSwdenk
3395c609719bSwdenkThe following is not intended to be a complete description of every
3396c609719bSwdenkimplementation detail. However, it should help to understand the
3397c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3398c609719bSwdenkhardware.
3399c609719bSwdenk
3400c609719bSwdenk
3401c609719bSwdenkInitial Stack, Global Data:
3402c609719bSwdenk---------------------------
3403c609719bSwdenk
3404c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3405c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3406c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3407c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3408c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3409c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3410c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3411c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3412c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3413c609719bSwdenklocked as (mis-) used as memory, etc.
3414c609719bSwdenk
34157152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
341643d9616cSwdenk	u-boot-users mailing list:
341743d9616cSwdenk
341843d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
341943d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
342043d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
342143d9616cSwdenk	...
342243d9616cSwdenk
342343d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
342443d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
342543d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
342643d9616cSwdenk	is that the cache is being used as a temporary supply of
342743d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
342843d9616cSwdenk	beyond the scope of this list to expain the details, but you
342943d9616cSwdenk	can see how this works by studying the cache architecture and
343043d9616cSwdenk	operation in the architecture and processor-specific manuals.
343143d9616cSwdenk
343243d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
343343d9616cSwdenk	is another option for the system designer to use as an
343443d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
343543d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
343643d9616cSwdenk	board designers haven't used it for something that would
343743d9616cSwdenk	cause you grief during the initial boot! It is frequently not
343843d9616cSwdenk	used.
343943d9616cSwdenk
344043d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
344143d9616cSwdenk	with your processor/board/system design. The default value
344243d9616cSwdenk	you will find in any recent u-boot distribution in
34438a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
344443d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
344543d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
344643d9616cSwdenk	that are supposed to respond to that address! That code in
344743d9616cSwdenk	start.S has been around a while and should work as is when
344843d9616cSwdenk	you get the config right.
344943d9616cSwdenk
345043d9616cSwdenk	-Chris Hallinan
345143d9616cSwdenk	DS4.COM, Inc.
345243d9616cSwdenk
3453c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3454c609719bSwdenkcode for the initialization procedures:
3455c609719bSwdenk
3456c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3457c609719bSwdenk  to write it.
3458c609719bSwdenk
3459c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3460c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
34617152b1d0Swdenk  zation is performed later (when relocating to RAM).
3462c609719bSwdenk
3463c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3464c609719bSwdenk  that.
3465c609719bSwdenk
3466c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3467c609719bSwdenknormal global data to share information beween the code. But it
3468c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3469c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3470c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3471c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3472c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3473c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3474c609719bSwdenkreserve for this purpose.
3475c609719bSwdenk
34767152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3477c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3478c609719bSwdenkGCC's implementation.
3479c609719bSwdenk
3480c609719bSwdenkFor PowerPC, the following registers have specific use:
3481c609719bSwdenk	R1:	stack pointer
3482c609719bSwdenk	R2:	TOC pointer
3483c609719bSwdenk	R3-R4:	parameter passing and return values
3484c609719bSwdenk	R5-R10: parameter passing
3485c609719bSwdenk	R13:	small data area pointer
3486c609719bSwdenk	R30:	GOT pointer
3487c609719bSwdenk	R31:	frame pointer
3488c609719bSwdenk
3489c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3490c609719bSwdenk
3491c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3492c609719bSwdenk
3493c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3494c609719bSwdenk    address of the global data structure is known at compile time),
3495c609719bSwdenk    but it turned out that reserving a register results in somewhat
3496c609719bSwdenk    smaller code - although the code savings are not that big (on
3497c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3498c609719bSwdenk    624 text + 127 data).
3499c609719bSwdenk
3500c609719bSwdenkOn ARM, the following registers are used:
3501c609719bSwdenk
3502c609719bSwdenk	R0:	function argument word/integer result
3503c609719bSwdenk	R1-R3:	function argument word
3504c609719bSwdenk	R9:	GOT pointer
3505c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3506c609719bSwdenk	R11:	argument (frame) pointer
3507c609719bSwdenk	R12:	temporary workspace
3508c609719bSwdenk	R13:	stack pointer
3509c609719bSwdenk	R14:	link register
3510c609719bSwdenk	R15:	program counter
3511c609719bSwdenk
3512c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3513c609719bSwdenk
3514d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3515d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3516c609719bSwdenk
3517c609719bSwdenkMemory Management:
3518c609719bSwdenk------------------
3519c609719bSwdenk
3520c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3521c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3522c609719bSwdenk
3523c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3524c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3525c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3526c609719bSwdenkphysical memory banks.
3527c609719bSwdenk
3528c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3529c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3530c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3531c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3532c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3533c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3534c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3535c609719bSwdenk
3536c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3537c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3538c609719bSwdenk
3539c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3540c609719bSwdenkthis:
3541c609719bSwdenk
3542c609719bSwdenk	0x0000 0000	Exception Vector code
3543c609719bSwdenk	      :
3544c609719bSwdenk	0x0000 1FFF
3545c609719bSwdenk	0x0000 2000	Free for Application Use
3546c609719bSwdenk	      :
3547c609719bSwdenk	      :
3548c609719bSwdenk
3549c609719bSwdenk	      :
3550c609719bSwdenk	      :
3551c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3552c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3553c609719bSwdenk	0x00FC 0000	Malloc Arena
3554c609719bSwdenk	      :
3555c609719bSwdenk	0x00FD FFFF
3556c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3557c609719bSwdenk	...		eventually: LCD or video framebuffer
3558c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3559c609719bSwdenk	0x00FF FFFF	[End of RAM]
3560c609719bSwdenk
3561c609719bSwdenk
3562c609719bSwdenkSystem Initialization:
3563c609719bSwdenk----------------------
3564c609719bSwdenk
3565c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3566c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3567c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
35687152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3569c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3570c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3571c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3572c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3573c609719bSwdenkthe caches and the SIU.
3574c609719bSwdenk
3575c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3576c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3577c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3578c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3579c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3580c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3581c609719bSwdenkbanks.
3582c609719bSwdenk
3583c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
35847152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3585c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3586c609719bSwdenk0x00000000, with any additional banks following immediately to create
3587c609719bSwdenkcontiguous memory starting from 0.
3588c609719bSwdenk
3589c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3590c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3591c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3592c609719bSwdenkpages, and the final stack is set up.
3593c609719bSwdenk
3594c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3595c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3596c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3597c609719bSwdenknew address in RAM.
3598c609719bSwdenk
3599c609719bSwdenk
3600c609719bSwdenkU-Boot Porting Guide:
3601c609719bSwdenk----------------------
3602c609719bSwdenk
3603c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
36046aff3115Swdenklist, October 2002]
3605c609719bSwdenk
3606c609719bSwdenk
3607c609719bSwdenkint main (int argc, char *argv[])
3608c609719bSwdenk{
3609c609719bSwdenk	sighandler_t no_more_time;
3610c609719bSwdenk
3611c609719bSwdenk	signal (SIGALRM, no_more_time);
3612c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3613c609719bSwdenk
3614c609719bSwdenk	if (available_money > available_manpower) {
3615c609719bSwdenk		pay consultant to port U-Boot;
3616c609719bSwdenk		return 0;
3617c609719bSwdenk	}
3618c609719bSwdenk
3619c609719bSwdenk	Download latest U-Boot source;
3620c609719bSwdenk
36216aff3115Swdenk	Subscribe to u-boot-users mailing list;
36226aff3115Swdenk
3623c609719bSwdenk	if (clueless) {
3624c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3625c609719bSwdenk	}
3626c609719bSwdenk
3627c609719bSwdenk	while (learning) {
3628c609719bSwdenk		Read the README file in the top level directory;
36297cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3630c609719bSwdenk		Read the source, Luke;
3631c609719bSwdenk	}
3632c609719bSwdenk
3633c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3634c609719bSwdenk		Buy a BDI2000;
3635c609719bSwdenk	} else {
3636c609719bSwdenk		Add a lot of aggravation and time;
3637c609719bSwdenk	}
3638c609719bSwdenk
3639c609719bSwdenk	Create your own board support subdirectory;
3640c609719bSwdenk
36416aff3115Swdenk	Create your own board config file;
36426aff3115Swdenk
3643c609719bSwdenk	while (!running) {
3644c609719bSwdenk		do {
3645c609719bSwdenk			Add / modify source code;
3646c609719bSwdenk		} until (compiles);
3647c609719bSwdenk		Debug;
3648c609719bSwdenk		if (clueless)
3649c609719bSwdenk			email ("Hi, I am having problems...");
3650c609719bSwdenk	}
3651c609719bSwdenk	Send patch file to Wolfgang;
3652c609719bSwdenk
3653c609719bSwdenk	return 0;
3654c609719bSwdenk}
3655c609719bSwdenk
3656c609719bSwdenkvoid no_more_time (int sig)
3657c609719bSwdenk{
3658c609719bSwdenk      hire_a_guru();
3659c609719bSwdenk}
3660c609719bSwdenk
3661c609719bSwdenk
3662c609719bSwdenkCoding Standards:
3663c609719bSwdenk-----------------
3664c609719bSwdenk
3665c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
36662c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
36672c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
36682c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
36692c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3670c609719bSwdenk
36712c051651SDetlev ZundelSource files originating from a different project (for example the
36722c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
36732c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
36742c051651SDetlev Zundelsources.
36752c051651SDetlev Zundel
36762c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
36772c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
36782c051651SDetlev Zundelin your code.
3679c609719bSwdenk
3680c178d3daSwdenkPlease also stick to the following formatting rules:
3681180d3f74Swdenk- remove any trailing white space
3682180d3f74Swdenk- use TAB characters for indentation, not spaces
3683180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3684180d3f74Swdenk- do not add more than 2 empty lines to source files
3685180d3f74Swdenk- do not add trailing empty lines to source files
3686180d3f74Swdenk
3687c609719bSwdenkSubmissions which do not conform to the standards may be returned
3688c609719bSwdenkwith a request to reformat the changes.
3689c609719bSwdenk
3690c609719bSwdenk
3691c609719bSwdenkSubmitting Patches:
3692c609719bSwdenk-------------------
3693c609719bSwdenk
3694c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3695c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3696c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3697c609719bSwdenk
369890dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3699c609719bSwdenk
3700c609719bSwdenkWhen you send a patch, please include the following information with
3701c609719bSwdenkit:
3702c609719bSwdenk
3703c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3704c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3705c609719bSwdenk  patch actually fixes something.
3706c609719bSwdenk
3707c609719bSwdenk* For new features: a description of the feature and your
3708c609719bSwdenk  implementation.
3709c609719bSwdenk
3710c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3711c609719bSwdenk
3712c609719bSwdenk* For major contributions, your entry to the CREDITS file
3713c609719bSwdenk
3714c609719bSwdenk* When you add support for a new board, don't forget to add this
3715c609719bSwdenk  board to the MAKEALL script, too.
3716c609719bSwdenk
3717c609719bSwdenk* If your patch adds new configuration options, don't forget to
3718c609719bSwdenk  document these in the README file.
3719c609719bSwdenk
3720c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3721c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3722c609719bSwdenk  version of diff does not support these options, then get the latest
3723c609719bSwdenk  version of GNU diff.
3724c609719bSwdenk
37256dff5529Swdenk  The current directory when running this command shall be the top
37266dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
37276dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
37286dff5529Swdenk  directory information for the affected files).
37296dff5529Swdenk
3730c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3731c609719bSwdenk  gzipped text.
3732c609719bSwdenk
373352f52c14Swdenk* If one logical set of modifications affects or creates several
373452f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
373552f52c14Swdenk
373652f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
373752f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
373852f52c14Swdenk
373952f52c14Swdenk
3740c609719bSwdenkNotes:
3741c609719bSwdenk
3742c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3743c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3744c609719bSwdenk  for any of the boards.
3745c609719bSwdenk
3746c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3747c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3748c609719bSwdenk  returned with a request to re-formatting / split it.
3749c609719bSwdenk
3750c609719bSwdenk* If you modify existing code, make sure that your new code does not
3751c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3752c609719bSwdenk  When adding new features, these should compile conditionally only
3753c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3754c609719bSwdenk  disabled must not need more memory than the old code without your
3755c609719bSwdenk  modification.
375690dc6704Swdenk
375790dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
375890dc6704Swdenk  u-boot-users mailing list. Compression may help.
3759