xref: /openbmc/u-boot/README (revision 7b64fef33c66be648826c0ff9758298ef13d0604)
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
13511dadd54Swdenk  - i386	Files specific to i386 CPUs
13611dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
137983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
13811dadd54Swdenk  - mips	Files specific to MIPS CPUs
139983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
140983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
141983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
142983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
143983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
144983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
145983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14611dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1475c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1480c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
14911dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15011dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15111dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
152c609719bSwdenk- disk		Code for disk drive partition handling
153c609719bSwdenk- doc		Documentation (don't expect too much)
1547152b1d0Swdenk- drivers	Commonly used device drivers
155c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
156c609719bSwdenk- examples	Example code for standalone applications, etc.
157c609719bSwdenk- include	Header Files
15811dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
159*7b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
16011dadd54Swdenk- lib_generic	Files generic to all	 architectures
16111dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16211dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16311dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16411dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16511dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
166c609719bSwdenk- net		Networking code
167c609719bSwdenk- post		Power On Self Test
168c609719bSwdenk- rtc		Real Time Clock drivers
169c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
170c609719bSwdenk
171c609719bSwdenkSoftware Configuration:
172c609719bSwdenk=======================
173c609719bSwdenk
174c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
175c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
176c609719bSwdenk
177c609719bSwdenkThere are two classes of configuration variables:
178c609719bSwdenk
179c609719bSwdenk* Configuration _OPTIONS_:
180c609719bSwdenk  These are selectable by the user and have names beginning with
181c609719bSwdenk  "CONFIG_".
182c609719bSwdenk
183c609719bSwdenk* Configuration _SETTINGS_:
184c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
185c609719bSwdenk  you don't know what you're doing; they have names beginning with
186c609719bSwdenk  "CFG_".
187c609719bSwdenk
188c609719bSwdenkLater we will add a configuration tool - probably similar to or even
189c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
190c609719bSwdenkdo the configuration by hand, which means creating some symbolic
191c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
192c609719bSwdenkas an example here.
193c609719bSwdenk
194c609719bSwdenk
195c609719bSwdenkSelection of Processor Architecture and Board Type:
196c609719bSwdenk---------------------------------------------------
197c609719bSwdenk
198c609719bSwdenkFor all supported boards there are ready-to-use default
199c609719bSwdenkconfigurations available; just type "make <board_name>_config".
200c609719bSwdenk
201c609719bSwdenkExample: For a TQM823L module type:
202c609719bSwdenk
203c609719bSwdenk	cd u-boot
204c609719bSwdenk	make TQM823L_config
205c609719bSwdenk
206c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
207c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
208c609719bSwdenkdirectory according to the instructions in cogent/README.
209c609719bSwdenk
210c609719bSwdenk
211c609719bSwdenkConfiguration Options:
212c609719bSwdenk----------------------
213c609719bSwdenk
214c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
215c609719bSwdenksuch information is kept in a configuration file
216c609719bSwdenk"include/configs/<board_name>.h".
217c609719bSwdenk
218c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
219c609719bSwdenk"include/configs/TQM823L.h".
220c609719bSwdenk
221c609719bSwdenk
2227f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2237f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2247f6c2cbcSwdenkbuild a config tool - later.
2257f6c2cbcSwdenk
2267f6c2cbcSwdenk
227c609719bSwdenkThe following options need to be configured:
228c609719bSwdenk
229c609719bSwdenk- CPU Type:	Define exactly one of
230c609719bSwdenk
231c609719bSwdenk		PowerPC based CPUs:
232c609719bSwdenk		-------------------
233c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2340db5bca8Swdenk	or	CONFIG_MPC5xx
235983fda83Swdenk	or	CONFIG_MPC8220
236c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23742d1f039Swdenk	or	CONFIG_MPC85xx
238c609719bSwdenk	or	CONFIG_IOP480
239c609719bSwdenk	or	CONFIG_405GP
24012f34241Swdenk	or	CONFIG_405EP
241c609719bSwdenk	or	CONFIG_440
242c609719bSwdenk	or	CONFIG_MPC74xx
24372755c71Swdenk	or	CONFIG_750FX
244c609719bSwdenk
245c609719bSwdenk		ARM based CPUs:
246c609719bSwdenk		---------------
247c609719bSwdenk		CONFIG_SA1110
248c609719bSwdenk		CONFIG_ARM7
249c609719bSwdenk		CONFIG_PXA250
2500b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
251c609719bSwdenk
252507bbe3eSwdenk		MicroBlaze based CPUs:
253507bbe3eSwdenk		----------------------
254857cad37Swdenk		CONFIG_MICROBLAZE
255507bbe3eSwdenk
2565c952cf0Swdenk		Nios-2 based CPUs:
2575c952cf0Swdenk		----------------------
2585c952cf0Swdenk		CONFIG_NIOS2
2595c952cf0Swdenk
260c609719bSwdenk
261c609719bSwdenk- Board Type:	Define exactly one of
262c609719bSwdenk
263c609719bSwdenk		PowerPC based boards:
264c609719bSwdenk		---------------------
265c609719bSwdenk
26676544f80SDetlev Zundel		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
26776544f80SDetlev Zundel		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
26876544f80SDetlev Zundel		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
26976544f80SDetlev Zundel		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
27076544f80SDetlev Zundel		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
27176544f80SDetlev Zundel		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
27276544f80SDetlev Zundel		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
27309e4b0c5SWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
27409e4b0c5SWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
27509e4b0c5SWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
27609e4b0c5SWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
27709e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
27809e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
27909e4b0c5SWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
28009e4b0c5SWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
28109e4b0c5SWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
28209e4b0c5SWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
28309e4b0c5SWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
28409e4b0c5SWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
28509e4b0c5SWolfgang Denk		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
28609e4b0c5SWolfgang Denk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
28709e4b0c5SWolfgang Denk		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
28809e4b0c5SWolfgang Denk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
28909e4b0c5SWolfgang Denk		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
29009e4b0c5SWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
29109e4b0c5SWolfgang Denk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
29209e4b0c5SWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
29309e4b0c5SWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
29409e4b0c5SWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
29509e4b0c5SWolfgang Denk		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
29609e4b0c5SWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
29709e4b0c5SWolfgang Denk		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
29809e4b0c5SWolfgang Denk		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
29909e4b0c5SWolfgang Denk		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
30009e4b0c5SWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
30109e4b0c5SWolfgang Denk		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
30209e4b0c5SWolfgang Denk		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
30309e4b0c5SWolfgang Denk		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
304c609719bSwdenk
305c609719bSwdenk		ARM based boards:
306c609719bSwdenk		-----------------
307c609719bSwdenk
308c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
3090b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
3100b953ffcSMarkus Klotzbuecher		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
3110b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
3120b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
3130b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
3145720df78SHeiko Schocher		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
3155720df78SHeiko Schocher		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
3165720df78SHeiko Schocher		CONFIG_VCMA9
317c609719bSwdenk
318507bbe3eSwdenk		MicroBlaze based boards:
319507bbe3eSwdenk		------------------------
320507bbe3eSwdenk
321507bbe3eSwdenk		CONFIG_SUZAKU
322507bbe3eSwdenk
3235c952cf0Swdenk		Nios-2 based boards:
3245c952cf0Swdenk		------------------------
3255c952cf0Swdenk
3265c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3279cc83378SScott McNutt		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
3285c952cf0Swdenk
329c609719bSwdenk
330c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
331c609719bSwdenk		Define exactly one of
332c609719bSwdenk		CONFIG_CMA286_60_OLD
333c609719bSwdenk--- FIXME --- not tested yet:
334c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
335c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
336c609719bSwdenk
337c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
338c609719bSwdenk		Define exactly one of
339c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
340c609719bSwdenk
341c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
342c609719bSwdenk		Define one or more of
343c609719bSwdenk		CONFIG_CMA302
344c609719bSwdenk
345c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
346c609719bSwdenk		Define one or more of
347c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
348c609719bSwdenk					  the lcd display every second with
349c609719bSwdenk					  a "rotator" |\-/|\-/
350c609719bSwdenk
3512535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3522535d602Swdenk		CONFIG_ADSTYPE
3532535d602Swdenk		Possible values are:
3542535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
355180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
35654387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
35704a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3582535d602Swdenk
359c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
360c609719bSwdenk		Define exactly one of
361c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
362c609719bSwdenk
36375d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
36466ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
36566ca92a5Swdenk					  get_gclk_freq() cannot work
3665da627a4Swdenk					  e.g. if there is no 32KHz
3675da627a4Swdenk					  reference PIT/RTC clock
36866ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
36966ca92a5Swdenk					  or XTAL/EXTAL)
370c609719bSwdenk
37166ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
37266ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
37366ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
37466ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
37575d1ea7fSwdenk			See doc/README.MPC866
37675d1ea7fSwdenk
37775d1ea7fSwdenk		CFG_MEASURE_CPUCLK
37875d1ea7fSwdenk
37975d1ea7fSwdenk		Define this to measure the actual CPU clock instead
38075d1ea7fSwdenk		of relying on the correctness of the configured
38175d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
38275d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
38375d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
38466ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
38575d1ea7fSwdenk
3860b953ffcSMarkus Klotzbuecher- Intel Monahans options:
3870b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
3880b953ffcSMarkus Klotzbuecher
3890b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
3900b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
3910b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
3920b953ffcSMarkus Klotzbuecher
3930b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
3940b953ffcSMarkus Klotzbuecher
3950b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
3960b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
3970b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
3980b953ffcSMarkus Klotzbuecher		by this value.
3990b953ffcSMarkus Klotzbuecher
4005da627a4Swdenk- Linux Kernel Interface:
401c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
402c609719bSwdenk
403c609719bSwdenk		U-Boot stores all clock information in Hz
404c609719bSwdenk		internally. For binary compatibility with older Linux
405c609719bSwdenk		kernels (which expect the clocks passed in the
406c609719bSwdenk		bd_info data to be in MHz) the environment variable
407c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
408c609719bSwdenk		converts clock data to MHZ before passing it to the
409c609719bSwdenk		Linux kernel.
410c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
411c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
412c609719bSwdenk		default environment.
413c609719bSwdenk
4145da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4155da627a4Swdenk
4165da627a4Swdenk		When transfering memsize parameter to linux, some versions
4175da627a4Swdenk		expect it to be in bytes, others in MB.
4185da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4195da627a4Swdenk
420f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE
421f57f70aaSWolfgang Denk
422f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
423f57f70aaSWolfgang Denk		passed using flat open firmware trees.
424f57f70aaSWolfgang Denk		The environment variable "disable_of", when set, disables this
425f57f70aaSWolfgang Denk		functionality.
426f57f70aaSWolfgang Denk
427f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
428f57f70aaSWolfgang Denk
429f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
430f57f70aaSWolfgang Denk
431f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
432c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
433f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
434c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
435f57f70aaSWolfgang Denk
436e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
437e4f880edSKumar Gala
438e4f880edSKumar Gala		The resulting flat device tree will have a copy of the bd_t.
439e4f880edSKumar Gala		Space should be pre-allocated in the dts for the bd_t.
440e4f880edSKumar Gala
441e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
442e4f880edSKumar Gala
443e4f880edSKumar Gala		The resulting flat device tree will have a copy of u-boot's
444e4f880edSKumar Gala		environment variables
445e4f880edSKumar Gala
4464e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4474e253137SKumar Gala
4484e253137SKumar Gala		Board code has addition modification that it wants to make
4494e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4506705d81eSwdenk
4516705d81eSwdenk- Serial Ports:
4526705d81eSwdenk		CFG_PL010_SERIAL
4536705d81eSwdenk
4546705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4556705d81eSwdenk
4566705d81eSwdenk		CFG_PL011_SERIAL
4576705d81eSwdenk
458c609719bSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
459c609719bSwdenk
460c609719bSwdenk		CONFIG_PL011_CLOCK
461c609719bSwdenk
462c609719bSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
463c609719bSwdenk		the clock speed of the UARTs.
464c609719bSwdenk
465c609719bSwdenk		CONFIG_PL01x_PORTS
466c609719bSwdenk
467c609719bSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
468c609719bSwdenk		define this to a list of base addresses for each (supported)
469c609719bSwdenk		port. See e.g. include/configs/versatile.h
470c609719bSwdenk
471c609719bSwdenk
472c609719bSwdenk- Console Interface:
473c609719bSwdenk		Depending on board, define exactly one serial port
474c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
475c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
476c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
477c609719bSwdenk
478c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
479c609719bSwdenk		port routines must be defined elsewhere
480c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
481c609719bSwdenk
482c609719bSwdenk		CONFIG_CFB_CONSOLE
483c609719bSwdenk		Enables console device for a color framebuffer. Needs following
484c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
485c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
486c609719bSwdenk						(default big endian)
487c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
488c609719bSwdenk						rectangle fill
489c609719bSwdenk						(cf. smiLynxEM)
490c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
491c609719bSwdenk						bit-blit (cf. smiLynxEM)
492c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
493c609719bSwdenk						(cols=pitch)
494c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
495c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
496c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
497c609719bSwdenk						(0-5, cf. cfb_console.c)
498c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
499c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
500a6c7ad2fSwdenk						(i.e. i8042_kbd_init())
501a6c7ad2fSwdenk			VIDEO_TSTC_FCT		test char fct
502a6c7ad2fSwdenk						(i.e. i8042_tstc)
503c609719bSwdenk			VIDEO_GETC_FCT		get char fct
504c609719bSwdenk						(i.e. i8042_getc)
505c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
506c609719bSwdenk						(requires blink timer
507c609719bSwdenk						cf. i8042.c)
508c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
509c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
510c609719bSwdenk						upper right corner
511a3ad8e26Swdenk						(requires CFG_CMD_DATE)
512a3ad8e26Swdenk			CONFIG_VIDEO_LOGO	display Linux logo in
513a3ad8e26Swdenk						upper left corner
514a3ad8e26Swdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
515a3ad8e26Swdenk						linux_logo.h for logo.
516c609719bSwdenk						Requires CONFIG_VIDEO_LOGO
517c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
518c609719bSwdenk						addional board info beside
519c609719bSwdenk						the logo
5203bbc899fSwdenk
521c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
522c609719bSwdenk		default i/o. Serial console can be forced with
523c609719bSwdenk		environment 'console=serial'.
524c609719bSwdenk
525c609719bSwdenk		When CONFIG_SILENT_CONSOLE is defined, all console
526c609719bSwdenk		messages (by U-Boot and Linux!) can be silenced with
527c609719bSwdenk		the "silent" environment variable. See
528c609719bSwdenk		doc/README.silent for more information.
529c609719bSwdenk
530c609719bSwdenk- Console Baudrate:
531109c0e3aSwdenk		CONFIG_BAUDRATE - in bps
532109c0e3aSwdenk		Select one of the baudrates listed in
533c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5341d49b1f3Sstroese		CFG_BRGCLK_PRESCALE, baudrate prescale
5351d49b1f3Sstroese
5361d49b1f3Sstroese- Interrupt driven serial port input:
5370c8721a4SWolfgang Denk		CONFIG_SERIAL_SOFTWARE_FIFO
5381d49b1f3Sstroese
5391d49b1f3Sstroese		PPC405GP only.
5401d49b1f3Sstroese		Use an interrupt handler for receiving data on the
541c609719bSwdenk		serial port. It also enables using hardware handshake
542c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
543c609719bSwdenk		bytes the interrupt driven input buffer should have.
544c609719bSwdenk
545c609719bSwdenk		Leave undefined to disable this feature, including
546c609719bSwdenk		disable the buffer and hardware handshake.
547c609719bSwdenk
548c609719bSwdenk- Console UART Number:
549c609719bSwdenk		CONFIG_UART1_CONSOLE
550c609719bSwdenk
551c609719bSwdenk		AMCC PPC4xx only.
552c609719bSwdenk		If defined internal UART1 (and not UART0) is used
553c609719bSwdenk		as default U-Boot console.
554c609719bSwdenk
555c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
556c609719bSwdenk		Delay before automatically booting the default image;
557c609719bSwdenk		set to -1 to disable autoboot.
558c609719bSwdenk
559c609719bSwdenk		See doc/README.autoboot for these options that
560c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
561c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
562c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
563c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
564c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
565c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
566c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
567c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
568c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
569c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
570c609719bSwdenk		CONFIG_RESET_TO_RETRY
571c609719bSwdenk
572c609719bSwdenk- Autoboot Command:
573c609719bSwdenk		CONFIG_BOOTCOMMAND
574c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
575c609719bSwdenk		define a command string that is automatically executed
576c609719bSwdenk		when no character is read on the console interface
577c609719bSwdenk		within "Boot Delay" after reset.
578c609719bSwdenk
579c609719bSwdenk		CONFIG_BOOTARGS
580c609719bSwdenk		This can be used to pass arguments to the bootm
581c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
582c609719bSwdenk		environment value "bootargs".
583c609719bSwdenk
584c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
585c609719bSwdenk		The value of these goes into the environment as
586c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
587c609719bSwdenk		as a convenience, when switching between booting from
588c609719bSwdenk		ram and nfs.
589c609719bSwdenk
590c609719bSwdenk- Pre-Boot Commands:
591c609719bSwdenk		CONFIG_PREBOOT
592c609719bSwdenk
593c609719bSwdenk		When this option is #defined, the existence of the
594c609719bSwdenk		environment variable "preboot" will be checked
595c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
596c609719bSwdenk		countdown and/or running the auto-boot command resp.
597c609719bSwdenk		entering interactive mode.
598c609719bSwdenk
599c609719bSwdenk		This feature is especially useful when "preboot" is
600c609719bSwdenk		automatically generated or modified. For an example
601c609719bSwdenk		see the LWMON board specific code: here "preboot" is
602c609719bSwdenk		modified when the user holds down a certain
603c609719bSwdenk		combination of keys on the (special) keyboard when
604c609719bSwdenk		booting the systems
605c609719bSwdenk
606c609719bSwdenk- Serial Download Echo Mode:
607c609719bSwdenk		CONFIG_LOADS_ECHO
608c609719bSwdenk		If defined to 1, all characters received during a
609c609719bSwdenk		serial download (using the "loads" command) are
610c609719bSwdenk		echoed back. This might be needed by some terminal
611c609719bSwdenk		emulations (like "cu"), but may as well just take
612c609719bSwdenk		time on others. This setting #define's the initial
613c609719bSwdenk		value of the "loads_echo" environment variable.
614c609719bSwdenk
615c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
616c609719bSwdenk		CONFIG_KGDB_BAUDRATE
61778137c3cSwdenk		Select one of the baudrates listed in
618c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
6196705d81eSwdenk
62078137c3cSwdenk- Monitor Functions:
6216705d81eSwdenk		CONFIG_COMMANDS
622c609719bSwdenk		Most monitor functions can be selected (or
6236705d81eSwdenk		de-selected) by adjusting the definition of
624c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
625c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
6266705d81eSwdenk		following values:
62778137c3cSwdenk
62878137c3cSwdenk		#define enables commands:
6296705d81eSwdenk		-------------------------
630c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
631c609719bSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
6326705d81eSwdenk		CFG_CMD_BDI	  bdinfo
633c609719bSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
634c609719bSwdenk		CFG_CMD_BMP	* BMP support
6356705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
6362262cfeeSwdenk		CFG_CMD_BOOTD	  bootd
637c609719bSwdenk		CFG_CMD_CACHE	* icache, dcache
638c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
63978137c3cSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
640c609719bSwdenk		CFG_CMD_DHCP	* DHCP support
641c609719bSwdenk		CFG_CMD_DIAG	* Diagnostics
642c609719bSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
64378137c3cSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
644953c5b6fSWolfgang Denk		CFG_CMD_ECHO	  echo arguments
645c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
646c609719bSwdenk		CFG_CMD_ELF	* bootelf, bootvx
647c609719bSwdenk		CFG_CMD_ENV	  saveenv
648c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
649c609719bSwdenk		CFG_CMD_FAT	* FAT partition support
650c609719bSwdenk		CFG_CMD_FDOS	* Dos diskette Support
651c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
652c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
653c609719bSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
654c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
655c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
656c609719bSwdenk		CFG_CMD_IMI	  iminfo
657c609719bSwdenk		CFG_CMD_IMLS	  List all found images
658c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
659c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6606705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
66178137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
662c609719bSwdenk		CFG_CMD_KGDB	* kgdb
663c609719bSwdenk		CFG_CMD_LOADB	  loadb
664c609719bSwdenk		CFG_CMD_LOADS	  loads
665c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
66656523f12Swdenk				  loop, loopw, mtest
66778137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
6686705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
6696705d81eSwdenk		CFG_CMD_MII	* MII utility commands
67078137c3cSwdenk		CFG_CMD_NAND	* NAND support
671c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
672c609719bSwdenk		CFG_CMD_PCI	* pciinfo
673c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
67478137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
675ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
676c609719bSwdenk		CFG_CMD_REGINFO * Register dump
677c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
6786705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
679c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
68078137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
681b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
682c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
683c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
684c609719bSwdenk		CFG_CMD_USB	* USB support
68578137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
686c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
687a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
688c609719bSwdenk		-----------------------------------------------
689c609719bSwdenk		CFG_CMD_ALL	all
690c609719bSwdenk
69181050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
692c609719bSwdenk				this is includes all commands, except
693c609719bSwdenk				the ones marked with "*" in the list
694c609719bSwdenk				above.
695c609719bSwdenk
696c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
69781050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
698c609719bSwdenk		override the default settings in the respective
699c609719bSwdenk		include file.
700c609719bSwdenk
701c609719bSwdenk		EXAMPLE: If you want all functions except of network
702c609719bSwdenk		support you can write:
703c609719bSwdenk
704c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
705c609719bSwdenk
706c609719bSwdenk
707c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
708c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
709c609719bSwdenk		what you (and your U-Boot users) are doing. Data
710c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
711c609719bSwdenk		8260 (where accesses to the IMMR region must be
712c609719bSwdenk		uncached), and it cannot be disabled on all other
713c609719bSwdenk		systems where we (mis-) use the data cache to hold an
714c609719bSwdenk		initial stack and some data.
715c609719bSwdenk
716c609719bSwdenk
717c609719bSwdenk		XXX - this list needs to get updated!
718c609719bSwdenk
719c609719bSwdenk- Watchdog:
720c609719bSwdenk		CONFIG_WATCHDOG
721c609719bSwdenk		If this variable is defined, it enables watchdog
7227152b1d0Swdenk		support. There must be support in the platform specific
723c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
724c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
725c609719bSwdenk		register.
726c609719bSwdenk
727c1551ea8Sstroese- U-Boot Version:
728c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
729c1551ea8Sstroese		If this variable is defined, an environment variable
730c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
731c1551ea8Sstroese		version as printed by the "version" command.
732c1551ea8Sstroese		This variable is readonly.
733c1551ea8Sstroese
734c609719bSwdenk- Real-Time Clock:
735c609719bSwdenk
736c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
737c609719bSwdenk		has to be selected, too. Define exactly one of the
738c609719bSwdenk		following options:
739c609719bSwdenk
740c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
741c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
742c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7431cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
744c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7457f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7463bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7474c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
748c609719bSwdenk
749b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
750b37c7e5eSwdenk		must also be configured. See I2C Support, below.
751b37c7e5eSwdenk
752c609719bSwdenk- Timestamp Support:
753c609719bSwdenk
754c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
755c609719bSwdenk		(date and time) of an image is printed by image
756c609719bSwdenk		commands like bootm or iminfo. This option is
757c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
758c609719bSwdenk
759c609719bSwdenk- Partition Support:
760c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
761c609719bSwdenk		and/or CONFIG_ISO_PARTITION
762c609719bSwdenk
763c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
764c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
765c609719bSwdenk		one partition type as well.
766c609719bSwdenk
767c609719bSwdenk- IDE Reset method:
7684d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7694d13cbadSwdenk		board configurations files but used nowhere!
770c609719bSwdenk
7714d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7724d13cbadSwdenk		be performed by calling the function
7734d13cbadSwdenk			ide_set_reset(int reset)
7744d13cbadSwdenk		which has to be defined in a board specific file
775c609719bSwdenk
776c609719bSwdenk- ATAPI Support:
777c609719bSwdenk		CONFIG_ATAPI
778c609719bSwdenk
779c609719bSwdenk		Set this to enable ATAPI support.
780c609719bSwdenk
781c40b2956Swdenk- LBA48 Support
782c40b2956Swdenk		CONFIG_LBA48
783c40b2956Swdenk
784c40b2956Swdenk		Set this to enable support for disks larger than 137GB
785c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
786c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
787c40b2956Swdenk		support disks up to 2.1TB.
788c40b2956Swdenk
789c40b2956Swdenk		CFG_64BIT_LBA:
790c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
791c40b2956Swdenk			Default is 32bit.
792c40b2956Swdenk
793c609719bSwdenk- SCSI Support:
794c609719bSwdenk		At the moment only there is only support for the
795c609719bSwdenk		SYM53C8XX SCSI controller; define
796c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
797c609719bSwdenk
798c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
799c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
800c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
801c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
802c609719bSwdenk		devices.
803c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
804c609719bSwdenk
805c609719bSwdenk- NETWORK Support (PCI):
806682011ffSwdenk		CONFIG_E1000
807682011ffSwdenk		Support for Intel 8254x gigabit chips.
808682011ffSwdenk
809c609719bSwdenk		CONFIG_EEPRO100
810c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
811c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
812c609719bSwdenk		write routine for first time initialisation.
813c609719bSwdenk
814c609719bSwdenk		CONFIG_TULIP
815c609719bSwdenk		Support for Digital 2114x chips.
816c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
817c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
818c609719bSwdenk
819c609719bSwdenk		CONFIG_NATSEMI
820c609719bSwdenk		Support for National dp83815 chips.
821c609719bSwdenk
822c609719bSwdenk		CONFIG_NS8382X
823c609719bSwdenk		Support for National dp8382[01] gigabit chips.
824c609719bSwdenk
82545219c46Swdenk- NETWORK Support (other):
82645219c46Swdenk
82745219c46Swdenk		CONFIG_DRIVER_LAN91C96
82845219c46Swdenk		Support for SMSC's LAN91C96 chips.
82945219c46Swdenk
83045219c46Swdenk			CONFIG_LAN91C96_BASE
83145219c46Swdenk			Define this to hold the physical address
83245219c46Swdenk			of the LAN91C96's I/O space
83345219c46Swdenk
83445219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
83545219c46Swdenk			Define this to enable 32 bit addressing
83645219c46Swdenk
837f39748aeSwdenk		CONFIG_DRIVER_SMC91111
838f39748aeSwdenk		Support for SMSC's LAN91C111 chip
839f39748aeSwdenk
840f39748aeSwdenk			CONFIG_SMC91111_BASE
841f39748aeSwdenk			Define this to hold the physical address
842f39748aeSwdenk			of the device (I/O space)
843f39748aeSwdenk
844f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
845f39748aeSwdenk			Define this if data bus is 32 bits
846f39748aeSwdenk
847f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
848f39748aeSwdenk			Define this to use i/o functions instead of macros
849f39748aeSwdenk			(some hardware wont work with macros)
850f39748aeSwdenk
851c609719bSwdenk- USB Support:
852c609719bSwdenk		At the moment only the UHCI host controller is
8534d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
854c609719bSwdenk		CONFIG_USB_UHCI to enable it.
855c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
85630d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
857c609719bSwdenk		storage devices.
858c609719bSwdenk		Note:
859c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
860c609719bSwdenk		(TEAC FD-05PUB).
8614d13cbadSwdenk		MPC5200 USB requires additional defines:
8624d13cbadSwdenk			CONFIG_USB_CLOCK
8634d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8644d13cbadSwdenk			CONFIG_USB_CONFIG
8654d13cbadSwdenk				for differential drivers: 0x00001000
8664d13cbadSwdenk				for single ended drivers: 0x00005000
8674d13cbadSwdenk
868c609719bSwdenk
86971f95118Swdenk- MMC Support:
87071f95118Swdenk		The MMC controller on the Intel PXA is supported. To
87171f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
87271f95118Swdenk		accessed from the boot prompt by mapping the device
87371f95118Swdenk		to physical memory similar to flash. Command line is
87471f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
87571f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
87671f95118Swdenk
8776705d81eSwdenk- Journaling Flash filesystem support:
8786705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8796705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8806705d81eSwdenk		Define these for a default partition on a NAND device
8816705d81eSwdenk
8826705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8836705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8846705d81eSwdenk		Define these for a default partition on a NOR device
8856705d81eSwdenk
8866705d81eSwdenk		CFG_JFFS_CUSTOM_PART
8876705d81eSwdenk		Define this to create an own partition. You have to provide a
8886705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
8896705d81eSwdenk
8906705d81eSwdenk		If you define only one JFFS2 partition you may also want to
8916705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
8926705d81eSwdenk		to disable the command chpart. This is the default when you
8936705d81eSwdenk		have not defined a custom partition
8946705d81eSwdenk
895c609719bSwdenk- Keyboard Support:
896c609719bSwdenk		CONFIG_ISA_KEYBOARD
897c609719bSwdenk
898c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
899c609719bSwdenk		support
900c609719bSwdenk
901c609719bSwdenk		CONFIG_I8042_KBD
902c609719bSwdenk		Standard PC keyboard driver with US (is default) and
903c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
904c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
905c609719bSwdenk		for cfb_console. Supports cursor blinking.
906c609719bSwdenk
907c609719bSwdenk- Video support:
908c609719bSwdenk		CONFIG_VIDEO
909c609719bSwdenk
910c609719bSwdenk		Define this to enable video support (for output to
911c609719bSwdenk		video).
912c609719bSwdenk
913c609719bSwdenk		CONFIG_VIDEO_CT69000
914c609719bSwdenk
915c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
916c609719bSwdenk
917c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
918eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
919eeb1b77bSwdenk		video output is selected via environment 'videoout'
920eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
921eeb1b77bSwdenk		assumed.
922c609719bSwdenk
923eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
924eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
925eeb1b77bSwdenk		are possible:
926eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
927eeb1b77bSwdenk		Following standard modes are supported	(* is default):
928eeb1b77bSwdenk
929eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
930eeb1b77bSwdenk		-------------+---------------------------------------------
931eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
932eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
933eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
934eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
935eeb1b77bSwdenk		-------------+---------------------------------------------
936c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
937c609719bSwdenk
938eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
939eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
940eeb1b77bSwdenk
941eeb1b77bSwdenk
942a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
943a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
944a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
945a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
946a6c7ad2fSwdenk
947682011ffSwdenk- Keyboard Support:
948682011ffSwdenk		CONFIG_KEYBOARD
949682011ffSwdenk
950682011ffSwdenk		Define this to enable a custom keyboard support.
951682011ffSwdenk		This simply calls drv_keyboard_init() which must be
952682011ffSwdenk		defined in your board-specific files.
953682011ffSwdenk		The only board using this so far is RBC823.
954a6c7ad2fSwdenk
955c609719bSwdenk- LCD Support:	CONFIG_LCD
956c609719bSwdenk
957c609719bSwdenk		Define this to enable LCD support (for output to LCD
958c609719bSwdenk		display); also select one of the supported displays
959c609719bSwdenk		by defining one of these:
960c609719bSwdenk
961fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
962c609719bSwdenk
963fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
964c609719bSwdenk
965fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
966c609719bSwdenk
967fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
968fd3103bbSwdenk			Active, color, single scan.
969fd3103bbSwdenk
970fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
971fd3103bbSwdenk
972fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
973c609719bSwdenk			Active, color, single scan.
974c609719bSwdenk
975c609719bSwdenk		CONFIG_SHARP_16x9
976c609719bSwdenk
977c609719bSwdenk			Sharp 320x240. Active, color, single scan.
978c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
979c609719bSwdenk
980c609719bSwdenk		CONFIG_SHARP_LQ64D341
981c609719bSwdenk
982c609719bSwdenk			Sharp LQ64D341 display, 640x480.
983c609719bSwdenk			Active, color, single scan.
984c609719bSwdenk
985c609719bSwdenk		CONFIG_HLD1045
986c609719bSwdenk
987c609719bSwdenk			HLD1045 display, 640x480.
988c609719bSwdenk			Active, color, single scan.
989c609719bSwdenk
990c609719bSwdenk		CONFIG_OPTREX_BW
991c609719bSwdenk
992c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
993c609719bSwdenk			or
994c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
995c609719bSwdenk			or
996c609719bSwdenk			Hitachi	 SP14Q002
997c609719bSwdenk
998c609719bSwdenk			320x240. Black & white.
999c609719bSwdenk
1000c609719bSwdenk		Normally display is black on white background; define
1001c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1002c609719bSwdenk
10037152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1004d791b1dcSwdenk
1005d791b1dcSwdenk		If this option is set, the environment is checked for
1006d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1007d791b1dcSwdenk		of logo, copyright and system information on the LCD
1008e94d2cd9Swdenk		is suppressed and the BMP image at the address
1009d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1010d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1011d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1012d791b1dcSwdenk		loaded very quickly after power-on.
1013d791b1dcSwdenk
101498f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
101598f4a3dfSStefan Roese
101698f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
101798f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
101898f4a3dfSStefan Roese		splashscreen support or the bmp command.
101998f4a3dfSStefan Roese
1020c29fdfc1Swdenk- Compression support:
1021c29fdfc1Swdenk		CONFIG_BZIP2
1022c29fdfc1Swdenk
1023c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1024c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1025c29fdfc1Swdenk		compressed images are supported.
1026c29fdfc1Swdenk
1027c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1028c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1029c29fdfc1Swdenk		be at least 4MB.
1030d791b1dcSwdenk
103117ea1177Swdenk- MII/PHY support:
103217ea1177Swdenk		CONFIG_PHY_ADDR
103317ea1177Swdenk
103417ea1177Swdenk		The address of PHY on MII bus.
103517ea1177Swdenk
103617ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
103717ea1177Swdenk
103817ea1177Swdenk		The clock frequency of the MII bus
103917ea1177Swdenk
104017ea1177Swdenk		CONFIG_PHY_GIGE
104117ea1177Swdenk
104217ea1177Swdenk		If this option is set, support for speed/duplex
104317ea1177Swdenk		detection of Gigabit PHY is included.
104417ea1177Swdenk
104517ea1177Swdenk		CONFIG_PHY_RESET_DELAY
104617ea1177Swdenk
104717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
104817ea1177Swdenk		reset before any MII register access is possible.
104917ea1177Swdenk		For such PHY, set this option to the usec delay
105017ea1177Swdenk		required. (minimum 300usec for LXT971A)
105117ea1177Swdenk
105217ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
105317ea1177Swdenk
105417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
105517ea1177Swdenk		command issued before MII status register can be read
105617ea1177Swdenk
1057c609719bSwdenk- Ethernet address:
1058c609719bSwdenk		CONFIG_ETHADDR
1059c609719bSwdenk		CONFIG_ETH2ADDR
1060c609719bSwdenk		CONFIG_ETH3ADDR
1061c609719bSwdenk
1062c609719bSwdenk		Define a default value for ethernet address to use
1063c609719bSwdenk		for the respective ethernet interface, in case this
1064c609719bSwdenk		is not determined automatically.
1065c609719bSwdenk
1066c609719bSwdenk- IP address:
1067c609719bSwdenk		CONFIG_IPADDR
1068c609719bSwdenk
1069c609719bSwdenk		Define a default value for the IP address to use for
1070c609719bSwdenk		the default ethernet interface, in case this is not
1071c609719bSwdenk		determined through e.g. bootp.
1072c609719bSwdenk
1073c609719bSwdenk- Server IP address:
1074c609719bSwdenk		CONFIG_SERVERIP
1075c609719bSwdenk
1076c609719bSwdenk		Defines a default value for theIP address of a TFTP
1077c609719bSwdenk		server to contact when using the "tftboot" command.
1078c609719bSwdenk
1079c609719bSwdenk- BOOTP Recovery Mode:
1080c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1081c609719bSwdenk
1082c609719bSwdenk		If you have many targets in a network that try to
1083c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1084c609719bSwdenk		systems send out BOOTP requests at precisely the same
1085c609719bSwdenk		moment (which would happen for instance at recovery
1086c609719bSwdenk		from a power failure, when all systems will try to
1087c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1088c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1089c609719bSwdenk		inserted before sending out BOOTP requests. The
1090c609719bSwdenk		following delays are insterted then:
1091c609719bSwdenk
1092c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1093c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1094c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1095c609719bSwdenk		4th and following
1096c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1097c609719bSwdenk
1098fe389a82Sstroese- DHCP Advanced Options:
1099fe389a82Sstroese		CONFIG_BOOTP_MASK
1100fe389a82Sstroese
1101fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1102fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1103fe389a82Sstroese
1104fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1105fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1106fe389a82Sstroese		than one DNS serverip is offered to the client.
1107fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1108fe389a82Sstroese		serverip will be stored in the additional environment
1109fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1110fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1111fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1112fe389a82Sstroese
1113fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1114fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1115fe389a82Sstroese		need the hostname of the DHCP requester.
1116fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1117fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1118fe389a82Sstroese		environment variable is passed as option 12 to
1119fe389a82Sstroese		the DHCP server.
1120fe389a82Sstroese
1121a3d991bdSwdenk - CDP Options:
1122a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1123a3d991bdSwdenk
1124a3d991bdSwdenk		The device id used in CDP trigger frames.
1125a3d991bdSwdenk
1126a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1127a3d991bdSwdenk
1128a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1129a3d991bdSwdenk		of the device.
1130a3d991bdSwdenk
1131a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1132a3d991bdSwdenk
1133a3d991bdSwdenk		A printf format string which contains the ascii name of
1134a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1135a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1136a3d991bdSwdenk
1137a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1138a3d991bdSwdenk
1139a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1140a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1141a3d991bdSwdenk
1142a3d991bdSwdenk		CONFIG_CDP_VERSION
1143a3d991bdSwdenk
1144a3d991bdSwdenk		An ascii string containing the version of the software.
1145a3d991bdSwdenk
1146a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1147a3d991bdSwdenk
1148a3d991bdSwdenk		An ascii string containing the name of the platform.
1149a3d991bdSwdenk
1150a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1151a3d991bdSwdenk
1152a3d991bdSwdenk		A 32bit integer sent on the trigger.
1153a3d991bdSwdenk
1154a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1155a3d991bdSwdenk
1156a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1157a3d991bdSwdenk		device in .1 of milliwatts.
1158a3d991bdSwdenk
1159a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1160a3d991bdSwdenk
1161a3d991bdSwdenk		A byte containing the id of the VLAN.
1162a3d991bdSwdenk
1163c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1164c609719bSwdenk
1165c609719bSwdenk		Several configurations allow to display the current
1166c609719bSwdenk		status using a LED. For instance, the LED will blink
1167c609719bSwdenk		fast while running U-Boot code, stop blinking as
1168c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1169c609719bSwdenk		start blinking slow once the Linux kernel is running
1170c609719bSwdenk		(supported by a status LED driver in the Linux
1171c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1172c609719bSwdenk		feature in U-Boot.
1173c609719bSwdenk
1174c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1175c609719bSwdenk
1176c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1177c609719bSwdenk		on those systems that support this (optional)
1178c609719bSwdenk		feature, like the TQM8xxL modules.
1179c609719bSwdenk
1180c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1181c609719bSwdenk
1182b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1183b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1184b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1185c609719bSwdenk
1186b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1187b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1188b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1189b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1190c609719bSwdenk		command line interface.
1191c609719bSwdenk
1192b37c7e5eSwdenk		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1193c609719bSwdenk
1194b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1195b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1196b37c7e5eSwdenk		support for I2C.
1197c609719bSwdenk
1198b37c7e5eSwdenk		There are several other quantities that must also be
1199b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1200c609719bSwdenk
1201b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1202b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1203b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1204b37c7e5eSwdenk		the cpu's i2c node address).
1205c609719bSwdenk
1206b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1207b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1208b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1209b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1210b37c7e5eSwdenk
1211b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1212b37c7e5eSwdenk
1213b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1214b37c7e5eSwdenk		then the following macros need to be defined (examples are
1215b37c7e5eSwdenk		from include/configs/lwmon.h):
1216c609719bSwdenk
1217c609719bSwdenk		I2C_INIT
1218c609719bSwdenk
1219b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1220c609719bSwdenk		controller or configure ports.
1221c609719bSwdenk
1222b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1223b37c7e5eSwdenk
1224c609719bSwdenk		I2C_PORT
1225c609719bSwdenk
1226c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1227c609719bSwdenk		assumes both bits are on the same port). Valid values
1228c609719bSwdenk		are 0..3 for ports A..D.
1229c609719bSwdenk
1230c609719bSwdenk		I2C_ACTIVE
1231c609719bSwdenk
1232c609719bSwdenk		The code necessary to make the I2C data line active
1233c609719bSwdenk		(driven).  If the data line is open collector, this
1234c609719bSwdenk		define can be null.
1235c609719bSwdenk
1236b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1237b37c7e5eSwdenk
1238c609719bSwdenk		I2C_TRISTATE
1239c609719bSwdenk
1240c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1241c609719bSwdenk		(inactive).  If the data line is open collector, this
1242c609719bSwdenk		define can be null.
1243c609719bSwdenk
1244b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1245b37c7e5eSwdenk
1246c609719bSwdenk		I2C_READ
1247c609719bSwdenk
1248c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1249c609719bSwdenk		FALSE if it is low.
1250c609719bSwdenk
1251b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1252b37c7e5eSwdenk
1253c609719bSwdenk		I2C_SDA(bit)
1254c609719bSwdenk
1255c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1256c609719bSwdenk		is FALSE, it clears it (low).
1257c609719bSwdenk
1258b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1259b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1260b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1261b37c7e5eSwdenk
1262c609719bSwdenk		I2C_SCL(bit)
1263c609719bSwdenk
1264c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1265c609719bSwdenk		is FALSE, it clears it (low).
1266c609719bSwdenk
1267b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1268b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1269b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1270b37c7e5eSwdenk
1271c609719bSwdenk		I2C_DELAY
1272c609719bSwdenk
1273c609719bSwdenk		This delay is invoked four times per clock cycle so this
1274c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1275b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1276b37c7e5eSwdenk		like:
1277b37c7e5eSwdenk
1278b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1279c609719bSwdenk
128047cd00faSwdenk		CFG_I2C_INIT_BOARD
128147cd00faSwdenk
128247cd00faSwdenk		When a board is reset during an i2c bus transfer
128347cd00faSwdenk		chips might think that the current transfer is still
128447cd00faSwdenk		in progress. On some boards it is possible to access
128547cd00faSwdenk		the i2c SCLK line directly, either by using the
128647cd00faSwdenk		processor pin as a GPIO or by having a second pin
128747cd00faSwdenk		connected to the bus. If this option is defined a
128847cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
128947cd00faSwdenk		is run early in the boot sequence.
129047cd00faSwdenk
129117ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
129217ea1177Swdenk
129317ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
129417ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
129517ea1177Swdenk		variable "i2cfast". (see also i2cfast)
129617ea1177Swdenk
1297c609719bSwdenk- SPI Support:	CONFIG_SPI
1298c609719bSwdenk
1299c609719bSwdenk		Enables SPI driver (so far only tested with
1300c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1301c609719bSwdenk		D/As on the SACSng board)
1302c609719bSwdenk
1303c609719bSwdenk		CONFIG_SPI_X
1304c609719bSwdenk
1305c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1306c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1307c609719bSwdenk
1308c609719bSwdenk		CONFIG_SOFT_SPI
1309c609719bSwdenk
1310c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1311c609719bSwdenk		using hardware support. This is a general purpose
1312c609719bSwdenk		driver that only requires three general I/O port pins
1313c609719bSwdenk		(two outputs, one input) to function. If this is
1314c609719bSwdenk		defined, the board configuration must define several
1315c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1316c609719bSwdenk		an example, see include/configs/sacsng.h.
1317c609719bSwdenk
1318c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1319c609719bSwdenk
1320c609719bSwdenk		Specify the number of FPGA devices to support.
1321c609719bSwdenk
1322c609719bSwdenk		CONFIG_FPGA
1323c609719bSwdenk
1324c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1325c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1326c609719bSwdenk
1327c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1328c609719bSwdenk
1329c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1330c609719bSwdenk
1331c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1332c609719bSwdenk
1333c609719bSwdenk		Enable checks on FPGA configuration interface busy
1334c609719bSwdenk		status by the configuration function. This option
1335c609719bSwdenk		will require a board or device specific function to
1336c609719bSwdenk		be written.
1337c609719bSwdenk
1338c609719bSwdenk		CONFIG_FPGA_DELAY
1339c609719bSwdenk
1340c609719bSwdenk		If defined, a function that provides delays in the FPGA
1341c609719bSwdenk		configuration driver.
1342c609719bSwdenk
1343c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1344c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1345c609719bSwdenk
1346c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1347c609719bSwdenk
1348c609719bSwdenk		Check for configuration errors during FPGA bitfile
1349c609719bSwdenk		loading. For example, abort during Virtex II
1350c609719bSwdenk		configuration if the INIT_B line goes low (which
1351c609719bSwdenk		indicated a CRC error).
1352c609719bSwdenk
1353c609719bSwdenk		CFG_FPGA_WAIT_INIT
1354c609719bSwdenk
1355c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1356c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1357c609719bSwdenk		FPGA configuration sequence. The default time is 500
1358c609719bSwdenk		mS.
1359c609719bSwdenk
1360c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1361c609719bSwdenk
1362c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1363c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1364c609719bSwdenk
1365c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1366c609719bSwdenk
1367c609719bSwdenk		Time to wait after FPGA configuration. The default is
1368c609719bSwdenk		200 mS.
1369c609719bSwdenk
1370c609719bSwdenk- Configuration Management:
1371c609719bSwdenk		CONFIG_IDENT_STRING
1372c609719bSwdenk
1373c609719bSwdenk		If defined, this string will be added to the U-Boot
1374c609719bSwdenk		version information (U_BOOT_VERSION)
1375c609719bSwdenk
1376c609719bSwdenk- Vendor Parameter Protection:
1377c609719bSwdenk
1378c609719bSwdenk		U-Boot considers the values of the environment
1379c609719bSwdenk		variables "serial#" (Board Serial Number) and
13807152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1381c609719bSwdenk		are set once by the board vendor / manufacturer, and
1382c609719bSwdenk		protects these variables from casual modification by
1383c609719bSwdenk		the user. Once set, these variables are read-only,
1384c609719bSwdenk		and write or delete attempts are rejected. You can
1385c609719bSwdenk		change this behviour:
1386c609719bSwdenk
1387c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1388c609719bSwdenk		file, the write protection for vendor parameters is
138947cd00faSwdenk		completely disabled. Anybody can change or delete
1390c609719bSwdenk		these parameters.
1391c609719bSwdenk
1392c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1393c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1394c609719bSwdenk		ethernet address is installed in the environment,
1395c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1396c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1397c609719bSwdenk		read-only.]
1398c609719bSwdenk
1399c609719bSwdenk- Protected RAM:
1400c609719bSwdenk		CONFIG_PRAM
1401c609719bSwdenk
1402c609719bSwdenk		Define this variable to enable the reservation of
1403c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1404c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1405c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1406c609719bSwdenk		this default value by defining an environment
1407c609719bSwdenk		variable "pram" to the number of kB you want to
1408c609719bSwdenk		reserve. Note that the board info structure will
1409c609719bSwdenk		still show the full amount of RAM. If pRAM is
1410c609719bSwdenk		reserved, a new environment variable "mem" will
1411c609719bSwdenk		automatically be defined to hold the amount of
1412c609719bSwdenk		remaining RAM in a form that can be passed as boot
1413c609719bSwdenk		argument to Linux, for instance like that:
1414c609719bSwdenk
1415fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1416c609719bSwdenk			saveenv
1417c609719bSwdenk
1418c609719bSwdenk		This way you can tell Linux not to use this memory,
1419c609719bSwdenk		either, which results in a memory region that will
1420c609719bSwdenk		not be affected by reboots.
1421c609719bSwdenk
1422c609719bSwdenk		*WARNING* If your board configuration uses automatic
1423c609719bSwdenk		detection of the RAM size, you must make sure that
1424c609719bSwdenk		this memory test is non-destructive. So far, the
1425c609719bSwdenk		following board configurations are known to be
1426c609719bSwdenk		"pRAM-clean":
1427c609719bSwdenk
1428c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1429c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1430c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1431c609719bSwdenk
1432c609719bSwdenk- Error Recovery:
1433c609719bSwdenk		CONFIG_PANIC_HANG
1434c609719bSwdenk
1435c609719bSwdenk		Define this variable to stop the system in case of a
1436c609719bSwdenk		fatal error, so that you have to reset it manually.
1437c609719bSwdenk		This is probably NOT a good idea for an embedded
1438c609719bSwdenk		system where you want to system to reboot
1439c609719bSwdenk		automatically as fast as possible, but it may be
1440c609719bSwdenk		useful during development since you can try to debug
1441c609719bSwdenk		the conditions that lead to the situation.
1442c609719bSwdenk
1443c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1444c609719bSwdenk
1445c609719bSwdenk		This variable defines the number of retries for
1446c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1447c609719bSwdenk		before giving up the operation. If not defined, a
1448c609719bSwdenk		default value of 5 is used.
1449c609719bSwdenk
1450c609719bSwdenk- Command Interpreter:
145104a85b3bSwdenk		CFG_AUTO_COMPLETE
145204a85b3bSwdenk
145304a85b3bSwdenk		Enable auto completion of commands using TAB.
145404a85b3bSwdenk
1455c609719bSwdenk		CFG_HUSH_PARSER
1456c609719bSwdenk
1457c609719bSwdenk		Define this variable to enable the "hush" shell (from
1458c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1459c609719bSwdenk		powerful command line syntax like
1460c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1461c609719bSwdenk		constructs ("shell scripts").
1462c609719bSwdenk
1463c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1464c609719bSwdenk		with a somewhat smaller memory footprint.
1465c609719bSwdenk
1466c609719bSwdenk
1467c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1468c609719bSwdenk
1469c609719bSwdenk		This defines the secondary prompt string, which is
1470c609719bSwdenk		printed when the command interpreter needs more input
1471c609719bSwdenk		to complete a command. Usually "> ".
1472c609719bSwdenk
1473c609719bSwdenk	Note:
1474c609719bSwdenk
1475c609719bSwdenk		In the current implementation, the local variables
1476c609719bSwdenk		space and global environment variables space are
1477c609719bSwdenk		separated. Local variables are those you define by
14783b57fe0aSwdenk		simply typing `name=value'. To access a local
1479c609719bSwdenk		variable later on, you have write `$name' or
14803b57fe0aSwdenk		`${name}'; to execute the contents of a variable
14813b57fe0aSwdenk		directly type `$name' at the command prompt.
1482c609719bSwdenk
1483c609719bSwdenk		Global environment variables are those you use
1484c609719bSwdenk		setenv/printenv to work with. To run a command stored
1485c609719bSwdenk		in such a variable, you need to use the run command,
1486c609719bSwdenk		and you must not use the '$' sign to access them.
1487c609719bSwdenk
1488c609719bSwdenk		To store commands and special characters in a
1489c609719bSwdenk		variable, please use double quotation marks
1490c609719bSwdenk		surrounding the whole text of the variable, instead
1491c609719bSwdenk		of the backslashes before semicolons and special
1492c609719bSwdenk		symbols.
1493c609719bSwdenk
1494aa0c71acSWolfgang Denk- Commandline Editing and History:
1495aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1496aa0c71acSWolfgang Denk
1497aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1498aa0c71acSWolfgang Denk		commandline input operations
1499aa0c71acSWolfgang Denk
1500a8c7c708Swdenk- Default Environment:
1501c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1502c609719bSwdenk
1503c609719bSwdenk		Define this to contain any number of null terminated
1504c609719bSwdenk		strings (variable = value pairs) that will be part of
15057152b1d0Swdenk		the default environment compiled into the boot image.
15062262cfeeSwdenk
1507c609719bSwdenk		For example, place something like this in your
1508c609719bSwdenk		board's config file:
1509c609719bSwdenk
1510c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1511c609719bSwdenk			"myvar1=value1\0" \
1512c609719bSwdenk			"myvar2=value2\0"
1513c609719bSwdenk
1514c609719bSwdenk		Warning: This method is based on knowledge about the
1515c609719bSwdenk		internal format how the environment is stored by the
15162262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1517c609719bSwdenk		interface! Although it is unlikely that this format
15187152b1d0Swdenk		will change soon, there is no guarantee either.
1519c609719bSwdenk		You better know what you are doing here.
1520c609719bSwdenk
1521c609719bSwdenk		Note: overly (ab)use of the default environment is
1522c609719bSwdenk		discouraged. Make sure to check other ways to preset
1523c609719bSwdenk		the environment like the autoscript function or the
1524c609719bSwdenk		boot command first.
1525c609719bSwdenk
1526a8c7c708Swdenk- DataFlash Support:
15272abbe075Swdenk		CONFIG_HAS_DATAFLASH
15282abbe075Swdenk
15292abbe075Swdenk		Defining this option enables DataFlash features and
15302abbe075Swdenk		allows to read/write in Dataflash via the standard
15312abbe075Swdenk		commands cp, md...
15322abbe075Swdenk
15333f85ce27Swdenk- SystemACE Support:
15343f85ce27Swdenk		CONFIG_SYSTEMACE
15353f85ce27Swdenk
15363f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
15373f85ce27Swdenk		chips attached via some sort of local bus. The address
15383f85ce27Swdenk		of the chip must alsh be defined in the
15393f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
15403f85ce27Swdenk
15413f85ce27Swdenk		#define CONFIG_SYSTEMACE
15423f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
15433f85ce27Swdenk
15443f85ce27Swdenk		When SystemACE support is added, the "ace" device type
15453f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
15463f85ce27Swdenk
1547ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1548ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1549ecb0ccd9SWolfgang Denk
155028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1551ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
155228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1553ecb0ccd9SWolfgang Denk		number generator is used.
1554ecb0ccd9SWolfgang Denk
155528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
155628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
155728cb9375SWolfgang Denk		defined, the normal port 69 is used.
155828cb9375SWolfgang Denk
155928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1560ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1561ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1562ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1563ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1564ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1565ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1566ecb0ccd9SWolfgang Denk
1567a8c7c708Swdenk- Show boot progress:
1568c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1569c609719bSwdenk
1570c609719bSwdenk		Defining this option allows to add some board-
1571c609719bSwdenk		specific code (calling a user-provided function
1572c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1573c609719bSwdenk		the system's boot progress on some display (for
1574c609719bSwdenk		example, some LED's) on your board. At the moment,
1575c609719bSwdenk		the following checkpoints are implemented:
1576c609719bSwdenk
1577c609719bSwdenk  Arg	Where			When
1578c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1579c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1580c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1581c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1582c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1583c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1584c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1585c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1586c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1587c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1588c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1589c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1590c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1591c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1592c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1593c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1594c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1595c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1596c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1597c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1598c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1599c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1600c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1601c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1602c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1603c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1604c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1605c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1606c609719bSwdenk
160763e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
160863e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
160963e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
161063e73c9aSwdenk
1611c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1612c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1613c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1614c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1615c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1616c609719bSwdenk
1617c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1618c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1619c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1620c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1621c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1622c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1623c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1624c609719bSwdenk
1625206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1626206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1627206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1628206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1629206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1630206c60cbSwdenk
1631206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1632c609719bSwdenk
1633c609719bSwdenk
1634c609719bSwdenkModem Support:
1635c609719bSwdenk--------------
1636c609719bSwdenk
163785ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1638c609719bSwdenk
1639c609719bSwdenk- Modem support endable:
1640c609719bSwdenk		CONFIG_MODEM_SUPPORT
1641c609719bSwdenk
1642c609719bSwdenk- RTS/CTS Flow control enable:
1643c609719bSwdenk		CONFIG_HWFLOW
1644c609719bSwdenk
1645c609719bSwdenk- Modem debug support:
1646c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1647c609719bSwdenk
1648c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1649c609719bSwdenk		for modem support. Useful only with BDI2000.
1650c609719bSwdenk
1651a8c7c708Swdenk- Interrupt support (PPC):
1652a8c7c708Swdenk
1653a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1654a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1655a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1656a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1657a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1658a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1659a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1660a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1661a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1662a8c7c708Swdenk		general timer_interrupt().
1663a8c7c708Swdenk
1664c609719bSwdenk- General:
1665c609719bSwdenk
1666c609719bSwdenk		In the target system modem support is enabled when a
1667c609719bSwdenk		specific key (key combination) is pressed during
1668c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1669c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1670c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1671c609719bSwdenk		function, returning 1 and thus enabling modem
1672c609719bSwdenk		initialization.
1673c609719bSwdenk
1674c609719bSwdenk		If there are no modem init strings in the
1675c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1676c609719bSwdenk		previous output (banner, info printfs) will be
1677c609719bSwdenk		supressed, though.
1678c609719bSwdenk
1679c609719bSwdenk		See also: doc/README.Modem
1680c609719bSwdenk
1681c609719bSwdenk
1682c609719bSwdenkConfiguration Settings:
1683c609719bSwdenk-----------------------
1684c609719bSwdenk
1685c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1686c609719bSwdenk		undefine this when you're short of memory.
1687c609719bSwdenk
1688c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1689c609719bSwdenk		prompt for user input.
1690c609719bSwdenk
1691c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1692c609719bSwdenk
1693c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1694c609719bSwdenk
1695c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1696c609719bSwdenk
1697c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1698c609719bSwdenk		the application (usually a Linux kernel) when it is
1699c609719bSwdenk		booted
1700c609719bSwdenk
1701c609719bSwdenk- CFG_BAUDRATE_TABLE:
1702c609719bSwdenk		List of legal baudrate settings for this board.
1703c609719bSwdenk
1704c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1705c609719bSwdenk		Suppress display of console information at boot.
1706c609719bSwdenk
1707c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1708c609719bSwdenk		If the board specific function
1709c609719bSwdenk			extern int overwrite_console (void);
1710c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1711c609719bSwdenk		serial port, else the settings in the environment are used.
1712c609719bSwdenk
1713c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1714c609719bSwdenk		Enable the call to overwrite_console().
1715c609719bSwdenk
1716c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1717c609719bSwdenk		Enable overwrite of previous console environment settings.
1718c609719bSwdenk
1719c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1720c609719bSwdenk		Begin and End addresses of the area used by the
1721c609719bSwdenk		simple memory test.
1722c609719bSwdenk
1723c609719bSwdenk- CFG_ALT_MEMTEST:
1724c609719bSwdenk		Enable an alternate, more extensive memory test.
1725c609719bSwdenk
17265f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
17275f535fe1Swdenk		Scratch address used by the alternate memory test
17285f535fe1Swdenk		You only need to set this if address zero isn't writeable
17295f535fe1Swdenk
1730c609719bSwdenk- CFG_TFTP_LOADADDR:
1731c609719bSwdenk		Default load address for network file downloads
1732c609719bSwdenk
1733c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1734c609719bSwdenk		Enable temporary baudrate change while serial download
1735c609719bSwdenk
1736c609719bSwdenk- CFG_SDRAM_BASE:
1737c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1738c609719bSwdenk
1739c609719bSwdenk- CFG_MBIO_BASE:
1740c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1741c609719bSwdenk		Cogent motherboard)
1742c609719bSwdenk
1743c609719bSwdenk- CFG_FLASH_BASE:
1744c609719bSwdenk		Physical start address of Flash memory.
1745c609719bSwdenk
1746c609719bSwdenk- CFG_MONITOR_BASE:
1747c609719bSwdenk		Physical start address of boot monitor code (set by
1748c609719bSwdenk		make config files to be same as the text base address
1749c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1750c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1751c609719bSwdenk
1752c609719bSwdenk- CFG_MONITOR_LEN:
17533b57fe0aSwdenk		Size of memory reserved for monitor code, used to
17543b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
17553b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
17563b57fe0aSwdenk		flash sector.
1757c609719bSwdenk
1758c609719bSwdenk- CFG_MALLOC_LEN:
1759c609719bSwdenk		Size of DRAM reserved for malloc() use.
1760c609719bSwdenk
176115940c9aSStefan Roese- CFG_BOOTM_LEN:
176215940c9aSStefan Roese		Normally compressed uImages are limited to an
176315940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
176415940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
176515940c9aSStefan Roese		to adjust this setting to your needs.
1766c609719bSwdenk
1767c609719bSwdenk- CFG_BOOTMAPSZ:
1768c609719bSwdenk		Maximum size of memory mapped by the startup code of
1769c609719bSwdenk		the Linux kernel; all data that must be processed by
1770c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1771c609719bSwdenk		initrd image) must be put below this limit.
1772c609719bSwdenk
1773c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1774c609719bSwdenk		Max number of Flash memory banks
1775c609719bSwdenk
1776c609719bSwdenk- CFG_MAX_FLASH_SECT:
1777c609719bSwdenk		Max number of sectors on a Flash chip
1778c609719bSwdenk
1779c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1780c609719bSwdenk		Timeout for Flash erase operations (in ms)
1781c609719bSwdenk
1782c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1783c609719bSwdenk		Timeout for Flash write operations (in ms)
1784c609719bSwdenk
17858564acf9Swdenk- CFG_FLASH_LOCK_TOUT
17868564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
17878564acf9Swdenk
17888564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
17898564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
17908564acf9Swdenk
17918564acf9Swdenk- CFG_FLASH_PROTECTION
17928564acf9Swdenk		If defined, hardware flash sectors protection is used
17938564acf9Swdenk		instead of U-Boot software protection.
17948564acf9Swdenk
1795c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1796c609719bSwdenk
1797c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1798c609719bSwdenk		without this option such a download has to be
1799c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1800c609719bSwdenk		copy from RAM to flash.
1801c609719bSwdenk
1802c609719bSwdenk		The two-step approach is usually more reliable, since
1803c609719bSwdenk		you can check if the download worked before you erase
1804c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1805c609719bSwdenk		too limited to allow for a tempory copy of the
1806c609719bSwdenk		downloaded image) this option may be very useful.
1807c609719bSwdenk
1808c609719bSwdenk- CFG_FLASH_CFI:
1809c609719bSwdenk		Define if the flash driver uses extra elements in the
18105653fc33Swdenk		common flash structure for storing flash geometry.
18115653fc33Swdenk
18125653fc33Swdenk- CFG_FLASH_CFI_DRIVER
18135653fc33Swdenk		This option also enables the building of the cfi_flash driver
18145653fc33Swdenk		in the drivers directory
181553cf9435Sstroese
18165568e613SStefan Roese- CFG_FLASH_QUIET_TEST
18175568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
18185568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
18195568e613SStefan Roese		is useful, if some of the configured banks are only
18205568e613SStefan Roese		optionally available.
18215568e613SStefan Roese
182253cf9435Sstroese- CFG_RX_ETH_BUFFER:
182353cf9435Sstroese		Defines the number of ethernet receive buffers. On some
182453cf9435Sstroese		ethernet controllers it is recommended to set this value
182553cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
182653cf9435Sstroese		buffers can be full shortly after enabling the interface
182753cf9435Sstroese		on high ethernet traffic.
182853cf9435Sstroese		Defaults to 4 if not defined.
1829c609719bSwdenk
1830c609719bSwdenkThe following definitions that deal with the placement and management
1831c609719bSwdenkof environment data (variable area); in general, we support the
1832c609719bSwdenkfollowing configurations:
1833c609719bSwdenk
1834c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1835c609719bSwdenk
1836c609719bSwdenk	Define this if the environment is in flash memory.
1837c609719bSwdenk
1838c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1839c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1840c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1841c609719bSwdenk	   sector" type flash chips, which have several smaller
1842c609719bSwdenk	   sectors at the start or the end. For instance, such a
1843c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1844c609719bSwdenk	   such a case you would place the environment in one of the
1845c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1846c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1847c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1848c609719bSwdenk	   between U-Boot and the environment.
1849c609719bSwdenk
1850c609719bSwdenk	- CFG_ENV_OFFSET:
1851c609719bSwdenk
1852c609719bSwdenk	   Offset of environment data (variable area) to the
1853c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1854c609719bSwdenk	   type flash chips the second sector can be used: the offset
1855c609719bSwdenk	   for this sector is given here.
1856c609719bSwdenk
1857c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1858c609719bSwdenk
1859c609719bSwdenk	- CFG_ENV_ADDR:
1860c609719bSwdenk
1861c609719bSwdenk	   This is just another way to specify the start address of
1862c609719bSwdenk	   the flash sector containing the environment (instead of
1863c609719bSwdenk	   CFG_ENV_OFFSET).
1864c609719bSwdenk
1865c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1866c609719bSwdenk
1867c609719bSwdenk	   Size of the sector containing the environment.
1868c609719bSwdenk
1869c609719bSwdenk
1870c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1871c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1872c609719bSwdenk	   the environment.
1873c609719bSwdenk
1874c609719bSwdenk	- CFG_ENV_SIZE:
1875c609719bSwdenk
1876c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1877c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1878c609719bSwdenk	   of this flash sector for the environment. This saves
1879c609719bSwdenk	   memory for the RAM copy of the environment.
1880c609719bSwdenk
1881c609719bSwdenk	   It may also save flash memory if you decide to use this
1882c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1883c609719bSwdenk	   since then the remainder of the flash sector could be used
1884c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1885c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1886c609719bSwdenk	   updating the environment in flash makes it always
1887c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1888c609719bSwdenk	   wrong before the contents has been restored from a copy in
1889c609719bSwdenk	   RAM, your target system will be dead.
1890c609719bSwdenk
1891c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1892c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1893c609719bSwdenk
1894c609719bSwdenk	   These settings describe a second storage area used to hold
1895c609719bSwdenk	   a redundand copy of the environment data, so that there is
18963e38691eSwdenk	   a valid backup copy in case there is a power failure during
1897c609719bSwdenk	   a "saveenv" operation.
1898c609719bSwdenk
1899c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1900c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1901c609719bSwdenkaccordingly!
1902c609719bSwdenk
1903c609719bSwdenk
1904c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1905c609719bSwdenk
1906c609719bSwdenk	Define this if you have some non-volatile memory device
1907c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1908c609719bSwdenk	environment.
1909c609719bSwdenk
1910c609719bSwdenk	- CFG_ENV_ADDR:
1911c609719bSwdenk	- CFG_ENV_SIZE:
1912c609719bSwdenk
1913c609719bSwdenk	  These two #defines are used to determin the memory area you
1914c609719bSwdenk	  want to use for environment. It is assumed that this memory
1915c609719bSwdenk	  can just be read and written to, without any special
1916c609719bSwdenk	  provision.
1917c609719bSwdenk
1918c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
1919c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
1920c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
1921c609719bSwdenkU-Boot will hang.
1922c609719bSwdenk
1923c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
1924c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
1925c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
1926c609719bSwdenkto save the current settings.
1927c609719bSwdenk
1928c609719bSwdenk
1929c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
1930c609719bSwdenk
1931c609719bSwdenk	Use this if you have an EEPROM or similar serial access
1932c609719bSwdenk	device and a driver for it.
1933c609719bSwdenk
1934c609719bSwdenk	- CFG_ENV_OFFSET:
1935c609719bSwdenk	- CFG_ENV_SIZE:
1936c609719bSwdenk
1937c609719bSwdenk	  These two #defines specify the offset and size of the
1938c609719bSwdenk	  environment area within the total memory of your EEPROM.
1939c609719bSwdenk
1940c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
1941c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
1942c609719bSwdenk	  The default address is zero.
1943c609719bSwdenk
1944c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
1945c609719bSwdenk	  If defined, the number of bits used to address bytes in a
1946c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
1947c609719bSwdenk	  would require six bits.
1948c609719bSwdenk
1949c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1950c609719bSwdenk	  If defined, the number of milliseconds to delay between
1951c609719bSwdenk	  page writes.	The default is zero milliseconds.
1952c609719bSwdenk
1953c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
1954c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
1955c609719bSwdenk	  that this is NOT the chip address length!
1956c609719bSwdenk
19575cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
19585cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
19595cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
19605cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
19615cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
19625cf91d6bSwdenk	  byte chips.
19635cf91d6bSwdenk
19645cf91d6bSwdenk	  Note that we consider the length of the address field to
19655cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
19665cf91d6bSwdenk	  in the chip address.
19675cf91d6bSwdenk
1968c609719bSwdenk	- CFG_EEPROM_SIZE:
1969c609719bSwdenk	  The size in bytes of the EEPROM device.
1970c609719bSwdenk
1971c609719bSwdenk
19725779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
19735779d8d9Swdenk
19745779d8d9Swdenk	Define this if you have a DataFlash memory device which you
19755779d8d9Swdenk	want to use for the environment.
19765779d8d9Swdenk
19775779d8d9Swdenk	- CFG_ENV_OFFSET:
19785779d8d9Swdenk	- CFG_ENV_ADDR:
19795779d8d9Swdenk	- CFG_ENV_SIZE:
19805779d8d9Swdenk
19815779d8d9Swdenk	  These three #defines specify the offset and size of the
19825779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
19835779d8d9Swdenk	  at the specified address.
19845779d8d9Swdenk
198513a5695bSwdenk- CFG_ENV_IS_IN_NAND:
198613a5695bSwdenk
198713a5695bSwdenk	Define this if you have a NAND device which you want to use
198813a5695bSwdenk	for the environment.
198913a5695bSwdenk
199013a5695bSwdenk	- CFG_ENV_OFFSET:
199113a5695bSwdenk	- CFG_ENV_SIZE:
199213a5695bSwdenk
199313a5695bSwdenk	  These two #defines specify the offset and size of the environment
199413a5695bSwdenk	  area within the first NAND device.
19955779d8d9Swdenk
1996e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
1997e443c944SMarkus Klotzbuecher
1998e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
1999e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2000e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2001e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2002e443c944SMarkus Klotzbuecher
2003e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2004e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2005e443c944SMarkus Klotzbuecher	the NAND devices block size.
2006e443c944SMarkus Klotzbuecher
2007c609719bSwdenk- CFG_SPI_INIT_OFFSET
2008c609719bSwdenk
2009c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2010c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2011c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2012c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2013c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2014c609719bSwdenk	to be a good choice since it makes it far enough from the
2015c609719bSwdenk	start of the data area as well as from the stack pointer.
2016c609719bSwdenk
2017c609719bSwdenkPlease note that the environment is read-only as long as the monitor
2018c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2019c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2020c609719bSwdenkuntil then to read environment variables.
2021c609719bSwdenk
202285ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
202385ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
202485ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
202585ec0bccSwdenknecessary, because the first environment variable we need is the
202685ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
202785ec0bccSwdenkhave any device yet where we could complain.]
2028c609719bSwdenk
2029c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2030c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
203185ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2032c609719bSwdenk
2033fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2034fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2035fc3e2165Swdenk
2036fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2037fc3e2165Swdenk		      also needs to be defined.
2038fc3e2165Swdenk
2039fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2040fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2041c609719bSwdenk
2042c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2043c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2044c40b2956Swdenk		of 64bit values by using the L quantifier
2045c40b2956Swdenk
2046c40b2956Swdenk- CFG_64BIT_STRTOUL:
2047c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2048c40b2956Swdenk
2049c609719bSwdenkLow Level (hardware related) configuration options:
2050dc7c9a1aSwdenk---------------------------------------------------
2051c609719bSwdenk
2052c609719bSwdenk- CFG_CACHELINE_SIZE:
2053c609719bSwdenk		Cache Line Size of the CPU.
2054c609719bSwdenk
2055c609719bSwdenk- CFG_DEFAULT_IMMR:
2056c609719bSwdenk		Default address of the IMMR after system reset.
20572535d602Swdenk
20582535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
20592535d602Swdenk		and RPXsuper) to be able to adjust the position of
20602535d602Swdenk		the IMMR register after a reset.
2061c609719bSwdenk
20627f6c2cbcSwdenk- Floppy Disk Support:
20637f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
20647f6c2cbcSwdenk
20657f6c2cbcSwdenk		the default drive number (default value 0)
20667f6c2cbcSwdenk
20677f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
20687f6c2cbcSwdenk
20697f6c2cbcSwdenk		defines the spacing between fdc chipset registers
20707f6c2cbcSwdenk		(default value 1)
20717f6c2cbcSwdenk
20727f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
20737f6c2cbcSwdenk
20747f6c2cbcSwdenk		defines the offset of register from address. It
20757f6c2cbcSwdenk		depends on which part of the data bus is connected to
20767f6c2cbcSwdenk		the fdc chipset. (default value 0)
20777f6c2cbcSwdenk
20787f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
20797f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
20807f6c2cbcSwdenk		default value.
20817f6c2cbcSwdenk
20827f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
20837f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
20847f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
20857f6c2cbcSwdenk		source code. It is used to make hardware dependant
20867f6c2cbcSwdenk		initializations.
20877f6c2cbcSwdenk
208825d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
208925d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
209025d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2091c609719bSwdenk
2092c609719bSwdenk- CFG_INIT_RAM_ADDR:
2093c609719bSwdenk
20947152b1d0Swdenk		Start address of memory area that can be used for
2095c609719bSwdenk		initial data and stack; please note that this must be
2096c609719bSwdenk		writable memory that is working WITHOUT special
2097c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2098c609719bSwdenk		will become available only after programming the
2099c609719bSwdenk		memory controller and running certain initialization
2100c609719bSwdenk		sequences.
2101c609719bSwdenk
2102c609719bSwdenk		U-Boot uses the following memory types:
2103c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2104c609719bSwdenk		- MPC824X: data cache
2105c609719bSwdenk		- PPC4xx:  data cache
2106c609719bSwdenk
210785ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2108c609719bSwdenk
2109c609719bSwdenk		Offset of the initial data structure in the memory
2110c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
211185ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2112c609719bSwdenk		data is located at the end of the available space
2113c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2114c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2115c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
211685ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2117c609719bSwdenk
2118c609719bSwdenk	Note:
2119c609719bSwdenk		On the MPC824X (or other systems that use the data
2120c609719bSwdenk		cache for initial memory) the address chosen for
2121c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2122c609719bSwdenk		point to an otherwise UNUSED address space between
2123c609719bSwdenk		the top of RAM and the start of the PCI space.
2124c609719bSwdenk
2125c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2126c609719bSwdenk
2127c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2128c609719bSwdenk
2129c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2130c609719bSwdenk
2131c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2132c609719bSwdenk
2133c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2134c609719bSwdenk
2135c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2136c609719bSwdenk
2137c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2138c609719bSwdenk		SDRAM timing
2139c609719bSwdenk
2140c609719bSwdenk- CFG_MAMR_PTA:
2141c609719bSwdenk		periodic timer for refresh
2142c609719bSwdenk
2143c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2144c609719bSwdenk
2145c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2146c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2147c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2148c609719bSwdenk  CFG_BR1_PRELIM:
2149c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2150c609719bSwdenk
2151c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2152c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2153c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2154c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2155c609719bSwdenk
2156c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2157c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2158c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2159c609719bSwdenk		Prescaler definitions (SDRAM timing)
2160c609719bSwdenk
2161c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2162c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2163c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2164c609719bSwdenk
2165c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2166c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2167c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2168c609719bSwdenk
2169c609719bSwdenk- CFG_USE_OSCCLK:
2170c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2171c609719bSwdenk		wrong setting might damage your board. Read
2172c609719bSwdenk		doc/README.MBX before setting this variable!
2173c609719bSwdenk
2174ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2175ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2176ea909b76Swdenk		(Power On Self Tests). This definition overrides
2177ea909b76Swdenk		#define'd default value in commproc.h resp.
2178ea909b76Swdenk		cpm_8260.h.
2179ea909b76Swdenk
21805d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
21815d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
21825d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
21835d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
21845d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
21855d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
21865d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
21875d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
21885d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
21895d232d0eSwdenk
2190c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2191c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2192c26e454dSwdenk
2193c26e454dSwdenk- CONFIG_FEC[12]_PHY
2194c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
21956e592385Swdenk		to the given FEC; i. e.
2196c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2197c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2198c26e454dSwdenk
2199c26e454dSwdenk		When set to -1, means to probe for first available.
2200c26e454dSwdenk
2201c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2202c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2203c26e454dSwdenk		(so program the FEC to ignore it).
2204c26e454dSwdenk
2205c26e454dSwdenk- CONFIG_RMII
2206c26e454dSwdenk		Enable RMII mode for all FECs.
2207c26e454dSwdenk		Note that this is a global option, we can't
2208c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2209c26e454dSwdenk
22105cf91d6bSwdenk- CONFIG_CRC32_VERIFY
22115cf91d6bSwdenk		Add a verify option to the crc32 command.
22125cf91d6bSwdenk		The syntax is:
22135cf91d6bSwdenk
22145cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
22155cf91d6bSwdenk
22165cf91d6bSwdenk		Where address/count indicate a memory area
22175cf91d6bSwdenk		and crc32 is the correct crc32 which the
22185cf91d6bSwdenk		area should have.
22195cf91d6bSwdenk
222056523f12Swdenk- CONFIG_LOOPW
222156523f12Swdenk		Add the "loopw" memory command. This only takes effect if
222256523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
222356523f12Swdenk
22247b466641Sstroese- CONFIG_MX_CYCLIC
22257b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
22267b466641Sstroese		"md/mw" commands.
22277b466641Sstroese		Examples:
22287b466641Sstroese
22297b466641Sstroese		=> mdc.b 10 4 500
22307b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
22317b466641Sstroese
22327b466641Sstroese		=> mwc.l 100 12345678 10
22337b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
22347b466641Sstroese
22357b466641Sstroese		This only takes effect if the memory commands are activated
22367b466641Sstroese		globally (CFG_CMD_MEM).
22377b466641Sstroese
22388aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
22398aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
22408aa1a2d1Swdenk
22418aa1a2d1Swdenk		[ARM only] If these variables are defined, then
22428aa1a2d1Swdenk		certain low level initializations (like setting up
22438aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
22448aa1a2d1Swdenk		not relocate itself into RAM.
22458aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
22468aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
22478aa1a2d1Swdenk		some other boot loader or by a debugger which
22488aa1a2d1Swdenk		performs these intializations itself.
22498aa1a2d1Swdenk
2250400558b5Swdenk
2251c609719bSwdenkBuilding the Software:
2252c609719bSwdenk======================
2253c609719bSwdenk
2254c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2255c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2256c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2257c609719bSwdenkNetBSD 1.5 on x86).
2258c609719bSwdenk
2259c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2260c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2261c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2262c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2263c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2264c609719bSwdenkchange it to:
2265c609719bSwdenk
2266c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2267c609719bSwdenk
2268c609719bSwdenk
2269c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2270c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2271c609719bSwdenkis done by typing:
2272c609719bSwdenk
2273c609719bSwdenk	make NAME_config
2274c609719bSwdenk
2275c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2276c609719bSwdenkconfigurations; the following names are supported:
2277c609719bSwdenk
22781eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
22791eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2280983fda83Swdenk	Alaska8220_config
22811eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
22821eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
22831eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
22841eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
22851eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2286e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2287e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2288e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2289e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2290e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2291466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2292466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
22938b07a110Swdenk	EBONY_config		MPC8260ADS_config	SM850_config
22948b07a110Swdenk	ELPT860_config		MPC8540ADS_config	SPD823TS_config
2295b0e32949SLunsheng Wang	ESTEEM192E_config	MPC8540EVAL_config	stxgp3_config
2296b0e32949SLunsheng Wang	ETX094_config		MPC8560ADS_config	SXNI855T_config
2297b0e32949SLunsheng Wang	FADS823_config		NETVIA_config		TQM823L_config
2298b0e32949SLunsheng Wang	FADS850SAR_config	omap1510inn_config	TQM850L_config
2299b0e32949SLunsheng Wang	FADS860T_config		omap1610h2_config	TQM855L_config
2300b0e32949SLunsheng Wang	FPS850L_config		omap1610inn_config	TQM860L_config
23014b1d95d9SJon Loeliger				omap5912osk_config	walnut_config
2302b0e32949SLunsheng Wang				omap2420h4_config	Yukon8220_config
23038b07a110Swdenk							ZPC1900_config
230454387ac9Swdenk
2305c609719bSwdenkNote: for some board special configuration names may exist; check if
2306c609719bSwdenk      additional information is available from the board vendor; for
23072729af9dSwdenk      instance, the TQM823L systems are available without (standard)
23082729af9dSwdenk      or with LCD support. You can select such additional "features"
2309c609719bSwdenk      when chosing the configuration, i. e.
2310c609719bSwdenk
23112729af9dSwdenk      make TQM823L_config
23122729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2313c609719bSwdenk
2314c609719bSwdenk      make TQM823L_LCD_config
2315c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2316c609719bSwdenk
2317c609719bSwdenk      etc.
2318c609719bSwdenk
2319c609719bSwdenk
2320c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
23217152b1d0Swdenkimages ready for download to / installation on your system:
2322c609719bSwdenk
2323c609719bSwdenk- "u-boot.bin" is a raw binary image
2324c609719bSwdenk- "u-boot" is an image in ELF binary format
2325c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2326c609719bSwdenk
2327baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2328baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2329baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2330baf31249SMarian Balakowicz
2331baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2332baf31249SMarian Balakowicz
2333baf31249SMarian Balakowicz	make O=/tmp/build distclean
2334baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2335baf31249SMarian Balakowicz	make O=/tmp/build all
2336baf31249SMarian Balakowicz
2337baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2338baf31249SMarian Balakowicz
2339baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2340baf31249SMarian Balakowicz	make distclean
2341baf31249SMarian Balakowicz	make NAME_config
2342baf31249SMarian Balakowicz	make all
2343baf31249SMarian Balakowicz
2344baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2345baf31249SMarian Balakowiczvariable.
2346baf31249SMarian Balakowicz
2347c609719bSwdenk
2348c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2349c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2350c609719bSwdenknative "make".
2351c609719bSwdenk
2352c609719bSwdenk
2353c609719bSwdenkIf the system board that you have is not listed, then you will need
2354c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2355c609719bSwdenksteps:
2356c609719bSwdenk
2357c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
235885ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
235985ec0bccSwdenk    entries as examples. Note that here and at many other places
23607152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
236185ec0bccSwdenk    keep this order.
2362c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
236385ec0bccSwdenk    files you need. In your board directory, you will need at least
236485ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
236585ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
236685ec0bccSwdenk    your board
2367c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2368c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
236985ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2370c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2371c609719bSwdenk    to be installed on your target system.
237285ec0bccSwdenk6.  Debug and solve any problems that might arise.
2373c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2374c609719bSwdenk
2375c609719bSwdenk
2376c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2377c609719bSwdenk==============================================================
2378c609719bSwdenk
2379c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2380c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2381c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2382c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2383c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2384c609719bSwdenk
2385c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2386c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2387c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2388c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2389c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
23907152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2391c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2392c609719bSwdenkMontaVista's Hard Hat Linux you can type
2393c609719bSwdenk
2394c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2395c609719bSwdenk
2396c609719bSwdenkor to build on a native PowerPC system you can type
2397c609719bSwdenk
2398c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2399c609719bSwdenk
2400baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2401baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2402baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2403baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2404baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2405baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2406baf31249SMarian Balakowicz
2407baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2408baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2409baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2410baf31249SMarian Balakowicz
2411baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2412baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2413baf31249SMarian Balakowiczthe whole build process.
2414baf31249SMarian Balakowicz
2415baf31249SMarian Balakowicz
2416c609719bSwdenkSee also "U-Boot Porting Guide" below.
2417c609719bSwdenk
2418c609719bSwdenk
2419c609719bSwdenkMonitor Commands - Overview:
2420c609719bSwdenk============================
2421c609719bSwdenk
2422c609719bSwdenkgo	- start application at address 'addr'
2423c609719bSwdenkrun	- run commands in an environment variable
2424c609719bSwdenkbootm	- boot application image from memory
2425c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2426c609719bSwdenktftpboot- boot image via network using TFTP protocol
2427c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2428c609719bSwdenk	       (and eventually "gatewayip")
2429c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2430c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2431c609719bSwdenkloads	- load S-Record file over serial line
2432c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2433c609719bSwdenkmd	- memory display
2434c609719bSwdenkmm	- memory modify (auto-incrementing)
2435c609719bSwdenknm	- memory modify (constant address)
2436c609719bSwdenkmw	- memory write (fill)
2437c609719bSwdenkcp	- memory copy
2438c609719bSwdenkcmp	- memory compare
2439c609719bSwdenkcrc32	- checksum calculation
2440c609719bSwdenkimd	- i2c memory display
2441c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2442c609719bSwdenkinm	- i2c memory modify (constant address)
2443c609719bSwdenkimw	- i2c memory write (fill)
2444c609719bSwdenkicrc32	- i2c checksum calculation
2445c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2446c609719bSwdenkiloop	- infinite loop on address range
2447c609719bSwdenkisdram	- print SDRAM configuration information
2448c609719bSwdenksspi	- SPI utility commands
2449c609719bSwdenkbase	- print or set address offset
2450c609719bSwdenkprintenv- print environment variables
2451c609719bSwdenksetenv	- set environment variables
2452c609719bSwdenksaveenv - save environment variables to persistent storage
2453c609719bSwdenkprotect - enable or disable FLASH write protection
2454c609719bSwdenkerase	- erase FLASH memory
2455c609719bSwdenkflinfo	- print FLASH memory information
2456c609719bSwdenkbdinfo	- print Board Info structure
2457c609719bSwdenkiminfo	- print header information for application image
2458c609719bSwdenkconinfo - print console devices and informations
2459c609719bSwdenkide	- IDE sub-system
2460c609719bSwdenkloop	- infinite loop on address range
246156523f12Swdenkloopw	- infinite write loop on address range
2462c609719bSwdenkmtest	- simple RAM test
2463c609719bSwdenkicache	- enable or disable instruction cache
2464c609719bSwdenkdcache	- enable or disable data cache
2465c609719bSwdenkreset	- Perform RESET of the CPU
2466c609719bSwdenkecho	- echo args to console
2467c609719bSwdenkversion - print monitor version
2468c609719bSwdenkhelp	- print online help
2469c609719bSwdenk?	- alias for 'help'
2470c609719bSwdenk
2471c609719bSwdenk
2472c609719bSwdenkMonitor Commands - Detailed Description:
2473c609719bSwdenk========================================
2474c609719bSwdenk
2475c609719bSwdenkTODO.
2476c609719bSwdenk
2477c609719bSwdenkFor now: just type "help <command>".
2478c609719bSwdenk
2479c609719bSwdenk
2480c609719bSwdenkEnvironment Variables:
2481c609719bSwdenk======================
2482c609719bSwdenk
2483c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2484c609719bSwdenkcan be made persistent by saving to Flash memory.
2485c609719bSwdenk
2486c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2487c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2488c609719bSwdenkwithout a value can be used to delete a variable from the
2489c609719bSwdenkenvironment. As long as you don't save the environment you are
2490c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2491c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2492c609719bSwdenk
2493c609719bSwdenkSome configuration options can be set using Environment Variables:
2494c609719bSwdenk
2495c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2496c609719bSwdenk
2497c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2498c609719bSwdenk
2499c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2500c609719bSwdenk
2501c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2502c609719bSwdenk
2503c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2504c609719bSwdenk
2505c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2506c609719bSwdenk		  "bootp" will just load perform a lookup of the
2507c609719bSwdenk		  configuration from the BOOTP server, but not try to
2508c609719bSwdenk		  load any image using TFTP
2509c609719bSwdenk
2510c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2511c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2512c609719bSwdenk		  be automatically started (by internally calling
2513c609719bSwdenk		  "bootm")
2514c609719bSwdenk
25154a6fd34bSwdenk		  If set to "no", a standalone image passed to the
25164a6fd34bSwdenk		  "bootm" command will be copied to the load address
25174a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
25184a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
25194a6fd34bSwdenk		  data.
25204a6fd34bSwdenk
252117ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
252217ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
252317ea1177Swdenk		  mode (400kHZ). This environment variable is used in
252417ea1177Swdenk		  initialization code. So, for changes to be effective
252517ea1177Swdenk		  it must be saved and board must be reset.
252617ea1177Swdenk
2527c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2528c609719bSwdenk		  If this variable is not set, initrd images will be
2529c609719bSwdenk		  copied to the highest possible address in RAM; this
2530c609719bSwdenk		  is usually what you want since it allows for
2531c609719bSwdenk		  maximum initrd size. If for some reason you want to
2532c609719bSwdenk		  make sure that the initrd image is loaded below the
2533c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2534c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2535c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2536c609719bSwdenk		  address to use (U-Boot will still check that it
2537c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2538c609719bSwdenk
2539c609719bSwdenk		  For instance, when you have a system with 16 MB
25407152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2541c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2542c609719bSwdenk		  the "bootargs" variable. However, now you must make
25437152b1d0Swdenk		  sure that the initrd image is placed in the first
2544c609719bSwdenk		  12 MB as well - this can be done with
2545c609719bSwdenk
2546c609719bSwdenk		  setenv initrd_high 00c00000
2547c609719bSwdenk
254838b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
254938b99261Swdenk		  indication to U-Boot that all addresses are legal
255038b99261Swdenk		  for the Linux kernel, including addresses in flash
255138b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
255238b99261Swdenk		  ramdisk at all. This may be useful to reduce the
255338b99261Swdenk		  boot time on your system, but requires that this
255438b99261Swdenk		  feature is supported by your Linux kernel.
255538b99261Swdenk
2556c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2557c609719bSwdenk
2558c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2559dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2560c609719bSwdenk
2561c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2562c609719bSwdenk
2563c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2564c609719bSwdenk
2565c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2566c609719bSwdenk
2567c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2568c609719bSwdenk
2569c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2570c609719bSwdenk
2571a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2572a3d991bdSwdenk		  interface is used first.
2573a3d991bdSwdenk
2574a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2575a3d991bdSwdenk		  interface is currently active. For example you
2576a3d991bdSwdenk		  can do the following
2577a3d991bdSwdenk
2578a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2579a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2580a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2581a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2582a3d991bdSwdenk
2583a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2584a3d991bdSwdenk		  either succeed or fail without retrying.
25856e592385Swdenk		  When set to "once" the network operation will
25866e592385Swdenk		  fail when all the available network interfaces
25876e592385Swdenk		  are tried once without success.
2588a3d991bdSwdenk		  Useful on scripts which control the retry operation
2589a3d991bdSwdenk		  themselves.
2590a3d991bdSwdenk
259128cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2592ecb0ccd9SWolfgang Denk		  UDP source port.
2593ecb0ccd9SWolfgang Denk
259428cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
259528cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
259628cb9375SWolfgang Denk
2597a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2598a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2599a3d991bdSwdenk		  VLAN tagged frames.
2600c609719bSwdenk
2601c609719bSwdenkThe following environment variables may be used and automatically
2602c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2603c609719bSwdenkdepending the information provided by your boot server:
2604c609719bSwdenk
2605c609719bSwdenk  bootfile	- see above
2606c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2607fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2608c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2609c609719bSwdenk  hostname	- Target hostname
2610c609719bSwdenk  ipaddr	- see above
2611c609719bSwdenk  netmask	- Subnet Mask
2612c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2613c609719bSwdenk  serverip	- see above
2614c609719bSwdenk
2615c609719bSwdenk
2616c609719bSwdenkThere are two special Environment Variables:
2617c609719bSwdenk
2618c609719bSwdenk  serial#	- contains hardware identification information such
2619c609719bSwdenk		  as type string and/or serial number
2620c609719bSwdenk  ethaddr	- Ethernet address
2621c609719bSwdenk
2622c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2623c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2624c609719bSwdenkonce they have been set once.
2625c609719bSwdenk
2626c609719bSwdenk
2627c1551ea8SstroeseFurther special Environment Variables:
2628c1551ea8Sstroese
2629c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2630c1551ea8Sstroese		  with the "version" command. This variable is
2631c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2632c1551ea8Sstroese
2633c1551ea8Sstroese
2634c609719bSwdenkPlease note that changes to some configuration parameters may take
2635c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2636c609719bSwdenk
2637c609719bSwdenk
2638f07771ccSwdenkCommand Line Parsing:
2639f07771ccSwdenk=====================
2640f07771ccSwdenk
2641f07771ccSwdenkThere are two different command line parsers available with U-Boot:
26427152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2643f07771ccSwdenk
2644f07771ccSwdenkOld, simple command line parser:
2645f07771ccSwdenk--------------------------------
2646f07771ccSwdenk
2647f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2648f07771ccSwdenk- several commands on one line, separated by ';'
2649fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2650f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2651f07771ccSwdenk  for example:
2652fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2653f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2654f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2655f07771ccSwdenk
2656f07771ccSwdenkHush shell:
2657f07771ccSwdenk-----------
2658f07771ccSwdenk
2659f07771ccSwdenk- similar to Bourne shell, with control structures like
2660f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2661f07771ccSwdenk  until...do...done, ...
2662f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2663f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2664f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2665f07771ccSwdenk  command
2666f07771ccSwdenk
2667f07771ccSwdenkGeneral rules:
2668f07771ccSwdenk--------------
2669f07771ccSwdenk
2670f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2671f07771ccSwdenk    command) contains several commands separated by semicolon, and
2672f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2673f07771ccSwdenk    executed anyway.
2674f07771ccSwdenk
2675f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2676f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2677f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2678f07771ccSwdenk    variables are not executed.
2679f07771ccSwdenk
2680c609719bSwdenkNote for Redundant Ethernet Interfaces:
2681c609719bSwdenk=======================================
2682c609719bSwdenk
26837152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2684c609719bSwdenksuch configurations and is capable of automatic selection of a
26857152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2686c609719bSwdenk
2687c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2688c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2689c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2690c609719bSwdenk
2691c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2692c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2693c609719bSwdenkding setting in the environment; if the corresponding environment
2694c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2695c609719bSwdenk
2696c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2697c609719bSwdenk  environment, the SROM's address is used.
2698c609719bSwdenk
2699c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2700c609719bSwdenk  environment exists, then the value from the environment variable is
2701c609719bSwdenk  used.
2702c609719bSwdenk
2703c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2704c609719bSwdenk  both addresses are the same, this MAC address is used.
2705c609719bSwdenk
2706c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2707c609719bSwdenk  addresses differ, the value from the environment is used and a
2708c609719bSwdenk  warning is printed.
2709c609719bSwdenk
2710c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2711c609719bSwdenk  is raised.
2712c609719bSwdenk
2713c609719bSwdenk
2714c609719bSwdenkImage Formats:
2715c609719bSwdenk==============
2716c609719bSwdenk
2717c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2718c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2719c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2720c609719bSwdenkdefines the following image properties:
2721c609719bSwdenk
2722c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2723c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
27247f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
27251f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
2726*7b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
27273d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
2728*7b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2729c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2730c609719bSwdenk* Load Address
2731c609719bSwdenk* Entry Point
2732c609719bSwdenk* Image Name
2733c609719bSwdenk* Image Timestamp
2734c609719bSwdenk
2735c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2736c609719bSwdenkand the data portions of the image are secured against corruption by
2737c609719bSwdenkCRC32 checksums.
2738c609719bSwdenk
2739c609719bSwdenk
2740c609719bSwdenkLinux Support:
2741c609719bSwdenk==============
2742c609719bSwdenk
2743c609719bSwdenkAlthough U-Boot should support any OS or standalone application
27447152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2745c609719bSwdenkU-Boot.
2746c609719bSwdenk
2747c609719bSwdenkU-Boot includes many features that so far have been part of some
2748c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2749c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2750c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
27517152b1d0Swdenkserves several purposes:
2752c609719bSwdenk
2753c609719bSwdenk- the same features can be used for other OS or standalone
2754c609719bSwdenk  applications (for instance: using compressed images to reduce the
2755c609719bSwdenk  Flash memory footprint)
2756c609719bSwdenk
2757c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
27587152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2759c609719bSwdenk
2760c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2761c609719bSwdenk  images; of course this also means that different kernel images can
2762c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2763c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2764c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2765c609719bSwdenk  software is easier now.
2766c609719bSwdenk
2767c609719bSwdenk
2768c609719bSwdenkLinux HOWTO:
2769c609719bSwdenk============
2770c609719bSwdenk
2771c609719bSwdenkPorting Linux to U-Boot based systems:
2772c609719bSwdenk---------------------------------------
2773c609719bSwdenk
2774c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2775c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2776c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2777c609719bSwdenkLinux :-).
2778c609719bSwdenk
2779c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2780c609719bSwdenk
2781c609719bSwdenkJust make sure your machine specific header file (for instance
2782c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2783c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2784c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2785c609719bSwdenkU-Boot configuration in CFG_IMMR.
2786c609719bSwdenk
2787c609719bSwdenk
2788c609719bSwdenkConfiguring the Linux kernel:
2789c609719bSwdenk-----------------------------
2790c609719bSwdenk
2791c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2792c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2793c609719bSwdenk
2794c609719bSwdenk
2795c609719bSwdenkBuilding a Linux Image:
2796c609719bSwdenk-----------------------
2797c609719bSwdenk
279824ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
279924ee89b9Swdenknot used. If you use recent kernel source, a new build target
280024ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
280124ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
280224ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
280324ee89b9Swdenk100% compatible format.
2804c609719bSwdenk
2805c609719bSwdenkExample:
2806c609719bSwdenk
2807c609719bSwdenk	make TQM850L_config
2808c609719bSwdenk	make oldconfig
2809c609719bSwdenk	make dep
281024ee89b9Swdenk	make uImage
2811c609719bSwdenk
281224ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
281324ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
281424ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2815c609719bSwdenk
281624ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
281724ee89b9Swdenk
281824ee89b9Swdenk* convert the kernel into a raw binary image:
281924ee89b9Swdenk
282024ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
282124ee89b9Swdenk				 -R .note -R .comment \
282224ee89b9Swdenk				 -S vmlinux linux.bin
282324ee89b9Swdenk
282424ee89b9Swdenk* compress the binary image:
282524ee89b9Swdenk
282624ee89b9Swdenk	gzip -9 linux.bin
282724ee89b9Swdenk
282824ee89b9Swdenk* package compressed binary image for U-Boot:
282924ee89b9Swdenk
283024ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
283124ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
283224ee89b9Swdenk		-d linux.bin.gz uImage
283324ee89b9Swdenk
283424ee89b9Swdenk
283524ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
283624ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
283724ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
283824ee89b9Swdenkbyte header containing information about target architecture,
283924ee89b9Swdenkoperating system, image type, compression method, entry points, time
284024ee89b9Swdenkstamp, CRC32 checksums, etc.
284124ee89b9Swdenk
284224ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
284324ee89b9Swdenkprint the header information, or to build new images.
2844c609719bSwdenk
2845c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2846c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2847c609719bSwdenkchecksum verification:
2848c609719bSwdenk
2849c609719bSwdenk	tools/mkimage -l image
2850c609719bSwdenk	  -l ==> list image header information
2851c609719bSwdenk
2852c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2853c609719bSwdenkfrom a "data file" which is used as image payload:
2854c609719bSwdenk
2855c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2856c609719bSwdenk		      -n name -d data_file image
2857c609719bSwdenk	  -A ==> set architecture to 'arch'
2858c609719bSwdenk	  -O ==> set operating system to 'os'
2859c609719bSwdenk	  -T ==> set image type to 'type'
2860c609719bSwdenk	  -C ==> set compression type 'comp'
2861c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2862c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2863c609719bSwdenk	  -n ==> set image name to 'name'
2864c609719bSwdenk	  -d ==> use image data from 'datafile'
2865c609719bSwdenk
286669459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
286769459791Swdenkaddress (0x00000000), but the entry point address depends on the
286869459791Swdenkkernel version:
2869c609719bSwdenk
2870c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
287124ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2872c609719bSwdenk
2873c609719bSwdenkSo a typical call to build a U-Boot image would read:
2874c609719bSwdenk
287524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
287624ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
287724ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
287824ee89b9Swdenk	> examples/uImage.TQM850L
287924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2880c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2881c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2882c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2883c609719bSwdenk	Load Address: 0x00000000
288424ee89b9Swdenk	Entry Point:  0x00000000
2885c609719bSwdenk
2886c609719bSwdenkTo verify the contents of the image (or check for corruption):
2887c609719bSwdenk
288824ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
288924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2890c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2891c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2892c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2893c609719bSwdenk	Load Address: 0x00000000
289424ee89b9Swdenk	Entry Point:  0x00000000
2895c609719bSwdenk
2896c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
2897c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
2898c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
2899c609719bSwdenkneed to be uncompressed:
2900c609719bSwdenk
290124ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
290224ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
290324ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
290424ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
290524ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
290624ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2907c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2908c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
2909c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2910c609719bSwdenk	Load Address: 0x00000000
291124ee89b9Swdenk	Entry Point:  0x00000000
2912c609719bSwdenk
2913c609719bSwdenk
2914c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
2915c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
2916c609719bSwdenk
2917c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
2918c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
2919c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2920c609719bSwdenk	Image Name:   Simple Ramdisk Image
2921c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
2922c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2923c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2924c609719bSwdenk	Load Address: 0x00000000
2925c609719bSwdenk	Entry Point:  0x00000000
2926c609719bSwdenk
2927c609719bSwdenk
2928c609719bSwdenkInstalling a Linux Image:
2929c609719bSwdenk-------------------------
2930c609719bSwdenk
2931c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
2932c609719bSwdenkyou must convert the image to S-Record format:
2933c609719bSwdenk
2934c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
2935c609719bSwdenk
2936c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
2937c609719bSwdenkimage header, so the resulting S-Record file will be relative to
2938c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
2939c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
2940c609719bSwdenkcommand.
2941c609719bSwdenk
2942c609719bSwdenkExample: install the image to address 0x40100000 (which on the
2943c609719bSwdenkTQM8xxL is in the first Flash bank):
2944c609719bSwdenk
2945c609719bSwdenk	=> erase 40100000 401FFFFF
2946c609719bSwdenk
2947c609719bSwdenk	.......... done
2948c609719bSwdenk	Erased 8 sectors
2949c609719bSwdenk
2950c609719bSwdenk	=> loads 40100000
2951c609719bSwdenk	## Ready for S-Record download ...
2952c609719bSwdenk	~>examples/image.srec
2953c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2954c609719bSwdenk	...
2955c609719bSwdenk	15989 15990 15991 15992
2956c609719bSwdenk	[file transfer complete]
2957c609719bSwdenk	[connected]
2958c609719bSwdenk	## Start Addr = 0x00000000
2959c609719bSwdenk
2960c609719bSwdenk
2961c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
2962c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
2963c609719bSwdenkcorruption happened:
2964c609719bSwdenk
2965c609719bSwdenk	=> imi 40100000
2966c609719bSwdenk
2967c609719bSwdenk	## Checking Image at 40100000 ...
2968c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2969c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2970c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2971c609719bSwdenk	   Load Address: 00000000
2972c609719bSwdenk	   Entry Point:	 0000000c
2973c609719bSwdenk	   Verifying Checksum ... OK
2974c609719bSwdenk
2975c609719bSwdenk
2976c609719bSwdenkBoot Linux:
2977c609719bSwdenk-----------
2978c609719bSwdenk
2979c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
2980c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
2981c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
2982c609719bSwdenkparameters. You can check and modify this variable using the
2983c609719bSwdenk"printenv" and "setenv" commands:
2984c609719bSwdenk
2985c609719bSwdenk
2986c609719bSwdenk	=> printenv bootargs
2987c609719bSwdenk	bootargs=root=/dev/ram
2988c609719bSwdenk
2989c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2990c609719bSwdenk
2991c609719bSwdenk	=> printenv bootargs
2992c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
2993c609719bSwdenk
2994c609719bSwdenk	=> bootm 40020000
2995c609719bSwdenk	## Booting Linux kernel at 40020000 ...
2996c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
2997c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2998c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
2999c609719bSwdenk	   Load Address: 00000000
3000c609719bSwdenk	   Entry Point:	 0000000c
3001c609719bSwdenk	   Verifying Checksum ... OK
3002c609719bSwdenk	   Uncompressing Kernel Image ... OK
3003c609719bSwdenk	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
3004c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3005c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3006c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3007c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3008c609719bSwdenk	...
3009c609719bSwdenk
3010c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
30117152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3012c609719bSwdenkformat!) to the "bootm" command:
3013c609719bSwdenk
3014c609719bSwdenk	=> imi 40100000 40200000
3015c609719bSwdenk
3016c609719bSwdenk	## Checking Image at 40100000 ...
3017c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3018c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3019c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3020c609719bSwdenk	   Load Address: 00000000
3021c609719bSwdenk	   Entry Point:	 0000000c
3022c609719bSwdenk	   Verifying Checksum ... OK
3023c609719bSwdenk
3024c609719bSwdenk	## Checking Image at 40200000 ...
3025c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3026c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3027c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3028c609719bSwdenk	   Load Address: 00000000
3029c609719bSwdenk	   Entry Point:	 00000000
3030c609719bSwdenk	   Verifying Checksum ... OK
3031c609719bSwdenk
3032c609719bSwdenk	=> bootm 40100000 40200000
3033c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3034c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3035c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3036c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3037c609719bSwdenk	   Load Address: 00000000
3038c609719bSwdenk	   Entry Point:	 0000000c
3039c609719bSwdenk	   Verifying Checksum ... OK
3040c609719bSwdenk	   Uncompressing Kernel Image ... OK
3041c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3042c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3043c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3044c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3045c609719bSwdenk	   Load Address: 00000000
3046c609719bSwdenk	   Entry Point:	 00000000
3047c609719bSwdenk	   Verifying Checksum ... OK
3048c609719bSwdenk	   Loading Ramdisk ... OK
3049c609719bSwdenk	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
3050c609719bSwdenk	Boot arguments: root=/dev/ram
3051c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3052c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3053c609719bSwdenk	...
3054c609719bSwdenk	RAMDISK: Compressed image found at block 0
3055c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3056c609719bSwdenk
3057c609719bSwdenk	bash#
3058c609719bSwdenk
30596069ff26SwdenkMore About U-Boot Image Types:
30606069ff26Swdenk------------------------------
30616069ff26Swdenk
30626069ff26SwdenkU-Boot supports the following image types:
30636069ff26Swdenk
30646069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
30656069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
30666069ff26Swdenk	well) you can continue to work in U-Boot after return from
30676069ff26Swdenk	the Standalone Program.
30686069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
30696069ff26Swdenk	will take over control completely. Usually these programs
30706069ff26Swdenk	will install their own set of exception handlers, device
30716069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
30726069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
30736069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
30746069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
30756069ff26Swdenk	being started.
30766069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
30776069ff26Swdenk	(Linux) kernel image and one or more data images like
30786069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
30796069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
30806069ff26Swdenk	server provides just a single image file, but you want to get
30816069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
30826069ff26Swdenk
30836069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
30846069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
30856069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
30866069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
30876069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
30886069ff26Swdenk	a multiple of 4 bytes).
30896069ff26Swdenk
30906069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
30916069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
30926069ff26Swdenk	flash memory.
30936069ff26Swdenk
30946069ff26Swdenk   "Script files" are command sequences that will be executed by
30956069ff26Swdenk	U-Boot's command interpreter; this feature is especially
30966069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
30976069ff26Swdenk	as command interpreter.
30986069ff26Swdenk
3099c609719bSwdenk
3100c609719bSwdenkStandalone HOWTO:
3101c609719bSwdenk=================
3102c609719bSwdenk
3103c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3104c609719bSwdenkrun "standalone" applications, which can use some resources of
3105c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3106c609719bSwdenk
3107c609719bSwdenkTwo simple examples are included with the sources:
3108c609719bSwdenk
3109c609719bSwdenk"Hello World" Demo:
3110c609719bSwdenk-------------------
3111c609719bSwdenk
3112c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3113c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3114c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3115c609719bSwdenklike that:
3116c609719bSwdenk
3117c609719bSwdenk	=> loads
3118c609719bSwdenk	## Ready for S-Record download ...
3119c609719bSwdenk	~>examples/hello_world.srec
3120c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3121c609719bSwdenk	[file transfer complete]
3122c609719bSwdenk	[connected]
3123c609719bSwdenk	## Start Addr = 0x00040004
3124c609719bSwdenk
3125c609719bSwdenk	=> go 40004 Hello World! This is a test.
3126c609719bSwdenk	## Starting application at 0x00040004 ...
3127c609719bSwdenk	Hello World
3128c609719bSwdenk	argc = 7
3129c609719bSwdenk	argv[0] = "40004"
3130c609719bSwdenk	argv[1] = "Hello"
3131c609719bSwdenk	argv[2] = "World!"
3132c609719bSwdenk	argv[3] = "This"
3133c609719bSwdenk	argv[4] = "is"
3134c609719bSwdenk	argv[5] = "a"
3135c609719bSwdenk	argv[6] = "test."
3136c609719bSwdenk	argv[7] = "<NULL>"
3137c609719bSwdenk	Hit any key to exit ...
3138c609719bSwdenk
3139c609719bSwdenk	## Application terminated, rc = 0x0
3140c609719bSwdenk
3141c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3142c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3143c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3144c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3145c609719bSwdenkcharacter, but this is just a demo program. The application can be
3146c609719bSwdenkcontrolled by the following keys:
3147c609719bSwdenk
3148c609719bSwdenk	? - print current values og the CPM Timer registers
3149c609719bSwdenk	b - enable interrupts and start timer
3150c609719bSwdenk	e - stop timer and disable interrupts
3151c609719bSwdenk	q - quit application
3152c609719bSwdenk
3153c609719bSwdenk	=> loads
3154c609719bSwdenk	## Ready for S-Record download ...
3155c609719bSwdenk	~>examples/timer.srec
3156c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3157c609719bSwdenk	[file transfer complete]
3158c609719bSwdenk	[connected]
3159c609719bSwdenk	## Start Addr = 0x00040004
3160c609719bSwdenk
3161c609719bSwdenk	=> go 40004
3162c609719bSwdenk	## Starting application at 0x00040004 ...
3163c609719bSwdenk	TIMERS=0xfff00980
3164c609719bSwdenk	Using timer 1
3165c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3166c609719bSwdenk
3167c609719bSwdenkHit 'b':
3168c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3169c609719bSwdenk	Enabling timer
3170c609719bSwdenkHit '?':
3171c609719bSwdenk	[q, b, e, ?] ........
3172c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3173c609719bSwdenkHit '?':
3174c609719bSwdenk	[q, b, e, ?] .
3175c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3176c609719bSwdenkHit '?':
3177c609719bSwdenk	[q, b, e, ?] .
3178c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3179c609719bSwdenkHit '?':
3180c609719bSwdenk	[q, b, e, ?] .
3181c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3182c609719bSwdenkHit 'e':
3183c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3184c609719bSwdenkHit 'q':
3185c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3186c609719bSwdenk
3187c609719bSwdenk
318885ec0bccSwdenkMinicom warning:
318985ec0bccSwdenk================
319085ec0bccSwdenk
31917152b1d0SwdenkOver time, many people have reported problems when trying to use the
319285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
319385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3194f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
319585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
319685ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
319785ec0bccSwdenk
319852f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
319952f52c14Swdenkconfiguration to your "File transfer protocols" section:
320052f52c14Swdenk
320152f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
320252f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
320352f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
320452f52c14Swdenk
320552f52c14Swdenk
3206c609719bSwdenkNetBSD Notes:
3207c609719bSwdenk=============
3208c609719bSwdenk
3209c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3210c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3211c609719bSwdenk
3212c609719bSwdenkBuilding requires a cross environment; it is known to work on
3213c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3214c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3215c609719bSwdenkNote that the cross-powerpc package does not install include files;
3216c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3217c609719bSwdenkmissing.  This file has to be installed and patched manually:
3218c609719bSwdenk
3219c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3220c609719bSwdenk	# mkdir powerpc
3221c609719bSwdenk	# ln -s powerpc machine
3222c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3223c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3224c609719bSwdenk
3225c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3226c609719bSwdenkand U-Boot include files.
3227c609719bSwdenk
3228c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3229c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3230c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3231c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
32322a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3233c609719bSwdenk
3234c609719bSwdenk
3235c609719bSwdenkImplementation Internals:
3236c609719bSwdenk=========================
3237c609719bSwdenk
3238c609719bSwdenkThe following is not intended to be a complete description of every
3239c609719bSwdenkimplementation detail. However, it should help to understand the
3240c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3241c609719bSwdenkhardware.
3242c609719bSwdenk
3243c609719bSwdenk
3244c609719bSwdenkInitial Stack, Global Data:
3245c609719bSwdenk---------------------------
3246c609719bSwdenk
3247c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3248c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3249c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3250c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3251c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3252c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3253c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3254c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3255c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3256c609719bSwdenklocked as (mis-) used as memory, etc.
3257c609719bSwdenk
32587152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
325943d9616cSwdenk	u-boot-users mailing list:
326043d9616cSwdenk
326143d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
326243d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
326343d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
326443d9616cSwdenk	...
326543d9616cSwdenk
326643d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
326743d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
326843d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
326943d9616cSwdenk	is that the cache is being used as a temporary supply of
327043d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
327143d9616cSwdenk	beyond the scope of this list to expain the details, but you
327243d9616cSwdenk	can see how this works by studying the cache architecture and
327343d9616cSwdenk	operation in the architecture and processor-specific manuals.
327443d9616cSwdenk
327543d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
327643d9616cSwdenk	is another option for the system designer to use as an
327743d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
327843d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
327943d9616cSwdenk	board designers haven't used it for something that would
328043d9616cSwdenk	cause you grief during the initial boot! It is frequently not
328143d9616cSwdenk	used.
328243d9616cSwdenk
328343d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
328443d9616cSwdenk	with your processor/board/system design. The default value
328543d9616cSwdenk	you will find in any recent u-boot distribution in
32868a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
328743d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
328843d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
328943d9616cSwdenk	that are supposed to respond to that address! That code in
329043d9616cSwdenk	start.S has been around a while and should work as is when
329143d9616cSwdenk	you get the config right.
329243d9616cSwdenk
329343d9616cSwdenk	-Chris Hallinan
329443d9616cSwdenk	DS4.COM, Inc.
329543d9616cSwdenk
3296c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3297c609719bSwdenkcode for the initialization procedures:
3298c609719bSwdenk
3299c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3300c609719bSwdenk  to write it.
3301c609719bSwdenk
3302c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3303c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
33047152b1d0Swdenk  zation is performed later (when relocating to RAM).
3305c609719bSwdenk
3306c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3307c609719bSwdenk  that.
3308c609719bSwdenk
3309c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3310c609719bSwdenknormal global data to share information beween the code. But it
3311c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3312c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3313c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3314c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3315c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3316c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3317c609719bSwdenkreserve for this purpose.
3318c609719bSwdenk
33197152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3320c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3321c609719bSwdenkGCC's implementation.
3322c609719bSwdenk
3323c609719bSwdenkFor PowerPC, the following registers have specific use:
3324c609719bSwdenk	R1:	stack pointer
3325c609719bSwdenk	R2:	TOC pointer
3326c609719bSwdenk	R3-R4:	parameter passing and return values
3327c609719bSwdenk	R5-R10: parameter passing
3328c609719bSwdenk	R13:	small data area pointer
3329c609719bSwdenk	R30:	GOT pointer
3330c609719bSwdenk	R31:	frame pointer
3331c609719bSwdenk
3332c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3333c609719bSwdenk
3334c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3335c609719bSwdenk
3336c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3337c609719bSwdenk    address of the global data structure is known at compile time),
3338c609719bSwdenk    but it turned out that reserving a register results in somewhat
3339c609719bSwdenk    smaller code - although the code savings are not that big (on
3340c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3341c609719bSwdenk    624 text + 127 data).
3342c609719bSwdenk
3343c609719bSwdenkOn ARM, the following registers are used:
3344c609719bSwdenk
3345c609719bSwdenk	R0:	function argument word/integer result
3346c609719bSwdenk	R1-R3:	function argument word
3347c609719bSwdenk	R9:	GOT pointer
3348c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3349c609719bSwdenk	R11:	argument (frame) pointer
3350c609719bSwdenk	R12:	temporary workspace
3351c609719bSwdenk	R13:	stack pointer
3352c609719bSwdenk	R14:	link register
3353c609719bSwdenk	R15:	program counter
3354c609719bSwdenk
3355c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3356c609719bSwdenk
3357d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3358d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3359c609719bSwdenk
3360c609719bSwdenkMemory Management:
3361c609719bSwdenk------------------
3362c609719bSwdenk
3363c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3364c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3365c609719bSwdenk
3366c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3367c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3368c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3369c609719bSwdenkphysical memory banks.
3370c609719bSwdenk
3371c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3372c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3373c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3374c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3375c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3376c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3377c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3378c609719bSwdenk
3379c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3380c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3381c609719bSwdenk
3382c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3383c609719bSwdenkthis:
3384c609719bSwdenk
3385c609719bSwdenk	0x0000 0000	Exception Vector code
3386c609719bSwdenk	      :
3387c609719bSwdenk	0x0000 1FFF
3388c609719bSwdenk	0x0000 2000	Free for Application Use
3389c609719bSwdenk	      :
3390c609719bSwdenk	      :
3391c609719bSwdenk
3392c609719bSwdenk	      :
3393c609719bSwdenk	      :
3394c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3395c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3396c609719bSwdenk	0x00FC 0000	Malloc Arena
3397c609719bSwdenk	      :
3398c609719bSwdenk	0x00FD FFFF
3399c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3400c609719bSwdenk	...		eventually: LCD or video framebuffer
3401c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3402c609719bSwdenk	0x00FF FFFF	[End of RAM]
3403c609719bSwdenk
3404c609719bSwdenk
3405c609719bSwdenkSystem Initialization:
3406c609719bSwdenk----------------------
3407c609719bSwdenk
3408c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3409c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3410c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
34117152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3412c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3413c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3414c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3415c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3416c609719bSwdenkthe caches and the SIU.
3417c609719bSwdenk
3418c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3419c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3420c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3421c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3422c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3423c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3424c609719bSwdenkbanks.
3425c609719bSwdenk
3426c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
34277152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3428c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3429c609719bSwdenk0x00000000, with any additional banks following immediately to create
3430c609719bSwdenkcontiguous memory starting from 0.
3431c609719bSwdenk
3432c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3433c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3434c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3435c609719bSwdenkpages, and the final stack is set up.
3436c609719bSwdenk
3437c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3438c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3439c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3440c609719bSwdenknew address in RAM.
3441c609719bSwdenk
3442c609719bSwdenk
3443c609719bSwdenkU-Boot Porting Guide:
3444c609719bSwdenk----------------------
3445c609719bSwdenk
3446c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
34476aff3115Swdenklist, October 2002]
3448c609719bSwdenk
3449c609719bSwdenk
3450c609719bSwdenkint main (int argc, char *argv[])
3451c609719bSwdenk{
3452c609719bSwdenk	sighandler_t no_more_time;
3453c609719bSwdenk
3454c609719bSwdenk	signal (SIGALRM, no_more_time);
3455c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3456c609719bSwdenk
3457c609719bSwdenk	if (available_money > available_manpower) {
3458c609719bSwdenk		pay consultant to port U-Boot;
3459c609719bSwdenk		return 0;
3460c609719bSwdenk	}
3461c609719bSwdenk
3462c609719bSwdenk	Download latest U-Boot source;
3463c609719bSwdenk
34646aff3115Swdenk	Subscribe to u-boot-users mailing list;
34656aff3115Swdenk
3466c609719bSwdenk	if (clueless) {
3467c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3468c609719bSwdenk	}
3469c609719bSwdenk
3470c609719bSwdenk	while (learning) {
3471c609719bSwdenk		Read the README file in the top level directory;
34727cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3473c609719bSwdenk		Read the source, Luke;
3474c609719bSwdenk	}
3475c609719bSwdenk
3476c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3477c609719bSwdenk		Buy a BDI2000;
3478c609719bSwdenk	} else {
3479c609719bSwdenk		Add a lot of aggravation and time;
3480c609719bSwdenk	}
3481c609719bSwdenk
3482c609719bSwdenk	Create your own board support subdirectory;
3483c609719bSwdenk
34846aff3115Swdenk	Create your own board config file;
34856aff3115Swdenk
3486c609719bSwdenk	while (!running) {
3487c609719bSwdenk		do {
3488c609719bSwdenk			Add / modify source code;
3489c609719bSwdenk		} until (compiles);
3490c609719bSwdenk		Debug;
3491c609719bSwdenk		if (clueless)
3492c609719bSwdenk			email ("Hi, I am having problems...");
3493c609719bSwdenk	}
3494c609719bSwdenk	Send patch file to Wolfgang;
3495c609719bSwdenk
3496c609719bSwdenk	return 0;
3497c609719bSwdenk}
3498c609719bSwdenk
3499c609719bSwdenkvoid no_more_time (int sig)
3500c609719bSwdenk{
3501c609719bSwdenk      hire_a_guru();
3502c609719bSwdenk}
3503c609719bSwdenk
3504c609719bSwdenk
3505c609719bSwdenkCoding Standards:
3506c609719bSwdenk-----------------
3507c609719bSwdenk
3508c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
35092c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
35102c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
35112c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
35122c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3513c609719bSwdenk
35142c051651SDetlev ZundelSource files originating from a different project (for example the
35152c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
35162c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
35172c051651SDetlev Zundelsources.
35182c051651SDetlev Zundel
35192c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
35202c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
35212c051651SDetlev Zundelin your code.
3522c609719bSwdenk
3523c178d3daSwdenkPlease also stick to the following formatting rules:
3524180d3f74Swdenk- remove any trailing white space
3525180d3f74Swdenk- use TAB characters for indentation, not spaces
3526180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3527180d3f74Swdenk- do not add more than 2 empty lines to source files
3528180d3f74Swdenk- do not add trailing empty lines to source files
3529180d3f74Swdenk
3530c609719bSwdenkSubmissions which do not conform to the standards may be returned
3531c609719bSwdenkwith a request to reformat the changes.
3532c609719bSwdenk
3533c609719bSwdenk
3534c609719bSwdenkSubmitting Patches:
3535c609719bSwdenk-------------------
3536c609719bSwdenk
3537c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3538c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3539c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3540c609719bSwdenk
354190dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3542c609719bSwdenk
3543c609719bSwdenkWhen you send a patch, please include the following information with
3544c609719bSwdenkit:
3545c609719bSwdenk
3546c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3547c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3548c609719bSwdenk  patch actually fixes something.
3549c609719bSwdenk
3550c609719bSwdenk* For new features: a description of the feature and your
3551c609719bSwdenk  implementation.
3552c609719bSwdenk
3553c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3554c609719bSwdenk
3555c609719bSwdenk* For major contributions, your entry to the CREDITS file
3556c609719bSwdenk
3557c609719bSwdenk* When you add support for a new board, don't forget to add this
3558c609719bSwdenk  board to the MAKEALL script, too.
3559c609719bSwdenk
3560c609719bSwdenk* If your patch adds new configuration options, don't forget to
3561c609719bSwdenk  document these in the README file.
3562c609719bSwdenk
3563c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3564c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3565c609719bSwdenk  version of diff does not support these options, then get the latest
3566c609719bSwdenk  version of GNU diff.
3567c609719bSwdenk
35686dff5529Swdenk  The current directory when running this command shall be the top
35696dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
35706dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
35716dff5529Swdenk  directory information for the affected files).
35726dff5529Swdenk
3573c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3574c609719bSwdenk  gzipped text.
3575c609719bSwdenk
357652f52c14Swdenk* If one logical set of modifications affects or creates several
357752f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
357852f52c14Swdenk
357952f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
358052f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
358152f52c14Swdenk
358252f52c14Swdenk
3583c609719bSwdenkNotes:
3584c609719bSwdenk
3585c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3586c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3587c609719bSwdenk  for any of the boards.
3588c609719bSwdenk
3589c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3590c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3591c609719bSwdenk  returned with a request to re-formatting / split it.
3592c609719bSwdenk
3593c609719bSwdenk* If you modify existing code, make sure that your new code does not
3594c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3595c609719bSwdenk  When adding new features, these should compile conditionally only
3596c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3597c609719bSwdenk  disabled must not need more memory than the old code without your
3598c609719bSwdenk  modification.
359990dc6704Swdenk
360090dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
360190dc6704Swdenk  u-boot-users mailing list. Compression may help.
3602