xref: /openbmc/u-boot/README (revision 6ccec4492e77428fd6eafd3dfe94fbdf08e91d37)
1c609719bSwdenk#
2151ab83aSwdenk# (C) Copyright 2000 - 2005
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5c609719bSwdenk# See file CREDITS for list of people who contributed to this
6c609719bSwdenk# project.
7c609719bSwdenk#
8c609719bSwdenk# This program is free software; you can redistribute it and/or
9c609719bSwdenk# modify it under the terms of the GNU General Public License as
10c609719bSwdenk# published by the Free Software Foundation; either version 2 of
11c609719bSwdenk# the License, or (at your option) any later version.
12c609719bSwdenk#
13c609719bSwdenk# This program is distributed in the hope that it will be useful,
14c609719bSwdenk# but WITHOUT ANY WARRANTY; without even the implied warranty of
15c609719bSwdenk# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
16c609719bSwdenk# GNU General Public License for more details.
17c609719bSwdenk#
18c609719bSwdenk# You should have received a copy of the GNU General Public License
19c609719bSwdenk# along with this program; if not, write to the Free Software
20c609719bSwdenk# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21c609719bSwdenk# MA 02111-1307 USA
22c609719bSwdenk#
23c609719bSwdenk
24c609719bSwdenkSummary:
25c609719bSwdenk========
26c609719bSwdenk
2724ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
28e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
29e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
30e86e5a07Swdenkinitialize and test the hardware or to download and run application
31e86e5a07Swdenkcode.
32c609719bSwdenk
33c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
3424ee89b9Swdenkthe source code originate in the Linux source tree, we have some
3524ee89b9Swdenkheader files in common, and special provision has been made to
36c609719bSwdenksupport booting of Linux images.
37c609719bSwdenk
38c609719bSwdenkSome attention has been paid to make this software easily
39c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
40c609719bSwdenkimplemented with the same call interface, so that it's very easy to
41c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
42c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
43c609719bSwdenkload and run it dynamically.
44c609719bSwdenk
45c609719bSwdenk
46c609719bSwdenkStatus:
47c609719bSwdenk=======
48c609719bSwdenk
49c609719bSwdenkIn general, all boards for which a configuration option exists in the
50c609719bSwdenkMakefile have been tested to some extent and can be considered
51c609719bSwdenk"working". In fact, many of them are used in production systems.
52c609719bSwdenk
53c609719bSwdenkIn case of problems see the CHANGELOG and CREDITS files to find out
54c609719bSwdenkwho contributed the specific port.
55c609719bSwdenk
56c609719bSwdenk
57c609719bSwdenkWhere to get help:
58c609719bSwdenk==================
59c609719bSwdenk
60c609719bSwdenkIn case you have questions about, problems with or contributions for
61c609719bSwdenkU-Boot you should send a message to the U-Boot mailing list at
62c609719bSwdenk<u-boot-users@lists.sourceforge.net>. There is also an archive of
63c609719bSwdenkprevious traffic on the mailing list - please search the archive
64c609719bSwdenkbefore asking FAQ's. Please see
65c609719bSwdenkhttp://lists.sourceforge.net/lists/listinfo/u-boot-users/
66c609719bSwdenk
67c609719bSwdenk
68c609719bSwdenkWhere we come from:
69c609719bSwdenk===================
70c609719bSwdenk
71c609719bSwdenk- start from 8xxrom sources
7224ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
73c609719bSwdenk- clean up code
74c609719bSwdenk- make it easier to add custom boards
75c609719bSwdenk- make it possible to add other [PowerPC] CPUs
76c609719bSwdenk- extend functions, especially:
77c609719bSwdenk  * Provide extended interface to Linux boot loader
78c609719bSwdenk  * S-Record download
79c609719bSwdenk  * network boot
80c609719bSwdenk  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
8124ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
82c609719bSwdenk- add other CPU families (starting with ARM)
8324ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
8424ee89b9Swdenk
8524ee89b9Swdenk
8624ee89b9SwdenkNames and Spelling:
8724ee89b9Swdenk===================
8824ee89b9Swdenk
8924ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9024ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
9124ee89b9Swdenkin source files etc.). Example:
9224ee89b9Swdenk
9324ee89b9Swdenk	This is the README file for the U-Boot project.
9424ee89b9Swdenk
9524ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
9624ee89b9Swdenk
9724ee89b9Swdenk	include/asm-ppc/u-boot.h
9824ee89b9Swdenk
9924ee89b9Swdenk	#include <asm/u-boot.h>
10024ee89b9Swdenk
10124ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
10224ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
10324ee89b9Swdenk
10424ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
10524ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
106c609719bSwdenk
107c609719bSwdenk
10893f19cc0SwdenkVersioning:
10993f19cc0Swdenk===========
11093f19cc0Swdenk
11193f19cc0SwdenkU-Boot uses a 3 level version number containing a version, a
11293f19cc0Swdenksub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
11393f19cc0Swdenksub-version "34", and patchlevel "4".
11493f19cc0Swdenk
11593f19cc0SwdenkThe patchlevel is used to indicate certain stages of development
11693f19cc0Swdenkbetween released versions, i. e. officially released versions of
11793f19cc0SwdenkU-Boot will always have a patchlevel of "0".
11893f19cc0Swdenk
11993f19cc0Swdenk
120c609719bSwdenkDirectory Hierarchy:
121c609719bSwdenk====================
122c609719bSwdenk
1237152b1d0Swdenk- board		Board dependent files
1247152b1d0Swdenk- common	Misc architecture independent functions
125c609719bSwdenk- cpu		CPU specific files
126983fda83Swdenk  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
12711dadd54Swdenk  - arm720t	Files specific to ARM 720 CPUs
12811dadd54Swdenk  - arm920t	Files specific to ARM 920 CPUs
129a85f9f21Swdenk    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
130983fda83Swdenk    - imx	Files specific to Freescale MC9328 i.MX CPUs
1311d9f4105Swdenk    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
13211dadd54Swdenk  - arm925t	Files specific to ARM 925 CPUs
13311dadd54Swdenk  - arm926ejs	Files specific to ARM 926 CPUs
1348ed96046Swdenk  - arm1136	Files specific to ARM 1136 CPUs
13572a087e0SWolfgang Denk  - at32ap	Files specific to Atmel AVR32 AP CPUs
13611dadd54Swdenk  - i386	Files specific to i386 CPUs
13711dadd54Swdenk  - ixp		Files specific to Intel XScale IXP CPUs
138983fda83Swdenk  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
13911dadd54Swdenk  - mips	Files specific to MIPS CPUs
140983fda83Swdenk  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
141983fda83Swdenk  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
142983fda83Swdenk  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
143983fda83Swdenk  - mpc8220	Files specific to Freescale MPC8220 CPUs
144983fda83Swdenk  - mpc824x	Files specific to Freescale MPC824x CPUs
145983fda83Swdenk  - mpc8260	Files specific to Freescale MPC8260 CPUs
146983fda83Swdenk  - mpc85xx	Files specific to Freescale MPC85xx CPUs
14711dadd54Swdenk  - nios	Files specific to Altera NIOS CPUs
1485c952cf0Swdenk  - nios2	Files specific to Altera Nios-II CPUs
1490c8721a4SWolfgang Denk  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
15011dadd54Swdenk  - pxa		Files specific to Intel XScale PXA CPUs
15111dadd54Swdenk  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
15211dadd54Swdenk  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
153c609719bSwdenk- disk		Code for disk drive partition handling
154c609719bSwdenk- doc		Documentation (don't expect too much)
1557152b1d0Swdenk- drivers	Commonly used device drivers
156c609719bSwdenk- dtt		Digital Thermometer and Thermostat drivers
157c609719bSwdenk- examples	Example code for standalone applications, etc.
158c609719bSwdenk- include	Header Files
15911dadd54Swdenk- lib_arm	Files generic to ARM	 architecture
1607b64fef3SWolfgang Denk- lib_avr32	Files generic to AVR32	 architecture
16111dadd54Swdenk- lib_generic	Files generic to all	 architectures
16211dadd54Swdenk- lib_i386	Files generic to i386	 architecture
16311dadd54Swdenk- lib_m68k	Files generic to m68k	 architecture
16411dadd54Swdenk- lib_mips	Files generic to MIPS	 architecture
16511dadd54Swdenk- lib_nios	Files generic to NIOS	 architecture
16611dadd54Swdenk- lib_ppc	Files generic to PowerPC architecture
167c609719bSwdenk- net		Networking code
168c609719bSwdenk- post		Power On Self Test
169c609719bSwdenk- rtc		Real Time Clock drivers
170c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
171c609719bSwdenk
172c609719bSwdenkSoftware Configuration:
173c609719bSwdenk=======================
174c609719bSwdenk
175c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
176c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
177c609719bSwdenk
178c609719bSwdenkThere are two classes of configuration variables:
179c609719bSwdenk
180c609719bSwdenk* Configuration _OPTIONS_:
181c609719bSwdenk  These are selectable by the user and have names beginning with
182c609719bSwdenk  "CONFIG_".
183c609719bSwdenk
184c609719bSwdenk* Configuration _SETTINGS_:
185c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
186c609719bSwdenk  you don't know what you're doing; they have names beginning with
187c609719bSwdenk  "CFG_".
188c609719bSwdenk
189c609719bSwdenkLater we will add a configuration tool - probably similar to or even
190c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
191c609719bSwdenkdo the configuration by hand, which means creating some symbolic
192c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
193c609719bSwdenkas an example here.
194c609719bSwdenk
195c609719bSwdenk
196c609719bSwdenkSelection of Processor Architecture and Board Type:
197c609719bSwdenk---------------------------------------------------
198c609719bSwdenk
199c609719bSwdenkFor all supported boards there are ready-to-use default
200c609719bSwdenkconfigurations available; just type "make <board_name>_config".
201c609719bSwdenk
202c609719bSwdenkExample: For a TQM823L module type:
203c609719bSwdenk
204c609719bSwdenk	cd u-boot
205c609719bSwdenk	make TQM823L_config
206c609719bSwdenk
207c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
208c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
209c609719bSwdenkdirectory according to the instructions in cogent/README.
210c609719bSwdenk
211c609719bSwdenk
212c609719bSwdenkConfiguration Options:
213c609719bSwdenk----------------------
214c609719bSwdenk
215c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
216c609719bSwdenksuch information is kept in a configuration file
217c609719bSwdenk"include/configs/<board_name>.h".
218c609719bSwdenk
219c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
220c609719bSwdenk"include/configs/TQM823L.h".
221c609719bSwdenk
222c609719bSwdenk
2237f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2247f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2257f6c2cbcSwdenkbuild a config tool - later.
2267f6c2cbcSwdenk
2277f6c2cbcSwdenk
228c609719bSwdenkThe following options need to be configured:
229c609719bSwdenk
230c609719bSwdenk- CPU Type:	Define exactly one of
231c609719bSwdenk
232c609719bSwdenk		PowerPC based CPUs:
233c609719bSwdenk		-------------------
234c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2350db5bca8Swdenk	or	CONFIG_MPC5xx
236983fda83Swdenk	or	CONFIG_MPC8220
237c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23842d1f039Swdenk	or	CONFIG_MPC85xx
239c609719bSwdenk	or	CONFIG_IOP480
240c609719bSwdenk	or	CONFIG_405GP
24112f34241Swdenk	or	CONFIG_405EP
242c609719bSwdenk	or	CONFIG_440
243c609719bSwdenk	or	CONFIG_MPC74xx
24472755c71Swdenk	or	CONFIG_750FX
245c609719bSwdenk
246c609719bSwdenk		ARM based CPUs:
247c609719bSwdenk		---------------
248c609719bSwdenk		CONFIG_SA1110
249c609719bSwdenk		CONFIG_ARM7
250c609719bSwdenk		CONFIG_PXA250
2510b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
252c609719bSwdenk
253507bbe3eSwdenk		MicroBlaze based CPUs:
254507bbe3eSwdenk		----------------------
255857cad37Swdenk		CONFIG_MICROBLAZE
256507bbe3eSwdenk
2575c952cf0Swdenk		Nios-2 based CPUs:
2585c952cf0Swdenk		----------------------
2595c952cf0Swdenk		CONFIG_NIOS2
2605c952cf0Swdenk
26172a087e0SWolfgang Denk		AVR32 based CPUs:
26272a087e0SWolfgang Denk		----------------------
26372a087e0SWolfgang Denk		CONFIG_AT32AP
264c609719bSwdenk
265c609719bSwdenk- Board Type:	Define exactly one of
266c609719bSwdenk
267c609719bSwdenk		PowerPC based boards:
268c609719bSwdenk		---------------------
269c609719bSwdenk
27076544f80SDetlev Zundel		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
27176544f80SDetlev Zundel		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
27276544f80SDetlev Zundel		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
27376544f80SDetlev Zundel		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
27476544f80SDetlev Zundel		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
27576544f80SDetlev Zundel		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
27676544f80SDetlev Zundel		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
27709e4b0c5SWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
27809e4b0c5SWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
27909e4b0c5SWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
28009e4b0c5SWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
28109e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
28209e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
28309e4b0c5SWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
28409e4b0c5SWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
28509e4b0c5SWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
28609e4b0c5SWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
28709e4b0c5SWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
28809e4b0c5SWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
28909e4b0c5SWolfgang Denk		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
29009e4b0c5SWolfgang Denk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
29109e4b0c5SWolfgang Denk		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
29209e4b0c5SWolfgang Denk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
29309e4b0c5SWolfgang Denk		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
29409e4b0c5SWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
29509e4b0c5SWolfgang Denk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
29609e4b0c5SWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
29709e4b0c5SWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
29809e4b0c5SWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
29909e4b0c5SWolfgang Denk		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
30009e4b0c5SWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
30109e4b0c5SWolfgang Denk		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
30209e4b0c5SWolfgang Denk		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
30309e4b0c5SWolfgang Denk		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
30409e4b0c5SWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
30509e4b0c5SWolfgang Denk		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
30609e4b0c5SWolfgang Denk		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
30709e4b0c5SWolfgang Denk		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
308c609719bSwdenk
309c609719bSwdenk		ARM based boards:
310c609719bSwdenk		-----------------
311c609719bSwdenk
312c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
3130b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
3140b953ffcSMarkus Klotzbuecher		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
3150b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
3160b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
3170b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
3185720df78SHeiko Schocher		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
3195720df78SHeiko Schocher		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
3205720df78SHeiko Schocher		CONFIG_VCMA9
321c609719bSwdenk
322507bbe3eSwdenk		MicroBlaze based boards:
323507bbe3eSwdenk		------------------------
324507bbe3eSwdenk
325507bbe3eSwdenk		CONFIG_SUZAKU
326507bbe3eSwdenk
3275c952cf0Swdenk		Nios-2 based boards:
3285c952cf0Swdenk		------------------------
3295c952cf0Swdenk
3305c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3319cc83378SScott McNutt		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
3325c952cf0Swdenk
333*6ccec449SWolfgang Denk		AVR32 based boards:
334*6ccec449SWolfgang Denk		-------------------
335*6ccec449SWolfgang Denk
336*6ccec449SWolfgang Denk		CONFIG_ATSTK1000
337*6ccec449SWolfgang Denk
338*6ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
339*6ccec449SWolfgang Denk		Define exactly one of
340*6ccec449SWolfgang Denk		CONFIG_ATSTK1002
341*6ccec449SWolfgang Denk
342c609719bSwdenk
343c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
344c609719bSwdenk		Define exactly one of
345c609719bSwdenk		CONFIG_CMA286_60_OLD
346c609719bSwdenk--- FIXME --- not tested yet:
347c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
348c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
349c609719bSwdenk
350c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
351c609719bSwdenk		Define exactly one of
352c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
353c609719bSwdenk
354c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
355c609719bSwdenk		Define one or more of
356c609719bSwdenk		CONFIG_CMA302
357c609719bSwdenk
358c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
359c609719bSwdenk		Define one or more of
360c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
361c609719bSwdenk					  the lcd display every second with
362c609719bSwdenk					  a "rotator" |\-/|\-/
363c609719bSwdenk
3642535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3652535d602Swdenk		CONFIG_ADSTYPE
3662535d602Swdenk		Possible values are:
3672535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
368180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
36954387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
37004a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3712535d602Swdenk
372c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
373c609719bSwdenk		Define exactly one of
374c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
375c609719bSwdenk
37675d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
37766ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
37866ca92a5Swdenk					  get_gclk_freq() cannot work
3795da627a4Swdenk					  e.g. if there is no 32KHz
3805da627a4Swdenk					  reference PIT/RTC clock
38166ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
38266ca92a5Swdenk					  or XTAL/EXTAL)
383c609719bSwdenk
38466ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
38566ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
38666ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
38766ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
38875d1ea7fSwdenk			See doc/README.MPC866
38975d1ea7fSwdenk
39075d1ea7fSwdenk		CFG_MEASURE_CPUCLK
39175d1ea7fSwdenk
39275d1ea7fSwdenk		Define this to measure the actual CPU clock instead
39375d1ea7fSwdenk		of relying on the correctness of the configured
39475d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
39575d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
39675d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
39766ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
39875d1ea7fSwdenk
3990b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4000b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
4010b953ffcSMarkus Klotzbuecher
4020b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4030b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4040b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4050b953ffcSMarkus Klotzbuecher
4060b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
4070b953ffcSMarkus Klotzbuecher
4080b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4090b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4100b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4110b953ffcSMarkus Klotzbuecher		by this value.
4120b953ffcSMarkus Klotzbuecher
4135da627a4Swdenk- Linux Kernel Interface:
414c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
415c609719bSwdenk
416c609719bSwdenk		U-Boot stores all clock information in Hz
417c609719bSwdenk		internally. For binary compatibility with older Linux
418c609719bSwdenk		kernels (which expect the clocks passed in the
419c609719bSwdenk		bd_info data to be in MHz) the environment variable
420c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
421c609719bSwdenk		converts clock data to MHZ before passing it to the
422c609719bSwdenk		Linux kernel.
423c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
424c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
425c609719bSwdenk		default environment.
426c609719bSwdenk
4275da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4285da627a4Swdenk
4295da627a4Swdenk		When transfering memsize parameter to linux, some versions
4305da627a4Swdenk		expect it to be in bytes, others in MB.
4315da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4325da627a4Swdenk
433f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE
434f57f70aaSWolfgang Denk
435f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
436f57f70aaSWolfgang Denk		passed using flat open firmware trees.
437f57f70aaSWolfgang Denk		The environment variable "disable_of", when set, disables this
438f57f70aaSWolfgang Denk		functionality.
439f57f70aaSWolfgang Denk
440f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
441f57f70aaSWolfgang Denk
442f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
443f57f70aaSWolfgang Denk
444f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
445c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
446f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
447c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
448f57f70aaSWolfgang Denk
449e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
450e4f880edSKumar Gala
451e4f880edSKumar Gala		The resulting flat device tree will have a copy of the bd_t.
452e4f880edSKumar Gala		Space should be pre-allocated in the dts for the bd_t.
453e4f880edSKumar Gala
454e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
455e4f880edSKumar Gala
456e4f880edSKumar Gala		The resulting flat device tree will have a copy of u-boot's
457e4f880edSKumar Gala		environment variables
458e4f880edSKumar Gala
4594e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4604e253137SKumar Gala
4614e253137SKumar Gala		Board code has addition modification that it wants to make
4624e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4636705d81eSwdenk
4646705d81eSwdenk- Serial Ports:
4656705d81eSwdenk		CFG_PL010_SERIAL
4666705d81eSwdenk
4676705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4686705d81eSwdenk
4696705d81eSwdenk		CFG_PL011_SERIAL
4706705d81eSwdenk
471c609719bSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
472c609719bSwdenk
473c609719bSwdenk		CONFIG_PL011_CLOCK
474c609719bSwdenk
475c609719bSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
476c609719bSwdenk		the clock speed of the UARTs.
477c609719bSwdenk
478c609719bSwdenk		CONFIG_PL01x_PORTS
479c609719bSwdenk
480c609719bSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
481c609719bSwdenk		define this to a list of base addresses for each (supported)
482c609719bSwdenk		port. See e.g. include/configs/versatile.h
483c609719bSwdenk
484c609719bSwdenk
485c609719bSwdenk- Console Interface:
486c609719bSwdenk		Depending on board, define exactly one serial port
487c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
488c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
489c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
490c609719bSwdenk
491c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
492c609719bSwdenk		port routines must be defined elsewhere
493c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
494c609719bSwdenk
495c609719bSwdenk		CONFIG_CFB_CONSOLE
496c609719bSwdenk		Enables console device for a color framebuffer. Needs following
497c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
498c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
499c609719bSwdenk						(default big endian)
500c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
501c609719bSwdenk						rectangle fill
502c609719bSwdenk						(cf. smiLynxEM)
503c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
504c609719bSwdenk						bit-blit (cf. smiLynxEM)
505c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
506c609719bSwdenk						(cols=pitch)
507c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
508c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
509c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
510c609719bSwdenk						(0-5, cf. cfb_console.c)
511c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
512c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
513a6c7ad2fSwdenk						(i.e. i8042_kbd_init())
514a6c7ad2fSwdenk			VIDEO_TSTC_FCT		test char fct
515a6c7ad2fSwdenk						(i.e. i8042_tstc)
516c609719bSwdenk			VIDEO_GETC_FCT		get char fct
517c609719bSwdenk						(i.e. i8042_getc)
518c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
519c609719bSwdenk						(requires blink timer
520c609719bSwdenk						cf. i8042.c)
521c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
522c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
523c609719bSwdenk						upper right corner
524a3ad8e26Swdenk						(requires CFG_CMD_DATE)
525a3ad8e26Swdenk			CONFIG_VIDEO_LOGO	display Linux logo in
526a3ad8e26Swdenk						upper left corner
527a3ad8e26Swdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
528a3ad8e26Swdenk						linux_logo.h for logo.
529c609719bSwdenk						Requires CONFIG_VIDEO_LOGO
530c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
531c609719bSwdenk						addional board info beside
532c609719bSwdenk						the logo
5333bbc899fSwdenk
534c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
535c609719bSwdenk		default i/o. Serial console can be forced with
536c609719bSwdenk		environment 'console=serial'.
537c609719bSwdenk
538c609719bSwdenk		When CONFIG_SILENT_CONSOLE is defined, all console
539c609719bSwdenk		messages (by U-Boot and Linux!) can be silenced with
540c609719bSwdenk		the "silent" environment variable. See
541c609719bSwdenk		doc/README.silent for more information.
542c609719bSwdenk
543c609719bSwdenk- Console Baudrate:
544109c0e3aSwdenk		CONFIG_BAUDRATE - in bps
545109c0e3aSwdenk		Select one of the baudrates listed in
546c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5471d49b1f3Sstroese		CFG_BRGCLK_PRESCALE, baudrate prescale
5481d49b1f3Sstroese
5491d49b1f3Sstroese- Interrupt driven serial port input:
5500c8721a4SWolfgang Denk		CONFIG_SERIAL_SOFTWARE_FIFO
5511d49b1f3Sstroese
5521d49b1f3Sstroese		PPC405GP only.
5531d49b1f3Sstroese		Use an interrupt handler for receiving data on the
554c609719bSwdenk		serial port. It also enables using hardware handshake
555c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
556c609719bSwdenk		bytes the interrupt driven input buffer should have.
557c609719bSwdenk
558c609719bSwdenk		Leave undefined to disable this feature, including
559c609719bSwdenk		disable the buffer and hardware handshake.
560c609719bSwdenk
561c609719bSwdenk- Console UART Number:
562c609719bSwdenk		CONFIG_UART1_CONSOLE
563c609719bSwdenk
564c609719bSwdenk		AMCC PPC4xx only.
565c609719bSwdenk		If defined internal UART1 (and not UART0) is used
566c609719bSwdenk		as default U-Boot console.
567c609719bSwdenk
568c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
569c609719bSwdenk		Delay before automatically booting the default image;
570c609719bSwdenk		set to -1 to disable autoboot.
571c609719bSwdenk
572c609719bSwdenk		See doc/README.autoboot for these options that
573c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
574c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
575c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
576c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
577c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
578c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
579c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
580c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
581c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
582c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
583c609719bSwdenk		CONFIG_RESET_TO_RETRY
584c609719bSwdenk
585c609719bSwdenk- Autoboot Command:
586c609719bSwdenk		CONFIG_BOOTCOMMAND
587c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
588c609719bSwdenk		define a command string that is automatically executed
589c609719bSwdenk		when no character is read on the console interface
590c609719bSwdenk		within "Boot Delay" after reset.
591c609719bSwdenk
592c609719bSwdenk		CONFIG_BOOTARGS
593c609719bSwdenk		This can be used to pass arguments to the bootm
594c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
595c609719bSwdenk		environment value "bootargs".
596c609719bSwdenk
597c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
598c609719bSwdenk		The value of these goes into the environment as
599c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
600c609719bSwdenk		as a convenience, when switching between booting from
601c609719bSwdenk		ram and nfs.
602c609719bSwdenk
603c609719bSwdenk- Pre-Boot Commands:
604c609719bSwdenk		CONFIG_PREBOOT
605c609719bSwdenk
606c609719bSwdenk		When this option is #defined, the existence of the
607c609719bSwdenk		environment variable "preboot" will be checked
608c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
609c609719bSwdenk		countdown and/or running the auto-boot command resp.
610c609719bSwdenk		entering interactive mode.
611c609719bSwdenk
612c609719bSwdenk		This feature is especially useful when "preboot" is
613c609719bSwdenk		automatically generated or modified. For an example
614c609719bSwdenk		see the LWMON board specific code: here "preboot" is
615c609719bSwdenk		modified when the user holds down a certain
616c609719bSwdenk		combination of keys on the (special) keyboard when
617c609719bSwdenk		booting the systems
618c609719bSwdenk
619c609719bSwdenk- Serial Download Echo Mode:
620c609719bSwdenk		CONFIG_LOADS_ECHO
621c609719bSwdenk		If defined to 1, all characters received during a
622c609719bSwdenk		serial download (using the "loads" command) are
623c609719bSwdenk		echoed back. This might be needed by some terminal
624c609719bSwdenk		emulations (like "cu"), but may as well just take
625c609719bSwdenk		time on others. This setting #define's the initial
626c609719bSwdenk		value of the "loads_echo" environment variable.
627c609719bSwdenk
628c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
629c609719bSwdenk		CONFIG_KGDB_BAUDRATE
63078137c3cSwdenk		Select one of the baudrates listed in
631c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
6326705d81eSwdenk
63378137c3cSwdenk- Monitor Functions:
6346705d81eSwdenk		CONFIG_COMMANDS
635c609719bSwdenk		Most monitor functions can be selected (or
6366705d81eSwdenk		de-selected) by adjusting the definition of
637c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
638c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
6396705d81eSwdenk		following values:
64078137c3cSwdenk
64178137c3cSwdenk		#define enables commands:
6426705d81eSwdenk		-------------------------
643c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
644c609719bSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
6456705d81eSwdenk		CFG_CMD_BDI	  bdinfo
646c609719bSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
647c609719bSwdenk		CFG_CMD_BMP	* BMP support
6486705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
6492262cfeeSwdenk		CFG_CMD_BOOTD	  bootd
650c609719bSwdenk		CFG_CMD_CACHE	* icache, dcache
651c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
65278137c3cSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
653c609719bSwdenk		CFG_CMD_DHCP	* DHCP support
654c609719bSwdenk		CFG_CMD_DIAG	* Diagnostics
655c609719bSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
65678137c3cSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
657953c5b6fSWolfgang Denk		CFG_CMD_ECHO	  echo arguments
658c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
659c609719bSwdenk		CFG_CMD_ELF	* bootelf, bootvx
660c609719bSwdenk		CFG_CMD_ENV	  saveenv
661c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
662c609719bSwdenk		CFG_CMD_FAT	* FAT partition support
663c609719bSwdenk		CFG_CMD_FDOS	* Dos diskette Support
664c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
665c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
666c609719bSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
667c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
668c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
669c609719bSwdenk		CFG_CMD_IMI	  iminfo
670c609719bSwdenk		CFG_CMD_IMLS	  List all found images
671c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
672c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6736705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
67478137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
675c609719bSwdenk		CFG_CMD_KGDB	* kgdb
676c609719bSwdenk		CFG_CMD_LOADB	  loadb
677c609719bSwdenk		CFG_CMD_LOADS	  loads
678c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
67956523f12Swdenk				  loop, loopw, mtest
68078137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
6816705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
6826705d81eSwdenk		CFG_CMD_MII	* MII utility commands
68378137c3cSwdenk		CFG_CMD_NAND	* NAND support
684c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
685c609719bSwdenk		CFG_CMD_PCI	* pciinfo
686c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
68778137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
688ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
689c609719bSwdenk		CFG_CMD_REGINFO * Register dump
690c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
6916705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
692c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
69378137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
694b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
695c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
696c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
697c609719bSwdenk		CFG_CMD_USB	* USB support
69878137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
699c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
700a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
701c609719bSwdenk		-----------------------------------------------
702c609719bSwdenk		CFG_CMD_ALL	all
703c609719bSwdenk
70481050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
705c609719bSwdenk				this is includes all commands, except
706c609719bSwdenk				the ones marked with "*" in the list
707c609719bSwdenk				above.
708c609719bSwdenk
709c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
71081050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
711c609719bSwdenk		override the default settings in the respective
712c609719bSwdenk		include file.
713c609719bSwdenk
714c609719bSwdenk		EXAMPLE: If you want all functions except of network
715c609719bSwdenk		support you can write:
716c609719bSwdenk
717c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
718c609719bSwdenk
719c609719bSwdenk
720c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
721c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
722c609719bSwdenk		what you (and your U-Boot users) are doing. Data
723c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
724c609719bSwdenk		8260 (where accesses to the IMMR region must be
725c609719bSwdenk		uncached), and it cannot be disabled on all other
726c609719bSwdenk		systems where we (mis-) use the data cache to hold an
727c609719bSwdenk		initial stack and some data.
728c609719bSwdenk
729c609719bSwdenk
730c609719bSwdenk		XXX - this list needs to get updated!
731c609719bSwdenk
732c609719bSwdenk- Watchdog:
733c609719bSwdenk		CONFIG_WATCHDOG
734c609719bSwdenk		If this variable is defined, it enables watchdog
7357152b1d0Swdenk		support. There must be support in the platform specific
736c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
737c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
738c609719bSwdenk		register.
739c609719bSwdenk
740c1551ea8Sstroese- U-Boot Version:
741c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
742c1551ea8Sstroese		If this variable is defined, an environment variable
743c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
744c1551ea8Sstroese		version as printed by the "version" command.
745c1551ea8Sstroese		This variable is readonly.
746c1551ea8Sstroese
747c609719bSwdenk- Real-Time Clock:
748c609719bSwdenk
749c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
750c609719bSwdenk		has to be selected, too. Define exactly one of the
751c609719bSwdenk		following options:
752c609719bSwdenk
753c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
754c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
755c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7561cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
757c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7587f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7593bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7604c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
761c609719bSwdenk
762b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
763b37c7e5eSwdenk		must also be configured. See I2C Support, below.
764b37c7e5eSwdenk
765c609719bSwdenk- Timestamp Support:
766c609719bSwdenk
767c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
768c609719bSwdenk		(date and time) of an image is printed by image
769c609719bSwdenk		commands like bootm or iminfo. This option is
770c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
771c609719bSwdenk
772c609719bSwdenk- Partition Support:
773c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
774c609719bSwdenk		and/or CONFIG_ISO_PARTITION
775c609719bSwdenk
776c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
777c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
778c609719bSwdenk		one partition type as well.
779c609719bSwdenk
780c609719bSwdenk- IDE Reset method:
7814d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
7824d13cbadSwdenk		board configurations files but used nowhere!
783c609719bSwdenk
7844d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
7854d13cbadSwdenk		be performed by calling the function
7864d13cbadSwdenk			ide_set_reset(int reset)
7874d13cbadSwdenk		which has to be defined in a board specific file
788c609719bSwdenk
789c609719bSwdenk- ATAPI Support:
790c609719bSwdenk		CONFIG_ATAPI
791c609719bSwdenk
792c609719bSwdenk		Set this to enable ATAPI support.
793c609719bSwdenk
794c40b2956Swdenk- LBA48 Support
795c40b2956Swdenk		CONFIG_LBA48
796c40b2956Swdenk
797c40b2956Swdenk		Set this to enable support for disks larger than 137GB
798c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
799c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
800c40b2956Swdenk		support disks up to 2.1TB.
801c40b2956Swdenk
802c40b2956Swdenk		CFG_64BIT_LBA:
803c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
804c40b2956Swdenk			Default is 32bit.
805c40b2956Swdenk
806c609719bSwdenk- SCSI Support:
807c609719bSwdenk		At the moment only there is only support for the
808c609719bSwdenk		SYM53C8XX SCSI controller; define
809c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
810c609719bSwdenk
811c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
812c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
813c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
814c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
815c609719bSwdenk		devices.
816c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
817c609719bSwdenk
818c609719bSwdenk- NETWORK Support (PCI):
819682011ffSwdenk		CONFIG_E1000
820682011ffSwdenk		Support for Intel 8254x gigabit chips.
821682011ffSwdenk
822c609719bSwdenk		CONFIG_EEPRO100
823c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
824c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
825c609719bSwdenk		write routine for first time initialisation.
826c609719bSwdenk
827c609719bSwdenk		CONFIG_TULIP
828c609719bSwdenk		Support for Digital 2114x chips.
829c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
830c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
831c609719bSwdenk
832c609719bSwdenk		CONFIG_NATSEMI
833c609719bSwdenk		Support for National dp83815 chips.
834c609719bSwdenk
835c609719bSwdenk		CONFIG_NS8382X
836c609719bSwdenk		Support for National dp8382[01] gigabit chips.
837c609719bSwdenk
83845219c46Swdenk- NETWORK Support (other):
83945219c46Swdenk
84045219c46Swdenk		CONFIG_DRIVER_LAN91C96
84145219c46Swdenk		Support for SMSC's LAN91C96 chips.
84245219c46Swdenk
84345219c46Swdenk			CONFIG_LAN91C96_BASE
84445219c46Swdenk			Define this to hold the physical address
84545219c46Swdenk			of the LAN91C96's I/O space
84645219c46Swdenk
84745219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
84845219c46Swdenk			Define this to enable 32 bit addressing
84945219c46Swdenk
850f39748aeSwdenk		CONFIG_DRIVER_SMC91111
851f39748aeSwdenk		Support for SMSC's LAN91C111 chip
852f39748aeSwdenk
853f39748aeSwdenk			CONFIG_SMC91111_BASE
854f39748aeSwdenk			Define this to hold the physical address
855f39748aeSwdenk			of the device (I/O space)
856f39748aeSwdenk
857f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
858f39748aeSwdenk			Define this if data bus is 32 bits
859f39748aeSwdenk
860f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
861f39748aeSwdenk			Define this to use i/o functions instead of macros
862f39748aeSwdenk			(some hardware wont work with macros)
863f39748aeSwdenk
864c609719bSwdenk- USB Support:
865c609719bSwdenk		At the moment only the UHCI host controller is
8664d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
867c609719bSwdenk		CONFIG_USB_UHCI to enable it.
868c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
86930d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
870c609719bSwdenk		storage devices.
871c609719bSwdenk		Note:
872c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
873c609719bSwdenk		(TEAC FD-05PUB).
8744d13cbadSwdenk		MPC5200 USB requires additional defines:
8754d13cbadSwdenk			CONFIG_USB_CLOCK
8764d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
8774d13cbadSwdenk			CONFIG_USB_CONFIG
8784d13cbadSwdenk				for differential drivers: 0x00001000
8794d13cbadSwdenk				for single ended drivers: 0x00005000
8804d13cbadSwdenk
881c609719bSwdenk
88271f95118Swdenk- MMC Support:
88371f95118Swdenk		The MMC controller on the Intel PXA is supported. To
88471f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
88571f95118Swdenk		accessed from the boot prompt by mapping the device
88671f95118Swdenk		to physical memory similar to flash. Command line is
88771f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
88871f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
88971f95118Swdenk
8906705d81eSwdenk- Journaling Flash filesystem support:
8916705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
8926705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
8936705d81eSwdenk		Define these for a default partition on a NAND device
8946705d81eSwdenk
8956705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
8966705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
8976705d81eSwdenk		Define these for a default partition on a NOR device
8986705d81eSwdenk
8996705d81eSwdenk		CFG_JFFS_CUSTOM_PART
9006705d81eSwdenk		Define this to create an own partition. You have to provide a
9016705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9026705d81eSwdenk
9036705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9046705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
9056705d81eSwdenk		to disable the command chpart. This is the default when you
9066705d81eSwdenk		have not defined a custom partition
9076705d81eSwdenk
908c609719bSwdenk- Keyboard Support:
909c609719bSwdenk		CONFIG_ISA_KEYBOARD
910c609719bSwdenk
911c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
912c609719bSwdenk		support
913c609719bSwdenk
914c609719bSwdenk		CONFIG_I8042_KBD
915c609719bSwdenk		Standard PC keyboard driver with US (is default) and
916c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
917c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
918c609719bSwdenk		for cfb_console. Supports cursor blinking.
919c609719bSwdenk
920c609719bSwdenk- Video support:
921c609719bSwdenk		CONFIG_VIDEO
922c609719bSwdenk
923c609719bSwdenk		Define this to enable video support (for output to
924c609719bSwdenk		video).
925c609719bSwdenk
926c609719bSwdenk		CONFIG_VIDEO_CT69000
927c609719bSwdenk
928c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
929c609719bSwdenk
930c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
931eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
932eeb1b77bSwdenk		video output is selected via environment 'videoout'
933eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
934eeb1b77bSwdenk		assumed.
935c609719bSwdenk
936eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
937eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
938eeb1b77bSwdenk		are possible:
939eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
940eeb1b77bSwdenk		Following standard modes are supported	(* is default):
941eeb1b77bSwdenk
942eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
943eeb1b77bSwdenk		-------------+---------------------------------------------
944eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
945eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
946eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
947eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
948eeb1b77bSwdenk		-------------+---------------------------------------------
949c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
950c609719bSwdenk
951eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
952eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
953eeb1b77bSwdenk
954eeb1b77bSwdenk
955a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
956a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
957a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
958a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
959a6c7ad2fSwdenk
960682011ffSwdenk- Keyboard Support:
961682011ffSwdenk		CONFIG_KEYBOARD
962682011ffSwdenk
963682011ffSwdenk		Define this to enable a custom keyboard support.
964682011ffSwdenk		This simply calls drv_keyboard_init() which must be
965682011ffSwdenk		defined in your board-specific files.
966682011ffSwdenk		The only board using this so far is RBC823.
967a6c7ad2fSwdenk
968c609719bSwdenk- LCD Support:	CONFIG_LCD
969c609719bSwdenk
970c609719bSwdenk		Define this to enable LCD support (for output to LCD
971c609719bSwdenk		display); also select one of the supported displays
972c609719bSwdenk		by defining one of these:
973c609719bSwdenk
974fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
975c609719bSwdenk
976fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
977c609719bSwdenk
978fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
979c609719bSwdenk
980fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
981fd3103bbSwdenk			Active, color, single scan.
982fd3103bbSwdenk
983fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
984fd3103bbSwdenk
985fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
986c609719bSwdenk			Active, color, single scan.
987c609719bSwdenk
988c609719bSwdenk		CONFIG_SHARP_16x9
989c609719bSwdenk
990c609719bSwdenk			Sharp 320x240. Active, color, single scan.
991c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
992c609719bSwdenk
993c609719bSwdenk		CONFIG_SHARP_LQ64D341
994c609719bSwdenk
995c609719bSwdenk			Sharp LQ64D341 display, 640x480.
996c609719bSwdenk			Active, color, single scan.
997c609719bSwdenk
998c609719bSwdenk		CONFIG_HLD1045
999c609719bSwdenk
1000c609719bSwdenk			HLD1045 display, 640x480.
1001c609719bSwdenk			Active, color, single scan.
1002c609719bSwdenk
1003c609719bSwdenk		CONFIG_OPTREX_BW
1004c609719bSwdenk
1005c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1006c609719bSwdenk			or
1007c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1008c609719bSwdenk			or
1009c609719bSwdenk			Hitachi	 SP14Q002
1010c609719bSwdenk
1011c609719bSwdenk			320x240. Black & white.
1012c609719bSwdenk
1013c609719bSwdenk		Normally display is black on white background; define
1014c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1015c609719bSwdenk
10167152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1017d791b1dcSwdenk
1018d791b1dcSwdenk		If this option is set, the environment is checked for
1019d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1020d791b1dcSwdenk		of logo, copyright and system information on the LCD
1021e94d2cd9Swdenk		is suppressed and the BMP image at the address
1022d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1023d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1024d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1025d791b1dcSwdenk		loaded very quickly after power-on.
1026d791b1dcSwdenk
102798f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
102898f4a3dfSStefan Roese
102998f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
103098f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
103198f4a3dfSStefan Roese		splashscreen support or the bmp command.
103298f4a3dfSStefan Roese
1033c29fdfc1Swdenk- Compression support:
1034c29fdfc1Swdenk		CONFIG_BZIP2
1035c29fdfc1Swdenk
1036c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1037c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1038c29fdfc1Swdenk		compressed images are supported.
1039c29fdfc1Swdenk
1040c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1041c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1042c29fdfc1Swdenk		be at least 4MB.
1043d791b1dcSwdenk
104417ea1177Swdenk- MII/PHY support:
104517ea1177Swdenk		CONFIG_PHY_ADDR
104617ea1177Swdenk
104717ea1177Swdenk		The address of PHY on MII bus.
104817ea1177Swdenk
104917ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
105017ea1177Swdenk
105117ea1177Swdenk		The clock frequency of the MII bus
105217ea1177Swdenk
105317ea1177Swdenk		CONFIG_PHY_GIGE
105417ea1177Swdenk
105517ea1177Swdenk		If this option is set, support for speed/duplex
105617ea1177Swdenk		detection of Gigabit PHY is included.
105717ea1177Swdenk
105817ea1177Swdenk		CONFIG_PHY_RESET_DELAY
105917ea1177Swdenk
106017ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
106117ea1177Swdenk		reset before any MII register access is possible.
106217ea1177Swdenk		For such PHY, set this option to the usec delay
106317ea1177Swdenk		required. (minimum 300usec for LXT971A)
106417ea1177Swdenk
106517ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
106617ea1177Swdenk
106717ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
106817ea1177Swdenk		command issued before MII status register can be read
106917ea1177Swdenk
1070c609719bSwdenk- Ethernet address:
1071c609719bSwdenk		CONFIG_ETHADDR
1072c609719bSwdenk		CONFIG_ETH2ADDR
1073c609719bSwdenk		CONFIG_ETH3ADDR
1074c609719bSwdenk
1075c609719bSwdenk		Define a default value for ethernet address to use
1076c609719bSwdenk		for the respective ethernet interface, in case this
1077c609719bSwdenk		is not determined automatically.
1078c609719bSwdenk
1079c609719bSwdenk- IP address:
1080c609719bSwdenk		CONFIG_IPADDR
1081c609719bSwdenk
1082c609719bSwdenk		Define a default value for the IP address to use for
1083c609719bSwdenk		the default ethernet interface, in case this is not
1084c609719bSwdenk		determined through e.g. bootp.
1085c609719bSwdenk
1086c609719bSwdenk- Server IP address:
1087c609719bSwdenk		CONFIG_SERVERIP
1088c609719bSwdenk
1089c609719bSwdenk		Defines a default value for theIP address of a TFTP
1090c609719bSwdenk		server to contact when using the "tftboot" command.
1091c609719bSwdenk
1092c609719bSwdenk- BOOTP Recovery Mode:
1093c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1094c609719bSwdenk
1095c609719bSwdenk		If you have many targets in a network that try to
1096c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1097c609719bSwdenk		systems send out BOOTP requests at precisely the same
1098c609719bSwdenk		moment (which would happen for instance at recovery
1099c609719bSwdenk		from a power failure, when all systems will try to
1100c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1101c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1102c609719bSwdenk		inserted before sending out BOOTP requests. The
1103c609719bSwdenk		following delays are insterted then:
1104c609719bSwdenk
1105c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1106c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1107c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1108c609719bSwdenk		4th and following
1109c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1110c609719bSwdenk
1111fe389a82Sstroese- DHCP Advanced Options:
1112fe389a82Sstroese		CONFIG_BOOTP_MASK
1113fe389a82Sstroese
1114fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1115fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1116fe389a82Sstroese
1117fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1118fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1119fe389a82Sstroese		than one DNS serverip is offered to the client.
1120fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1121fe389a82Sstroese		serverip will be stored in the additional environment
1122fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1123fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1124fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1125fe389a82Sstroese
1126fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1127fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1128fe389a82Sstroese		need the hostname of the DHCP requester.
1129fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1130fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1131fe389a82Sstroese		environment variable is passed as option 12 to
1132fe389a82Sstroese		the DHCP server.
1133fe389a82Sstroese
1134a3d991bdSwdenk - CDP Options:
1135a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1136a3d991bdSwdenk
1137a3d991bdSwdenk		The device id used in CDP trigger frames.
1138a3d991bdSwdenk
1139a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1140a3d991bdSwdenk
1141a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1142a3d991bdSwdenk		of the device.
1143a3d991bdSwdenk
1144a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1145a3d991bdSwdenk
1146a3d991bdSwdenk		A printf format string which contains the ascii name of
1147a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1148a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1149a3d991bdSwdenk
1150a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1151a3d991bdSwdenk
1152a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1153a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1154a3d991bdSwdenk
1155a3d991bdSwdenk		CONFIG_CDP_VERSION
1156a3d991bdSwdenk
1157a3d991bdSwdenk		An ascii string containing the version of the software.
1158a3d991bdSwdenk
1159a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1160a3d991bdSwdenk
1161a3d991bdSwdenk		An ascii string containing the name of the platform.
1162a3d991bdSwdenk
1163a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1164a3d991bdSwdenk
1165a3d991bdSwdenk		A 32bit integer sent on the trigger.
1166a3d991bdSwdenk
1167a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1168a3d991bdSwdenk
1169a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1170a3d991bdSwdenk		device in .1 of milliwatts.
1171a3d991bdSwdenk
1172a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1173a3d991bdSwdenk
1174a3d991bdSwdenk		A byte containing the id of the VLAN.
1175a3d991bdSwdenk
1176c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1177c609719bSwdenk
1178c609719bSwdenk		Several configurations allow to display the current
1179c609719bSwdenk		status using a LED. For instance, the LED will blink
1180c609719bSwdenk		fast while running U-Boot code, stop blinking as
1181c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1182c609719bSwdenk		start blinking slow once the Linux kernel is running
1183c609719bSwdenk		(supported by a status LED driver in the Linux
1184c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1185c609719bSwdenk		feature in U-Boot.
1186c609719bSwdenk
1187c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1188c609719bSwdenk
1189c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1190c609719bSwdenk		on those systems that support this (optional)
1191c609719bSwdenk		feature, like the TQM8xxL modules.
1192c609719bSwdenk
1193c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1194c609719bSwdenk
1195b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1196b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1197b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1198c609719bSwdenk
1199b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1200b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1201b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1202b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1203c609719bSwdenk		command line interface.
1204c609719bSwdenk
1205b37c7e5eSwdenk		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
1206c609719bSwdenk
1207b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1208b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1209b37c7e5eSwdenk		support for I2C.
1210c609719bSwdenk
1211b37c7e5eSwdenk		There are several other quantities that must also be
1212b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1213c609719bSwdenk
1214b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1215b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1216b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1217b37c7e5eSwdenk		the cpu's i2c node address).
1218c609719bSwdenk
1219b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1220b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1221b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1222b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1223b37c7e5eSwdenk
1224b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1225b37c7e5eSwdenk
1226b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1227b37c7e5eSwdenk		then the following macros need to be defined (examples are
1228b37c7e5eSwdenk		from include/configs/lwmon.h):
1229c609719bSwdenk
1230c609719bSwdenk		I2C_INIT
1231c609719bSwdenk
1232b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1233c609719bSwdenk		controller or configure ports.
1234c609719bSwdenk
1235b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1236b37c7e5eSwdenk
1237c609719bSwdenk		I2C_PORT
1238c609719bSwdenk
1239c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1240c609719bSwdenk		assumes both bits are on the same port). Valid values
1241c609719bSwdenk		are 0..3 for ports A..D.
1242c609719bSwdenk
1243c609719bSwdenk		I2C_ACTIVE
1244c609719bSwdenk
1245c609719bSwdenk		The code necessary to make the I2C data line active
1246c609719bSwdenk		(driven).  If the data line is open collector, this
1247c609719bSwdenk		define can be null.
1248c609719bSwdenk
1249b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1250b37c7e5eSwdenk
1251c609719bSwdenk		I2C_TRISTATE
1252c609719bSwdenk
1253c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1254c609719bSwdenk		(inactive).  If the data line is open collector, this
1255c609719bSwdenk		define can be null.
1256c609719bSwdenk
1257b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1258b37c7e5eSwdenk
1259c609719bSwdenk		I2C_READ
1260c609719bSwdenk
1261c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1262c609719bSwdenk		FALSE if it is low.
1263c609719bSwdenk
1264b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1265b37c7e5eSwdenk
1266c609719bSwdenk		I2C_SDA(bit)
1267c609719bSwdenk
1268c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1269c609719bSwdenk		is FALSE, it clears it (low).
1270c609719bSwdenk
1271b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1272b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1273b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1274b37c7e5eSwdenk
1275c609719bSwdenk		I2C_SCL(bit)
1276c609719bSwdenk
1277c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1278c609719bSwdenk		is FALSE, it clears it (low).
1279c609719bSwdenk
1280b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1281b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1282b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1283b37c7e5eSwdenk
1284c609719bSwdenk		I2C_DELAY
1285c609719bSwdenk
1286c609719bSwdenk		This delay is invoked four times per clock cycle so this
1287c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1288b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1289b37c7e5eSwdenk		like:
1290b37c7e5eSwdenk
1291b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1292c609719bSwdenk
129347cd00faSwdenk		CFG_I2C_INIT_BOARD
129447cd00faSwdenk
129547cd00faSwdenk		When a board is reset during an i2c bus transfer
129647cd00faSwdenk		chips might think that the current transfer is still
129747cd00faSwdenk		in progress. On some boards it is possible to access
129847cd00faSwdenk		the i2c SCLK line directly, either by using the
129947cd00faSwdenk		processor pin as a GPIO or by having a second pin
130047cd00faSwdenk		connected to the bus. If this option is defined a
130147cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
130247cd00faSwdenk		is run early in the boot sequence.
130347cd00faSwdenk
130417ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
130517ea1177Swdenk
130617ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
130717ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
130817ea1177Swdenk		variable "i2cfast". (see also i2cfast)
130917ea1177Swdenk
1310c609719bSwdenk- SPI Support:	CONFIG_SPI
1311c609719bSwdenk
1312c609719bSwdenk		Enables SPI driver (so far only tested with
1313c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1314c609719bSwdenk		D/As on the SACSng board)
1315c609719bSwdenk
1316c609719bSwdenk		CONFIG_SPI_X
1317c609719bSwdenk
1318c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1319c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1320c609719bSwdenk
1321c609719bSwdenk		CONFIG_SOFT_SPI
1322c609719bSwdenk
1323c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1324c609719bSwdenk		using hardware support. This is a general purpose
1325c609719bSwdenk		driver that only requires three general I/O port pins
1326c609719bSwdenk		(two outputs, one input) to function. If this is
1327c609719bSwdenk		defined, the board configuration must define several
1328c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1329c609719bSwdenk		an example, see include/configs/sacsng.h.
1330c609719bSwdenk
1331c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1332c609719bSwdenk
1333c609719bSwdenk		Specify the number of FPGA devices to support.
1334c609719bSwdenk
1335c609719bSwdenk		CONFIG_FPGA
1336c609719bSwdenk
1337c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1338c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1339c609719bSwdenk
1340c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1341c609719bSwdenk
1342c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1343c609719bSwdenk
1344c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1345c609719bSwdenk
1346c609719bSwdenk		Enable checks on FPGA configuration interface busy
1347c609719bSwdenk		status by the configuration function. This option
1348c609719bSwdenk		will require a board or device specific function to
1349c609719bSwdenk		be written.
1350c609719bSwdenk
1351c609719bSwdenk		CONFIG_FPGA_DELAY
1352c609719bSwdenk
1353c609719bSwdenk		If defined, a function that provides delays in the FPGA
1354c609719bSwdenk		configuration driver.
1355c609719bSwdenk
1356c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1357c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1358c609719bSwdenk
1359c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1360c609719bSwdenk
1361c609719bSwdenk		Check for configuration errors during FPGA bitfile
1362c609719bSwdenk		loading. For example, abort during Virtex II
1363c609719bSwdenk		configuration if the INIT_B line goes low (which
1364c609719bSwdenk		indicated a CRC error).
1365c609719bSwdenk
1366c609719bSwdenk		CFG_FPGA_WAIT_INIT
1367c609719bSwdenk
1368c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1369c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1370c609719bSwdenk		FPGA configuration sequence. The default time is 500
1371c609719bSwdenk		mS.
1372c609719bSwdenk
1373c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1374c609719bSwdenk
1375c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1376c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1377c609719bSwdenk
1378c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1379c609719bSwdenk
1380c609719bSwdenk		Time to wait after FPGA configuration. The default is
1381c609719bSwdenk		200 mS.
1382c609719bSwdenk
1383c609719bSwdenk- Configuration Management:
1384c609719bSwdenk		CONFIG_IDENT_STRING
1385c609719bSwdenk
1386c609719bSwdenk		If defined, this string will be added to the U-Boot
1387c609719bSwdenk		version information (U_BOOT_VERSION)
1388c609719bSwdenk
1389c609719bSwdenk- Vendor Parameter Protection:
1390c609719bSwdenk
1391c609719bSwdenk		U-Boot considers the values of the environment
1392c609719bSwdenk		variables "serial#" (Board Serial Number) and
13937152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1394c609719bSwdenk		are set once by the board vendor / manufacturer, and
1395c609719bSwdenk		protects these variables from casual modification by
1396c609719bSwdenk		the user. Once set, these variables are read-only,
1397c609719bSwdenk		and write or delete attempts are rejected. You can
1398c609719bSwdenk		change this behviour:
1399c609719bSwdenk
1400c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1401c609719bSwdenk		file, the write protection for vendor parameters is
140247cd00faSwdenk		completely disabled. Anybody can change or delete
1403c609719bSwdenk		these parameters.
1404c609719bSwdenk
1405c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1406c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1407c609719bSwdenk		ethernet address is installed in the environment,
1408c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1409c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1410c609719bSwdenk		read-only.]
1411c609719bSwdenk
1412c609719bSwdenk- Protected RAM:
1413c609719bSwdenk		CONFIG_PRAM
1414c609719bSwdenk
1415c609719bSwdenk		Define this variable to enable the reservation of
1416c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1417c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1418c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1419c609719bSwdenk		this default value by defining an environment
1420c609719bSwdenk		variable "pram" to the number of kB you want to
1421c609719bSwdenk		reserve. Note that the board info structure will
1422c609719bSwdenk		still show the full amount of RAM. If pRAM is
1423c609719bSwdenk		reserved, a new environment variable "mem" will
1424c609719bSwdenk		automatically be defined to hold the amount of
1425c609719bSwdenk		remaining RAM in a form that can be passed as boot
1426c609719bSwdenk		argument to Linux, for instance like that:
1427c609719bSwdenk
1428fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1429c609719bSwdenk			saveenv
1430c609719bSwdenk
1431c609719bSwdenk		This way you can tell Linux not to use this memory,
1432c609719bSwdenk		either, which results in a memory region that will
1433c609719bSwdenk		not be affected by reboots.
1434c609719bSwdenk
1435c609719bSwdenk		*WARNING* If your board configuration uses automatic
1436c609719bSwdenk		detection of the RAM size, you must make sure that
1437c609719bSwdenk		this memory test is non-destructive. So far, the
1438c609719bSwdenk		following board configurations are known to be
1439c609719bSwdenk		"pRAM-clean":
1440c609719bSwdenk
1441c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1442c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1443c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1444c609719bSwdenk
1445c609719bSwdenk- Error Recovery:
1446c609719bSwdenk		CONFIG_PANIC_HANG
1447c609719bSwdenk
1448c609719bSwdenk		Define this variable to stop the system in case of a
1449c609719bSwdenk		fatal error, so that you have to reset it manually.
1450c609719bSwdenk		This is probably NOT a good idea for an embedded
1451c609719bSwdenk		system where you want to system to reboot
1452c609719bSwdenk		automatically as fast as possible, but it may be
1453c609719bSwdenk		useful during development since you can try to debug
1454c609719bSwdenk		the conditions that lead to the situation.
1455c609719bSwdenk
1456c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1457c609719bSwdenk
1458c609719bSwdenk		This variable defines the number of retries for
1459c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1460c609719bSwdenk		before giving up the operation. If not defined, a
1461c609719bSwdenk		default value of 5 is used.
1462c609719bSwdenk
1463c609719bSwdenk- Command Interpreter:
146404a85b3bSwdenk		CFG_AUTO_COMPLETE
146504a85b3bSwdenk
146604a85b3bSwdenk		Enable auto completion of commands using TAB.
146704a85b3bSwdenk
1468c609719bSwdenk		CFG_HUSH_PARSER
1469c609719bSwdenk
1470c609719bSwdenk		Define this variable to enable the "hush" shell (from
1471c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1472c609719bSwdenk		powerful command line syntax like
1473c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1474c609719bSwdenk		constructs ("shell scripts").
1475c609719bSwdenk
1476c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1477c609719bSwdenk		with a somewhat smaller memory footprint.
1478c609719bSwdenk
1479c609719bSwdenk
1480c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1481c609719bSwdenk
1482c609719bSwdenk		This defines the secondary prompt string, which is
1483c609719bSwdenk		printed when the command interpreter needs more input
1484c609719bSwdenk		to complete a command. Usually "> ".
1485c609719bSwdenk
1486c609719bSwdenk	Note:
1487c609719bSwdenk
1488c609719bSwdenk		In the current implementation, the local variables
1489c609719bSwdenk		space and global environment variables space are
1490c609719bSwdenk		separated. Local variables are those you define by
14913b57fe0aSwdenk		simply typing `name=value'. To access a local
1492c609719bSwdenk		variable later on, you have write `$name' or
14933b57fe0aSwdenk		`${name}'; to execute the contents of a variable
14943b57fe0aSwdenk		directly type `$name' at the command prompt.
1495c609719bSwdenk
1496c609719bSwdenk		Global environment variables are those you use
1497c609719bSwdenk		setenv/printenv to work with. To run a command stored
1498c609719bSwdenk		in such a variable, you need to use the run command,
1499c609719bSwdenk		and you must not use the '$' sign to access them.
1500c609719bSwdenk
1501c609719bSwdenk		To store commands and special characters in a
1502c609719bSwdenk		variable, please use double quotation marks
1503c609719bSwdenk		surrounding the whole text of the variable, instead
1504c609719bSwdenk		of the backslashes before semicolons and special
1505c609719bSwdenk		symbols.
1506c609719bSwdenk
1507aa0c71acSWolfgang Denk- Commandline Editing and History:
1508aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1509aa0c71acSWolfgang Denk
1510aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1511aa0c71acSWolfgang Denk		commandline input operations
1512aa0c71acSWolfgang Denk
1513a8c7c708Swdenk- Default Environment:
1514c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1515c609719bSwdenk
1516c609719bSwdenk		Define this to contain any number of null terminated
1517c609719bSwdenk		strings (variable = value pairs) that will be part of
15187152b1d0Swdenk		the default environment compiled into the boot image.
15192262cfeeSwdenk
1520c609719bSwdenk		For example, place something like this in your
1521c609719bSwdenk		board's config file:
1522c609719bSwdenk
1523c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1524c609719bSwdenk			"myvar1=value1\0" \
1525c609719bSwdenk			"myvar2=value2\0"
1526c609719bSwdenk
1527c609719bSwdenk		Warning: This method is based on knowledge about the
1528c609719bSwdenk		internal format how the environment is stored by the
15292262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1530c609719bSwdenk		interface! Although it is unlikely that this format
15317152b1d0Swdenk		will change soon, there is no guarantee either.
1532c609719bSwdenk		You better know what you are doing here.
1533c609719bSwdenk
1534c609719bSwdenk		Note: overly (ab)use of the default environment is
1535c609719bSwdenk		discouraged. Make sure to check other ways to preset
1536c609719bSwdenk		the environment like the autoscript function or the
1537c609719bSwdenk		boot command first.
1538c609719bSwdenk
1539a8c7c708Swdenk- DataFlash Support:
15402abbe075Swdenk		CONFIG_HAS_DATAFLASH
15412abbe075Swdenk
15422abbe075Swdenk		Defining this option enables DataFlash features and
15432abbe075Swdenk		allows to read/write in Dataflash via the standard
15442abbe075Swdenk		commands cp, md...
15452abbe075Swdenk
15463f85ce27Swdenk- SystemACE Support:
15473f85ce27Swdenk		CONFIG_SYSTEMACE
15483f85ce27Swdenk
15493f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
15503f85ce27Swdenk		chips attached via some sort of local bus. The address
15513f85ce27Swdenk		of the chip must alsh be defined in the
15523f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
15533f85ce27Swdenk
15543f85ce27Swdenk		#define CONFIG_SYSTEMACE
15553f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
15563f85ce27Swdenk
15573f85ce27Swdenk		When SystemACE support is added, the "ace" device type
15583f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
15593f85ce27Swdenk
1560ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1561ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1562ecb0ccd9SWolfgang Denk
156328cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1564ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
156528cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1566ecb0ccd9SWolfgang Denk		number generator is used.
1567ecb0ccd9SWolfgang Denk
156828cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
156928cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
157028cb9375SWolfgang Denk		defined, the normal port 69 is used.
157128cb9375SWolfgang Denk
157228cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1573ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1574ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1575ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1576ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1577ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1578ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1579ecb0ccd9SWolfgang Denk
1580a8c7c708Swdenk- Show boot progress:
1581c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1582c609719bSwdenk
1583c609719bSwdenk		Defining this option allows to add some board-
1584c609719bSwdenk		specific code (calling a user-provided function
1585c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1586c609719bSwdenk		the system's boot progress on some display (for
1587c609719bSwdenk		example, some LED's) on your board. At the moment,
1588c609719bSwdenk		the following checkpoints are implemented:
1589c609719bSwdenk
1590c609719bSwdenk  Arg	Where			When
1591c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1592c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1593c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1594c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1595c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1596c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1597c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1598c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1599c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1600c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1601c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1602c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1603c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1604c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1605c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1606c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1607c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1608c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1609c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1610c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1611c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1612c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1613c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1614c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1615c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1616c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1617c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1618c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1619c609719bSwdenk
162063e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
162163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
162263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
162363e73c9aSwdenk
1624c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1625c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1626c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1627c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1628c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1629c609719bSwdenk
1630c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1631c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1632c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1633c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1634c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1635c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1636c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1637c609719bSwdenk
1638206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1639206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1640206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1641206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1642206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1643206c60cbSwdenk
1644206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1645c609719bSwdenk
1646c609719bSwdenk
1647c609719bSwdenkModem Support:
1648c609719bSwdenk--------------
1649c609719bSwdenk
165085ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1651c609719bSwdenk
1652c609719bSwdenk- Modem support endable:
1653c609719bSwdenk		CONFIG_MODEM_SUPPORT
1654c609719bSwdenk
1655c609719bSwdenk- RTS/CTS Flow control enable:
1656c609719bSwdenk		CONFIG_HWFLOW
1657c609719bSwdenk
1658c609719bSwdenk- Modem debug support:
1659c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1660c609719bSwdenk
1661c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1662c609719bSwdenk		for modem support. Useful only with BDI2000.
1663c609719bSwdenk
1664a8c7c708Swdenk- Interrupt support (PPC):
1665a8c7c708Swdenk
1666a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1667a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1668a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1669a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1670a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1671a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1672a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1673a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1674a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1675a8c7c708Swdenk		general timer_interrupt().
1676a8c7c708Swdenk
1677c609719bSwdenk- General:
1678c609719bSwdenk
1679c609719bSwdenk		In the target system modem support is enabled when a
1680c609719bSwdenk		specific key (key combination) is pressed during
1681c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1682c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1683c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1684c609719bSwdenk		function, returning 1 and thus enabling modem
1685c609719bSwdenk		initialization.
1686c609719bSwdenk
1687c609719bSwdenk		If there are no modem init strings in the
1688c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1689c609719bSwdenk		previous output (banner, info printfs) will be
1690c609719bSwdenk		supressed, though.
1691c609719bSwdenk
1692c609719bSwdenk		See also: doc/README.Modem
1693c609719bSwdenk
1694c609719bSwdenk
1695c609719bSwdenkConfiguration Settings:
1696c609719bSwdenk-----------------------
1697c609719bSwdenk
1698c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1699c609719bSwdenk		undefine this when you're short of memory.
1700c609719bSwdenk
1701c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1702c609719bSwdenk		prompt for user input.
1703c609719bSwdenk
1704c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1705c609719bSwdenk
1706c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1707c609719bSwdenk
1708c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1709c609719bSwdenk
1710c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1711c609719bSwdenk		the application (usually a Linux kernel) when it is
1712c609719bSwdenk		booted
1713c609719bSwdenk
1714c609719bSwdenk- CFG_BAUDRATE_TABLE:
1715c609719bSwdenk		List of legal baudrate settings for this board.
1716c609719bSwdenk
1717c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1718c609719bSwdenk		Suppress display of console information at boot.
1719c609719bSwdenk
1720c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1721c609719bSwdenk		If the board specific function
1722c609719bSwdenk			extern int overwrite_console (void);
1723c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1724c609719bSwdenk		serial port, else the settings in the environment are used.
1725c609719bSwdenk
1726c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1727c609719bSwdenk		Enable the call to overwrite_console().
1728c609719bSwdenk
1729c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1730c609719bSwdenk		Enable overwrite of previous console environment settings.
1731c609719bSwdenk
1732c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1733c609719bSwdenk		Begin and End addresses of the area used by the
1734c609719bSwdenk		simple memory test.
1735c609719bSwdenk
1736c609719bSwdenk- CFG_ALT_MEMTEST:
1737c609719bSwdenk		Enable an alternate, more extensive memory test.
1738c609719bSwdenk
17395f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
17405f535fe1Swdenk		Scratch address used by the alternate memory test
17415f535fe1Swdenk		You only need to set this if address zero isn't writeable
17425f535fe1Swdenk
1743c609719bSwdenk- CFG_TFTP_LOADADDR:
1744c609719bSwdenk		Default load address for network file downloads
1745c609719bSwdenk
1746c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1747c609719bSwdenk		Enable temporary baudrate change while serial download
1748c609719bSwdenk
1749c609719bSwdenk- CFG_SDRAM_BASE:
1750c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1751c609719bSwdenk
1752c609719bSwdenk- CFG_MBIO_BASE:
1753c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1754c609719bSwdenk		Cogent motherboard)
1755c609719bSwdenk
1756c609719bSwdenk- CFG_FLASH_BASE:
1757c609719bSwdenk		Physical start address of Flash memory.
1758c609719bSwdenk
1759c609719bSwdenk- CFG_MONITOR_BASE:
1760c609719bSwdenk		Physical start address of boot monitor code (set by
1761c609719bSwdenk		make config files to be same as the text base address
1762c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1763c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1764c609719bSwdenk
1765c609719bSwdenk- CFG_MONITOR_LEN:
17663b57fe0aSwdenk		Size of memory reserved for monitor code, used to
17673b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
17683b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
17693b57fe0aSwdenk		flash sector.
1770c609719bSwdenk
1771c609719bSwdenk- CFG_MALLOC_LEN:
1772c609719bSwdenk		Size of DRAM reserved for malloc() use.
1773c609719bSwdenk
177415940c9aSStefan Roese- CFG_BOOTM_LEN:
177515940c9aSStefan Roese		Normally compressed uImages are limited to an
177615940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
177715940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
177815940c9aSStefan Roese		to adjust this setting to your needs.
1779c609719bSwdenk
1780c609719bSwdenk- CFG_BOOTMAPSZ:
1781c609719bSwdenk		Maximum size of memory mapped by the startup code of
1782c609719bSwdenk		the Linux kernel; all data that must be processed by
1783c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1784c609719bSwdenk		initrd image) must be put below this limit.
1785c609719bSwdenk
1786c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1787c609719bSwdenk		Max number of Flash memory banks
1788c609719bSwdenk
1789c609719bSwdenk- CFG_MAX_FLASH_SECT:
1790c609719bSwdenk		Max number of sectors on a Flash chip
1791c609719bSwdenk
1792c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1793c609719bSwdenk		Timeout for Flash erase operations (in ms)
1794c609719bSwdenk
1795c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1796c609719bSwdenk		Timeout for Flash write operations (in ms)
1797c609719bSwdenk
17988564acf9Swdenk- CFG_FLASH_LOCK_TOUT
17998564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
18008564acf9Swdenk
18018564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
18028564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
18038564acf9Swdenk
18048564acf9Swdenk- CFG_FLASH_PROTECTION
18058564acf9Swdenk		If defined, hardware flash sectors protection is used
18068564acf9Swdenk		instead of U-Boot software protection.
18078564acf9Swdenk
1808c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1809c609719bSwdenk
1810c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1811c609719bSwdenk		without this option such a download has to be
1812c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1813c609719bSwdenk		copy from RAM to flash.
1814c609719bSwdenk
1815c609719bSwdenk		The two-step approach is usually more reliable, since
1816c609719bSwdenk		you can check if the download worked before you erase
1817c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1818c609719bSwdenk		too limited to allow for a tempory copy of the
1819c609719bSwdenk		downloaded image) this option may be very useful.
1820c609719bSwdenk
1821c609719bSwdenk- CFG_FLASH_CFI:
1822c609719bSwdenk		Define if the flash driver uses extra elements in the
18235653fc33Swdenk		common flash structure for storing flash geometry.
18245653fc33Swdenk
18255653fc33Swdenk- CFG_FLASH_CFI_DRIVER
18265653fc33Swdenk		This option also enables the building of the cfi_flash driver
18275653fc33Swdenk		in the drivers directory
182853cf9435Sstroese
18295568e613SStefan Roese- CFG_FLASH_QUIET_TEST
18305568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
18315568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
18325568e613SStefan Roese		is useful, if some of the configured banks are only
18335568e613SStefan Roese		optionally available.
18345568e613SStefan Roese
183553cf9435Sstroese- CFG_RX_ETH_BUFFER:
183653cf9435Sstroese		Defines the number of ethernet receive buffers. On some
183753cf9435Sstroese		ethernet controllers it is recommended to set this value
183853cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
183953cf9435Sstroese		buffers can be full shortly after enabling the interface
184053cf9435Sstroese		on high ethernet traffic.
184153cf9435Sstroese		Defaults to 4 if not defined.
1842c609719bSwdenk
1843c609719bSwdenkThe following definitions that deal with the placement and management
1844c609719bSwdenkof environment data (variable area); in general, we support the
1845c609719bSwdenkfollowing configurations:
1846c609719bSwdenk
1847c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1848c609719bSwdenk
1849c609719bSwdenk	Define this if the environment is in flash memory.
1850c609719bSwdenk
1851c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1852c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1853c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1854c609719bSwdenk	   sector" type flash chips, which have several smaller
1855c609719bSwdenk	   sectors at the start or the end. For instance, such a
1856c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
1857c609719bSwdenk	   such a case you would place the environment in one of the
1858c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
1859c609719bSwdenk	   "top boot sector" type flash chips, you would put the
1860c609719bSwdenk	   environment in one of the last sectors, leaving a gap
1861c609719bSwdenk	   between U-Boot and the environment.
1862c609719bSwdenk
1863c609719bSwdenk	- CFG_ENV_OFFSET:
1864c609719bSwdenk
1865c609719bSwdenk	   Offset of environment data (variable area) to the
1866c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
1867c609719bSwdenk	   type flash chips the second sector can be used: the offset
1868c609719bSwdenk	   for this sector is given here.
1869c609719bSwdenk
1870c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
1871c609719bSwdenk
1872c609719bSwdenk	- CFG_ENV_ADDR:
1873c609719bSwdenk
1874c609719bSwdenk	   This is just another way to specify the start address of
1875c609719bSwdenk	   the flash sector containing the environment (instead of
1876c609719bSwdenk	   CFG_ENV_OFFSET).
1877c609719bSwdenk
1878c609719bSwdenk	- CFG_ENV_SECT_SIZE:
1879c609719bSwdenk
1880c609719bSwdenk	   Size of the sector containing the environment.
1881c609719bSwdenk
1882c609719bSwdenk
1883c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
1884c609719bSwdenk	   In such a case you don't want to spend a whole sector for
1885c609719bSwdenk	   the environment.
1886c609719bSwdenk
1887c609719bSwdenk	- CFG_ENV_SIZE:
1888c609719bSwdenk
1889c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
1890c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
1891c609719bSwdenk	   of this flash sector for the environment. This saves
1892c609719bSwdenk	   memory for the RAM copy of the environment.
1893c609719bSwdenk
1894c609719bSwdenk	   It may also save flash memory if you decide to use this
1895c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
1896c609719bSwdenk	   since then the remainder of the flash sector could be used
1897c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
1898c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
1899c609719bSwdenk	   updating the environment in flash makes it always
1900c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
1901c609719bSwdenk	   wrong before the contents has been restored from a copy in
1902c609719bSwdenk	   RAM, your target system will be dead.
1903c609719bSwdenk
1904c609719bSwdenk	- CFG_ENV_ADDR_REDUND
1905c609719bSwdenk	  CFG_ENV_SIZE_REDUND
1906c609719bSwdenk
1907c609719bSwdenk	   These settings describe a second storage area used to hold
1908c609719bSwdenk	   a redundand copy of the environment data, so that there is
19093e38691eSwdenk	   a valid backup copy in case there is a power failure during
1910c609719bSwdenk	   a "saveenv" operation.
1911c609719bSwdenk
1912c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
1913c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
1914c609719bSwdenkaccordingly!
1915c609719bSwdenk
1916c609719bSwdenk
1917c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
1918c609719bSwdenk
1919c609719bSwdenk	Define this if you have some non-volatile memory device
1920c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
1921c609719bSwdenk	environment.
1922c609719bSwdenk
1923c609719bSwdenk	- CFG_ENV_ADDR:
1924c609719bSwdenk	- CFG_ENV_SIZE:
1925c609719bSwdenk
1926c609719bSwdenk	  These two #defines are used to determin the memory area you
1927c609719bSwdenk	  want to use for environment. It is assumed that this memory
1928c609719bSwdenk	  can just be read and written to, without any special
1929c609719bSwdenk	  provision.
1930c609719bSwdenk
1931c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
1932c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
1933c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
1934c609719bSwdenkU-Boot will hang.
1935c609719bSwdenk
1936c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
1937c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
1938c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
1939c609719bSwdenkto save the current settings.
1940c609719bSwdenk
1941c609719bSwdenk
1942c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
1943c609719bSwdenk
1944c609719bSwdenk	Use this if you have an EEPROM or similar serial access
1945c609719bSwdenk	device and a driver for it.
1946c609719bSwdenk
1947c609719bSwdenk	- CFG_ENV_OFFSET:
1948c609719bSwdenk	- CFG_ENV_SIZE:
1949c609719bSwdenk
1950c609719bSwdenk	  These two #defines specify the offset and size of the
1951c609719bSwdenk	  environment area within the total memory of your EEPROM.
1952c609719bSwdenk
1953c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
1954c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
1955c609719bSwdenk	  The default address is zero.
1956c609719bSwdenk
1957c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
1958c609719bSwdenk	  If defined, the number of bits used to address bytes in a
1959c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
1960c609719bSwdenk	  would require six bits.
1961c609719bSwdenk
1962c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
1963c609719bSwdenk	  If defined, the number of milliseconds to delay between
1964c609719bSwdenk	  page writes.	The default is zero milliseconds.
1965c609719bSwdenk
1966c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
1967c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
1968c609719bSwdenk	  that this is NOT the chip address length!
1969c609719bSwdenk
19705cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
19715cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
19725cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
19735cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
19745cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
19755cf91d6bSwdenk	  byte chips.
19765cf91d6bSwdenk
19775cf91d6bSwdenk	  Note that we consider the length of the address field to
19785cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
19795cf91d6bSwdenk	  in the chip address.
19805cf91d6bSwdenk
1981c609719bSwdenk	- CFG_EEPROM_SIZE:
1982c609719bSwdenk	  The size in bytes of the EEPROM device.
1983c609719bSwdenk
1984c609719bSwdenk
19855779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
19865779d8d9Swdenk
19875779d8d9Swdenk	Define this if you have a DataFlash memory device which you
19885779d8d9Swdenk	want to use for the environment.
19895779d8d9Swdenk
19905779d8d9Swdenk	- CFG_ENV_OFFSET:
19915779d8d9Swdenk	- CFG_ENV_ADDR:
19925779d8d9Swdenk	- CFG_ENV_SIZE:
19935779d8d9Swdenk
19945779d8d9Swdenk	  These three #defines specify the offset and size of the
19955779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
19965779d8d9Swdenk	  at the specified address.
19975779d8d9Swdenk
199813a5695bSwdenk- CFG_ENV_IS_IN_NAND:
199913a5695bSwdenk
200013a5695bSwdenk	Define this if you have a NAND device which you want to use
200113a5695bSwdenk	for the environment.
200213a5695bSwdenk
200313a5695bSwdenk	- CFG_ENV_OFFSET:
200413a5695bSwdenk	- CFG_ENV_SIZE:
200513a5695bSwdenk
200613a5695bSwdenk	  These two #defines specify the offset and size of the environment
200713a5695bSwdenk	  area within the first NAND device.
20085779d8d9Swdenk
2009e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2010e443c944SMarkus Klotzbuecher
2011e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2012e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2013e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2014e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2015e443c944SMarkus Klotzbuecher
2016e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2017e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2018e443c944SMarkus Klotzbuecher	the NAND devices block size.
2019e443c944SMarkus Klotzbuecher
2020c609719bSwdenk- CFG_SPI_INIT_OFFSET
2021c609719bSwdenk
2022c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2023c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2024c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2025c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2026c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2027c609719bSwdenk	to be a good choice since it makes it far enough from the
2028c609719bSwdenk	start of the data area as well as from the stack pointer.
2029c609719bSwdenk
2030c609719bSwdenkPlease note that the environment is read-only as long as the monitor
2031c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2032c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2033c609719bSwdenkuntil then to read environment variables.
2034c609719bSwdenk
203585ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
203685ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
203785ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
203885ec0bccSwdenknecessary, because the first environment variable we need is the
203985ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
204085ec0bccSwdenkhave any device yet where we could complain.]
2041c609719bSwdenk
2042c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2043c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
204485ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2045c609719bSwdenk
2046fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2047fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2048fc3e2165Swdenk
2049fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2050fc3e2165Swdenk		      also needs to be defined.
2051fc3e2165Swdenk
2052fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2053fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2054c609719bSwdenk
2055c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2056c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2057c40b2956Swdenk		of 64bit values by using the L quantifier
2058c40b2956Swdenk
2059c40b2956Swdenk- CFG_64BIT_STRTOUL:
2060c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2061c40b2956Swdenk
2062c609719bSwdenkLow Level (hardware related) configuration options:
2063dc7c9a1aSwdenk---------------------------------------------------
2064c609719bSwdenk
2065c609719bSwdenk- CFG_CACHELINE_SIZE:
2066c609719bSwdenk		Cache Line Size of the CPU.
2067c609719bSwdenk
2068c609719bSwdenk- CFG_DEFAULT_IMMR:
2069c609719bSwdenk		Default address of the IMMR after system reset.
20702535d602Swdenk
20712535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
20722535d602Swdenk		and RPXsuper) to be able to adjust the position of
20732535d602Swdenk		the IMMR register after a reset.
2074c609719bSwdenk
20757f6c2cbcSwdenk- Floppy Disk Support:
20767f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
20777f6c2cbcSwdenk
20787f6c2cbcSwdenk		the default drive number (default value 0)
20797f6c2cbcSwdenk
20807f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
20817f6c2cbcSwdenk
20827f6c2cbcSwdenk		defines the spacing between fdc chipset registers
20837f6c2cbcSwdenk		(default value 1)
20847f6c2cbcSwdenk
20857f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
20867f6c2cbcSwdenk
20877f6c2cbcSwdenk		defines the offset of register from address. It
20887f6c2cbcSwdenk		depends on which part of the data bus is connected to
20897f6c2cbcSwdenk		the fdc chipset. (default value 0)
20907f6c2cbcSwdenk
20917f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
20927f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
20937f6c2cbcSwdenk		default value.
20947f6c2cbcSwdenk
20957f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
20967f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
20977f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
20987f6c2cbcSwdenk		source code. It is used to make hardware dependant
20997f6c2cbcSwdenk		initializations.
21007f6c2cbcSwdenk
210125d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
210225d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
210325d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2104c609719bSwdenk
2105c609719bSwdenk- CFG_INIT_RAM_ADDR:
2106c609719bSwdenk
21077152b1d0Swdenk		Start address of memory area that can be used for
2108c609719bSwdenk		initial data and stack; please note that this must be
2109c609719bSwdenk		writable memory that is working WITHOUT special
2110c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2111c609719bSwdenk		will become available only after programming the
2112c609719bSwdenk		memory controller and running certain initialization
2113c609719bSwdenk		sequences.
2114c609719bSwdenk
2115c609719bSwdenk		U-Boot uses the following memory types:
2116c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2117c609719bSwdenk		- MPC824X: data cache
2118c609719bSwdenk		- PPC4xx:  data cache
2119c609719bSwdenk
212085ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2121c609719bSwdenk
2122c609719bSwdenk		Offset of the initial data structure in the memory
2123c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
212485ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2125c609719bSwdenk		data is located at the end of the available space
2126c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2127c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2128c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
212985ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2130c609719bSwdenk
2131c609719bSwdenk	Note:
2132c609719bSwdenk		On the MPC824X (or other systems that use the data
2133c609719bSwdenk		cache for initial memory) the address chosen for
2134c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2135c609719bSwdenk		point to an otherwise UNUSED address space between
2136c609719bSwdenk		the top of RAM and the start of the PCI space.
2137c609719bSwdenk
2138c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2139c609719bSwdenk
2140c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2141c609719bSwdenk
2142c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2143c609719bSwdenk
2144c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2145c609719bSwdenk
2146c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2147c609719bSwdenk
2148c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2149c609719bSwdenk
2150c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2151c609719bSwdenk		SDRAM timing
2152c609719bSwdenk
2153c609719bSwdenk- CFG_MAMR_PTA:
2154c609719bSwdenk		periodic timer for refresh
2155c609719bSwdenk
2156c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2157c609719bSwdenk
2158c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2159c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2160c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2161c609719bSwdenk  CFG_BR1_PRELIM:
2162c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2163c609719bSwdenk
2164c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2165c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2166c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2167c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2168c609719bSwdenk
2169c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2170c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2171c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2172c609719bSwdenk		Prescaler definitions (SDRAM timing)
2173c609719bSwdenk
2174c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2175c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2176c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2177c609719bSwdenk
2178c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2179c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2180c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2181c609719bSwdenk
2182c609719bSwdenk- CFG_USE_OSCCLK:
2183c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2184c609719bSwdenk		wrong setting might damage your board. Read
2185c609719bSwdenk		doc/README.MBX before setting this variable!
2186c609719bSwdenk
2187ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2188ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2189ea909b76Swdenk		(Power On Self Tests). This definition overrides
2190ea909b76Swdenk		#define'd default value in commproc.h resp.
2191ea909b76Swdenk		cpm_8260.h.
2192ea909b76Swdenk
21935d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
21945d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
21955d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
21965d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
21975d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
21985d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
21995d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
22005d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
22015d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
22025d232d0eSwdenk
2203c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2204c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2205c26e454dSwdenk
2206c26e454dSwdenk- CONFIG_FEC[12]_PHY
2207c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
22086e592385Swdenk		to the given FEC; i. e.
2209c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2210c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2211c26e454dSwdenk
2212c26e454dSwdenk		When set to -1, means to probe for first available.
2213c26e454dSwdenk
2214c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2215c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2216c26e454dSwdenk		(so program the FEC to ignore it).
2217c26e454dSwdenk
2218c26e454dSwdenk- CONFIG_RMII
2219c26e454dSwdenk		Enable RMII mode for all FECs.
2220c26e454dSwdenk		Note that this is a global option, we can't
2221c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2222c26e454dSwdenk
22235cf91d6bSwdenk- CONFIG_CRC32_VERIFY
22245cf91d6bSwdenk		Add a verify option to the crc32 command.
22255cf91d6bSwdenk		The syntax is:
22265cf91d6bSwdenk
22275cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
22285cf91d6bSwdenk
22295cf91d6bSwdenk		Where address/count indicate a memory area
22305cf91d6bSwdenk		and crc32 is the correct crc32 which the
22315cf91d6bSwdenk		area should have.
22325cf91d6bSwdenk
223356523f12Swdenk- CONFIG_LOOPW
223456523f12Swdenk		Add the "loopw" memory command. This only takes effect if
223556523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
223656523f12Swdenk
22377b466641Sstroese- CONFIG_MX_CYCLIC
22387b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
22397b466641Sstroese		"md/mw" commands.
22407b466641Sstroese		Examples:
22417b466641Sstroese
22427b466641Sstroese		=> mdc.b 10 4 500
22437b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
22447b466641Sstroese
22457b466641Sstroese		=> mwc.l 100 12345678 10
22467b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
22477b466641Sstroese
22487b466641Sstroese		This only takes effect if the memory commands are activated
22497b466641Sstroese		globally (CFG_CMD_MEM).
22507b466641Sstroese
22518aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
22528aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
22538aa1a2d1Swdenk
22548aa1a2d1Swdenk		[ARM only] If these variables are defined, then
22558aa1a2d1Swdenk		certain low level initializations (like setting up
22568aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
22578aa1a2d1Swdenk		not relocate itself into RAM.
22588aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
22598aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
22608aa1a2d1Swdenk		some other boot loader or by a debugger which
22618aa1a2d1Swdenk		performs these intializations itself.
22628aa1a2d1Swdenk
2263400558b5Swdenk
2264c609719bSwdenkBuilding the Software:
2265c609719bSwdenk======================
2266c609719bSwdenk
2267c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2268c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2269c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2270c609719bSwdenkNetBSD 1.5 on x86).
2271c609719bSwdenk
2272c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2273c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2274c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2275c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2276c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2277c609719bSwdenkchange it to:
2278c609719bSwdenk
2279c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2280c609719bSwdenk
2281c609719bSwdenk
2282c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2283c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2284c609719bSwdenkis done by typing:
2285c609719bSwdenk
2286c609719bSwdenk	make NAME_config
2287c609719bSwdenk
2288c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2289c609719bSwdenkconfigurations; the following names are supported:
2290c609719bSwdenk
22911eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
22921eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2293983fda83Swdenk	Alaska8220_config
22941eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
22951eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
22961eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
22971eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
22981eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2299e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2300e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2301e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2302e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2303e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2304466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2305466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
23068b07a110Swdenk	EBONY_config		MPC8260ADS_config	SM850_config
23078b07a110Swdenk	ELPT860_config		MPC8540ADS_config	SPD823TS_config
2308b0e32949SLunsheng Wang	ESTEEM192E_config	MPC8540EVAL_config	stxgp3_config
2309b0e32949SLunsheng Wang	ETX094_config		MPC8560ADS_config	SXNI855T_config
2310b0e32949SLunsheng Wang	FADS823_config		NETVIA_config		TQM823L_config
2311b0e32949SLunsheng Wang	FADS850SAR_config	omap1510inn_config	TQM850L_config
2312b0e32949SLunsheng Wang	FADS860T_config		omap1610h2_config	TQM855L_config
2313b0e32949SLunsheng Wang	FPS850L_config		omap1610inn_config	TQM860L_config
23144b1d95d9SJon Loeliger				omap5912osk_config	walnut_config
2315b0e32949SLunsheng Wang				omap2420h4_config	Yukon8220_config
23168b07a110Swdenk							ZPC1900_config
231754387ac9Swdenk
2318c609719bSwdenkNote: for some board special configuration names may exist; check if
2319c609719bSwdenk      additional information is available from the board vendor; for
23202729af9dSwdenk      instance, the TQM823L systems are available without (standard)
23212729af9dSwdenk      or with LCD support. You can select such additional "features"
2322c609719bSwdenk      when chosing the configuration, i. e.
2323c609719bSwdenk
23242729af9dSwdenk      make TQM823L_config
23252729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2326c609719bSwdenk
2327c609719bSwdenk      make TQM823L_LCD_config
2328c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2329c609719bSwdenk
2330c609719bSwdenk      etc.
2331c609719bSwdenk
2332c609719bSwdenk
2333c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
23347152b1d0Swdenkimages ready for download to / installation on your system:
2335c609719bSwdenk
2336c609719bSwdenk- "u-boot.bin" is a raw binary image
2337c609719bSwdenk- "u-boot" is an image in ELF binary format
2338c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2339c609719bSwdenk
2340baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2341baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2342baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2343baf31249SMarian Balakowicz
2344baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2345baf31249SMarian Balakowicz
2346baf31249SMarian Balakowicz	make O=/tmp/build distclean
2347baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2348baf31249SMarian Balakowicz	make O=/tmp/build all
2349baf31249SMarian Balakowicz
2350baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2351baf31249SMarian Balakowicz
2352baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2353baf31249SMarian Balakowicz	make distclean
2354baf31249SMarian Balakowicz	make NAME_config
2355baf31249SMarian Balakowicz	make all
2356baf31249SMarian Balakowicz
2357baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2358baf31249SMarian Balakowiczvariable.
2359baf31249SMarian Balakowicz
2360c609719bSwdenk
2361c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2362c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2363c609719bSwdenknative "make".
2364c609719bSwdenk
2365c609719bSwdenk
2366c609719bSwdenkIf the system board that you have is not listed, then you will need
2367c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2368c609719bSwdenksteps:
2369c609719bSwdenk
2370c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
237185ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
237285ec0bccSwdenk    entries as examples. Note that here and at many other places
23737152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
237485ec0bccSwdenk    keep this order.
2375c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
237685ec0bccSwdenk    files you need. In your board directory, you will need at least
237785ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
237885ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
237985ec0bccSwdenk    your board
2380c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2381c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
238285ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2383c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2384c609719bSwdenk    to be installed on your target system.
238585ec0bccSwdenk6.  Debug and solve any problems that might arise.
2386c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2387c609719bSwdenk
2388c609719bSwdenk
2389c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2390c609719bSwdenk==============================================================
2391c609719bSwdenk
2392c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2393c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2394c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2395c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2396c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2397c609719bSwdenk
2398c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2399c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2400c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2401c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2402c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
24037152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2404c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2405c609719bSwdenkMontaVista's Hard Hat Linux you can type
2406c609719bSwdenk
2407c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2408c609719bSwdenk
2409c609719bSwdenkor to build on a native PowerPC system you can type
2410c609719bSwdenk
2411c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2412c609719bSwdenk
2413baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2414baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2415baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2416baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2417baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2418baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2419baf31249SMarian Balakowicz
2420baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2421baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2422baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2423baf31249SMarian Balakowicz
2424baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2425baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2426baf31249SMarian Balakowiczthe whole build process.
2427baf31249SMarian Balakowicz
2428baf31249SMarian Balakowicz
2429c609719bSwdenkSee also "U-Boot Porting Guide" below.
2430c609719bSwdenk
2431c609719bSwdenk
2432c609719bSwdenkMonitor Commands - Overview:
2433c609719bSwdenk============================
2434c609719bSwdenk
2435c609719bSwdenkgo	- start application at address 'addr'
2436c609719bSwdenkrun	- run commands in an environment variable
2437c609719bSwdenkbootm	- boot application image from memory
2438c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2439c609719bSwdenktftpboot- boot image via network using TFTP protocol
2440c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2441c609719bSwdenk	       (and eventually "gatewayip")
2442c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2443c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2444c609719bSwdenkloads	- load S-Record file over serial line
2445c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2446c609719bSwdenkmd	- memory display
2447c609719bSwdenkmm	- memory modify (auto-incrementing)
2448c609719bSwdenknm	- memory modify (constant address)
2449c609719bSwdenkmw	- memory write (fill)
2450c609719bSwdenkcp	- memory copy
2451c609719bSwdenkcmp	- memory compare
2452c609719bSwdenkcrc32	- checksum calculation
2453c609719bSwdenkimd	- i2c memory display
2454c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2455c609719bSwdenkinm	- i2c memory modify (constant address)
2456c609719bSwdenkimw	- i2c memory write (fill)
2457c609719bSwdenkicrc32	- i2c checksum calculation
2458c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2459c609719bSwdenkiloop	- infinite loop on address range
2460c609719bSwdenkisdram	- print SDRAM configuration information
2461c609719bSwdenksspi	- SPI utility commands
2462c609719bSwdenkbase	- print or set address offset
2463c609719bSwdenkprintenv- print environment variables
2464c609719bSwdenksetenv	- set environment variables
2465c609719bSwdenksaveenv - save environment variables to persistent storage
2466c609719bSwdenkprotect - enable or disable FLASH write protection
2467c609719bSwdenkerase	- erase FLASH memory
2468c609719bSwdenkflinfo	- print FLASH memory information
2469c609719bSwdenkbdinfo	- print Board Info structure
2470c609719bSwdenkiminfo	- print header information for application image
2471c609719bSwdenkconinfo - print console devices and informations
2472c609719bSwdenkide	- IDE sub-system
2473c609719bSwdenkloop	- infinite loop on address range
247456523f12Swdenkloopw	- infinite write loop on address range
2475c609719bSwdenkmtest	- simple RAM test
2476c609719bSwdenkicache	- enable or disable instruction cache
2477c609719bSwdenkdcache	- enable or disable data cache
2478c609719bSwdenkreset	- Perform RESET of the CPU
2479c609719bSwdenkecho	- echo args to console
2480c609719bSwdenkversion - print monitor version
2481c609719bSwdenkhelp	- print online help
2482c609719bSwdenk?	- alias for 'help'
2483c609719bSwdenk
2484c609719bSwdenk
2485c609719bSwdenkMonitor Commands - Detailed Description:
2486c609719bSwdenk========================================
2487c609719bSwdenk
2488c609719bSwdenkTODO.
2489c609719bSwdenk
2490c609719bSwdenkFor now: just type "help <command>".
2491c609719bSwdenk
2492c609719bSwdenk
2493c609719bSwdenkEnvironment Variables:
2494c609719bSwdenk======================
2495c609719bSwdenk
2496c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2497c609719bSwdenkcan be made persistent by saving to Flash memory.
2498c609719bSwdenk
2499c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2500c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2501c609719bSwdenkwithout a value can be used to delete a variable from the
2502c609719bSwdenkenvironment. As long as you don't save the environment you are
2503c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2504c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2505c609719bSwdenk
2506c609719bSwdenkSome configuration options can be set using Environment Variables:
2507c609719bSwdenk
2508c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2509c609719bSwdenk
2510c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2511c609719bSwdenk
2512c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2513c609719bSwdenk
2514c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2515c609719bSwdenk
2516c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2517c609719bSwdenk
2518c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2519c609719bSwdenk		  "bootp" will just load perform a lookup of the
2520c609719bSwdenk		  configuration from the BOOTP server, but not try to
2521c609719bSwdenk		  load any image using TFTP
2522c609719bSwdenk
2523c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2524c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2525c609719bSwdenk		  be automatically started (by internally calling
2526c609719bSwdenk		  "bootm")
2527c609719bSwdenk
25284a6fd34bSwdenk		  If set to "no", a standalone image passed to the
25294a6fd34bSwdenk		  "bootm" command will be copied to the load address
25304a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
25314a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
25324a6fd34bSwdenk		  data.
25334a6fd34bSwdenk
253417ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
253517ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
253617ea1177Swdenk		  mode (400kHZ). This environment variable is used in
253717ea1177Swdenk		  initialization code. So, for changes to be effective
253817ea1177Swdenk		  it must be saved and board must be reset.
253917ea1177Swdenk
2540c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2541c609719bSwdenk		  If this variable is not set, initrd images will be
2542c609719bSwdenk		  copied to the highest possible address in RAM; this
2543c609719bSwdenk		  is usually what you want since it allows for
2544c609719bSwdenk		  maximum initrd size. If for some reason you want to
2545c609719bSwdenk		  make sure that the initrd image is loaded below the
2546c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2547c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2548c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2549c609719bSwdenk		  address to use (U-Boot will still check that it
2550c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2551c609719bSwdenk
2552c609719bSwdenk		  For instance, when you have a system with 16 MB
25537152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2554c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2555c609719bSwdenk		  the "bootargs" variable. However, now you must make
25567152b1d0Swdenk		  sure that the initrd image is placed in the first
2557c609719bSwdenk		  12 MB as well - this can be done with
2558c609719bSwdenk
2559c609719bSwdenk		  setenv initrd_high 00c00000
2560c609719bSwdenk
256138b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
256238b99261Swdenk		  indication to U-Boot that all addresses are legal
256338b99261Swdenk		  for the Linux kernel, including addresses in flash
256438b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
256538b99261Swdenk		  ramdisk at all. This may be useful to reduce the
256638b99261Swdenk		  boot time on your system, but requires that this
256738b99261Swdenk		  feature is supported by your Linux kernel.
256838b99261Swdenk
2569c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2570c609719bSwdenk
2571c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2572dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2573c609719bSwdenk
2574c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2575c609719bSwdenk
2576c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2577c609719bSwdenk
2578c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2579c609719bSwdenk
2580c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2581c609719bSwdenk
2582c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2583c609719bSwdenk
2584a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2585a3d991bdSwdenk		  interface is used first.
2586a3d991bdSwdenk
2587a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2588a3d991bdSwdenk		  interface is currently active. For example you
2589a3d991bdSwdenk		  can do the following
2590a3d991bdSwdenk
2591a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2592a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2593a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2594a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2595a3d991bdSwdenk
2596a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2597a3d991bdSwdenk		  either succeed or fail without retrying.
25986e592385Swdenk		  When set to "once" the network operation will
25996e592385Swdenk		  fail when all the available network interfaces
26006e592385Swdenk		  are tried once without success.
2601a3d991bdSwdenk		  Useful on scripts which control the retry operation
2602a3d991bdSwdenk		  themselves.
2603a3d991bdSwdenk
260428cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2605ecb0ccd9SWolfgang Denk		  UDP source port.
2606ecb0ccd9SWolfgang Denk
260728cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
260828cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
260928cb9375SWolfgang Denk
2610a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2611a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2612a3d991bdSwdenk		  VLAN tagged frames.
2613c609719bSwdenk
2614c609719bSwdenkThe following environment variables may be used and automatically
2615c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2616c609719bSwdenkdepending the information provided by your boot server:
2617c609719bSwdenk
2618c609719bSwdenk  bootfile	- see above
2619c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2620fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2621c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2622c609719bSwdenk  hostname	- Target hostname
2623c609719bSwdenk  ipaddr	- see above
2624c609719bSwdenk  netmask	- Subnet Mask
2625c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2626c609719bSwdenk  serverip	- see above
2627c609719bSwdenk
2628c609719bSwdenk
2629c609719bSwdenkThere are two special Environment Variables:
2630c609719bSwdenk
2631c609719bSwdenk  serial#	- contains hardware identification information such
2632c609719bSwdenk		  as type string and/or serial number
2633c609719bSwdenk  ethaddr	- Ethernet address
2634c609719bSwdenk
2635c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2636c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2637c609719bSwdenkonce they have been set once.
2638c609719bSwdenk
2639c609719bSwdenk
2640c1551ea8SstroeseFurther special Environment Variables:
2641c1551ea8Sstroese
2642c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2643c1551ea8Sstroese		  with the "version" command. This variable is
2644c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2645c1551ea8Sstroese
2646c1551ea8Sstroese
2647c609719bSwdenkPlease note that changes to some configuration parameters may take
2648c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2649c609719bSwdenk
2650c609719bSwdenk
2651f07771ccSwdenkCommand Line Parsing:
2652f07771ccSwdenk=====================
2653f07771ccSwdenk
2654f07771ccSwdenkThere are two different command line parsers available with U-Boot:
26557152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2656f07771ccSwdenk
2657f07771ccSwdenkOld, simple command line parser:
2658f07771ccSwdenk--------------------------------
2659f07771ccSwdenk
2660f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2661f07771ccSwdenk- several commands on one line, separated by ';'
2662fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2663f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2664f07771ccSwdenk  for example:
2665fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2666f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2667f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2668f07771ccSwdenk
2669f07771ccSwdenkHush shell:
2670f07771ccSwdenk-----------
2671f07771ccSwdenk
2672f07771ccSwdenk- similar to Bourne shell, with control structures like
2673f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2674f07771ccSwdenk  until...do...done, ...
2675f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2676f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2677f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2678f07771ccSwdenk  command
2679f07771ccSwdenk
2680f07771ccSwdenkGeneral rules:
2681f07771ccSwdenk--------------
2682f07771ccSwdenk
2683f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2684f07771ccSwdenk    command) contains several commands separated by semicolon, and
2685f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2686f07771ccSwdenk    executed anyway.
2687f07771ccSwdenk
2688f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2689f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2690f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2691f07771ccSwdenk    variables are not executed.
2692f07771ccSwdenk
2693c609719bSwdenkNote for Redundant Ethernet Interfaces:
2694c609719bSwdenk=======================================
2695c609719bSwdenk
26967152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2697c609719bSwdenksuch configurations and is capable of automatic selection of a
26987152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2699c609719bSwdenk
2700c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2701c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2702c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2703c609719bSwdenk
2704c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2705c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2706c609719bSwdenkding setting in the environment; if the corresponding environment
2707c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2708c609719bSwdenk
2709c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2710c609719bSwdenk  environment, the SROM's address is used.
2711c609719bSwdenk
2712c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2713c609719bSwdenk  environment exists, then the value from the environment variable is
2714c609719bSwdenk  used.
2715c609719bSwdenk
2716c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2717c609719bSwdenk  both addresses are the same, this MAC address is used.
2718c609719bSwdenk
2719c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2720c609719bSwdenk  addresses differ, the value from the environment is used and a
2721c609719bSwdenk  warning is printed.
2722c609719bSwdenk
2723c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2724c609719bSwdenk  is raised.
2725c609719bSwdenk
2726c609719bSwdenk
2727c609719bSwdenkImage Formats:
2728c609719bSwdenk==============
2729c609719bSwdenk
2730c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2731c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2732c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2733c609719bSwdenkdefines the following image properties:
2734c609719bSwdenk
2735c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2736c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
27377f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
27381f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
27397b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
27403d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
27417b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2742c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2743c609719bSwdenk* Load Address
2744c609719bSwdenk* Entry Point
2745c609719bSwdenk* Image Name
2746c609719bSwdenk* Image Timestamp
2747c609719bSwdenk
2748c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2749c609719bSwdenkand the data portions of the image are secured against corruption by
2750c609719bSwdenkCRC32 checksums.
2751c609719bSwdenk
2752c609719bSwdenk
2753c609719bSwdenkLinux Support:
2754c609719bSwdenk==============
2755c609719bSwdenk
2756c609719bSwdenkAlthough U-Boot should support any OS or standalone application
27577152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2758c609719bSwdenkU-Boot.
2759c609719bSwdenk
2760c609719bSwdenkU-Boot includes many features that so far have been part of some
2761c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2762c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2763c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
27647152b1d0Swdenkserves several purposes:
2765c609719bSwdenk
2766c609719bSwdenk- the same features can be used for other OS or standalone
2767c609719bSwdenk  applications (for instance: using compressed images to reduce the
2768c609719bSwdenk  Flash memory footprint)
2769c609719bSwdenk
2770c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
27717152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2772c609719bSwdenk
2773c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2774c609719bSwdenk  images; of course this also means that different kernel images can
2775c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2776c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2777c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2778c609719bSwdenk  software is easier now.
2779c609719bSwdenk
2780c609719bSwdenk
2781c609719bSwdenkLinux HOWTO:
2782c609719bSwdenk============
2783c609719bSwdenk
2784c609719bSwdenkPorting Linux to U-Boot based systems:
2785c609719bSwdenk---------------------------------------
2786c609719bSwdenk
2787c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2788c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2789c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2790c609719bSwdenkLinux :-).
2791c609719bSwdenk
2792c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2793c609719bSwdenk
2794c609719bSwdenkJust make sure your machine specific header file (for instance
2795c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2796c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2797c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2798c609719bSwdenkU-Boot configuration in CFG_IMMR.
2799c609719bSwdenk
2800c609719bSwdenk
2801c609719bSwdenkConfiguring the Linux kernel:
2802c609719bSwdenk-----------------------------
2803c609719bSwdenk
2804c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2805c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2806c609719bSwdenk
2807c609719bSwdenk
2808c609719bSwdenkBuilding a Linux Image:
2809c609719bSwdenk-----------------------
2810c609719bSwdenk
281124ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
281224ee89b9Swdenknot used. If you use recent kernel source, a new build target
281324ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
281424ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
281524ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
281624ee89b9Swdenk100% compatible format.
2817c609719bSwdenk
2818c609719bSwdenkExample:
2819c609719bSwdenk
2820c609719bSwdenk	make TQM850L_config
2821c609719bSwdenk	make oldconfig
2822c609719bSwdenk	make dep
282324ee89b9Swdenk	make uImage
2824c609719bSwdenk
282524ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
282624ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
282724ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2828c609719bSwdenk
282924ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
283024ee89b9Swdenk
283124ee89b9Swdenk* convert the kernel into a raw binary image:
283224ee89b9Swdenk
283324ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
283424ee89b9Swdenk				 -R .note -R .comment \
283524ee89b9Swdenk				 -S vmlinux linux.bin
283624ee89b9Swdenk
283724ee89b9Swdenk* compress the binary image:
283824ee89b9Swdenk
283924ee89b9Swdenk	gzip -9 linux.bin
284024ee89b9Swdenk
284124ee89b9Swdenk* package compressed binary image for U-Boot:
284224ee89b9Swdenk
284324ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
284424ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
284524ee89b9Swdenk		-d linux.bin.gz uImage
284624ee89b9Swdenk
284724ee89b9Swdenk
284824ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
284924ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
285024ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
285124ee89b9Swdenkbyte header containing information about target architecture,
285224ee89b9Swdenkoperating system, image type, compression method, entry points, time
285324ee89b9Swdenkstamp, CRC32 checksums, etc.
285424ee89b9Swdenk
285524ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
285624ee89b9Swdenkprint the header information, or to build new images.
2857c609719bSwdenk
2858c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
2859c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
2860c609719bSwdenkchecksum verification:
2861c609719bSwdenk
2862c609719bSwdenk	tools/mkimage -l image
2863c609719bSwdenk	  -l ==> list image header information
2864c609719bSwdenk
2865c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
2866c609719bSwdenkfrom a "data file" which is used as image payload:
2867c609719bSwdenk
2868c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
2869c609719bSwdenk		      -n name -d data_file image
2870c609719bSwdenk	  -A ==> set architecture to 'arch'
2871c609719bSwdenk	  -O ==> set operating system to 'os'
2872c609719bSwdenk	  -T ==> set image type to 'type'
2873c609719bSwdenk	  -C ==> set compression type 'comp'
2874c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
2875c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
2876c609719bSwdenk	  -n ==> set image name to 'name'
2877c609719bSwdenk	  -d ==> use image data from 'datafile'
2878c609719bSwdenk
287969459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
288069459791Swdenkaddress (0x00000000), but the entry point address depends on the
288169459791Swdenkkernel version:
2882c609719bSwdenk
2883c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
288424ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
2885c609719bSwdenk
2886c609719bSwdenkSo a typical call to build a U-Boot image would read:
2887c609719bSwdenk
288824ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
288924ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
289024ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
289124ee89b9Swdenk	> examples/uImage.TQM850L
289224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2893c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2894c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2895c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2896c609719bSwdenk	Load Address: 0x00000000
289724ee89b9Swdenk	Entry Point:  0x00000000
2898c609719bSwdenk
2899c609719bSwdenkTo verify the contents of the image (or check for corruption):
2900c609719bSwdenk
290124ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
290224ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2903c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2904c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
2905c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
2906c609719bSwdenk	Load Address: 0x00000000
290724ee89b9Swdenk	Entry Point:  0x00000000
2908c609719bSwdenk
2909c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
2910c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
2911c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
2912c609719bSwdenkneed to be uncompressed:
2913c609719bSwdenk
291424ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
291524ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
291624ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
291724ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
291824ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
291924ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
2920c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
2921c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
2922c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
2923c609719bSwdenk	Load Address: 0x00000000
292424ee89b9Swdenk	Entry Point:  0x00000000
2925c609719bSwdenk
2926c609719bSwdenk
2927c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
2928c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
2929c609719bSwdenk
2930c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
2931c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
2932c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
2933c609719bSwdenk	Image Name:   Simple Ramdisk Image
2934c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
2935c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
2936c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
2937c609719bSwdenk	Load Address: 0x00000000
2938c609719bSwdenk	Entry Point:  0x00000000
2939c609719bSwdenk
2940c609719bSwdenk
2941c609719bSwdenkInstalling a Linux Image:
2942c609719bSwdenk-------------------------
2943c609719bSwdenk
2944c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
2945c609719bSwdenkyou must convert the image to S-Record format:
2946c609719bSwdenk
2947c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
2948c609719bSwdenk
2949c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
2950c609719bSwdenkimage header, so the resulting S-Record file will be relative to
2951c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
2952c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
2953c609719bSwdenkcommand.
2954c609719bSwdenk
2955c609719bSwdenkExample: install the image to address 0x40100000 (which on the
2956c609719bSwdenkTQM8xxL is in the first Flash bank):
2957c609719bSwdenk
2958c609719bSwdenk	=> erase 40100000 401FFFFF
2959c609719bSwdenk
2960c609719bSwdenk	.......... done
2961c609719bSwdenk	Erased 8 sectors
2962c609719bSwdenk
2963c609719bSwdenk	=> loads 40100000
2964c609719bSwdenk	## Ready for S-Record download ...
2965c609719bSwdenk	~>examples/image.srec
2966c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
2967c609719bSwdenk	...
2968c609719bSwdenk	15989 15990 15991 15992
2969c609719bSwdenk	[file transfer complete]
2970c609719bSwdenk	[connected]
2971c609719bSwdenk	## Start Addr = 0x00000000
2972c609719bSwdenk
2973c609719bSwdenk
2974c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
2975c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
2976c609719bSwdenkcorruption happened:
2977c609719bSwdenk
2978c609719bSwdenk	=> imi 40100000
2979c609719bSwdenk
2980c609719bSwdenk	## Checking Image at 40100000 ...
2981c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
2982c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
2983c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
2984c609719bSwdenk	   Load Address: 00000000
2985c609719bSwdenk	   Entry Point:	 0000000c
2986c609719bSwdenk	   Verifying Checksum ... OK
2987c609719bSwdenk
2988c609719bSwdenk
2989c609719bSwdenkBoot Linux:
2990c609719bSwdenk-----------
2991c609719bSwdenk
2992c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
2993c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
2994c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
2995c609719bSwdenkparameters. You can check and modify this variable using the
2996c609719bSwdenk"printenv" and "setenv" commands:
2997c609719bSwdenk
2998c609719bSwdenk
2999c609719bSwdenk	=> printenv bootargs
3000c609719bSwdenk	bootargs=root=/dev/ram
3001c609719bSwdenk
3002c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3003c609719bSwdenk
3004c609719bSwdenk	=> printenv bootargs
3005c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3006c609719bSwdenk
3007c609719bSwdenk	=> bootm 40020000
3008c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3009c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3010c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3011c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3012c609719bSwdenk	   Load Address: 00000000
3013c609719bSwdenk	   Entry Point:	 0000000c
3014c609719bSwdenk	   Verifying Checksum ... OK
3015c609719bSwdenk	   Uncompressing Kernel Image ... OK
3016c609719bSwdenk	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
3017c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3018c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3019c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3020c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3021c609719bSwdenk	...
3022c609719bSwdenk
3023c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
30247152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3025c609719bSwdenkformat!) to the "bootm" command:
3026c609719bSwdenk
3027c609719bSwdenk	=> imi 40100000 40200000
3028c609719bSwdenk
3029c609719bSwdenk	## Checking Image at 40100000 ...
3030c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3031c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3032c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3033c609719bSwdenk	   Load Address: 00000000
3034c609719bSwdenk	   Entry Point:	 0000000c
3035c609719bSwdenk	   Verifying Checksum ... OK
3036c609719bSwdenk
3037c609719bSwdenk	## Checking Image at 40200000 ...
3038c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3039c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3040c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3041c609719bSwdenk	   Load Address: 00000000
3042c609719bSwdenk	   Entry Point:	 00000000
3043c609719bSwdenk	   Verifying Checksum ... OK
3044c609719bSwdenk
3045c609719bSwdenk	=> bootm 40100000 40200000
3046c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3047c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3048c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3049c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3050c609719bSwdenk	   Load Address: 00000000
3051c609719bSwdenk	   Entry Point:	 0000000c
3052c609719bSwdenk	   Verifying Checksum ... OK
3053c609719bSwdenk	   Uncompressing Kernel Image ... OK
3054c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3055c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3056c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3057c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3058c609719bSwdenk	   Load Address: 00000000
3059c609719bSwdenk	   Entry Point:	 00000000
3060c609719bSwdenk	   Verifying Checksum ... OK
3061c609719bSwdenk	   Loading Ramdisk ... OK
3062c609719bSwdenk	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
3063c609719bSwdenk	Boot arguments: root=/dev/ram
3064c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3065c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3066c609719bSwdenk	...
3067c609719bSwdenk	RAMDISK: Compressed image found at block 0
3068c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3069c609719bSwdenk
3070c609719bSwdenk	bash#
3071c609719bSwdenk
30726069ff26SwdenkMore About U-Boot Image Types:
30736069ff26Swdenk------------------------------
30746069ff26Swdenk
30756069ff26SwdenkU-Boot supports the following image types:
30766069ff26Swdenk
30776069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
30786069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
30796069ff26Swdenk	well) you can continue to work in U-Boot after return from
30806069ff26Swdenk	the Standalone Program.
30816069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
30826069ff26Swdenk	will take over control completely. Usually these programs
30836069ff26Swdenk	will install their own set of exception handlers, device
30846069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
30856069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
30866069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
30876069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
30886069ff26Swdenk	being started.
30896069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
30906069ff26Swdenk	(Linux) kernel image and one or more data images like
30916069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
30926069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
30936069ff26Swdenk	server provides just a single image file, but you want to get
30946069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
30956069ff26Swdenk
30966069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
30976069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
30986069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
30996069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
31006069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
31016069ff26Swdenk	a multiple of 4 bytes).
31026069ff26Swdenk
31036069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
31046069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
31056069ff26Swdenk	flash memory.
31066069ff26Swdenk
31076069ff26Swdenk   "Script files" are command sequences that will be executed by
31086069ff26Swdenk	U-Boot's command interpreter; this feature is especially
31096069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
31106069ff26Swdenk	as command interpreter.
31116069ff26Swdenk
3112c609719bSwdenk
3113c609719bSwdenkStandalone HOWTO:
3114c609719bSwdenk=================
3115c609719bSwdenk
3116c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3117c609719bSwdenkrun "standalone" applications, which can use some resources of
3118c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3119c609719bSwdenk
3120c609719bSwdenkTwo simple examples are included with the sources:
3121c609719bSwdenk
3122c609719bSwdenk"Hello World" Demo:
3123c609719bSwdenk-------------------
3124c609719bSwdenk
3125c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3126c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3127c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3128c609719bSwdenklike that:
3129c609719bSwdenk
3130c609719bSwdenk	=> loads
3131c609719bSwdenk	## Ready for S-Record download ...
3132c609719bSwdenk	~>examples/hello_world.srec
3133c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3134c609719bSwdenk	[file transfer complete]
3135c609719bSwdenk	[connected]
3136c609719bSwdenk	## Start Addr = 0x00040004
3137c609719bSwdenk
3138c609719bSwdenk	=> go 40004 Hello World! This is a test.
3139c609719bSwdenk	## Starting application at 0x00040004 ...
3140c609719bSwdenk	Hello World
3141c609719bSwdenk	argc = 7
3142c609719bSwdenk	argv[0] = "40004"
3143c609719bSwdenk	argv[1] = "Hello"
3144c609719bSwdenk	argv[2] = "World!"
3145c609719bSwdenk	argv[3] = "This"
3146c609719bSwdenk	argv[4] = "is"
3147c609719bSwdenk	argv[5] = "a"
3148c609719bSwdenk	argv[6] = "test."
3149c609719bSwdenk	argv[7] = "<NULL>"
3150c609719bSwdenk	Hit any key to exit ...
3151c609719bSwdenk
3152c609719bSwdenk	## Application terminated, rc = 0x0
3153c609719bSwdenk
3154c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3155c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3156c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3157c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3158c609719bSwdenkcharacter, but this is just a demo program. The application can be
3159c609719bSwdenkcontrolled by the following keys:
3160c609719bSwdenk
3161c609719bSwdenk	? - print current values og the CPM Timer registers
3162c609719bSwdenk	b - enable interrupts and start timer
3163c609719bSwdenk	e - stop timer and disable interrupts
3164c609719bSwdenk	q - quit application
3165c609719bSwdenk
3166c609719bSwdenk	=> loads
3167c609719bSwdenk	## Ready for S-Record download ...
3168c609719bSwdenk	~>examples/timer.srec
3169c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3170c609719bSwdenk	[file transfer complete]
3171c609719bSwdenk	[connected]
3172c609719bSwdenk	## Start Addr = 0x00040004
3173c609719bSwdenk
3174c609719bSwdenk	=> go 40004
3175c609719bSwdenk	## Starting application at 0x00040004 ...
3176c609719bSwdenk	TIMERS=0xfff00980
3177c609719bSwdenk	Using timer 1
3178c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3179c609719bSwdenk
3180c609719bSwdenkHit 'b':
3181c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3182c609719bSwdenk	Enabling timer
3183c609719bSwdenkHit '?':
3184c609719bSwdenk	[q, b, e, ?] ........
3185c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3186c609719bSwdenkHit '?':
3187c609719bSwdenk	[q, b, e, ?] .
3188c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3189c609719bSwdenkHit '?':
3190c609719bSwdenk	[q, b, e, ?] .
3191c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3192c609719bSwdenkHit '?':
3193c609719bSwdenk	[q, b, e, ?] .
3194c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3195c609719bSwdenkHit 'e':
3196c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3197c609719bSwdenkHit 'q':
3198c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3199c609719bSwdenk
3200c609719bSwdenk
320185ec0bccSwdenkMinicom warning:
320285ec0bccSwdenk================
320385ec0bccSwdenk
32047152b1d0SwdenkOver time, many people have reported problems when trying to use the
320585ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
320685ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3207f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
320885ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
320985ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
321085ec0bccSwdenk
321152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
321252f52c14Swdenkconfiguration to your "File transfer protocols" section:
321352f52c14Swdenk
321452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
321552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
321652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
321752f52c14Swdenk
321852f52c14Swdenk
3219c609719bSwdenkNetBSD Notes:
3220c609719bSwdenk=============
3221c609719bSwdenk
3222c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3223c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3224c609719bSwdenk
3225c609719bSwdenkBuilding requires a cross environment; it is known to work on
3226c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3227c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3228c609719bSwdenkNote that the cross-powerpc package does not install include files;
3229c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3230c609719bSwdenkmissing.  This file has to be installed and patched manually:
3231c609719bSwdenk
3232c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3233c609719bSwdenk	# mkdir powerpc
3234c609719bSwdenk	# ln -s powerpc machine
3235c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3236c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3237c609719bSwdenk
3238c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3239c609719bSwdenkand U-Boot include files.
3240c609719bSwdenk
3241c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3242c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3243c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3244c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
32452a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3246c609719bSwdenk
3247c609719bSwdenk
3248c609719bSwdenkImplementation Internals:
3249c609719bSwdenk=========================
3250c609719bSwdenk
3251c609719bSwdenkThe following is not intended to be a complete description of every
3252c609719bSwdenkimplementation detail. However, it should help to understand the
3253c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3254c609719bSwdenkhardware.
3255c609719bSwdenk
3256c609719bSwdenk
3257c609719bSwdenkInitial Stack, Global Data:
3258c609719bSwdenk---------------------------
3259c609719bSwdenk
3260c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3261c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3262c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3263c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3264c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3265c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3266c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3267c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3268c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3269c609719bSwdenklocked as (mis-) used as memory, etc.
3270c609719bSwdenk
32717152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
327243d9616cSwdenk	u-boot-users mailing list:
327343d9616cSwdenk
327443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
327543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
327643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
327743d9616cSwdenk	...
327843d9616cSwdenk
327943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
328043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
328143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
328243d9616cSwdenk	is that the cache is being used as a temporary supply of
328343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
328443d9616cSwdenk	beyond the scope of this list to expain the details, but you
328543d9616cSwdenk	can see how this works by studying the cache architecture and
328643d9616cSwdenk	operation in the architecture and processor-specific manuals.
328743d9616cSwdenk
328843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
328943d9616cSwdenk	is another option for the system designer to use as an
329043d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
329143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
329243d9616cSwdenk	board designers haven't used it for something that would
329343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
329443d9616cSwdenk	used.
329543d9616cSwdenk
329643d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
329743d9616cSwdenk	with your processor/board/system design. The default value
329843d9616cSwdenk	you will find in any recent u-boot distribution in
32998a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
330043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
330143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
330243d9616cSwdenk	that are supposed to respond to that address! That code in
330343d9616cSwdenk	start.S has been around a while and should work as is when
330443d9616cSwdenk	you get the config right.
330543d9616cSwdenk
330643d9616cSwdenk	-Chris Hallinan
330743d9616cSwdenk	DS4.COM, Inc.
330843d9616cSwdenk
3309c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3310c609719bSwdenkcode for the initialization procedures:
3311c609719bSwdenk
3312c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3313c609719bSwdenk  to write it.
3314c609719bSwdenk
3315c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3316c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
33177152b1d0Swdenk  zation is performed later (when relocating to RAM).
3318c609719bSwdenk
3319c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3320c609719bSwdenk  that.
3321c609719bSwdenk
3322c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3323c609719bSwdenknormal global data to share information beween the code. But it
3324c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3325c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3326c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3327c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3328c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3329c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3330c609719bSwdenkreserve for this purpose.
3331c609719bSwdenk
33327152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3333c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3334c609719bSwdenkGCC's implementation.
3335c609719bSwdenk
3336c609719bSwdenkFor PowerPC, the following registers have specific use:
3337c609719bSwdenk	R1:	stack pointer
3338c609719bSwdenk	R2:	TOC pointer
3339c609719bSwdenk	R3-R4:	parameter passing and return values
3340c609719bSwdenk	R5-R10: parameter passing
3341c609719bSwdenk	R13:	small data area pointer
3342c609719bSwdenk	R30:	GOT pointer
3343c609719bSwdenk	R31:	frame pointer
3344c609719bSwdenk
3345c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3346c609719bSwdenk
3347c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3348c609719bSwdenk
3349c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3350c609719bSwdenk    address of the global data structure is known at compile time),
3351c609719bSwdenk    but it turned out that reserving a register results in somewhat
3352c609719bSwdenk    smaller code - although the code savings are not that big (on
3353c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3354c609719bSwdenk    624 text + 127 data).
3355c609719bSwdenk
3356c609719bSwdenkOn ARM, the following registers are used:
3357c609719bSwdenk
3358c609719bSwdenk	R0:	function argument word/integer result
3359c609719bSwdenk	R1-R3:	function argument word
3360c609719bSwdenk	R9:	GOT pointer
3361c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3362c609719bSwdenk	R11:	argument (frame) pointer
3363c609719bSwdenk	R12:	temporary workspace
3364c609719bSwdenk	R13:	stack pointer
3365c609719bSwdenk	R14:	link register
3366c609719bSwdenk	R15:	program counter
3367c609719bSwdenk
3368c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3369c609719bSwdenk
3370d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3371d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3372c609719bSwdenk
3373c609719bSwdenkMemory Management:
3374c609719bSwdenk------------------
3375c609719bSwdenk
3376c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3377c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3378c609719bSwdenk
3379c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3380c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3381c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3382c609719bSwdenkphysical memory banks.
3383c609719bSwdenk
3384c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3385c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3386c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3387c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3388c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3389c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3390c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3391c609719bSwdenk
3392c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3393c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3394c609719bSwdenk
3395c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3396c609719bSwdenkthis:
3397c609719bSwdenk
3398c609719bSwdenk	0x0000 0000	Exception Vector code
3399c609719bSwdenk	      :
3400c609719bSwdenk	0x0000 1FFF
3401c609719bSwdenk	0x0000 2000	Free for Application Use
3402c609719bSwdenk	      :
3403c609719bSwdenk	      :
3404c609719bSwdenk
3405c609719bSwdenk	      :
3406c609719bSwdenk	      :
3407c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3408c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3409c609719bSwdenk	0x00FC 0000	Malloc Arena
3410c609719bSwdenk	      :
3411c609719bSwdenk	0x00FD FFFF
3412c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3413c609719bSwdenk	...		eventually: LCD or video framebuffer
3414c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3415c609719bSwdenk	0x00FF FFFF	[End of RAM]
3416c609719bSwdenk
3417c609719bSwdenk
3418c609719bSwdenkSystem Initialization:
3419c609719bSwdenk----------------------
3420c609719bSwdenk
3421c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3422c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3423c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
34247152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3425c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3426c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3427c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3428c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3429c609719bSwdenkthe caches and the SIU.
3430c609719bSwdenk
3431c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3432c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3433c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3434c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3435c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3436c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3437c609719bSwdenkbanks.
3438c609719bSwdenk
3439c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
34407152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3441c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3442c609719bSwdenk0x00000000, with any additional banks following immediately to create
3443c609719bSwdenkcontiguous memory starting from 0.
3444c609719bSwdenk
3445c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3446c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3447c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3448c609719bSwdenkpages, and the final stack is set up.
3449c609719bSwdenk
3450c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3451c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3452c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3453c609719bSwdenknew address in RAM.
3454c609719bSwdenk
3455c609719bSwdenk
3456c609719bSwdenkU-Boot Porting Guide:
3457c609719bSwdenk----------------------
3458c609719bSwdenk
3459c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
34606aff3115Swdenklist, October 2002]
3461c609719bSwdenk
3462c609719bSwdenk
3463c609719bSwdenkint main (int argc, char *argv[])
3464c609719bSwdenk{
3465c609719bSwdenk	sighandler_t no_more_time;
3466c609719bSwdenk
3467c609719bSwdenk	signal (SIGALRM, no_more_time);
3468c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3469c609719bSwdenk
3470c609719bSwdenk	if (available_money > available_manpower) {
3471c609719bSwdenk		pay consultant to port U-Boot;
3472c609719bSwdenk		return 0;
3473c609719bSwdenk	}
3474c609719bSwdenk
3475c609719bSwdenk	Download latest U-Boot source;
3476c609719bSwdenk
34776aff3115Swdenk	Subscribe to u-boot-users mailing list;
34786aff3115Swdenk
3479c609719bSwdenk	if (clueless) {
3480c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3481c609719bSwdenk	}
3482c609719bSwdenk
3483c609719bSwdenk	while (learning) {
3484c609719bSwdenk		Read the README file in the top level directory;
34857cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3486c609719bSwdenk		Read the source, Luke;
3487c609719bSwdenk	}
3488c609719bSwdenk
3489c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3490c609719bSwdenk		Buy a BDI2000;
3491c609719bSwdenk	} else {
3492c609719bSwdenk		Add a lot of aggravation and time;
3493c609719bSwdenk	}
3494c609719bSwdenk
3495c609719bSwdenk	Create your own board support subdirectory;
3496c609719bSwdenk
34976aff3115Swdenk	Create your own board config file;
34986aff3115Swdenk
3499c609719bSwdenk	while (!running) {
3500c609719bSwdenk		do {
3501c609719bSwdenk			Add / modify source code;
3502c609719bSwdenk		} until (compiles);
3503c609719bSwdenk		Debug;
3504c609719bSwdenk		if (clueless)
3505c609719bSwdenk			email ("Hi, I am having problems...");
3506c609719bSwdenk	}
3507c609719bSwdenk	Send patch file to Wolfgang;
3508c609719bSwdenk
3509c609719bSwdenk	return 0;
3510c609719bSwdenk}
3511c609719bSwdenk
3512c609719bSwdenkvoid no_more_time (int sig)
3513c609719bSwdenk{
3514c609719bSwdenk      hire_a_guru();
3515c609719bSwdenk}
3516c609719bSwdenk
3517c609719bSwdenk
3518c609719bSwdenkCoding Standards:
3519c609719bSwdenk-----------------
3520c609719bSwdenk
3521c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
35222c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
35232c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
35242c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
35252c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3526c609719bSwdenk
35272c051651SDetlev ZundelSource files originating from a different project (for example the
35282c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
35292c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
35302c051651SDetlev Zundelsources.
35312c051651SDetlev Zundel
35322c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
35332c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
35342c051651SDetlev Zundelin your code.
3535c609719bSwdenk
3536c178d3daSwdenkPlease also stick to the following formatting rules:
3537180d3f74Swdenk- remove any trailing white space
3538180d3f74Swdenk- use TAB characters for indentation, not spaces
3539180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3540180d3f74Swdenk- do not add more than 2 empty lines to source files
3541180d3f74Swdenk- do not add trailing empty lines to source files
3542180d3f74Swdenk
3543c609719bSwdenkSubmissions which do not conform to the standards may be returned
3544c609719bSwdenkwith a request to reformat the changes.
3545c609719bSwdenk
3546c609719bSwdenk
3547c609719bSwdenkSubmitting Patches:
3548c609719bSwdenk-------------------
3549c609719bSwdenk
3550c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3551c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3552c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3553c609719bSwdenk
355490dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3555c609719bSwdenk
3556c609719bSwdenkWhen you send a patch, please include the following information with
3557c609719bSwdenkit:
3558c609719bSwdenk
3559c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3560c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3561c609719bSwdenk  patch actually fixes something.
3562c609719bSwdenk
3563c609719bSwdenk* For new features: a description of the feature and your
3564c609719bSwdenk  implementation.
3565c609719bSwdenk
3566c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3567c609719bSwdenk
3568c609719bSwdenk* For major contributions, your entry to the CREDITS file
3569c609719bSwdenk
3570c609719bSwdenk* When you add support for a new board, don't forget to add this
3571c609719bSwdenk  board to the MAKEALL script, too.
3572c609719bSwdenk
3573c609719bSwdenk* If your patch adds new configuration options, don't forget to
3574c609719bSwdenk  document these in the README file.
3575c609719bSwdenk
3576c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3577c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3578c609719bSwdenk  version of diff does not support these options, then get the latest
3579c609719bSwdenk  version of GNU diff.
3580c609719bSwdenk
35816dff5529Swdenk  The current directory when running this command shall be the top
35826dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
35836dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
35846dff5529Swdenk  directory information for the affected files).
35856dff5529Swdenk
3586c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3587c609719bSwdenk  gzipped text.
3588c609719bSwdenk
358952f52c14Swdenk* If one logical set of modifications affects or creates several
359052f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
359152f52c14Swdenk
359252f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
359352f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
359452f52c14Swdenk
359552f52c14Swdenk
3596c609719bSwdenkNotes:
3597c609719bSwdenk
3598c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3599c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3600c609719bSwdenk  for any of the boards.
3601c609719bSwdenk
3602c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3603c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3604c609719bSwdenk  returned with a request to re-formatting / split it.
3605c609719bSwdenk
3606c609719bSwdenk* If you modify existing code, make sure that your new code does not
3607c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3608c609719bSwdenk  When adding new features, these should compile conditionally only
3609c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3610c609719bSwdenk  disabled must not need more memory than the old code without your
3611c609719bSwdenk  modification.
361290dc6704Swdenk
361390dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
361490dc6704Swdenk  u-boot-users mailing list. Compression may help.
3615