xref: /openbmc/u-boot/README (revision fdcfaa1b02268b2899e374b35adf936c911a47eb)
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
167213bf8c8SGerald Van Baren- libfdt 	Library files to support flattened device trees
168c609719bSwdenk- net		Networking code
169c609719bSwdenk- post		Power On Self Test
170c609719bSwdenk- rtc		Real Time Clock drivers
171c609719bSwdenk- tools		Tools to build S-Record or U-Boot images, etc.
172c609719bSwdenk
173c609719bSwdenkSoftware Configuration:
174c609719bSwdenk=======================
175c609719bSwdenk
176c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
177c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
178c609719bSwdenk
179c609719bSwdenkThere are two classes of configuration variables:
180c609719bSwdenk
181c609719bSwdenk* Configuration _OPTIONS_:
182c609719bSwdenk  These are selectable by the user and have names beginning with
183c609719bSwdenk  "CONFIG_".
184c609719bSwdenk
185c609719bSwdenk* Configuration _SETTINGS_:
186c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
187c609719bSwdenk  you don't know what you're doing; they have names beginning with
188c609719bSwdenk  "CFG_".
189c609719bSwdenk
190c609719bSwdenkLater we will add a configuration tool - probably similar to or even
191c609719bSwdenkidentical to what's used for the Linux kernel. Right now, we have to
192c609719bSwdenkdo the configuration by hand, which means creating some symbolic
193c609719bSwdenklinks and editing some configuration files. We use the TQM8xxL boards
194c609719bSwdenkas an example here.
195c609719bSwdenk
196c609719bSwdenk
197c609719bSwdenkSelection of Processor Architecture and Board Type:
198c609719bSwdenk---------------------------------------------------
199c609719bSwdenk
200c609719bSwdenkFor all supported boards there are ready-to-use default
201c609719bSwdenkconfigurations available; just type "make <board_name>_config".
202c609719bSwdenk
203c609719bSwdenkExample: For a TQM823L module type:
204c609719bSwdenk
205c609719bSwdenk	cd u-boot
206c609719bSwdenk	make TQM823L_config
207c609719bSwdenk
208c609719bSwdenkFor the Cogent platform, you need to specify the cpu type as well;
209c609719bSwdenke.g. "make cogent_mpc8xx_config". And also configure the cogent
210c609719bSwdenkdirectory according to the instructions in cogent/README.
211c609719bSwdenk
212c609719bSwdenk
213c609719bSwdenkConfiguration Options:
214c609719bSwdenk----------------------
215c609719bSwdenk
216c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
217c609719bSwdenksuch information is kept in a configuration file
218c609719bSwdenk"include/configs/<board_name>.h".
219c609719bSwdenk
220c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
221c609719bSwdenk"include/configs/TQM823L.h".
222c609719bSwdenk
223c609719bSwdenk
2247f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
2257f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
2267f6c2cbcSwdenkbuild a config tool - later.
2277f6c2cbcSwdenk
2287f6c2cbcSwdenk
229c609719bSwdenkThe following options need to be configured:
230c609719bSwdenk
231c609719bSwdenk- CPU Type:	Define exactly one of
232c609719bSwdenk
233c609719bSwdenk		PowerPC based CPUs:
234c609719bSwdenk		-------------------
235c609719bSwdenk		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
2360db5bca8Swdenk	or	CONFIG_MPC5xx
237983fda83Swdenk	or	CONFIG_MPC8220
238c609719bSwdenk	or	CONFIG_MPC824X, CONFIG_MPC8260
23942d1f039Swdenk	or	CONFIG_MPC85xx
240c609719bSwdenk	or	CONFIG_IOP480
241c609719bSwdenk	or	CONFIG_405GP
24212f34241Swdenk	or	CONFIG_405EP
243c609719bSwdenk	or	CONFIG_440
244c609719bSwdenk	or	CONFIG_MPC74xx
24572755c71Swdenk	or	CONFIG_750FX
246c609719bSwdenk
247c609719bSwdenk		ARM based CPUs:
248c609719bSwdenk		---------------
249c609719bSwdenk		CONFIG_SA1110
250c609719bSwdenk		CONFIG_ARM7
251c609719bSwdenk		CONFIG_PXA250
252ae00bb4bSRodolfo Giometti		CONFIG_PXA27X
2530b953ffcSMarkus Klotzbuecher		CONFIG_CPU_MONAHANS
254c609719bSwdenk
255507bbe3eSwdenk		MicroBlaze based CPUs:
256507bbe3eSwdenk		----------------------
257857cad37Swdenk		CONFIG_MICROBLAZE
258507bbe3eSwdenk
2595c952cf0Swdenk		Nios-2 based CPUs:
2605c952cf0Swdenk		----------------------
2615c952cf0Swdenk		CONFIG_NIOS2
2625c952cf0Swdenk
26372a087e0SWolfgang Denk		AVR32 based CPUs:
26472a087e0SWolfgang Denk		----------------------
26572a087e0SWolfgang Denk		CONFIG_AT32AP
266c609719bSwdenk
267c609719bSwdenk- Board Type:	Define exactly one of
268c609719bSwdenk
269c609719bSwdenk		PowerPC based boards:
270c609719bSwdenk		---------------------
271c609719bSwdenk
27276544f80SDetlev Zundel		CONFIG_ADCIOP		CONFIG_FPS860L		CONFIG_OXC
27376544f80SDetlev Zundel		CONFIG_ADS860		CONFIG_GEN860T		CONFIG_PCI405
27476544f80SDetlev Zundel		CONFIG_AMX860		CONFIG_GENIETV		CONFIG_PCIPPC2
27576544f80SDetlev Zundel		CONFIG_AP1000		CONFIG_GTH		CONFIG_PCIPPC6
27676544f80SDetlev Zundel		CONFIG_AR405		CONFIG_gw8260		CONFIG_pcu_e
27776544f80SDetlev Zundel		CONFIG_BAB7xx		CONFIG_hermes		CONFIG_PIP405
27876544f80SDetlev Zundel		CONFIG_BC3450		CONFIG_hymod		CONFIG_PM826
27909e4b0c5SWolfgang Denk		CONFIG_c2mon		CONFIG_IAD210		CONFIG_ppmc8260
28009e4b0c5SWolfgang Denk		CONFIG_CANBT		CONFIG_ICU862		CONFIG_QS823
28109e4b0c5SWolfgang Denk		CONFIG_CCM		CONFIG_IP860		CONFIG_QS850
28209e4b0c5SWolfgang Denk		CONFIG_CMI		CONFIG_IPHASE4539	CONFIG_QS860T
28309e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8260	CONFIG_IVML24		CONFIG_RBC823
28409e4b0c5SWolfgang Denk		CONFIG_cogent_mpc8xx	CONFIG_IVML24_128	CONFIG_RPXClassic
28509e4b0c5SWolfgang Denk		CONFIG_CPCI405		CONFIG_IVML24_256	CONFIG_RPXlite
28609e4b0c5SWolfgang Denk		CONFIG_CPCI4052		CONFIG_IVMS8		CONFIG_RPXsuper
28709e4b0c5SWolfgang Denk		CONFIG_CPCIISER4	CONFIG_IVMS8_128	CONFIG_rsdproto
28809e4b0c5SWolfgang Denk		CONFIG_CPU86		CONFIG_IVMS8_256	CONFIG_sacsng
28909e4b0c5SWolfgang Denk		CONFIG_CRAYL1		CONFIG_JSE		CONFIG_Sandpoint8240
29009e4b0c5SWolfgang Denk		CONFIG_CSB272		CONFIG_LANTEC		CONFIG_Sandpoint8245
29109e4b0c5SWolfgang Denk		CONFIG_CU824		CONFIG_LITE5200B	CONFIG_sbc8260
29209e4b0c5SWolfgang Denk		CONFIG_DASA_SIM		CONFIG_lwmon		CONFIG_sbc8560
29309e4b0c5SWolfgang Denk		CONFIG_DB64360		CONFIG_MBX		CONFIG_SM850
29409e4b0c5SWolfgang Denk		CONFIG_DB64460		CONFIG_MBX860T		CONFIG_SPD823TS
29509e4b0c5SWolfgang Denk		CONFIG_DU405		CONFIG_MHPC		CONFIG_STXGP3
29609e4b0c5SWolfgang Denk		CONFIG_DUET_ADS		CONFIG_MIP405		CONFIG_SXNI855T
29709e4b0c5SWolfgang Denk		CONFIG_EBONY		CONFIG_MOUSSE		CONFIG_TQM823L
29809e4b0c5SWolfgang Denk		CONFIG_ELPPC		CONFIG_MPC8260ADS	CONFIG_TQM8260
29909e4b0c5SWolfgang Denk		CONFIG_ELPT860		CONFIG_MPC8540ADS	CONFIG_TQM850L
30009e4b0c5SWolfgang Denk		CONFIG_ep8260		CONFIG_MPC8540EVAL	CONFIG_TQM855L
30109e4b0c5SWolfgang Denk		CONFIG_ERIC		CONFIG_MPC8560ADS	CONFIG_TQM860L
30209e4b0c5SWolfgang Denk		CONFIG_ESTEEM192E	CONFIG_MUSENKI		CONFIG_TTTech
30309e4b0c5SWolfgang Denk		CONFIG_ETX094		CONFIG_MVS1		CONFIG_UTX8245
30409e4b0c5SWolfgang Denk		CONFIG_EVB64260		CONFIG_NETPHONE		CONFIG_V37
30509e4b0c5SWolfgang Denk		CONFIG_FADS823		CONFIG_NETTA		CONFIG_W7OLMC
30609e4b0c5SWolfgang Denk		CONFIG_FADS850SAR	CONFIG_NETVIA		CONFIG_W7OLMG
30709e4b0c5SWolfgang Denk		CONFIG_FADS860T		CONFIG_NX823		CONFIG_WALNUT
30809e4b0c5SWolfgang Denk		CONFIG_FLAGADM		CONFIG_OCRTC		CONFIG_ZPC1900
30909e4b0c5SWolfgang Denk		CONFIG_FPS850L		CONFIG_ORSG		CONFIG_ZUMA
310c609719bSwdenk
311c609719bSwdenk		ARM based boards:
312c609719bSwdenk		-----------------
313c609719bSwdenk
314c570b2fdSWolfgang Denk		CONFIG_ARMADILLO,	CONFIG_AT91RM9200DK,	CONFIG_CERF250,
3150b953ffcSMarkus Klotzbuecher		CONFIG_CSB637,		CONFIG_DELTA,		CONFIG_DNP1110,
3160b953ffcSMarkus Klotzbuecher		CONFIG_EP7312,		CONFIG_H2_OMAP1610,	CONFIG_HHP_CRADLE,
3170b953ffcSMarkus Klotzbuecher		CONFIG_IMPA7,	    CONFIG_INNOVATOROMAP1510,	CONFIG_INNOVATOROMAP1610,
3180b953ffcSMarkus Klotzbuecher		CONFIG_KB9202,		CONFIG_LART,		CONFIG_LPD7A400,
3190b953ffcSMarkus Klotzbuecher		CONFIG_LUBBOCK,		CONFIG_OSK_OMAP5912,	CONFIG_OMAP2420H4,
3205720df78SHeiko Schocher		CONFIG_PLEB2,		CONFIG_SHANNON,		CONFIG_P2_OMAP730,
3215720df78SHeiko Schocher		CONFIG_SMDK2400,	CONFIG_SMDK2410,	CONFIG_TRAB,
3225720df78SHeiko Schocher		CONFIG_VCMA9
323c609719bSwdenk
324507bbe3eSwdenk		MicroBlaze based boards:
325507bbe3eSwdenk		------------------------
326507bbe3eSwdenk
327507bbe3eSwdenk		CONFIG_SUZAKU
328507bbe3eSwdenk
3295c952cf0Swdenk		Nios-2 based boards:
3305c952cf0Swdenk		------------------------
3315c952cf0Swdenk
3325c952cf0Swdenk		CONFIG_PCI5441 CONFIG_PK1C20
3339cc83378SScott McNutt		CONFIG_EP1C20 CONFIG_EP1S10 CONFIG_EP1S40
3345c952cf0Swdenk
3356ccec449SWolfgang Denk		AVR32 based boards:
3366ccec449SWolfgang Denk		-------------------
3376ccec449SWolfgang Denk
3386ccec449SWolfgang Denk		CONFIG_ATSTK1000
3396ccec449SWolfgang Denk
3406ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
3416ccec449SWolfgang Denk		Define exactly one of
3426ccec449SWolfgang Denk		CONFIG_ATSTK1002
3436ccec449SWolfgang Denk
344c609719bSwdenk
345c609719bSwdenk- CPU Module Type: (if CONFIG_COGENT is defined)
346c609719bSwdenk		Define exactly one of
347c609719bSwdenk		CONFIG_CMA286_60_OLD
348c609719bSwdenk--- FIXME --- not tested yet:
349c609719bSwdenk		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
350c609719bSwdenk		CONFIG_CMA287_23, CONFIG_CMA287_50
351c609719bSwdenk
352c609719bSwdenk- Motherboard Type: (if CONFIG_COGENT is defined)
353c609719bSwdenk		Define exactly one of
354c609719bSwdenk		CONFIG_CMA101, CONFIG_CMA102
355c609719bSwdenk
356c609719bSwdenk- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
357c609719bSwdenk		Define one or more of
358c609719bSwdenk		CONFIG_CMA302
359c609719bSwdenk
360c609719bSwdenk- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
361c609719bSwdenk		Define one or more of
362c609719bSwdenk		CONFIG_LCD_HEARTBEAT	- update a character position on
363c609719bSwdenk					  the lcd display every second with
364c609719bSwdenk					  a "rotator" |\-/|\-/
365c609719bSwdenk
3662535d602Swdenk- Board flavour: (if CONFIG_MPC8260ADS is defined)
3672535d602Swdenk		CONFIG_ADSTYPE
3682535d602Swdenk		Possible values are:
3692535d602Swdenk			CFG_8260ADS	- original MPC8260ADS
370180d3f74Swdenk			CFG_8266ADS	- MPC8266ADS
37154387ac9Swdenk			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
37204a85b3bSwdenk			CFG_8272ADS	- MPC8272ADS
3732535d602Swdenk
374c609719bSwdenk- MPC824X Family Member (if CONFIG_MPC824X is defined)
375c609719bSwdenk		Define exactly one of
376c609719bSwdenk		CONFIG_MPC8240, CONFIG_MPC8245
377c609719bSwdenk
37875d1ea7fSwdenk- 8xx CPU Options: (if using an MPC8xx cpu)
37966ca92a5Swdenk		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
38066ca92a5Swdenk					  get_gclk_freq() cannot work
3815da627a4Swdenk					  e.g. if there is no 32KHz
3825da627a4Swdenk					  reference PIT/RTC clock
38366ca92a5Swdenk		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
38466ca92a5Swdenk					  or XTAL/EXTAL)
385c609719bSwdenk
38666ca92a5Swdenk- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
38766ca92a5Swdenk		CFG_8xx_CPUCLK_MIN
38866ca92a5Swdenk		CFG_8xx_CPUCLK_MAX
38966ca92a5Swdenk		CONFIG_8xx_CPUCLK_DEFAULT
39075d1ea7fSwdenk			See doc/README.MPC866
39175d1ea7fSwdenk
39275d1ea7fSwdenk		CFG_MEASURE_CPUCLK
39375d1ea7fSwdenk
39475d1ea7fSwdenk		Define this to measure the actual CPU clock instead
39575d1ea7fSwdenk		of relying on the correctness of the configured
39675d1ea7fSwdenk		values. Mostly useful for board bringup to make sure
39775d1ea7fSwdenk		the PLL is locked at the intended frequency. Note
39875d1ea7fSwdenk		that this requires a (stable) reference clock (32 kHz
39966ca92a5Swdenk		RTC clock or CFG_8XX_XIN)
40075d1ea7fSwdenk
4010b953ffcSMarkus Klotzbuecher- Intel Monahans options:
4020b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_RUN_MODE_OSC_RATIO
4030b953ffcSMarkus Klotzbuecher
4040b953ffcSMarkus Klotzbuecher		Defines the Monahans run mode to oscillator
4050b953ffcSMarkus Klotzbuecher		ratio. Valid values are 8, 16, 24, 31. The core
4060b953ffcSMarkus Klotzbuecher		frequency is this value multiplied by 13 MHz.
4070b953ffcSMarkus Klotzbuecher
4080b953ffcSMarkus Klotzbuecher		CFG_MONAHANS_TURBO_RUN_MODE_RATIO
4090b953ffcSMarkus Klotzbuecher
4100b953ffcSMarkus Klotzbuecher		Defines the Monahans turbo mode to oscillator
4110b953ffcSMarkus Klotzbuecher		ratio. Valid values are 1 (default if undefined) and
4120b953ffcSMarkus Klotzbuecher		2. The core frequency as calculated above is multiplied
4130b953ffcSMarkus Klotzbuecher		by this value.
4140b953ffcSMarkus Klotzbuecher
4155da627a4Swdenk- Linux Kernel Interface:
416c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
417c609719bSwdenk
418c609719bSwdenk		U-Boot stores all clock information in Hz
419c609719bSwdenk		internally. For binary compatibility with older Linux
420c609719bSwdenk		kernels (which expect the clocks passed in the
421c609719bSwdenk		bd_info data to be in MHz) the environment variable
422c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
423c609719bSwdenk		converts clock data to MHZ before passing it to the
424c609719bSwdenk		Linux kernel.
425c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
426c609719bSwdenk		"clocks_in_mhz=1" is  automatically  included  in  the
427c609719bSwdenk		default environment.
428c609719bSwdenk
4295da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
4305da627a4Swdenk
4315da627a4Swdenk		When transfering memsize parameter to linux, some versions
4325da627a4Swdenk		expect it to be in bytes, others in MB.
4335da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
4345da627a4Swdenk
435213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT / CONFIG_OF_FLAT_TREE
436f57f70aaSWolfgang Denk
437f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
438213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
439213bf8c8SGerald Van Baren		concepts).
440213bf8c8SGerald Van Baren
441213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
442213bf8c8SGerald Van Baren		 * New libfdt-based support
443213bf8c8SGerald Van Baren		 * Adds the "fdt" command
444213bf8c8SGerald Van Baren		 * The bootm command does _not_ modify the fdt
445213bf8c8SGerald Van Baren
446213bf8c8SGerald Van Baren		CONFIG_OF_FLAT_TREE
447213bf8c8SGerald Van Baren		 * Deprecated, see CONFIG_OF_LIBFDT
448213bf8c8SGerald Van Baren		 * Original ft_build.c-based support
449213bf8c8SGerald Van Baren		 * Automatically modifies the dft as part of the bootm command
450213bf8c8SGerald Van Baren		 * The environment variable "disable_of", when set,
451213bf8c8SGerald Van Baren		     disables this functionality.
452f57f70aaSWolfgang Denk
453f57f70aaSWolfgang Denk		CONFIG_OF_FLAT_TREE_MAX_SIZE
454f57f70aaSWolfgang Denk
455f57f70aaSWolfgang Denk		The maximum size of the constructed OF tree.
456f57f70aaSWolfgang Denk
457f57f70aaSWolfgang Denk		OF_CPU - The proper name of the cpus node.
458c2871f03SKumar Gala		OF_SOC - The proper name of the soc node.
459f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
460c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
461f57f70aaSWolfgang Denk
462e4f880edSKumar Gala		CONFIG_OF_HAS_BD_T
463e4f880edSKumar Gala
464213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
465213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
466213bf8c8SGerald Van Baren		     will have a copy of the bd_t.  Space should be
467213bf8c8SGerald Van Baren		     pre-allocated in the dts for the bd_t.
468e4f880edSKumar Gala
469e4f880edSKumar Gala		CONFIG_OF_HAS_UBOOT_ENV
470e4f880edSKumar Gala
471213bf8c8SGerald Van Baren		 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
472213bf8c8SGerald Van Baren		 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
473213bf8c8SGerald Van Baren		     will have a copy of u-boot's environment variables
474e4f880edSKumar Gala
4754e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
4764e253137SKumar Gala
4774e253137SKumar Gala		Board code has addition modification that it wants to make
4784e253137SKumar Gala		to the flat device tree before handing it off to the kernel
4796705d81eSwdenk
4800267768eSMatthew McClintock		CONFIG_OF_BOOT_CPU
4810267768eSMatthew McClintock
4820267768eSMatthew McClintock		This define fills in the correct boot cpu in the boot
4830267768eSMatthew McClintock		param header, the default value is zero if undefined.
4840267768eSMatthew McClintock
4856705d81eSwdenk- Serial Ports:
4866705d81eSwdenk		CFG_PL010_SERIAL
4876705d81eSwdenk
4886705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
4896705d81eSwdenk
4906705d81eSwdenk		CFG_PL011_SERIAL
4916705d81eSwdenk
4926705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
4936705d81eSwdenk
4946705d81eSwdenk		CONFIG_PL011_CLOCK
4956705d81eSwdenk
4966705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
4976705d81eSwdenk		the clock speed of the UARTs.
4986705d81eSwdenk
4996705d81eSwdenk		CONFIG_PL01x_PORTS
5006705d81eSwdenk
5016705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
5026705d81eSwdenk		define this to a list of base addresses for each (supported)
5036705d81eSwdenk		port. See e.g. include/configs/versatile.h
5046705d81eSwdenk
5056705d81eSwdenk
506c609719bSwdenk- Console Interface:
507c609719bSwdenk		Depending on board, define exactly one serial port
508c609719bSwdenk		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
509c609719bSwdenk		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
510c609719bSwdenk		console by defining CONFIG_8xx_CONS_NONE
511c609719bSwdenk
512c609719bSwdenk		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
513c609719bSwdenk		port routines must be defined elsewhere
514c609719bSwdenk		(i.e. serial_init(), serial_getc(), ...)
515c609719bSwdenk
516c609719bSwdenk		CONFIG_CFB_CONSOLE
517c609719bSwdenk		Enables console device for a color framebuffer. Needs following
518c609719bSwdenk		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
519c609719bSwdenk			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
520c609719bSwdenk						(default big endian)
521c609719bSwdenk			VIDEO_HW_RECTFILL	graphic chip supports
522c609719bSwdenk						rectangle fill
523c609719bSwdenk						(cf. smiLynxEM)
524c609719bSwdenk			VIDEO_HW_BITBLT		graphic chip supports
525c609719bSwdenk						bit-blit (cf. smiLynxEM)
526c609719bSwdenk			VIDEO_VISIBLE_COLS	visible pixel columns
527c609719bSwdenk						(cols=pitch)
528c609719bSwdenk			VIDEO_VISIBLE_ROWS	visible pixel rows
529c609719bSwdenk			VIDEO_PIXEL_SIZE	bytes per pixel
530c609719bSwdenk			VIDEO_DATA_FORMAT	graphic data format
531c609719bSwdenk						(0-5, cf. cfb_console.c)
532c609719bSwdenk			VIDEO_FB_ADRS		framebuffer address
533c609719bSwdenk			VIDEO_KBD_INIT_FCT	keyboard int fct
534c609719bSwdenk						(i.e. i8042_kbd_init())
535c609719bSwdenk			VIDEO_TSTC_FCT		test char fct
536c609719bSwdenk						(i.e. i8042_tstc)
537c609719bSwdenk			VIDEO_GETC_FCT		get char fct
538c609719bSwdenk						(i.e. i8042_getc)
539c609719bSwdenk			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
540c609719bSwdenk						(requires blink timer
541c609719bSwdenk						cf. i8042.c)
542c609719bSwdenk			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
543c609719bSwdenk			CONFIG_CONSOLE_TIME	display time/date info in
544c609719bSwdenk						upper right corner
545c609719bSwdenk						(requires CFG_CMD_DATE)
546c609719bSwdenk			CONFIG_VIDEO_LOGO	display Linux logo in
547c609719bSwdenk						upper left corner
548a6c7ad2fSwdenk			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
549a6c7ad2fSwdenk						linux_logo.h for logo.
550a6c7ad2fSwdenk						Requires CONFIG_VIDEO_LOGO
551c609719bSwdenk			CONFIG_CONSOLE_EXTRA_INFO
552c609719bSwdenk						addional board info beside
553c609719bSwdenk						the logo
554c609719bSwdenk
555c609719bSwdenk		When CONFIG_CFB_CONSOLE is defined, video console is
556c609719bSwdenk		default i/o. Serial console can be forced with
557c609719bSwdenk		environment 'console=serial'.
558c609719bSwdenk
559a3ad8e26Swdenk		When CONFIG_SILENT_CONSOLE is defined, all console
560a3ad8e26Swdenk		messages (by U-Boot and Linux!) can be silenced with
561a3ad8e26Swdenk		the "silent" environment variable. See
562a3ad8e26Swdenk		doc/README.silent for more information.
563a3ad8e26Swdenk
564c609719bSwdenk- Console Baudrate:
565c609719bSwdenk		CONFIG_BAUDRATE - in bps
566c609719bSwdenk		Select one of the baudrates listed in
567c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
5683bbc899fSwdenk		CFG_BRGCLK_PRESCALE, baudrate prescale
569c609719bSwdenk
570c609719bSwdenk- Interrupt driven serial port input:
571c609719bSwdenk		CONFIG_SERIAL_SOFTWARE_FIFO
572c609719bSwdenk
573c609719bSwdenk		PPC405GP only.
574c609719bSwdenk		Use an interrupt handler for receiving data on the
575c609719bSwdenk		serial port. It also enables using hardware handshake
576c609719bSwdenk		(RTS/CTS) and UART's built-in FIFO. Set the number of
577c609719bSwdenk		bytes the interrupt driven input buffer should have.
578c609719bSwdenk
579109c0e3aSwdenk		Leave undefined to disable this feature, including
580109c0e3aSwdenk		disable the buffer and hardware handshake.
581c609719bSwdenk
5821d49b1f3Sstroese- Console UART Number:
5831d49b1f3Sstroese		CONFIG_UART1_CONSOLE
5841d49b1f3Sstroese
5850c8721a4SWolfgang Denk		AMCC PPC4xx only.
5861d49b1f3Sstroese		If defined internal UART1 (and not UART0) is used
5871d49b1f3Sstroese		as default U-Boot console.
5881d49b1f3Sstroese
589c609719bSwdenk- Boot Delay:	CONFIG_BOOTDELAY - in seconds
590c609719bSwdenk		Delay before automatically booting the default image;
591c609719bSwdenk		set to -1 to disable autoboot.
592c609719bSwdenk
593c609719bSwdenk		See doc/README.autoboot for these options that
594c609719bSwdenk		work with CONFIG_BOOTDELAY. None are required.
595c609719bSwdenk		CONFIG_BOOT_RETRY_TIME
596c609719bSwdenk		CONFIG_BOOT_RETRY_MIN
597c609719bSwdenk		CONFIG_AUTOBOOT_KEYED
598c609719bSwdenk		CONFIG_AUTOBOOT_PROMPT
599c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR
600c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR
601c609719bSwdenk		CONFIG_AUTOBOOT_DELAY_STR2
602c609719bSwdenk		CONFIG_AUTOBOOT_STOP_STR2
603c609719bSwdenk		CONFIG_ZERO_BOOTDELAY_CHECK
604c609719bSwdenk		CONFIG_RESET_TO_RETRY
605c609719bSwdenk
606c609719bSwdenk- Autoboot Command:
607c609719bSwdenk		CONFIG_BOOTCOMMAND
608c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
609c609719bSwdenk		define a command string that is automatically executed
610c609719bSwdenk		when no character is read on the console interface
611c609719bSwdenk		within "Boot Delay" after reset.
612c609719bSwdenk
613c609719bSwdenk		CONFIG_BOOTARGS
614c609719bSwdenk		This can be used to pass arguments to the bootm
615c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
616c609719bSwdenk		environment value "bootargs".
617c609719bSwdenk
618c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
619c609719bSwdenk		The value of these goes into the environment as
620c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
621c609719bSwdenk		as a convenience, when switching between booting from
622c609719bSwdenk		ram and nfs.
623c609719bSwdenk
624c609719bSwdenk- Pre-Boot Commands:
625c609719bSwdenk		CONFIG_PREBOOT
626c609719bSwdenk
627c609719bSwdenk		When this option is #defined, the existence of the
628c609719bSwdenk		environment variable "preboot" will be checked
629c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
630c609719bSwdenk		countdown and/or running the auto-boot command resp.
631c609719bSwdenk		entering interactive mode.
632c609719bSwdenk
633c609719bSwdenk		This feature is especially useful when "preboot" is
634c609719bSwdenk		automatically generated or modified. For an example
635c609719bSwdenk		see the LWMON board specific code: here "preboot" is
636c609719bSwdenk		modified when the user holds down a certain
637c609719bSwdenk		combination of keys on the (special) keyboard when
638c609719bSwdenk		booting the systems
639c609719bSwdenk
640c609719bSwdenk- Serial Download Echo Mode:
641c609719bSwdenk		CONFIG_LOADS_ECHO
642c609719bSwdenk		If defined to 1, all characters received during a
643c609719bSwdenk		serial download (using the "loads" command) are
644c609719bSwdenk		echoed back. This might be needed by some terminal
645c609719bSwdenk		emulations (like "cu"), but may as well just take
646c609719bSwdenk		time on others. This setting #define's the initial
647c609719bSwdenk		value of the "loads_echo" environment variable.
648c609719bSwdenk
649c609719bSwdenk- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
650c609719bSwdenk		CONFIG_KGDB_BAUDRATE
651c609719bSwdenk		Select one of the baudrates listed in
652c609719bSwdenk		CFG_BAUDRATE_TABLE, see below.
653c609719bSwdenk
654c609719bSwdenk- Monitor Functions:
655c609719bSwdenk		CONFIG_COMMANDS
656c609719bSwdenk		Most monitor functions can be selected (or
657c609719bSwdenk		de-selected) by adjusting the definition of
658c609719bSwdenk		CONFIG_COMMANDS; to select individual functions,
659c609719bSwdenk		#define CONFIG_COMMANDS by "OR"ing any of the
660c609719bSwdenk		following values:
661c609719bSwdenk
662c609719bSwdenk		#define enables commands:
663c609719bSwdenk		-------------------------
664c609719bSwdenk		CFG_CMD_ASKENV	* ask for env variable
66578137c3cSwdenk		CFG_CMD_AUTOSCRIPT Autoscript Support
666c609719bSwdenk		CFG_CMD_BDI	  bdinfo
6676705d81eSwdenk		CFG_CMD_BEDBUG	* Include BedBug Debugger
66878137c3cSwdenk		CFG_CMD_BMP	* BMP support
6696705d81eSwdenk		CFG_CMD_BSP	* Board specific commands
670c609719bSwdenk		CFG_CMD_BOOTD	  bootd
6716705d81eSwdenk		CFG_CMD_CACHE	* icache, dcache
672c609719bSwdenk		CFG_CMD_CONSOLE	  coninfo
673c609719bSwdenk		CFG_CMD_DATE	* support for RTC, date/time...
6746705d81eSwdenk		CFG_CMD_DHCP	* DHCP support
67578137c3cSwdenk		CFG_CMD_DIAG	* Diagnostics
67678137c3cSwdenk		CFG_CMD_DOC	* Disk-On-Chip Support
6776705d81eSwdenk		CFG_CMD_DTT	* Digital Therm and Thermostat
678953c5b6fSWolfgang Denk		CFG_CMD_ECHO	  echo arguments
679c609719bSwdenk		CFG_CMD_EEPROM	* EEPROM read/write support
6806705d81eSwdenk		CFG_CMD_ELF	* bootelf, bootvx
681c609719bSwdenk		CFG_CMD_ENV	  saveenv
682c609719bSwdenk		CFG_CMD_FDC	* Floppy Disk Support
6836705d81eSwdenk		CFG_CMD_FAT	* FAT partition support
6842262cfeeSwdenk		CFG_CMD_FDOS	* Dos diskette Support
685c609719bSwdenk		CFG_CMD_FLASH	  flinfo, erase, protect
686c609719bSwdenk		CFG_CMD_FPGA	  FPGA device initialization support
68778137c3cSwdenk		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
688c609719bSwdenk		CFG_CMD_I2C	* I2C serial bus support
689c609719bSwdenk		CFG_CMD_IDE	* IDE harddisk support
690c609719bSwdenk		CFG_CMD_IMI	  iminfo
69178137c3cSwdenk		CFG_CMD_IMLS	  List all found images
692c609719bSwdenk		CFG_CMD_IMMAP	* IMMR dump support
693c609719bSwdenk		CFG_CMD_IRQ	* irqinfo
6946705d81eSwdenk		CFG_CMD_ITEST	  Integer/string test of 2 values
69578137c3cSwdenk		CFG_CMD_JFFS2	* JFFS2 Support
696c609719bSwdenk		CFG_CMD_KGDB	* kgdb
697c609719bSwdenk		CFG_CMD_LOADB	  loadb
698c609719bSwdenk		CFG_CMD_LOADS	  loads
699c609719bSwdenk		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
70056523f12Swdenk				  loop, loopw, mtest
70178137c3cSwdenk		CFG_CMD_MISC	  Misc functions like sleep etc
7026705d81eSwdenk		CFG_CMD_MMC	* MMC memory mapped support
7036705d81eSwdenk		CFG_CMD_MII	* MII utility commands
70478137c3cSwdenk		CFG_CMD_NAND	* NAND support
705c609719bSwdenk		CFG_CMD_NET	  bootp, tftpboot, rarpboot
706c609719bSwdenk		CFG_CMD_PCI	* pciinfo
707c609719bSwdenk		CFG_CMD_PCMCIA	* PCMCIA support
70878137c3cSwdenk		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
709ef5a9672Swdenk		CFG_CMD_PORTIO	* Port I/O
710c609719bSwdenk		CFG_CMD_REGINFO * Register dump
711c609719bSwdenk		CFG_CMD_RUN	  run command in env variable
7126705d81eSwdenk		CFG_CMD_SAVES	* save S record dump
713c609719bSwdenk		CFG_CMD_SCSI	* SCSI Support
71478137c3cSwdenk		CFG_CMD_SDRAM	* print SDRAM configuration information
715b1bf6f2cSwdenk				  (requires CFG_CMD_I2C)
716c609719bSwdenk		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
717c609719bSwdenk		CFG_CMD_SPI	* SPI serial bus support
718c609719bSwdenk		CFG_CMD_USB	* USB support
71978137c3cSwdenk		CFG_CMD_VFD	* VFD support (TRAB)
720c609719bSwdenk		CFG_CMD_BSP	* Board SPecific functions
721a3d991bdSwdenk		CFG_CMD_CDP	* Cisco Discover Protocol support
722ffc50f9bSMichal Simek		CFG_CMD_FSL	* Microblaze FSL support
723c609719bSwdenk		-----------------------------------------------
724c609719bSwdenk		CFG_CMD_ALL	all
725c609719bSwdenk
72681050926Swdenk		CONFIG_CMD_DFL	Default configuration; at the moment
727c609719bSwdenk				this is includes all commands, except
728c609719bSwdenk				the ones marked with "*" in the list
729c609719bSwdenk				above.
730c609719bSwdenk
731c609719bSwdenk		If you don't define CONFIG_COMMANDS it defaults to
73281050926Swdenk		CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can
733c609719bSwdenk		override the default settings in the respective
734c609719bSwdenk		include file.
735c609719bSwdenk
736c609719bSwdenk		EXAMPLE: If you want all functions except of network
737c609719bSwdenk		support you can write:
738c609719bSwdenk
739c609719bSwdenk		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)
740c609719bSwdenk
741213bf8c8SGerald Van Baren	Other Commands:
742213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
743c609719bSwdenk
744c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
745c609719bSwdenk		(configuration option CFG_CMD_CACHE) unless you know
746c609719bSwdenk		what you (and your U-Boot users) are doing. Data
747c609719bSwdenk		cache cannot be enabled on systems like the 8xx or
748c609719bSwdenk		8260 (where accesses to the IMMR region must be
749c609719bSwdenk		uncached), and it cannot be disabled on all other
750c609719bSwdenk		systems where we (mis-) use the data cache to hold an
751c609719bSwdenk		initial stack and some data.
752c609719bSwdenk
753c609719bSwdenk
754c609719bSwdenk		XXX - this list needs to get updated!
755c609719bSwdenk
756c609719bSwdenk- Watchdog:
757c609719bSwdenk		CONFIG_WATCHDOG
758c609719bSwdenk		If this variable is defined, it enables watchdog
7597152b1d0Swdenk		support. There must be support in the platform specific
760c609719bSwdenk		code for a watchdog. For the 8xx and 8260 CPUs, the
761c609719bSwdenk		SIU Watchdog feature is enabled in the SYPCR
762c609719bSwdenk		register.
763c609719bSwdenk
764c1551ea8Sstroese- U-Boot Version:
765c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
766c1551ea8Sstroese		If this variable is defined, an environment variable
767c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
768c1551ea8Sstroese		version as printed by the "version" command.
769c1551ea8Sstroese		This variable is readonly.
770c1551ea8Sstroese
771c609719bSwdenk- Real-Time Clock:
772c609719bSwdenk
773c609719bSwdenk		When CFG_CMD_DATE is selected, the type of the RTC
774c609719bSwdenk		has to be selected, too. Define exactly one of the
775c609719bSwdenk		following options:
776c609719bSwdenk
777c609719bSwdenk		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
778c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
779c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
7801cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
781c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
7827f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
7833bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
7844c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
785c609719bSwdenk
786b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
787b37c7e5eSwdenk		must also be configured. See I2C Support, below.
788b37c7e5eSwdenk
789c609719bSwdenk- Timestamp Support:
790c609719bSwdenk
791c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
792c609719bSwdenk		(date and time) of an image is printed by image
793c609719bSwdenk		commands like bootm or iminfo. This option is
794c609719bSwdenk		automatically enabled when you select CFG_CMD_DATE .
795c609719bSwdenk
796c609719bSwdenk- Partition Support:
797c609719bSwdenk		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
798c609719bSwdenk		and/or CONFIG_ISO_PARTITION
799c609719bSwdenk
800c609719bSwdenk		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
801c609719bSwdenk		CFG_CMD_SCSI) you must configure support for at least
802c609719bSwdenk		one partition type as well.
803c609719bSwdenk
804c609719bSwdenk- IDE Reset method:
8054d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
8064d13cbadSwdenk		board configurations files but used nowhere!
807c609719bSwdenk
8084d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
8094d13cbadSwdenk		be performed by calling the function
8104d13cbadSwdenk			ide_set_reset(int reset)
8114d13cbadSwdenk		which has to be defined in a board specific file
812c609719bSwdenk
813c609719bSwdenk- ATAPI Support:
814c609719bSwdenk		CONFIG_ATAPI
815c609719bSwdenk
816c609719bSwdenk		Set this to enable ATAPI support.
817c609719bSwdenk
818c40b2956Swdenk- LBA48 Support
819c40b2956Swdenk		CONFIG_LBA48
820c40b2956Swdenk
821c40b2956Swdenk		Set this to enable support for disks larger than 137GB
822c40b2956Swdenk		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
823c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
824c40b2956Swdenk		support disks up to 2.1TB.
825c40b2956Swdenk
826c40b2956Swdenk		CFG_64BIT_LBA:
827c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
828c40b2956Swdenk			Default is 32bit.
829c40b2956Swdenk
830c609719bSwdenk- SCSI Support:
831c609719bSwdenk		At the moment only there is only support for the
832c609719bSwdenk		SYM53C8XX SCSI controller; define
833c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
834c609719bSwdenk
835c609719bSwdenk		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
836c609719bSwdenk		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
837c609719bSwdenk		CFG_SCSI_MAX_LUN] can be adjusted to define the
838c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
839c609719bSwdenk		devices.
840c609719bSwdenk		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
841c609719bSwdenk
842c609719bSwdenk- NETWORK Support (PCI):
843682011ffSwdenk		CONFIG_E1000
844682011ffSwdenk		Support for Intel 8254x gigabit chips.
845682011ffSwdenk
846c609719bSwdenk		CONFIG_EEPRO100
847c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
848c609719bSwdenk		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
849c609719bSwdenk		write routine for first time initialisation.
850c609719bSwdenk
851c609719bSwdenk		CONFIG_TULIP
852c609719bSwdenk		Support for Digital 2114x chips.
853c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
854c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
855c609719bSwdenk
856c609719bSwdenk		CONFIG_NATSEMI
857c609719bSwdenk		Support for National dp83815 chips.
858c609719bSwdenk
859c609719bSwdenk		CONFIG_NS8382X
860c609719bSwdenk		Support for National dp8382[01] gigabit chips.
861c609719bSwdenk
86245219c46Swdenk- NETWORK Support (other):
86345219c46Swdenk
86445219c46Swdenk		CONFIG_DRIVER_LAN91C96
86545219c46Swdenk		Support for SMSC's LAN91C96 chips.
86645219c46Swdenk
86745219c46Swdenk			CONFIG_LAN91C96_BASE
86845219c46Swdenk			Define this to hold the physical address
86945219c46Swdenk			of the LAN91C96's I/O space
87045219c46Swdenk
87145219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
87245219c46Swdenk			Define this to enable 32 bit addressing
87345219c46Swdenk
874f39748aeSwdenk		CONFIG_DRIVER_SMC91111
875f39748aeSwdenk		Support for SMSC's LAN91C111 chip
876f39748aeSwdenk
877f39748aeSwdenk			CONFIG_SMC91111_BASE
878f39748aeSwdenk			Define this to hold the physical address
879f39748aeSwdenk			of the device (I/O space)
880f39748aeSwdenk
881f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
882f39748aeSwdenk			Define this if data bus is 32 bits
883f39748aeSwdenk
884f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
885f39748aeSwdenk			Define this to use i/o functions instead of macros
886f39748aeSwdenk			(some hardware wont work with macros)
887f39748aeSwdenk
888c609719bSwdenk- USB Support:
889c609719bSwdenk		At the moment only the UHCI host controller is
8904d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
891c609719bSwdenk		CONFIG_USB_UHCI to enable it.
892c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
89330d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
894c609719bSwdenk		storage devices.
895c609719bSwdenk		Note:
896c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
897c609719bSwdenk		(TEAC FD-05PUB).
8984d13cbadSwdenk		MPC5200 USB requires additional defines:
8994d13cbadSwdenk			CONFIG_USB_CLOCK
9004d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
9014d13cbadSwdenk			CONFIG_USB_CONFIG
9024d13cbadSwdenk				for differential drivers: 0x00001000
9034d13cbadSwdenk				for single ended drivers: 0x00005000
904*fdcfaa1bSZhang Wei			CFG_USB_EVENT_POLL
905*fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
906*fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
9074d13cbadSwdenk
90816c8d5e7SWolfgang Denk- USB Device:
90916c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
91016c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
91116c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
91216c8d5e7SWolfgang Denk		attach your usb cable. The Unix command "dmesg" should print
91316c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
91416c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
91516c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
91616c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
91716c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
91816c8d5e7SWolfgang Denk		a Linux host by
91916c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
92016c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
92116c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
92216c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
92316c8d5e7SWolfgang Denk
92416c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
92516c8d5e7SWolfgang Denk			Define this to build a UDC device
92616c8d5e7SWolfgang Denk
92716c8d5e7SWolfgang Denk			CONFIG_USB_TTY
92816c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
92916c8d5e7SWolfgang Denk			talk to the UDC device
93016c8d5e7SWolfgang Denk
93116c8d5e7SWolfgang Denk			CFG_CONSOLE_IS_IN_ENV
93216c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
93316c8d5e7SWolfgang Denk			be set to usbtty.
93416c8d5e7SWolfgang Denk
93516c8d5e7SWolfgang Denk			mpc8xx:
93616c8d5e7SWolfgang Denk				CFG_USB_EXTC_CLK 0xBLAH
93716c8d5e7SWolfgang Denk				Derive USB clock from external clock "blah"
93816c8d5e7SWolfgang Denk				- CFG_USB_EXTC_CLK 0x02
93916c8d5e7SWolfgang Denk
94016c8d5e7SWolfgang Denk				CFG_USB_BRG_CLK 0xBLAH
94116c8d5e7SWolfgang Denk				Derive USB clock from brgclk
94216c8d5e7SWolfgang Denk				- CFG_USB_BRG_CLK 0x04
94316c8d5e7SWolfgang Denk
94416c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
94516c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
94616c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
94716c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
94816c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
94916c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
95016c8d5e7SWolfgang Denk
95116c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
95216c8d5e7SWolfgang Denk			Define this string as the name of your company for
95316c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
95416c8d5e7SWolfgang Denk
95516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
95616c8d5e7SWolfgang Denk			Define this string as the name of your product
95716c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
95816c8d5e7SWolfgang Denk
95916c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
96016c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
96116c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
96216c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
96316c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
96416c8d5e7SWolfgang Denk
96516c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
96616c8d5e7SWolfgang Denk			Define this as the unique Product ID
96716c8d5e7SWolfgang Denk			for your device
96816c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
96916c8d5e7SWolfgang Denk
970c609719bSwdenk
97171f95118Swdenk- MMC Support:
97271f95118Swdenk		The MMC controller on the Intel PXA is supported. To
97371f95118Swdenk		enable this define CONFIG_MMC. The MMC can be
97471f95118Swdenk		accessed from the boot prompt by mapping the device
97571f95118Swdenk		to physical memory similar to flash. Command line is
97671f95118Swdenk		enabled with CFG_CMD_MMC. The MMC driver also works with
97771f95118Swdenk		the FAT fs. This is enabled with CFG_CMD_FAT.
97871f95118Swdenk
9796705d81eSwdenk- Journaling Flash filesystem support:
9806705d81eSwdenk		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
9816705d81eSwdenk		CONFIG_JFFS2_NAND_DEV
9826705d81eSwdenk		Define these for a default partition on a NAND device
9836705d81eSwdenk
9846705d81eSwdenk		CFG_JFFS2_FIRST_SECTOR,
9856705d81eSwdenk		CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS
9866705d81eSwdenk		Define these for a default partition on a NOR device
9876705d81eSwdenk
9886705d81eSwdenk		CFG_JFFS_CUSTOM_PART
9896705d81eSwdenk		Define this to create an own partition. You have to provide a
9906705d81eSwdenk		function struct part_info* jffs2_part_info(int part_num)
9916705d81eSwdenk
9926705d81eSwdenk		If you define only one JFFS2 partition you may also want to
9936705d81eSwdenk		#define CFG_JFFS_SINGLE_PART	1
9946705d81eSwdenk		to disable the command chpart. This is the default when you
9956705d81eSwdenk		have not defined a custom partition
9966705d81eSwdenk
997c609719bSwdenk- Keyboard Support:
998c609719bSwdenk		CONFIG_ISA_KEYBOARD
999c609719bSwdenk
1000c609719bSwdenk		Define this to enable standard (PC-Style) keyboard
1001c609719bSwdenk		support
1002c609719bSwdenk
1003c609719bSwdenk		CONFIG_I8042_KBD
1004c609719bSwdenk		Standard PC keyboard driver with US (is default) and
1005c609719bSwdenk		GERMAN key layout (switch via environment 'keymap=de') support.
1006c609719bSwdenk		Export function i8042_kbd_init, i8042_tstc and i8042_getc
1007c609719bSwdenk		for cfb_console. Supports cursor blinking.
1008c609719bSwdenk
1009c609719bSwdenk- Video support:
1010c609719bSwdenk		CONFIG_VIDEO
1011c609719bSwdenk
1012c609719bSwdenk		Define this to enable video support (for output to
1013c609719bSwdenk		video).
1014c609719bSwdenk
1015c609719bSwdenk		CONFIG_VIDEO_CT69000
1016c609719bSwdenk
1017c609719bSwdenk		Enable Chips & Technologies 69000 Video chip
1018c609719bSwdenk
1019c609719bSwdenk		CONFIG_VIDEO_SMI_LYNXEM
1020eeb1b77bSwdenk		Enable Silicon Motion SMI 712/710/810 Video chip. The
1021eeb1b77bSwdenk		video output is selected via environment 'videoout'
1022eeb1b77bSwdenk		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1023eeb1b77bSwdenk		assumed.
1024c609719bSwdenk
1025eeb1b77bSwdenk		For the CT69000 and SMI_LYNXEM drivers, videomode is
1026eeb1b77bSwdenk		selected via environment 'videomode'. Two diferent ways
1027eeb1b77bSwdenk		are possible:
1028eeb1b77bSwdenk		- "videomode=num"   'num' is a standard LiLo mode numbers.
1029eeb1b77bSwdenk		Following standard modes are supported	(* is default):
1030eeb1b77bSwdenk
1031eeb1b77bSwdenk		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
1032eeb1b77bSwdenk		-------------+---------------------------------------------
1033eeb1b77bSwdenk		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
1034eeb1b77bSwdenk		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
1035eeb1b77bSwdenk		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
1036eeb1b77bSwdenk		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
1037eeb1b77bSwdenk		-------------+---------------------------------------------
1038c609719bSwdenk		(i.e. setenv videomode 317; saveenv; reset;)
1039c609719bSwdenk
1040eeb1b77bSwdenk		- "videomode=bootargs" all the video parameters are parsed
1041eeb1b77bSwdenk		from the bootargs. (See drivers/videomodes.c)
1042eeb1b77bSwdenk
1043eeb1b77bSwdenk
1044a6c7ad2fSwdenk		CONFIG_VIDEO_SED13806
1045a6c7ad2fSwdenk		Enable Epson SED13806 driver. This driver supports 8bpp
1046a6c7ad2fSwdenk		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1047a6c7ad2fSwdenk		or CONFIG_VIDEO_SED13806_16BPP
1048a6c7ad2fSwdenk
1049682011ffSwdenk- Keyboard Support:
1050682011ffSwdenk		CONFIG_KEYBOARD
1051682011ffSwdenk
1052682011ffSwdenk		Define this to enable a custom keyboard support.
1053682011ffSwdenk		This simply calls drv_keyboard_init() which must be
1054682011ffSwdenk		defined in your board-specific files.
1055682011ffSwdenk		The only board using this so far is RBC823.
1056a6c7ad2fSwdenk
1057c609719bSwdenk- LCD Support:	CONFIG_LCD
1058c609719bSwdenk
1059c609719bSwdenk		Define this to enable LCD support (for output to LCD
1060c609719bSwdenk		display); also select one of the supported displays
1061c609719bSwdenk		by defining one of these:
1062c609719bSwdenk
1063fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1064c609719bSwdenk
1065fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1066c609719bSwdenk
1067fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1068c609719bSwdenk
1069fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1070fd3103bbSwdenk			Active, color, single scan.
1071fd3103bbSwdenk
1072fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1073fd3103bbSwdenk
1074fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1075c609719bSwdenk			Active, color, single scan.
1076c609719bSwdenk
1077c609719bSwdenk		CONFIG_SHARP_16x9
1078c609719bSwdenk
1079c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1080c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1081c609719bSwdenk
1082c609719bSwdenk		CONFIG_SHARP_LQ64D341
1083c609719bSwdenk
1084c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1085c609719bSwdenk			Active, color, single scan.
1086c609719bSwdenk
1087c609719bSwdenk		CONFIG_HLD1045
1088c609719bSwdenk
1089c609719bSwdenk			HLD1045 display, 640x480.
1090c609719bSwdenk			Active, color, single scan.
1091c609719bSwdenk
1092c609719bSwdenk		CONFIG_OPTREX_BW
1093c609719bSwdenk
1094c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1095c609719bSwdenk			or
1096c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1097c609719bSwdenk			or
1098c609719bSwdenk			Hitachi	 SP14Q002
1099c609719bSwdenk
1100c609719bSwdenk			320x240. Black & white.
1101c609719bSwdenk
1102c609719bSwdenk		Normally display is black on white background; define
1103c609719bSwdenk		CFG_WHITE_ON_BLACK to get it inverted.
1104c609719bSwdenk
11057152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1106d791b1dcSwdenk
1107d791b1dcSwdenk		If this option is set, the environment is checked for
1108d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1109d791b1dcSwdenk		of logo, copyright and system information on the LCD
1110e94d2cd9Swdenk		is suppressed and the BMP image at the address
1111d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1112d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1113d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1114d791b1dcSwdenk		loaded very quickly after power-on.
1115d791b1dcSwdenk
111698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
111798f4a3dfSStefan Roese
111898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
111998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
112098f4a3dfSStefan Roese		splashscreen support or the bmp command.
112198f4a3dfSStefan Roese
1122c29fdfc1Swdenk- Compression support:
1123c29fdfc1Swdenk		CONFIG_BZIP2
1124c29fdfc1Swdenk
1125c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1126c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1127c29fdfc1Swdenk		compressed images are supported.
1128c29fdfc1Swdenk
1129c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
1130c29fdfc1Swdenk		the malloc area (as defined by CFG_MALLOC_LEN) should
1131c29fdfc1Swdenk		be at least 4MB.
1132d791b1dcSwdenk
113317ea1177Swdenk- MII/PHY support:
113417ea1177Swdenk		CONFIG_PHY_ADDR
113517ea1177Swdenk
113617ea1177Swdenk		The address of PHY on MII bus.
113717ea1177Swdenk
113817ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
113917ea1177Swdenk
114017ea1177Swdenk		The clock frequency of the MII bus
114117ea1177Swdenk
114217ea1177Swdenk		CONFIG_PHY_GIGE
114317ea1177Swdenk
114417ea1177Swdenk		If this option is set, support for speed/duplex
114517ea1177Swdenk		detection of Gigabit PHY is included.
114617ea1177Swdenk
114717ea1177Swdenk		CONFIG_PHY_RESET_DELAY
114817ea1177Swdenk
114917ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
115017ea1177Swdenk		reset before any MII register access is possible.
115117ea1177Swdenk		For such PHY, set this option to the usec delay
115217ea1177Swdenk		required. (minimum 300usec for LXT971A)
115317ea1177Swdenk
115417ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
115517ea1177Swdenk
115617ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
115717ea1177Swdenk		command issued before MII status register can be read
115817ea1177Swdenk
1159c609719bSwdenk- Ethernet address:
1160c609719bSwdenk		CONFIG_ETHADDR
1161c609719bSwdenk		CONFIG_ETH2ADDR
1162c609719bSwdenk		CONFIG_ETH3ADDR
1163c609719bSwdenk
1164c609719bSwdenk		Define a default value for ethernet address to use
1165c609719bSwdenk		for the respective ethernet interface, in case this
1166c609719bSwdenk		is not determined automatically.
1167c609719bSwdenk
1168c609719bSwdenk- IP address:
1169c609719bSwdenk		CONFIG_IPADDR
1170c609719bSwdenk
1171c609719bSwdenk		Define a default value for the IP address to use for
1172c609719bSwdenk		the default ethernet interface, in case this is not
1173c609719bSwdenk		determined through e.g. bootp.
1174c609719bSwdenk
1175c609719bSwdenk- Server IP address:
1176c609719bSwdenk		CONFIG_SERVERIP
1177c609719bSwdenk
1178c609719bSwdenk		Defines a default value for theIP address of a TFTP
1179c609719bSwdenk		server to contact when using the "tftboot" command.
1180c609719bSwdenk
1181c609719bSwdenk- BOOTP Recovery Mode:
1182c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1183c609719bSwdenk
1184c609719bSwdenk		If you have many targets in a network that try to
1185c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1186c609719bSwdenk		systems send out BOOTP requests at precisely the same
1187c609719bSwdenk		moment (which would happen for instance at recovery
1188c609719bSwdenk		from a power failure, when all systems will try to
1189c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1190c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1191c609719bSwdenk		inserted before sending out BOOTP requests. The
1192c609719bSwdenk		following delays are insterted then:
1193c609719bSwdenk
1194c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1195c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1196c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1197c609719bSwdenk		4th and following
1198c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1199c609719bSwdenk
1200fe389a82Sstroese- DHCP Advanced Options:
1201fe389a82Sstroese		CONFIG_BOOTP_MASK
1202fe389a82Sstroese
1203fe389a82Sstroese		You can fine tune the DHCP functionality by adding
1204fe389a82Sstroese		these flags to the CONFIG_BOOTP_MASK define:
1205fe389a82Sstroese
1206fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1207fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1208fe389a82Sstroese		than one DNS serverip is offered to the client.
1209fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1210fe389a82Sstroese		serverip will be stored in the additional environment
1211fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1212fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
1213fe389a82Sstroese		is added to the CONFIG_BOOTP_MASK.
1214fe389a82Sstroese
1215fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1216fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1217fe389a82Sstroese		need the hostname of the DHCP requester.
1218fe389a82Sstroese		If CONFIG_BOOP_SEND_HOSTNAME is added to the
1219fe389a82Sstroese		CONFIG_BOOTP_MASK, the content of the "hostname"
1220fe389a82Sstroese		environment variable is passed as option 12 to
1221fe389a82Sstroese		the DHCP server.
1222fe389a82Sstroese
1223a3d991bdSwdenk - CDP Options:
1224a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1225a3d991bdSwdenk
1226a3d991bdSwdenk		The device id used in CDP trigger frames.
1227a3d991bdSwdenk
1228a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1229a3d991bdSwdenk
1230a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1231a3d991bdSwdenk		of the device.
1232a3d991bdSwdenk
1233a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1234a3d991bdSwdenk
1235a3d991bdSwdenk		A printf format string which contains the ascii name of
1236a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
1237a3d991bdSwdenk		eth0 for the first ethernet, eth1 for the second etc.
1238a3d991bdSwdenk
1239a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1240a3d991bdSwdenk
1241a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1242a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1243a3d991bdSwdenk
1244a3d991bdSwdenk		CONFIG_CDP_VERSION
1245a3d991bdSwdenk
1246a3d991bdSwdenk		An ascii string containing the version of the software.
1247a3d991bdSwdenk
1248a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1249a3d991bdSwdenk
1250a3d991bdSwdenk		An ascii string containing the name of the platform.
1251a3d991bdSwdenk
1252a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1253a3d991bdSwdenk
1254a3d991bdSwdenk		A 32bit integer sent on the trigger.
1255a3d991bdSwdenk
1256a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1257a3d991bdSwdenk
1258a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1259a3d991bdSwdenk		device in .1 of milliwatts.
1260a3d991bdSwdenk
1261a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1262a3d991bdSwdenk
1263a3d991bdSwdenk		A byte containing the id of the VLAN.
1264a3d991bdSwdenk
1265c609719bSwdenk- Status LED:	CONFIG_STATUS_LED
1266c609719bSwdenk
1267c609719bSwdenk		Several configurations allow to display the current
1268c609719bSwdenk		status using a LED. For instance, the LED will blink
1269c609719bSwdenk		fast while running U-Boot code, stop blinking as
1270c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1271c609719bSwdenk		start blinking slow once the Linux kernel is running
1272c609719bSwdenk		(supported by a status LED driver in the Linux
1273c609719bSwdenk		kernel). Defining CONFIG_STATUS_LED enables this
1274c609719bSwdenk		feature in U-Boot.
1275c609719bSwdenk
1276c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1277c609719bSwdenk
1278c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1279c609719bSwdenk		on those systems that support this (optional)
1280c609719bSwdenk		feature, like the TQM8xxL modules.
1281c609719bSwdenk
1282c609719bSwdenk- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C
1283c609719bSwdenk
1284b37c7e5eSwdenk		These enable I2C serial bus commands. Defining either of
1285b37c7e5eSwdenk		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1286b37c7e5eSwdenk		include the appropriate I2C driver for the selected cpu.
1287c609719bSwdenk
1288b37c7e5eSwdenk		This will allow you to use i2c commands at the u-boot
1289b37c7e5eSwdenk		command line (as long as you set CFG_CMD_I2C in
1290b37c7e5eSwdenk		CONFIG_COMMANDS) and communicate with i2c based realtime
1291b37c7e5eSwdenk		clock chips. See common/cmd_i2c.c for a description of the
1292c609719bSwdenk		command line interface.
1293c609719bSwdenk
1294bb99ad6dSBen Warren		CONFIG_I2C_CMD_TREE is a recommended option that places
1295bb99ad6dSBen Warren		all I2C commands under a single 'i2c' root command.  The
1296bb99ad6dSBen Warren		older 'imm', 'imd', 'iprobe' etc. commands are considered
1297bb99ad6dSBen Warren		deprecated and may disappear in the future.
1298bb99ad6dSBen Warren
1299bb99ad6dSBen Warren		CONFIG_HARD_I2C selects a hardware I2C controller.
1300c609719bSwdenk
1301b37c7e5eSwdenk		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1302b37c7e5eSwdenk		bit-banging) driver instead of CPM or similar hardware
1303b37c7e5eSwdenk		support for I2C.
1304c609719bSwdenk
1305b37c7e5eSwdenk		There are several other quantities that must also be
1306b37c7e5eSwdenk		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
1307c609719bSwdenk
1308b37c7e5eSwdenk		In both cases you will need to define CFG_I2C_SPEED
1309b37c7e5eSwdenk		to be the frequency (in Hz) at which you wish your i2c bus
1310b37c7e5eSwdenk		to run and CFG_I2C_SLAVE to be the address of this node (ie
1311b37c7e5eSwdenk		the cpu's i2c node address).
1312c609719bSwdenk
1313b37c7e5eSwdenk		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
1314b37c7e5eSwdenk		sets the cpu up as a master node and so its address should
1315b37c7e5eSwdenk		therefore be cleared to 0 (See, eg, MPC823e User's Manual
1316b37c7e5eSwdenk		p.16-473). So, set CFG_I2C_SLAVE to 0.
1317b37c7e5eSwdenk
1318b37c7e5eSwdenk		That's all that's required for CONFIG_HARD_I2C.
1319b37c7e5eSwdenk
1320b37c7e5eSwdenk		If you use the software i2c interface (CONFIG_SOFT_I2C)
1321b37c7e5eSwdenk		then the following macros need to be defined (examples are
1322b37c7e5eSwdenk		from include/configs/lwmon.h):
1323c609719bSwdenk
1324c609719bSwdenk		I2C_INIT
1325c609719bSwdenk
1326b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
1327c609719bSwdenk		controller or configure ports.
1328c609719bSwdenk
1329b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1330b37c7e5eSwdenk
1331c609719bSwdenk		I2C_PORT
1332c609719bSwdenk
1333c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
1334c609719bSwdenk		assumes both bits are on the same port). Valid values
1335c609719bSwdenk		are 0..3 for ports A..D.
1336c609719bSwdenk
1337c609719bSwdenk		I2C_ACTIVE
1338c609719bSwdenk
1339c609719bSwdenk		The code necessary to make the I2C data line active
1340c609719bSwdenk		(driven).  If the data line is open collector, this
1341c609719bSwdenk		define can be null.
1342c609719bSwdenk
1343b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
1344b37c7e5eSwdenk
1345c609719bSwdenk		I2C_TRISTATE
1346c609719bSwdenk
1347c609719bSwdenk		The code necessary to make the I2C data line tri-stated
1348c609719bSwdenk		(inactive).  If the data line is open collector, this
1349c609719bSwdenk		define can be null.
1350c609719bSwdenk
1351b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1352b37c7e5eSwdenk
1353c609719bSwdenk		I2C_READ
1354c609719bSwdenk
1355c609719bSwdenk		Code that returns TRUE if the I2C data line is high,
1356c609719bSwdenk		FALSE if it is low.
1357c609719bSwdenk
1358b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1359b37c7e5eSwdenk
1360c609719bSwdenk		I2C_SDA(bit)
1361c609719bSwdenk
1362c609719bSwdenk		If <bit> is TRUE, sets the I2C data line high. If it
1363c609719bSwdenk		is FALSE, it clears it (low).
1364c609719bSwdenk
1365b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
1366b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1367b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1368b37c7e5eSwdenk
1369c609719bSwdenk		I2C_SCL(bit)
1370c609719bSwdenk
1371c609719bSwdenk		If <bit> is TRUE, sets the I2C clock line high. If it
1372c609719bSwdenk		is FALSE, it clears it (low).
1373c609719bSwdenk
1374b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
1375b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1376b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1377b37c7e5eSwdenk
1378c609719bSwdenk		I2C_DELAY
1379c609719bSwdenk
1380c609719bSwdenk		This delay is invoked four times per clock cycle so this
1381c609719bSwdenk		controls the rate of data transfer.  The data rate thus
1382b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
1383b37c7e5eSwdenk		like:
1384b37c7e5eSwdenk
1385b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
1386c609719bSwdenk
138747cd00faSwdenk		CFG_I2C_INIT_BOARD
138847cd00faSwdenk
138947cd00faSwdenk		When a board is reset during an i2c bus transfer
139047cd00faSwdenk		chips might think that the current transfer is still
139147cd00faSwdenk		in progress. On some boards it is possible to access
139247cd00faSwdenk		the i2c SCLK line directly, either by using the
139347cd00faSwdenk		processor pin as a GPIO or by having a second pin
139447cd00faSwdenk		connected to the bus. If this option is defined a
139547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
139647cd00faSwdenk		is run early in the boot sequence.
139747cd00faSwdenk
139817ea1177Swdenk		CONFIG_I2CFAST (PPC405GP|PPC405EP only)
139917ea1177Swdenk
140017ea1177Swdenk		This option enables configuration of bi_iic_fast[] flags
140117ea1177Swdenk		in u-boot bd_info structure based on u-boot environment
140217ea1177Swdenk		variable "i2cfast". (see also i2cfast)
140317ea1177Swdenk
1404bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
1405bb99ad6dSBen Warren
1406bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
1407bb99ad6dSBen Warren		must have a controller.  At any point in time, only one bus is
1408bb99ad6dSBen Warren		active.  To switch to a different bus, use the 'i2c dev' command.
1409bb99ad6dSBen Warren		Note that bus numbering is zero-based.
1410bb99ad6dSBen Warren
1411bb99ad6dSBen Warren		CFG_I2C_NOPROBES
1412bb99ad6dSBen Warren
1413bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
1414bb99ad6dSBen Warren		when the 'i2c probe' command is issued (or 'iprobe' using the legacy
1415bb99ad6dSBen Warren		command).  If CONFIG_I2C_MULTI_BUS is set, specify a list of bus-device
1416bb99ad6dSBen Warren		pairs.  Otherwise, specify a 1D array of device addresses
1417bb99ad6dSBen Warren
1418bb99ad6dSBen Warren		e.g.
1419bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
1420bb99ad6dSBen Warren			#define CFG_I2C_NOPROBES	{0x50,0x68}
1421bb99ad6dSBen Warren
1422bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
1423bb99ad6dSBen Warren
1424bb99ad6dSBen Warren			#define	CONFIG_I2C_MULTI_BUS
1425bb99ad6dSBen Warren			#define CFG_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1426bb99ad6dSBen Warren
1427bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1428bb99ad6dSBen Warren
1429be5e6181STimur Tabi		CFG_SPD_BUS_NUM
1430be5e6181STimur Tabi
1431be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
1432be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1433be5e6181STimur Tabi
14340dc018ecSStefan Roese		CFG_RTC_BUS_NUM
14350dc018ecSStefan Roese
14360dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
14370dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
14380dc018ecSStefan Roese
14390dc018ecSStefan Roese		CFG_DTT_BUS_NUM
14400dc018ecSStefan Roese
14410dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the DTT.
14420dc018ecSStefan Roese		If not defined, then U-Boot assumes that DTT is on I2C bus 0.
14430dc018ecSStefan Roese
1444be5e6181STimur Tabi		CONFIG_FSL_I2C
1445be5e6181STimur Tabi
1446be5e6181STimur Tabi		Define this option if you want to use Freescale's I2C driver in
1447be5e6181STimur Tabi		drivers/fsl_i2c.c.
1448be5e6181STimur Tabi
1449be5e6181STimur Tabi
1450c609719bSwdenk- SPI Support:	CONFIG_SPI
1451c609719bSwdenk
1452c609719bSwdenk		Enables SPI driver (so far only tested with
1453c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
1454c609719bSwdenk		D/As on the SACSng board)
1455c609719bSwdenk
1456c609719bSwdenk		CONFIG_SPI_X
1457c609719bSwdenk
1458c609719bSwdenk		Enables extended (16-bit) SPI EEPROM addressing.
1459c609719bSwdenk		(symmetrical to CONFIG_I2C_X)
1460c609719bSwdenk
1461c609719bSwdenk		CONFIG_SOFT_SPI
1462c609719bSwdenk
1463c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
1464c609719bSwdenk		using hardware support. This is a general purpose
1465c609719bSwdenk		driver that only requires three general I/O port pins
1466c609719bSwdenk		(two outputs, one input) to function. If this is
1467c609719bSwdenk		defined, the board configuration must define several
1468c609719bSwdenk		SPI configuration items (port pins to use, etc). For
1469c609719bSwdenk		an example, see include/configs/sacsng.h.
1470c609719bSwdenk
1471c609719bSwdenk- FPGA Support: CONFIG_FPGA_COUNT
1472c609719bSwdenk
1473c609719bSwdenk		Specify the number of FPGA devices to support.
1474c609719bSwdenk
1475c609719bSwdenk		CONFIG_FPGA
1476c609719bSwdenk
1477c609719bSwdenk		Used to specify the types of FPGA devices.  For example,
1478c609719bSwdenk		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
1479c609719bSwdenk
1480c609719bSwdenk		CFG_FPGA_PROG_FEEDBACK
1481c609719bSwdenk
1482c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
1483c609719bSwdenk
1484c609719bSwdenk		CFG_FPGA_CHECK_BUSY
1485c609719bSwdenk
1486c609719bSwdenk		Enable checks on FPGA configuration interface busy
1487c609719bSwdenk		status by the configuration function. This option
1488c609719bSwdenk		will require a board or device specific function to
1489c609719bSwdenk		be written.
1490c609719bSwdenk
1491c609719bSwdenk		CONFIG_FPGA_DELAY
1492c609719bSwdenk
1493c609719bSwdenk		If defined, a function that provides delays in the FPGA
1494c609719bSwdenk		configuration driver.
1495c609719bSwdenk
1496c609719bSwdenk		CFG_FPGA_CHECK_CTRLC
1497c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
1498c609719bSwdenk
1499c609719bSwdenk		CFG_FPGA_CHECK_ERROR
1500c609719bSwdenk
1501c609719bSwdenk		Check for configuration errors during FPGA bitfile
1502c609719bSwdenk		loading. For example, abort during Virtex II
1503c609719bSwdenk		configuration if the INIT_B line goes low (which
1504c609719bSwdenk		indicated a CRC error).
1505c609719bSwdenk
1506c609719bSwdenk		CFG_FPGA_WAIT_INIT
1507c609719bSwdenk
1508c609719bSwdenk		Maximum time to wait for the INIT_B line to deassert
1509c609719bSwdenk		after PROB_B has been deasserted during a Virtex II
1510c609719bSwdenk		FPGA configuration sequence. The default time is 500
1511c609719bSwdenk		mS.
1512c609719bSwdenk
1513c609719bSwdenk		CFG_FPGA_WAIT_BUSY
1514c609719bSwdenk
1515c609719bSwdenk		Maximum time to wait for BUSY to deassert during
1516c609719bSwdenk		Virtex II FPGA configuration. The default is 5 mS.
1517c609719bSwdenk
1518c609719bSwdenk		CFG_FPGA_WAIT_CONFIG
1519c609719bSwdenk
1520c609719bSwdenk		Time to wait after FPGA configuration. The default is
1521c609719bSwdenk		200 mS.
1522c609719bSwdenk
1523c609719bSwdenk- Configuration Management:
1524c609719bSwdenk		CONFIG_IDENT_STRING
1525c609719bSwdenk
1526c609719bSwdenk		If defined, this string will be added to the U-Boot
1527c609719bSwdenk		version information (U_BOOT_VERSION)
1528c609719bSwdenk
1529c609719bSwdenk- Vendor Parameter Protection:
1530c609719bSwdenk
1531c609719bSwdenk		U-Boot considers the values of the environment
1532c609719bSwdenk		variables "serial#" (Board Serial Number) and
15337152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
1534c609719bSwdenk		are set once by the board vendor / manufacturer, and
1535c609719bSwdenk		protects these variables from casual modification by
1536c609719bSwdenk		the user. Once set, these variables are read-only,
1537c609719bSwdenk		and write or delete attempts are rejected. You can
1538c609719bSwdenk		change this behviour:
1539c609719bSwdenk
1540c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
1541c609719bSwdenk		file, the write protection for vendor parameters is
154247cd00faSwdenk		completely disabled. Anybody can change or delete
1543c609719bSwdenk		these parameters.
1544c609719bSwdenk
1545c609719bSwdenk		Alternatively, if you #define _both_ CONFIG_ETHADDR
1546c609719bSwdenk		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
1547c609719bSwdenk		ethernet address is installed in the environment,
1548c609719bSwdenk		which can be changed exactly ONCE by the user. [The
1549c609719bSwdenk		serial# is unaffected by this, i. e. it remains
1550c609719bSwdenk		read-only.]
1551c609719bSwdenk
1552c609719bSwdenk- Protected RAM:
1553c609719bSwdenk		CONFIG_PRAM
1554c609719bSwdenk
1555c609719bSwdenk		Define this variable to enable the reservation of
1556c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
1557c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
1558c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
1559c609719bSwdenk		this default value by defining an environment
1560c609719bSwdenk		variable "pram" to the number of kB you want to
1561c609719bSwdenk		reserve. Note that the board info structure will
1562c609719bSwdenk		still show the full amount of RAM. If pRAM is
1563c609719bSwdenk		reserved, a new environment variable "mem" will
1564c609719bSwdenk		automatically be defined to hold the amount of
1565c609719bSwdenk		remaining RAM in a form that can be passed as boot
1566c609719bSwdenk		argument to Linux, for instance like that:
1567c609719bSwdenk
1568fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
1569c609719bSwdenk			saveenv
1570c609719bSwdenk
1571c609719bSwdenk		This way you can tell Linux not to use this memory,
1572c609719bSwdenk		either, which results in a memory region that will
1573c609719bSwdenk		not be affected by reboots.
1574c609719bSwdenk
1575c609719bSwdenk		*WARNING* If your board configuration uses automatic
1576c609719bSwdenk		detection of the RAM size, you must make sure that
1577c609719bSwdenk		this memory test is non-destructive. So far, the
1578c609719bSwdenk		following board configurations are known to be
1579c609719bSwdenk		"pRAM-clean":
1580c609719bSwdenk
1581c609719bSwdenk			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
1582c609719bSwdenk			HERMES, IP860, RPXlite, LWMON, LANTEC,
1583c609719bSwdenk			PCU_E, FLAGADM, TQM8260
1584c609719bSwdenk
1585c609719bSwdenk- Error Recovery:
1586c609719bSwdenk		CONFIG_PANIC_HANG
1587c609719bSwdenk
1588c609719bSwdenk		Define this variable to stop the system in case of a
1589c609719bSwdenk		fatal error, so that you have to reset it manually.
1590c609719bSwdenk		This is probably NOT a good idea for an embedded
1591c609719bSwdenk		system where you want to system to reboot
1592c609719bSwdenk		automatically as fast as possible, but it may be
1593c609719bSwdenk		useful during development since you can try to debug
1594c609719bSwdenk		the conditions that lead to the situation.
1595c609719bSwdenk
1596c609719bSwdenk		CONFIG_NET_RETRY_COUNT
1597c609719bSwdenk
1598c609719bSwdenk		This variable defines the number of retries for
1599c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
1600c609719bSwdenk		before giving up the operation. If not defined, a
1601c609719bSwdenk		default value of 5 is used.
1602c609719bSwdenk
1603c609719bSwdenk- Command Interpreter:
16048078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
160504a85b3bSwdenk
160604a85b3bSwdenk		Enable auto completion of commands using TAB.
160704a85b3bSwdenk
16088078f1a5SWolfgang Denk		Note that this feature has NOT been implemented yet
16098078f1a5SWolfgang Denk		for the "hush" shell.
16108078f1a5SWolfgang Denk
16118078f1a5SWolfgang Denk
1612c609719bSwdenk		CFG_HUSH_PARSER
1613c609719bSwdenk
1614c609719bSwdenk		Define this variable to enable the "hush" shell (from
1615c609719bSwdenk		Busybox) as command line interpreter, thus enabling
1616c609719bSwdenk		powerful command line syntax like
1617c609719bSwdenk		if...then...else...fi conditionals or `&&' and '||'
1618c609719bSwdenk		constructs ("shell scripts").
1619c609719bSwdenk
1620c609719bSwdenk		If undefined, you get the old, much simpler behaviour
1621c609719bSwdenk		with a somewhat smaller memory footprint.
1622c609719bSwdenk
1623c609719bSwdenk
1624c609719bSwdenk		CFG_PROMPT_HUSH_PS2
1625c609719bSwdenk
1626c609719bSwdenk		This defines the secondary prompt string, which is
1627c609719bSwdenk		printed when the command interpreter needs more input
1628c609719bSwdenk		to complete a command. Usually "> ".
1629c609719bSwdenk
1630c609719bSwdenk	Note:
1631c609719bSwdenk
1632c609719bSwdenk		In the current implementation, the local variables
1633c609719bSwdenk		space and global environment variables space are
1634c609719bSwdenk		separated. Local variables are those you define by
16353b57fe0aSwdenk		simply typing `name=value'. To access a local
1636c609719bSwdenk		variable later on, you have write `$name' or
16373b57fe0aSwdenk		`${name}'; to execute the contents of a variable
16383b57fe0aSwdenk		directly type `$name' at the command prompt.
1639c609719bSwdenk
1640c609719bSwdenk		Global environment variables are those you use
1641c609719bSwdenk		setenv/printenv to work with. To run a command stored
1642c609719bSwdenk		in such a variable, you need to use the run command,
1643c609719bSwdenk		and you must not use the '$' sign to access them.
1644c609719bSwdenk
1645c609719bSwdenk		To store commands and special characters in a
1646c609719bSwdenk		variable, please use double quotation marks
1647c609719bSwdenk		surrounding the whole text of the variable, instead
1648c609719bSwdenk		of the backslashes before semicolons and special
1649c609719bSwdenk		symbols.
1650c609719bSwdenk
1651aa0c71acSWolfgang Denk- Commandline Editing and History:
1652aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
1653aa0c71acSWolfgang Denk
1654aa0c71acSWolfgang Denk		Enable editiong and History functions for interactive
1655aa0c71acSWolfgang Denk		commandline input operations
1656aa0c71acSWolfgang Denk
1657a8c7c708Swdenk- Default Environment:
1658c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
1659c609719bSwdenk
1660c609719bSwdenk		Define this to contain any number of null terminated
1661c609719bSwdenk		strings (variable = value pairs) that will be part of
16627152b1d0Swdenk		the default environment compiled into the boot image.
16632262cfeeSwdenk
1664c609719bSwdenk		For example, place something like this in your
1665c609719bSwdenk		board's config file:
1666c609719bSwdenk
1667c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
1668c609719bSwdenk			"myvar1=value1\0" \
1669c609719bSwdenk			"myvar2=value2\0"
1670c609719bSwdenk
1671c609719bSwdenk		Warning: This method is based on knowledge about the
1672c609719bSwdenk		internal format how the environment is stored by the
16732262cfeeSwdenk		U-Boot code. This is NOT an official, exported
1674c609719bSwdenk		interface! Although it is unlikely that this format
16757152b1d0Swdenk		will change soon, there is no guarantee either.
1676c609719bSwdenk		You better know what you are doing here.
1677c609719bSwdenk
1678c609719bSwdenk		Note: overly (ab)use of the default environment is
1679c609719bSwdenk		discouraged. Make sure to check other ways to preset
1680c609719bSwdenk		the environment like the autoscript function or the
1681c609719bSwdenk		boot command first.
1682c609719bSwdenk
1683a8c7c708Swdenk- DataFlash Support:
16842abbe075Swdenk		CONFIG_HAS_DATAFLASH
16852abbe075Swdenk
16862abbe075Swdenk		Defining this option enables DataFlash features and
16872abbe075Swdenk		allows to read/write in Dataflash via the standard
16882abbe075Swdenk		commands cp, md...
16892abbe075Swdenk
16903f85ce27Swdenk- SystemACE Support:
16913f85ce27Swdenk		CONFIG_SYSTEMACE
16923f85ce27Swdenk
16933f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
16943f85ce27Swdenk		chips attached via some sort of local bus. The address
16953f85ce27Swdenk		of the chip must alsh be defined in the
16963f85ce27Swdenk		CFG_SYSTEMACE_BASE macro. For example:
16973f85ce27Swdenk
16983f85ce27Swdenk		#define CONFIG_SYSTEMACE
16993f85ce27Swdenk		#define CFG_SYSTEMACE_BASE 0xf0000000
17003f85ce27Swdenk
17013f85ce27Swdenk		When SystemACE support is added, the "ace" device type
17023f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
17033f85ce27Swdenk
1704ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
1705ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
1706ecb0ccd9SWolfgang Denk
170728cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
1708ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
170928cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
1710ecb0ccd9SWolfgang Denk		number generator is used.
1711ecb0ccd9SWolfgang Denk
171228cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
171328cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
171428cb9375SWolfgang Denk		defined, the normal port 69 is used.
171528cb9375SWolfgang Denk
171628cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
1717ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
1718ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
1719ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
1720ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
1721ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
1722ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
1723ecb0ccd9SWolfgang Denk
1724a8c7c708Swdenk- Show boot progress:
1725c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
1726c609719bSwdenk
1727c609719bSwdenk		Defining this option allows to add some board-
1728c609719bSwdenk		specific code (calling a user-provided function
1729c609719bSwdenk		"show_boot_progress(int)") that enables you to show
1730c609719bSwdenk		the system's boot progress on some display (for
1731c609719bSwdenk		example, some LED's) on your board. At the moment,
1732c609719bSwdenk		the following checkpoints are implemented:
1733c609719bSwdenk
1734c609719bSwdenk  Arg	Where			When
1735c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
1736c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
1737c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
1738c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
1739c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
1740c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
1741c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
1742c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
1743c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
1744c609719bSwdenk   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1745c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
1746c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
1747c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
1748c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
1749c609719bSwdenk   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
1750c609719bSwdenk    8	common/cmd_bootm.c	Image Type check OK
1751c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
1752c609719bSwdenk    9	common/cmd_bootm.c	Start initial ramdisk verification
1753c609719bSwdenk  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
1754c609719bSwdenk  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
1755c609719bSwdenk   10	common/cmd_bootm.c	Ramdisk header is OK
1756c609719bSwdenk  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
1757c609719bSwdenk   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
1758c609719bSwdenk   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
1759c609719bSwdenk  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
1760c609719bSwdenk   13	common/cmd_bootm.c	Start multifile image verification
1761c609719bSwdenk   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
1762c609719bSwdenk   15	common/cmd_bootm.c	All preparation done, transferring control to OS
1763c609719bSwdenk
176463e73c9aSwdenk  -30	lib_ppc/board.c		Fatal error, hang the system
176563e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
176663e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
176763e73c9aSwdenk
1768c609719bSwdenk   -1	common/cmd_doc.c	Bad usage of "doc" command
1769c609719bSwdenk   -1	common/cmd_doc.c	No boot device
1770c609719bSwdenk   -1	common/cmd_doc.c	Unknown Chip ID on boot device
1771c609719bSwdenk   -1	common/cmd_doc.c	Read Error on boot device
1772c609719bSwdenk   -1	common/cmd_doc.c	Image header has bad magic number
1773c609719bSwdenk
1774c609719bSwdenk   -1	common/cmd_ide.c	Bad usage of "ide" command
1775c609719bSwdenk   -1	common/cmd_ide.c	No boot device
1776c609719bSwdenk   -1	common/cmd_ide.c	Unknown boot device
1777c609719bSwdenk   -1	common/cmd_ide.c	Unknown partition table
1778c609719bSwdenk   -1	common/cmd_ide.c	Invalid partition type
1779c609719bSwdenk   -1	common/cmd_ide.c	Read Error on boot device
1780c609719bSwdenk   -1	common/cmd_ide.c	Image header has bad magic number
1781c609719bSwdenk
1782206c60cbSwdenk   -1	common/cmd_nand.c	Bad usage of "nand" command
1783206c60cbSwdenk   -1	common/cmd_nand.c	No boot device
1784206c60cbSwdenk   -1	common/cmd_nand.c	Unknown Chip ID on boot device
1785206c60cbSwdenk   -1	common/cmd_nand.c	Read Error on boot device
1786206c60cbSwdenk   -1	common/cmd_nand.c	Image header has bad magic number
1787206c60cbSwdenk
1788206c60cbSwdenk   -1	common/env_common.c	Environment has a bad CRC, using default
1789c609719bSwdenk
1790c609719bSwdenk
1791c609719bSwdenkModem Support:
1792c609719bSwdenk--------------
1793c609719bSwdenk
179485ec0bccSwdenk[so far only for SMDK2400 and TRAB boards]
1795c609719bSwdenk
1796c609719bSwdenk- Modem support endable:
1797c609719bSwdenk		CONFIG_MODEM_SUPPORT
1798c609719bSwdenk
1799c609719bSwdenk- RTS/CTS Flow control enable:
1800c609719bSwdenk		CONFIG_HWFLOW
1801c609719bSwdenk
1802c609719bSwdenk- Modem debug support:
1803c609719bSwdenk		CONFIG_MODEM_SUPPORT_DEBUG
1804c609719bSwdenk
1805c609719bSwdenk		Enables debugging stuff (char screen[1024], dbg())
1806c609719bSwdenk		for modem support. Useful only with BDI2000.
1807c609719bSwdenk
1808a8c7c708Swdenk- Interrupt support (PPC):
1809a8c7c708Swdenk
1810a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
1811a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
1812a8c7c708Swdenk		for cpu specific initialization. interrupt_init_cpu()
1813a8c7c708Swdenk		should set decrementer_count to appropriate value. If
1814a8c7c708Swdenk		cpu resets decrementer automatically after interrupt
1815a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
1816a8c7c708Swdenk		timer_interrupt() calls timer_interrupt_cpu() for cpu
1817a8c7c708Swdenk		specific handling. If board has watchdog / status_led
1818a8c7c708Swdenk		/ other_activity_monitor it works automatically from
1819a8c7c708Swdenk		general timer_interrupt().
1820a8c7c708Swdenk
1821c609719bSwdenk- General:
1822c609719bSwdenk
1823c609719bSwdenk		In the target system modem support is enabled when a
1824c609719bSwdenk		specific key (key combination) is pressed during
1825c609719bSwdenk		power-on. Otherwise U-Boot will boot normally
1826c609719bSwdenk		(autoboot). The key_pressed() fuction is called from
1827c609719bSwdenk		board_init(). Currently key_pressed() is a dummy
1828c609719bSwdenk		function, returning 1 and thus enabling modem
1829c609719bSwdenk		initialization.
1830c609719bSwdenk
1831c609719bSwdenk		If there are no modem init strings in the
1832c609719bSwdenk		environment, U-Boot proceed to autoboot; the
1833c609719bSwdenk		previous output (banner, info printfs) will be
1834c609719bSwdenk		supressed, though.
1835c609719bSwdenk
1836c609719bSwdenk		See also: doc/README.Modem
1837c609719bSwdenk
1838c609719bSwdenk
1839c609719bSwdenkConfiguration Settings:
1840c609719bSwdenk-----------------------
1841c609719bSwdenk
1842c609719bSwdenk- CFG_LONGHELP: Defined when you want long help messages included;
1843c609719bSwdenk		undefine this when you're short of memory.
1844c609719bSwdenk
1845c609719bSwdenk- CFG_PROMPT:	This is what U-Boot prints on the console to
1846c609719bSwdenk		prompt for user input.
1847c609719bSwdenk
1848c609719bSwdenk- CFG_CBSIZE:	Buffer size for input from the Console
1849c609719bSwdenk
1850c609719bSwdenk- CFG_PBSIZE:	Buffer size for Console output
1851c609719bSwdenk
1852c609719bSwdenk- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands
1853c609719bSwdenk
1854c609719bSwdenk- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
1855c609719bSwdenk		the application (usually a Linux kernel) when it is
1856c609719bSwdenk		booted
1857c609719bSwdenk
1858c609719bSwdenk- CFG_BAUDRATE_TABLE:
1859c609719bSwdenk		List of legal baudrate settings for this board.
1860c609719bSwdenk
1861c609719bSwdenk- CFG_CONSOLE_INFO_QUIET
1862c609719bSwdenk		Suppress display of console information at boot.
1863c609719bSwdenk
1864c609719bSwdenk- CFG_CONSOLE_IS_IN_ENV
1865c609719bSwdenk		If the board specific function
1866c609719bSwdenk			extern int overwrite_console (void);
1867c609719bSwdenk		returns 1, the stdin, stderr and stdout are switched to the
1868c609719bSwdenk		serial port, else the settings in the environment are used.
1869c609719bSwdenk
1870c609719bSwdenk- CFG_CONSOLE_OVERWRITE_ROUTINE
1871c609719bSwdenk		Enable the call to overwrite_console().
1872c609719bSwdenk
1873c609719bSwdenk- CFG_CONSOLE_ENV_OVERWRITE
1874c609719bSwdenk		Enable overwrite of previous console environment settings.
1875c609719bSwdenk
1876c609719bSwdenk- CFG_MEMTEST_START, CFG_MEMTEST_END:
1877c609719bSwdenk		Begin and End addresses of the area used by the
1878c609719bSwdenk		simple memory test.
1879c609719bSwdenk
1880c609719bSwdenk- CFG_ALT_MEMTEST:
1881c609719bSwdenk		Enable an alternate, more extensive memory test.
1882c609719bSwdenk
18835f535fe1Swdenk- CFG_MEMTEST_SCRATCH:
18845f535fe1Swdenk		Scratch address used by the alternate memory test
18855f535fe1Swdenk		You only need to set this if address zero isn't writeable
18865f535fe1Swdenk
1887c609719bSwdenk- CFG_TFTP_LOADADDR:
1888c609719bSwdenk		Default load address for network file downloads
1889c609719bSwdenk
1890c609719bSwdenk- CFG_LOADS_BAUD_CHANGE:
1891c609719bSwdenk		Enable temporary baudrate change while serial download
1892c609719bSwdenk
1893c609719bSwdenk- CFG_SDRAM_BASE:
1894c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
1895c609719bSwdenk
1896c609719bSwdenk- CFG_MBIO_BASE:
1897c609719bSwdenk		Physical start address of Motherboard I/O (if using a
1898c609719bSwdenk		Cogent motherboard)
1899c609719bSwdenk
1900c609719bSwdenk- CFG_FLASH_BASE:
1901c609719bSwdenk		Physical start address of Flash memory.
1902c609719bSwdenk
1903c609719bSwdenk- CFG_MONITOR_BASE:
1904c609719bSwdenk		Physical start address of boot monitor code (set by
1905c609719bSwdenk		make config files to be same as the text base address
1906c609719bSwdenk		(TEXT_BASE) used when linking) - same as
1907c609719bSwdenk		CFG_FLASH_BASE when booting from flash.
1908c609719bSwdenk
1909c609719bSwdenk- CFG_MONITOR_LEN:
19103b57fe0aSwdenk		Size of memory reserved for monitor code, used to
19113b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
19123b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
19133b57fe0aSwdenk		flash sector.
1914c609719bSwdenk
1915c609719bSwdenk- CFG_MALLOC_LEN:
1916c609719bSwdenk		Size of DRAM reserved for malloc() use.
1917c609719bSwdenk
191815940c9aSStefan Roese- CFG_BOOTM_LEN:
191915940c9aSStefan Roese		Normally compressed uImages are limited to an
192015940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
192115940c9aSStefan Roese		you can define CFG_BOOTM_LEN in your board config file
192215940c9aSStefan Roese		to adjust this setting to your needs.
1923c609719bSwdenk
1924c609719bSwdenk- CFG_BOOTMAPSZ:
1925c609719bSwdenk		Maximum size of memory mapped by the startup code of
1926c609719bSwdenk		the Linux kernel; all data that must be processed by
1927c609719bSwdenk		the Linux kernel (bd_info, boot arguments, eventually
1928c609719bSwdenk		initrd image) must be put below this limit.
1929c609719bSwdenk
1930c609719bSwdenk- CFG_MAX_FLASH_BANKS:
1931c609719bSwdenk		Max number of Flash memory banks
1932c609719bSwdenk
1933c609719bSwdenk- CFG_MAX_FLASH_SECT:
1934c609719bSwdenk		Max number of sectors on a Flash chip
1935c609719bSwdenk
1936c609719bSwdenk- CFG_FLASH_ERASE_TOUT:
1937c609719bSwdenk		Timeout for Flash erase operations (in ms)
1938c609719bSwdenk
1939c609719bSwdenk- CFG_FLASH_WRITE_TOUT:
1940c609719bSwdenk		Timeout for Flash write operations (in ms)
1941c609719bSwdenk
19428564acf9Swdenk- CFG_FLASH_LOCK_TOUT
19438564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
19448564acf9Swdenk
19458564acf9Swdenk- CFG_FLASH_UNLOCK_TOUT
19468564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
19478564acf9Swdenk
19488564acf9Swdenk- CFG_FLASH_PROTECTION
19498564acf9Swdenk		If defined, hardware flash sectors protection is used
19508564acf9Swdenk		instead of U-Boot software protection.
19518564acf9Swdenk
1952c609719bSwdenk- CFG_DIRECT_FLASH_TFTP:
1953c609719bSwdenk
1954c609719bSwdenk		Enable TFTP transfers directly to flash memory;
1955c609719bSwdenk		without this option such a download has to be
1956c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
1957c609719bSwdenk		copy from RAM to flash.
1958c609719bSwdenk
1959c609719bSwdenk		The two-step approach is usually more reliable, since
1960c609719bSwdenk		you can check if the download worked before you erase
1961c609719bSwdenk		the flash, but in some situations (when sytem RAM is
1962c609719bSwdenk		too limited to allow for a tempory copy of the
1963c609719bSwdenk		downloaded image) this option may be very useful.
1964c609719bSwdenk
1965c609719bSwdenk- CFG_FLASH_CFI:
1966c609719bSwdenk		Define if the flash driver uses extra elements in the
19675653fc33Swdenk		common flash structure for storing flash geometry.
19685653fc33Swdenk
19695653fc33Swdenk- CFG_FLASH_CFI_DRIVER
19705653fc33Swdenk		This option also enables the building of the cfi_flash driver
19715653fc33Swdenk		in the drivers directory
197253cf9435Sstroese
19735568e613SStefan Roese- CFG_FLASH_QUIET_TEST
19745568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
19755568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
19765568e613SStefan Roese		is useful, if some of the configured banks are only
19775568e613SStefan Roese		optionally available.
19785568e613SStefan Roese
197953cf9435Sstroese- CFG_RX_ETH_BUFFER:
198053cf9435Sstroese		Defines the number of ethernet receive buffers. On some
198153cf9435Sstroese		ethernet controllers it is recommended to set this value
198253cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
198353cf9435Sstroese		buffers can be full shortly after enabling the interface
198453cf9435Sstroese		on high ethernet traffic.
198553cf9435Sstroese		Defaults to 4 if not defined.
1986c609719bSwdenk
1987c609719bSwdenkThe following definitions that deal with the placement and management
1988c609719bSwdenkof environment data (variable area); in general, we support the
1989c609719bSwdenkfollowing configurations:
1990c609719bSwdenk
1991c609719bSwdenk- CFG_ENV_IS_IN_FLASH:
1992c609719bSwdenk
1993c609719bSwdenk	Define this if the environment is in flash memory.
1994c609719bSwdenk
1995c609719bSwdenk	a) The environment occupies one whole flash sector, which is
1996c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
1997c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
1998c609719bSwdenk	   sector" type flash chips, which have several smaller
1999c609719bSwdenk	   sectors at the start or the end. For instance, such a
2000c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
2001c609719bSwdenk	   such a case you would place the environment in one of the
2002c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
2003c609719bSwdenk	   "top boot sector" type flash chips, you would put the
2004c609719bSwdenk	   environment in one of the last sectors, leaving a gap
2005c609719bSwdenk	   between U-Boot and the environment.
2006c609719bSwdenk
2007c609719bSwdenk	- CFG_ENV_OFFSET:
2008c609719bSwdenk
2009c609719bSwdenk	   Offset of environment data (variable area) to the
2010c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
2011c609719bSwdenk	   type flash chips the second sector can be used: the offset
2012c609719bSwdenk	   for this sector is given here.
2013c609719bSwdenk
2014c609719bSwdenk	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
2015c609719bSwdenk
2016c609719bSwdenk	- CFG_ENV_ADDR:
2017c609719bSwdenk
2018c609719bSwdenk	   This is just another way to specify the start address of
2019c609719bSwdenk	   the flash sector containing the environment (instead of
2020c609719bSwdenk	   CFG_ENV_OFFSET).
2021c609719bSwdenk
2022c609719bSwdenk	- CFG_ENV_SECT_SIZE:
2023c609719bSwdenk
2024c609719bSwdenk	   Size of the sector containing the environment.
2025c609719bSwdenk
2026c609719bSwdenk
2027c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
2028c609719bSwdenk	   In such a case you don't want to spend a whole sector for
2029c609719bSwdenk	   the environment.
2030c609719bSwdenk
2031c609719bSwdenk	- CFG_ENV_SIZE:
2032c609719bSwdenk
2033c609719bSwdenk	   If you use this in combination with CFG_ENV_IS_IN_FLASH
2034c609719bSwdenk	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
2035c609719bSwdenk	   of this flash sector for the environment. This saves
2036c609719bSwdenk	   memory for the RAM copy of the environment.
2037c609719bSwdenk
2038c609719bSwdenk	   It may also save flash memory if you decide to use this
2039c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
2040c609719bSwdenk	   since then the remainder of the flash sector could be used
2041c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
2042c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
2043c609719bSwdenk	   updating the environment in flash makes it always
2044c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
2045c609719bSwdenk	   wrong before the contents has been restored from a copy in
2046c609719bSwdenk	   RAM, your target system will be dead.
2047c609719bSwdenk
2048c609719bSwdenk	- CFG_ENV_ADDR_REDUND
2049c609719bSwdenk	  CFG_ENV_SIZE_REDUND
2050c609719bSwdenk
2051c609719bSwdenk	   These settings describe a second storage area used to hold
2052c609719bSwdenk	   a redundand copy of the environment data, so that there is
20533e38691eSwdenk	   a valid backup copy in case there is a power failure during
2054c609719bSwdenk	   a "saveenv" operation.
2055c609719bSwdenk
2056c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
2057c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
2058c609719bSwdenkaccordingly!
2059c609719bSwdenk
2060c609719bSwdenk
2061c609719bSwdenk- CFG_ENV_IS_IN_NVRAM:
2062c609719bSwdenk
2063c609719bSwdenk	Define this if you have some non-volatile memory device
2064c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
2065c609719bSwdenk	environment.
2066c609719bSwdenk
2067c609719bSwdenk	- CFG_ENV_ADDR:
2068c609719bSwdenk	- CFG_ENV_SIZE:
2069c609719bSwdenk
2070c609719bSwdenk	  These two #defines are used to determin the memory area you
2071c609719bSwdenk	  want to use for environment. It is assumed that this memory
2072c609719bSwdenk	  can just be read and written to, without any special
2073c609719bSwdenk	  provision.
2074c609719bSwdenk
2075c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
2076c609719bSwdenkin U-Boot initalization (when we try to get the setting of for the
2077c609719bSwdenkconsole baudrate). You *MUST* have mappend your NVRAM area then, or
2078c609719bSwdenkU-Boot will hang.
2079c609719bSwdenk
2080c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
2081c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
2082c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
2083c609719bSwdenkto save the current settings.
2084c609719bSwdenk
2085c609719bSwdenk
2086c609719bSwdenk- CFG_ENV_IS_IN_EEPROM:
2087c609719bSwdenk
2088c609719bSwdenk	Use this if you have an EEPROM or similar serial access
2089c609719bSwdenk	device and a driver for it.
2090c609719bSwdenk
2091c609719bSwdenk	- CFG_ENV_OFFSET:
2092c609719bSwdenk	- CFG_ENV_SIZE:
2093c609719bSwdenk
2094c609719bSwdenk	  These two #defines specify the offset and size of the
2095c609719bSwdenk	  environment area within the total memory of your EEPROM.
2096c609719bSwdenk
2097c609719bSwdenk	- CFG_I2C_EEPROM_ADDR:
2098c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
2099c609719bSwdenk	  The default address is zero.
2100c609719bSwdenk
2101c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_BITS:
2102c609719bSwdenk	  If defined, the number of bits used to address bytes in a
2103c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
2104c609719bSwdenk	  would require six bits.
2105c609719bSwdenk
2106c609719bSwdenk	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
2107c609719bSwdenk	  If defined, the number of milliseconds to delay between
2108c609719bSwdenk	  page writes.	The default is zero milliseconds.
2109c609719bSwdenk
2110c609719bSwdenk	- CFG_I2C_EEPROM_ADDR_LEN:
2111c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
2112c609719bSwdenk	  that this is NOT the chip address length!
2113c609719bSwdenk
21145cf91d6bSwdenk	- CFG_I2C_EEPROM_ADDR_OVERFLOW:
21155cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
21165cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
21175cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
21185cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
21195cf91d6bSwdenk	  byte chips.
21205cf91d6bSwdenk
21215cf91d6bSwdenk	  Note that we consider the length of the address field to
21225cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
21235cf91d6bSwdenk	  in the chip address.
21245cf91d6bSwdenk
2125c609719bSwdenk	- CFG_EEPROM_SIZE:
2126c609719bSwdenk	  The size in bytes of the EEPROM device.
2127c609719bSwdenk
2128c609719bSwdenk
21295779d8d9Swdenk- CFG_ENV_IS_IN_DATAFLASH:
21305779d8d9Swdenk
21315779d8d9Swdenk	Define this if you have a DataFlash memory device which you
21325779d8d9Swdenk	want to use for the environment.
21335779d8d9Swdenk
21345779d8d9Swdenk	- CFG_ENV_OFFSET:
21355779d8d9Swdenk	- CFG_ENV_ADDR:
21365779d8d9Swdenk	- CFG_ENV_SIZE:
21375779d8d9Swdenk
21385779d8d9Swdenk	  These three #defines specify the offset and size of the
21395779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
21405779d8d9Swdenk	  at the specified address.
21415779d8d9Swdenk
214213a5695bSwdenk- CFG_ENV_IS_IN_NAND:
214313a5695bSwdenk
214413a5695bSwdenk	Define this if you have a NAND device which you want to use
214513a5695bSwdenk	for the environment.
214613a5695bSwdenk
214713a5695bSwdenk	- CFG_ENV_OFFSET:
214813a5695bSwdenk	- CFG_ENV_SIZE:
214913a5695bSwdenk
215013a5695bSwdenk	  These two #defines specify the offset and size of the environment
215113a5695bSwdenk	  area within the first NAND device.
21525779d8d9Swdenk
2153e443c944SMarkus Klotzbuecher	- CFG_ENV_OFFSET_REDUND
2154e443c944SMarkus Klotzbuecher
2155e443c944SMarkus Klotzbuecher	  This setting describes a second storage area of CFG_ENV_SIZE
2156e443c944SMarkus Klotzbuecher	  size used to hold a redundant copy of the environment data,
2157e443c944SMarkus Klotzbuecher	  so that there is a valid backup copy in case there is a
2158e443c944SMarkus Klotzbuecher	  power failure during a "saveenv" operation.
2159e443c944SMarkus Klotzbuecher
2160e443c944SMarkus Klotzbuecher	Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
2161e443c944SMarkus Klotzbuecher	to a block boundary, and CFG_ENV_SIZE must be a multiple of
2162e443c944SMarkus Klotzbuecher	the NAND devices block size.
2163e443c944SMarkus Klotzbuecher
2164c609719bSwdenk- CFG_SPI_INIT_OFFSET
2165c609719bSwdenk
2166c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
2167c609719bSwdenk	area is used at an early stage (ROM part) if the environment
2168c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
2169c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
2170c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
2171c609719bSwdenk	to be a good choice since it makes it far enough from the
2172c609719bSwdenk	start of the data area as well as from the stack pointer.
2173c609719bSwdenk
2174c609719bSwdenkPlease note that the environment is read-only as long as the monitor
2175c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
2176c609719bSwdenkcreated; also, when using EEPROM you will have to use getenv_r()
2177c609719bSwdenkuntil then to read environment variables.
2178c609719bSwdenk
217985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
218085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
218185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
218285ec0bccSwdenknecessary, because the first environment variable we need is the
218385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
218485ec0bccSwdenkhave any device yet where we could complain.]
2185c609719bSwdenk
2186c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
2187c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
218885ec0bccSwdenkuse the "saveenv" command to store a valid environment.
2189c609719bSwdenk
2190fc3e2165Swdenk- CFG_FAULT_ECHO_LINK_DOWN:
2191fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
2192fc3e2165Swdenk
2193fc3e2165Swdenk		Note: If this option is active, then CFG_FAULT_MII_ADDR
2194fc3e2165Swdenk		      also needs to be defined.
2195fc3e2165Swdenk
2196fc3e2165Swdenk- CFG_FAULT_MII_ADDR:
2197fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
2198c609719bSwdenk
2199c40b2956Swdenk- CFG_64BIT_VSPRINTF:
2200c40b2956Swdenk		Makes vsprintf (and all *printf functions) support printing
2201c40b2956Swdenk		of 64bit values by using the L quantifier
2202c40b2956Swdenk
2203c40b2956Swdenk- CFG_64BIT_STRTOUL:
2204c40b2956Swdenk		Adds simple_strtoull that returns a 64bit value
2205c40b2956Swdenk
2206c609719bSwdenkLow Level (hardware related) configuration options:
2207dc7c9a1aSwdenk---------------------------------------------------
2208c609719bSwdenk
2209c609719bSwdenk- CFG_CACHELINE_SIZE:
2210c609719bSwdenk		Cache Line Size of the CPU.
2211c609719bSwdenk
2212c609719bSwdenk- CFG_DEFAULT_IMMR:
2213c609719bSwdenk		Default address of the IMMR after system reset.
22142535d602Swdenk
22152535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
22162535d602Swdenk		and RPXsuper) to be able to adjust the position of
22172535d602Swdenk		the IMMR register after a reset.
2218c609719bSwdenk
22197f6c2cbcSwdenk- Floppy Disk Support:
22207f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER
22217f6c2cbcSwdenk
22227f6c2cbcSwdenk		the default drive number (default value 0)
22237f6c2cbcSwdenk
22247f6c2cbcSwdenk		CFG_ISA_IO_STRIDE
22257f6c2cbcSwdenk
22267f6c2cbcSwdenk		defines the spacing between fdc chipset registers
22277f6c2cbcSwdenk		(default value 1)
22287f6c2cbcSwdenk
22297f6c2cbcSwdenk		CFG_ISA_IO_OFFSET
22307f6c2cbcSwdenk
22317f6c2cbcSwdenk		defines the offset of register from address. It
22327f6c2cbcSwdenk		depends on which part of the data bus is connected to
22337f6c2cbcSwdenk		the fdc chipset. (default value 0)
22347f6c2cbcSwdenk
22357f6c2cbcSwdenk		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
22367f6c2cbcSwdenk		CFG_FDC_DRIVE_NUMBER are undefined, they take their
22377f6c2cbcSwdenk		default value.
22387f6c2cbcSwdenk
22397f6c2cbcSwdenk		if CFG_FDC_HW_INIT is defined, then the function
22407f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
22417f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
22427f6c2cbcSwdenk		source code. It is used to make hardware dependant
22437f6c2cbcSwdenk		initializations.
22447f6c2cbcSwdenk
224525d6712aSwdenk- CFG_IMMR:	Physical address of the Internal Memory.
224625d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
224725d6712aSwdenk		doing! (11-4) [MPC8xx/82xx systems only]
2248c609719bSwdenk
2249c609719bSwdenk- CFG_INIT_RAM_ADDR:
2250c609719bSwdenk
22517152b1d0Swdenk		Start address of memory area that can be used for
2252c609719bSwdenk		initial data and stack; please note that this must be
2253c609719bSwdenk		writable memory that is working WITHOUT special
2254c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
2255c609719bSwdenk		will become available only after programming the
2256c609719bSwdenk		memory controller and running certain initialization
2257c609719bSwdenk		sequences.
2258c609719bSwdenk
2259c609719bSwdenk		U-Boot uses the following memory types:
2260c609719bSwdenk		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
2261c609719bSwdenk		- MPC824X: data cache
2262c609719bSwdenk		- PPC4xx:  data cache
2263c609719bSwdenk
226485ec0bccSwdenk- CFG_GBL_DATA_OFFSET:
2265c609719bSwdenk
2266c609719bSwdenk		Offset of the initial data structure in the memory
2267c609719bSwdenk		area defined by CFG_INIT_RAM_ADDR. Usually
226885ec0bccSwdenk		CFG_GBL_DATA_OFFSET is chosen such that the initial
2269c609719bSwdenk		data is located at the end of the available space
2270c609719bSwdenk		(sometimes written as (CFG_INIT_RAM_END -
2271c609719bSwdenk		CFG_INIT_DATA_SIZE), and the initial stack is just
2272c609719bSwdenk		below that area (growing from (CFG_INIT_RAM_ADDR +
227385ec0bccSwdenk		CFG_GBL_DATA_OFFSET) downward.
2274c609719bSwdenk
2275c609719bSwdenk	Note:
2276c609719bSwdenk		On the MPC824X (or other systems that use the data
2277c609719bSwdenk		cache for initial memory) the address chosen for
2278c609719bSwdenk		CFG_INIT_RAM_ADDR is basically arbitrary - it must
2279c609719bSwdenk		point to an otherwise UNUSED address space between
2280c609719bSwdenk		the top of RAM and the start of the PCI space.
2281c609719bSwdenk
2282c609719bSwdenk- CFG_SIUMCR:	SIU Module Configuration (11-6)
2283c609719bSwdenk
2284c609719bSwdenk- CFG_SYPCR:	System Protection Control (11-9)
2285c609719bSwdenk
2286c609719bSwdenk- CFG_TBSCR:	Time Base Status and Control (11-26)
2287c609719bSwdenk
2288c609719bSwdenk- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)
2289c609719bSwdenk
2290c609719bSwdenk- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
2291c609719bSwdenk
2292c609719bSwdenk- CFG_SCCR:	System Clock and reset Control Register (15-27)
2293c609719bSwdenk
2294c609719bSwdenk- CFG_OR_TIMING_SDRAM:
2295c609719bSwdenk		SDRAM timing
2296c609719bSwdenk
2297c609719bSwdenk- CFG_MAMR_PTA:
2298c609719bSwdenk		periodic timer for refresh
2299c609719bSwdenk
2300c609719bSwdenk- CFG_DER:	Debug Event Register (37-47)
2301c609719bSwdenk
2302c609719bSwdenk- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
2303c609719bSwdenk  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
2304c609719bSwdenk  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
2305c609719bSwdenk  CFG_BR1_PRELIM:
2306c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
2307c609719bSwdenk
2308c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
2309c609719bSwdenk  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
2310c609719bSwdenk  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
2311c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
2312c609719bSwdenk
2313c609719bSwdenk- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
2314c609719bSwdenk  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
2315c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
2316c609719bSwdenk		Prescaler definitions (SDRAM timing)
2317c609719bSwdenk
2318c609719bSwdenk- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
2319c609719bSwdenk		enable I2C microcode relocation patch (MPC8xx);
2320c609719bSwdenk		define relocation offset in DPRAM [DSP2]
2321c609719bSwdenk
2322c609719bSwdenk- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
2323c609719bSwdenk		enable SPI microcode relocation patch (MPC8xx);
2324c609719bSwdenk		define relocation offset in DPRAM [SCC4]
2325c609719bSwdenk
2326c609719bSwdenk- CFG_USE_OSCCLK:
2327c609719bSwdenk		Use OSCM clock mode on MBX8xx board. Be careful,
2328c609719bSwdenk		wrong setting might damage your board. Read
2329c609719bSwdenk		doc/README.MBX before setting this variable!
2330c609719bSwdenk
2331ea909b76Swdenk- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
2332ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
2333ea909b76Swdenk		(Power On Self Tests). This definition overrides
2334ea909b76Swdenk		#define'd default value in commproc.h resp.
2335ea909b76Swdenk		cpm_8260.h.
2336ea909b76Swdenk
23375d232d0eSwdenk- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
23385d232d0eSwdenk  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
23395d232d0eSwdenk  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
23405d232d0eSwdenk  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
23415d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
23425d232d0eSwdenk  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
23435d232d0eSwdenk  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
23445d232d0eSwdenk  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
23455d232d0eSwdenk		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
23465d232d0eSwdenk
2347bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
2348bb99ad6dSBen Warren		Get DDR timing information from an I2C EEPROM.  Common with pluggable
2349bb99ad6dSBen Warren		memory modules such as SODIMMs
2350bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
2351bb99ad6dSBen Warren		I2C address of the SPD EEPROM
2352bb99ad6dSBen Warren
2353bb99ad6dSBen Warren- CFG_SPD_BUS_NUM
2354bb99ad6dSBen Warren		If SPD EEPROM is on an I2C bus other than the first one, specify here.
2355bb99ad6dSBen Warren		Note that the value must resolve to something your driver can deal with.
2356bb99ad6dSBen Warren
23572ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
23582ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
23592ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
23602ad6b513STimur Tabi
23612ad6b513STimur Tabi- CFG_83XX_DDR_USES_CS0
23622ad6b513STimur Tabi		Only for 83xx systems. If specified, then DDR should be configured
23632ad6b513STimur Tabi		using CS0 and CS1 instead of CS2 and CS3.
23642ad6b513STimur Tabi
2365c26e454dSwdenk- CONFIG_ETHER_ON_FEC[12]
2366c26e454dSwdenk		Define to enable FEC[12] on a 8xx series processor.
2367c26e454dSwdenk
2368c26e454dSwdenk- CONFIG_FEC[12]_PHY
2369c26e454dSwdenk		Define to the hardcoded PHY address which corresponds
23706e592385Swdenk		to the given FEC; i. e.
2371c26e454dSwdenk			#define CONFIG_FEC1_PHY 4
2372c26e454dSwdenk		means that the PHY with address 4 is connected to FEC1
2373c26e454dSwdenk
2374c26e454dSwdenk		When set to -1, means to probe for first available.
2375c26e454dSwdenk
2376c26e454dSwdenk- CONFIG_FEC[12]_PHY_NORXERR
2377c26e454dSwdenk		The PHY does not have a RXERR line (RMII only).
2378c26e454dSwdenk		(so program the FEC to ignore it).
2379c26e454dSwdenk
2380c26e454dSwdenk- CONFIG_RMII
2381c26e454dSwdenk		Enable RMII mode for all FECs.
2382c26e454dSwdenk		Note that this is a global option, we can't
2383c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
2384c26e454dSwdenk
23855cf91d6bSwdenk- CONFIG_CRC32_VERIFY
23865cf91d6bSwdenk		Add a verify option to the crc32 command.
23875cf91d6bSwdenk		The syntax is:
23885cf91d6bSwdenk
23895cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
23905cf91d6bSwdenk
23915cf91d6bSwdenk		Where address/count indicate a memory area
23925cf91d6bSwdenk		and crc32 is the correct crc32 which the
23935cf91d6bSwdenk		area should have.
23945cf91d6bSwdenk
239556523f12Swdenk- CONFIG_LOOPW
239656523f12Swdenk		Add the "loopw" memory command. This only takes effect if
239756523f12Swdenk		the memory commands are activated globally (CFG_CMD_MEM).
239856523f12Swdenk
23997b466641Sstroese- CONFIG_MX_CYCLIC
24007b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
24017b466641Sstroese		"md/mw" commands.
24027b466641Sstroese		Examples:
24037b466641Sstroese
24047b466641Sstroese		=> mdc.b 10 4 500
24057b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
24067b466641Sstroese
24077b466641Sstroese		=> mwc.l 100 12345678 10
24087b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
24097b466641Sstroese
24107b466641Sstroese		This only takes effect if the memory commands are activated
24117b466641Sstroese		globally (CFG_CMD_MEM).
24127b466641Sstroese
24138aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
24148aa1a2d1Swdenk- CONFIG_SKIP_RELOCATE_UBOOT
24158aa1a2d1Swdenk
24168aa1a2d1Swdenk		[ARM only] If these variables are defined, then
24178aa1a2d1Swdenk		certain low level initializations (like setting up
24188aa1a2d1Swdenk		the memory controller) are omitted and/or U-Boot does
24198aa1a2d1Swdenk		not relocate itself into RAM.
24208aa1a2d1Swdenk		Normally these variables MUST NOT be defined. The
24218aa1a2d1Swdenk		only exception is when U-Boot is loaded (to RAM) by
24228aa1a2d1Swdenk		some other boot loader or by a debugger which
24238aa1a2d1Swdenk		performs these intializations itself.
24248aa1a2d1Swdenk
2425400558b5Swdenk
2426c609719bSwdenkBuilding the Software:
2427c609719bSwdenk======================
2428c609719bSwdenk
2429c609719bSwdenkBuilding U-Boot has been tested in native PPC environments (on a
2430c609719bSwdenkPowerBook G3 running LinuxPPC 2000) and in cross environments
2431c609719bSwdenk(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
2432c609719bSwdenkNetBSD 1.5 on x86).
2433c609719bSwdenk
2434c609719bSwdenkIf you are not using a native PPC environment, it is assumed that you
2435c609719bSwdenkhave the GNU cross compiling tools available in your path and named
2436c609719bSwdenkwith a prefix of "powerpc-linux-". If this is not the case, (e.g. if
2437c609719bSwdenkyou are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
2438c609719bSwdenkthe definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
2439c609719bSwdenkchange it to:
2440c609719bSwdenk
2441c609719bSwdenk	CROSS_COMPILE = ppc_4xx-
2442c609719bSwdenk
2443c609719bSwdenk
2444c609719bSwdenkU-Boot is intended to be  simple  to  build.  After  installing	 the
2445c609719bSwdenksources	 you must configure U-Boot for one specific board type. This
2446c609719bSwdenkis done by typing:
2447c609719bSwdenk
2448c609719bSwdenk	make NAME_config
2449c609719bSwdenk
2450c609719bSwdenkwhere "NAME_config" is the name of one of the existing
2451c609719bSwdenkconfigurations; the following names are supported:
2452c609719bSwdenk
24531eaeb58eSwdenk	ADCIOP_config		FPS860L_config		omap730p2_config
24541eaeb58eSwdenk	ADS860_config		GEN860T_config		pcu_e_config
2455983fda83Swdenk	Alaska8220_config
24561eaeb58eSwdenk	AR405_config		GENIETV_config		PIP405_config
24571eaeb58eSwdenk	at91rm9200dk_config	GTH_config		QS823_config
24581eaeb58eSwdenk	CANBT_config		hermes_config		QS850_config
24591eaeb58eSwdenk	cmi_mpc5xx_config	hymod_config		QS860T_config
24601eaeb58eSwdenk	cogent_common_config	IP860_config		RPXlite_config
2461e63c8ee3Swdenk	cogent_mpc8260_config	IVML24_config		RPXlite_DW_config
2462e63c8ee3Swdenk	cogent_mpc8xx_config	IVMS8_config		RPXsuper_config
2463e63c8ee3Swdenk	CPCI405_config		JSE_config		rsdproto_config
2464e63c8ee3Swdenk	CPCIISER4_config	LANTEC_config		Sandpoint8240_config
2465e63c8ee3Swdenk	csb272_config		lwmon_config		sbc8260_config
2466466b7410Swdenk	CU824_config		MBX860T_config		sbc8560_33_config
2467466b7410Swdenk	DUET_ADS_config		MBX_config		sbc8560_66_config
24684c52783bSroy zang	EBONY_config		mpc7448hpc2_config	SM850_config
24694c52783bSroy zang	ELPT860_config		MPC8260ADS_config	SPD823TS_config
24704c52783bSroy zang	ESTEEM192E_config	MPC8540ADS_config	stxgp3_config
24714c52783bSroy zang	ETX094_config		MPC8540EVAL_config	SXNI855T_config
24724c52783bSroy zang	FADS823_config		NMPC8560ADS_config	TQM823L_config
24734c52783bSroy zang	FADS850SAR_config	NETVIA_config		TQM850L_config
24744c52783bSroy zang	FADS860T_config		omap1510inn_config	TQM855L_config
24754c52783bSroy zang	FPS850L_config		omap1610h2_config	TQM860L_config
24764c52783bSroy zang				omap1610inn_config	walnut_config
24774c52783bSroy zang				omap5912osk_config	Yukon8220_config
24784c52783bSroy zang				omap2420h4_config	ZPC1900_config
247954387ac9Swdenk
2480c609719bSwdenkNote: for some board special configuration names may exist; check if
2481c609719bSwdenk      additional information is available from the board vendor; for
24822729af9dSwdenk      instance, the TQM823L systems are available without (standard)
24832729af9dSwdenk      or with LCD support. You can select such additional "features"
2484c609719bSwdenk      when chosing the configuration, i. e.
2485c609719bSwdenk
24862729af9dSwdenk      make TQM823L_config
24872729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
2488c609719bSwdenk
2489c609719bSwdenk      make TQM823L_LCD_config
2490c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
2491c609719bSwdenk
2492c609719bSwdenk      etc.
2493c609719bSwdenk
2494c609719bSwdenk
2495c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
24967152b1d0Swdenkimages ready for download to / installation on your system:
2497c609719bSwdenk
2498c609719bSwdenk- "u-boot.bin" is a raw binary image
2499c609719bSwdenk- "u-boot" is an image in ELF binary format
2500c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
2501c609719bSwdenk
2502baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
2503baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
2504baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
2505baf31249SMarian Balakowicz
2506baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
2507baf31249SMarian Balakowicz
2508baf31249SMarian Balakowicz	make O=/tmp/build distclean
2509baf31249SMarian Balakowicz	make O=/tmp/build NAME_config
2510baf31249SMarian Balakowicz	make O=/tmp/build all
2511baf31249SMarian Balakowicz
2512baf31249SMarian Balakowicz2. Set environment variable BUILD_DIR to point to the desired location:
2513baf31249SMarian Balakowicz
2514baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2515baf31249SMarian Balakowicz	make distclean
2516baf31249SMarian Balakowicz	make NAME_config
2517baf31249SMarian Balakowicz	make all
2518baf31249SMarian Balakowicz
2519baf31249SMarian BalakowiczNote that the command line "O=" setting overrides the BUILD_DIR environment
2520baf31249SMarian Balakowiczvariable.
2521baf31249SMarian Balakowicz
2522c609719bSwdenk
2523c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
2524c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
2525c609719bSwdenknative "make".
2526c609719bSwdenk
2527c609719bSwdenk
2528c609719bSwdenkIf the system board that you have is not listed, then you will need
2529c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
2530c609719bSwdenksteps:
2531c609719bSwdenk
2532c609719bSwdenk1.  Add a new configuration option for your board to the toplevel
253385ec0bccSwdenk    "Makefile" and to the "MAKEALL" script, using the existing
253485ec0bccSwdenk    entries as examples. Note that here and at many other places
25357152b1d0Swdenk    boards and other names are listed in alphabetical sort order. Please
253685ec0bccSwdenk    keep this order.
2537c609719bSwdenk2.  Create a new directory to hold your board specific code. Add any
253885ec0bccSwdenk    files you need. In your board directory, you will need at least
253985ec0bccSwdenk    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
254085ec0bccSwdenk3.  Create a new configuration file "include/configs/<board>.h" for
254185ec0bccSwdenk    your board
2542c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
2543c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
254485ec0bccSwdenk4.  Run "make <board>_config" with your new name.
2545c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
2546c609719bSwdenk    to be installed on your target system.
254785ec0bccSwdenk6.  Debug and solve any problems that might arise.
2548c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
2549c609719bSwdenk
2550c609719bSwdenk
2551c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
2552c609719bSwdenk==============================================================
2553c609719bSwdenk
2554c609719bSwdenkIf you have modified U-Boot sources (for instance added a new	board
2555c609719bSwdenkor  support  for  new  devices,	 a new CPU, etc.) you are expected to
2556c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
2557c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
2558c609719bSwdenkofficial or latest in CVS) version of U-Boot sources.
2559c609719bSwdenk
2560c609719bSwdenkBut before you submit such a patch, please verify that	your  modifi-
2561c609719bSwdenkcation	did not break existing code. At least make sure that *ALL* of
2562c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
2563c609719bSwdenkjust run the "MAKEALL" script, which will configure and build U-Boot
2564c609719bSwdenkfor ALL supported system. Be warned, this will take a while. You  can
25657152b1d0Swdenkselect	which  (cross)	compiler  to use by passing a `CROSS_COMPILE'
2566c609719bSwdenkenvironment variable to the script, i. e. to use the cross tools from
2567c609719bSwdenkMontaVista's Hard Hat Linux you can type
2568c609719bSwdenk
2569c609719bSwdenk	CROSS_COMPILE=ppc_8xx- MAKEALL
2570c609719bSwdenk
2571c609719bSwdenkor to build on a native PowerPC system you can type
2572c609719bSwdenk
2573c609719bSwdenk	CROSS_COMPILE=' ' MAKEALL
2574c609719bSwdenk
2575baf31249SMarian BalakowiczWhen using the MAKEALL script, the default behaviour is to build U-Boot
2576baf31249SMarian Balakowiczin the source directory. This location can be changed by setting the
2577baf31249SMarian BalakowiczBUILD_DIR environment variable. Also, for each target built, the MAKEALL
2578baf31249SMarian Balakowiczscript saves two log files (<target>.ERR and <target>.MAKEALL) in the
2579baf31249SMarian Balakowicz<source dir>/LOG directory. This default location can be changed by
2580baf31249SMarian Balakowiczsetting the MAKEALL_LOGDIR environment variable. For example:
2581baf31249SMarian Balakowicz
2582baf31249SMarian Balakowicz	export BUILD_DIR=/tmp/build
2583baf31249SMarian Balakowicz	export MAKEALL_LOGDIR=/tmp/log
2584baf31249SMarian Balakowicz	CROSS_COMPILE=ppc_8xx- MAKEALL
2585baf31249SMarian Balakowicz
2586baf31249SMarian BalakowiczWith the above settings build objects are saved in the /tmp/build, log
2587baf31249SMarian Balakowiczfiles are saved in the /tmp/log and the source tree remains clean during
2588baf31249SMarian Balakowiczthe whole build process.
2589baf31249SMarian Balakowicz
2590baf31249SMarian Balakowicz
2591c609719bSwdenkSee also "U-Boot Porting Guide" below.
2592c609719bSwdenk
2593c609719bSwdenk
2594c609719bSwdenkMonitor Commands - Overview:
2595c609719bSwdenk============================
2596c609719bSwdenk
2597c609719bSwdenkgo	- start application at address 'addr'
2598c609719bSwdenkrun	- run commands in an environment variable
2599c609719bSwdenkbootm	- boot application image from memory
2600c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
2601c609719bSwdenktftpboot- boot image via network using TFTP protocol
2602c609719bSwdenk	       and env variables "ipaddr" and "serverip"
2603c609719bSwdenk	       (and eventually "gatewayip")
2604c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
2605c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
2606c609719bSwdenkloads	- load S-Record file over serial line
2607c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
2608c609719bSwdenkmd	- memory display
2609c609719bSwdenkmm	- memory modify (auto-incrementing)
2610c609719bSwdenknm	- memory modify (constant address)
2611c609719bSwdenkmw	- memory write (fill)
2612c609719bSwdenkcp	- memory copy
2613c609719bSwdenkcmp	- memory compare
2614c609719bSwdenkcrc32	- checksum calculation
2615c609719bSwdenkimd	- i2c memory display
2616c609719bSwdenkimm	- i2c memory modify (auto-incrementing)
2617c609719bSwdenkinm	- i2c memory modify (constant address)
2618c609719bSwdenkimw	- i2c memory write (fill)
2619c609719bSwdenkicrc32	- i2c checksum calculation
2620c609719bSwdenkiprobe	- probe to discover valid I2C chip addresses
2621c609719bSwdenkiloop	- infinite loop on address range
2622c609719bSwdenkisdram	- print SDRAM configuration information
2623c609719bSwdenksspi	- SPI utility commands
2624c609719bSwdenkbase	- print or set address offset
2625c609719bSwdenkprintenv- print environment variables
2626c609719bSwdenksetenv	- set environment variables
2627c609719bSwdenksaveenv - save environment variables to persistent storage
2628c609719bSwdenkprotect - enable or disable FLASH write protection
2629c609719bSwdenkerase	- erase FLASH memory
2630c609719bSwdenkflinfo	- print FLASH memory information
2631c609719bSwdenkbdinfo	- print Board Info structure
2632c609719bSwdenkiminfo	- print header information for application image
2633c609719bSwdenkconinfo - print console devices and informations
2634c609719bSwdenkide	- IDE sub-system
2635c609719bSwdenkloop	- infinite loop on address range
263656523f12Swdenkloopw	- infinite write loop on address range
2637c609719bSwdenkmtest	- simple RAM test
2638c609719bSwdenkicache	- enable or disable instruction cache
2639c609719bSwdenkdcache	- enable or disable data cache
2640c609719bSwdenkreset	- Perform RESET of the CPU
2641c609719bSwdenkecho	- echo args to console
2642c609719bSwdenkversion - print monitor version
2643c609719bSwdenkhelp	- print online help
2644c609719bSwdenk?	- alias for 'help'
2645c609719bSwdenk
2646c609719bSwdenk
2647c609719bSwdenkMonitor Commands - Detailed Description:
2648c609719bSwdenk========================================
2649c609719bSwdenk
2650c609719bSwdenkTODO.
2651c609719bSwdenk
2652c609719bSwdenkFor now: just type "help <command>".
2653c609719bSwdenk
2654c609719bSwdenk
2655c609719bSwdenkEnvironment Variables:
2656c609719bSwdenk======================
2657c609719bSwdenk
2658c609719bSwdenkU-Boot supports user configuration using Environment Variables which
2659c609719bSwdenkcan be made persistent by saving to Flash memory.
2660c609719bSwdenk
2661c609719bSwdenkEnvironment Variables are set using "setenv", printed using
2662c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
2663c609719bSwdenkwithout a value can be used to delete a variable from the
2664c609719bSwdenkenvironment. As long as you don't save the environment you are
2665c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
2666c609719bSwdenkenvironment is erased by accident, a default environment is provided.
2667c609719bSwdenk
2668c609719bSwdenkSome configuration options can be set using Environment Variables:
2669c609719bSwdenk
2670c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
2671c609719bSwdenk
2672c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
2673c609719bSwdenk
2674c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
2675c609719bSwdenk
2676c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
2677c609719bSwdenk
2678c609719bSwdenk  bootfile	- Name of the image to load with TFTP
2679c609719bSwdenk
2680c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
2681c609719bSwdenk		  "bootp" will just load perform a lookup of the
2682c609719bSwdenk		  configuration from the BOOTP server, but not try to
2683c609719bSwdenk		  load any image using TFTP
2684c609719bSwdenk
2685c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
2686c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
2687c609719bSwdenk		  be automatically started (by internally calling
2688c609719bSwdenk		  "bootm")
2689c609719bSwdenk
26904a6fd34bSwdenk		  If set to "no", a standalone image passed to the
26914a6fd34bSwdenk		  "bootm" command will be copied to the load address
26924a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
26934a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
26944a6fd34bSwdenk		  data.
26954a6fd34bSwdenk
269617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
269717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
269817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
269917ea1177Swdenk		  initialization code. So, for changes to be effective
270017ea1177Swdenk		  it must be saved and board must be reset.
270117ea1177Swdenk
2702c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
2703c609719bSwdenk		  If this variable is not set, initrd images will be
2704c609719bSwdenk		  copied to the highest possible address in RAM; this
2705c609719bSwdenk		  is usually what you want since it allows for
2706c609719bSwdenk		  maximum initrd size. If for some reason you want to
2707c609719bSwdenk		  make sure that the initrd image is loaded below the
2708c609719bSwdenk		  CFG_BOOTMAPSZ limit, you can set this environment
2709c609719bSwdenk		  variable to a value of "no" or "off" or "0".
2710c609719bSwdenk		  Alternatively, you can set it to a maximum upper
2711c609719bSwdenk		  address to use (U-Boot will still check that it
2712c609719bSwdenk		  does not overwrite the U-Boot stack and data).
2713c609719bSwdenk
2714c609719bSwdenk		  For instance, when you have a system with 16 MB
27157152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
2716c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
2717c609719bSwdenk		  the "bootargs" variable. However, now you must make
27187152b1d0Swdenk		  sure that the initrd image is placed in the first
2719c609719bSwdenk		  12 MB as well - this can be done with
2720c609719bSwdenk
2721c609719bSwdenk		  setenv initrd_high 00c00000
2722c609719bSwdenk
272338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
272438b99261Swdenk		  indication to U-Boot that all addresses are legal
272538b99261Swdenk		  for the Linux kernel, including addresses in flash
272638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
272738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
272838b99261Swdenk		  boot time on your system, but requires that this
272938b99261Swdenk		  feature is supported by your Linux kernel.
273038b99261Swdenk
2731c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
2732c609719bSwdenk
2733c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
2734dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
2735c609719bSwdenk
2736c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
2737c609719bSwdenk
2738c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
2739c609719bSwdenk
2740c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
2741c609719bSwdenk
2742c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
2743c609719bSwdenk
2744c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
2745c609719bSwdenk
2746a3d991bdSwdenk  ethprime	- When CONFIG_NET_MULTI is enabled controls which
2747a3d991bdSwdenk		  interface is used first.
2748a3d991bdSwdenk
2749a3d991bdSwdenk  ethact	- When CONFIG_NET_MULTI is enabled controls which
2750a3d991bdSwdenk		  interface is currently active. For example you
2751a3d991bdSwdenk		  can do the following
2752a3d991bdSwdenk
2753a3d991bdSwdenk		  => setenv ethact FEC ETHERNET
2754a3d991bdSwdenk		  => ping 192.168.0.1 # traffic sent on FEC ETHERNET
2755a3d991bdSwdenk		  => setenv ethact SCC ETHERNET
2756a3d991bdSwdenk		  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
2757a3d991bdSwdenk
2758a3d991bdSwdenk   netretry	- When set to "no" each network operation will
2759a3d991bdSwdenk		  either succeed or fail without retrying.
27606e592385Swdenk		  When set to "once" the network operation will
27616e592385Swdenk		  fail when all the available network interfaces
27626e592385Swdenk		  are tried once without success.
2763a3d991bdSwdenk		  Useful on scripts which control the retry operation
2764a3d991bdSwdenk		  themselves.
2765a3d991bdSwdenk
276628cb9375SWolfgang Denk  tftpsrcport	- If this is set, the value is used for TFTP's
2767ecb0ccd9SWolfgang Denk		  UDP source port.
2768ecb0ccd9SWolfgang Denk
276928cb9375SWolfgang Denk  tftpdstport	- If this is set, the value is used for TFTP's UDP
277028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
277128cb9375SWolfgang Denk
2772a3d991bdSwdenk   vlan		- When set to a value < 4095 the traffic over
2773a3d991bdSwdenk		  ethernet is encapsulated/received over 802.1q
2774a3d991bdSwdenk		  VLAN tagged frames.
2775c609719bSwdenk
2776c609719bSwdenkThe following environment variables may be used and automatically
2777c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
2778c609719bSwdenkdepending the information provided by your boot server:
2779c609719bSwdenk
2780c609719bSwdenk  bootfile	- see above
2781c609719bSwdenk  dnsip		- IP address of your Domain Name Server
2782fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
2783c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
2784c609719bSwdenk  hostname	- Target hostname
2785c609719bSwdenk  ipaddr	- see above
2786c609719bSwdenk  netmask	- Subnet Mask
2787c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
2788c609719bSwdenk  serverip	- see above
2789c609719bSwdenk
2790c609719bSwdenk
2791c609719bSwdenkThere are two special Environment Variables:
2792c609719bSwdenk
2793c609719bSwdenk  serial#	- contains hardware identification information such
2794c609719bSwdenk		  as type string and/or serial number
2795c609719bSwdenk  ethaddr	- Ethernet address
2796c609719bSwdenk
2797c609719bSwdenkThese variables can be set only once (usually during manufacturing of
2798c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
2799c609719bSwdenkonce they have been set once.
2800c609719bSwdenk
2801c609719bSwdenk
2802c1551ea8SstroeseFurther special Environment Variables:
2803c1551ea8Sstroese
2804c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
2805c1551ea8Sstroese		  with the "version" command. This variable is
2806c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
2807c1551ea8Sstroese
2808c1551ea8Sstroese
2809c609719bSwdenkPlease note that changes to some configuration parameters may take
2810c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
2811c609719bSwdenk
2812c609719bSwdenk
2813f07771ccSwdenkCommand Line Parsing:
2814f07771ccSwdenk=====================
2815f07771ccSwdenk
2816f07771ccSwdenkThere are two different command line parsers available with U-Boot:
28177152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
2818f07771ccSwdenk
2819f07771ccSwdenkOld, simple command line parser:
2820f07771ccSwdenk--------------------------------
2821f07771ccSwdenk
2822f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
2823f07771ccSwdenk- several commands on one line, separated by ';'
2824fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
2825f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
2826f07771ccSwdenk  for example:
2827fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
2828f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
2829f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
2830f07771ccSwdenk
2831f07771ccSwdenkHush shell:
2832f07771ccSwdenk-----------
2833f07771ccSwdenk
2834f07771ccSwdenk- similar to Bourne shell, with control structures like
2835f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
2836f07771ccSwdenk  until...do...done, ...
2837f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
2838f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
2839f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
2840f07771ccSwdenk  command
2841f07771ccSwdenk
2842f07771ccSwdenkGeneral rules:
2843f07771ccSwdenk--------------
2844f07771ccSwdenk
2845f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
2846f07771ccSwdenk    command) contains several commands separated by semicolon, and
2847f07771ccSwdenk    one of these commands fails, then the remaining commands will be
2848f07771ccSwdenk    executed anyway.
2849f07771ccSwdenk
2850f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
2851f07771ccSwdenk    calling run with a list af variables as arguments), any failing
2852f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
2853f07771ccSwdenk    variables are not executed.
2854f07771ccSwdenk
2855c609719bSwdenkNote for Redundant Ethernet Interfaces:
2856c609719bSwdenk=======================================
2857c609719bSwdenk
28587152b1d0SwdenkSome boards come with redundant ethernet interfaces; U-Boot supports
2859c609719bSwdenksuch configurations and is capable of automatic selection of a
28607152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
2861c609719bSwdenk
2862c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
2863c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
2864c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
2865c609719bSwdenk
2866c609719bSwdenkIf the network interface stores some valid MAC address (for instance
2867c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
2868c609719bSwdenkding setting in the environment; if the corresponding environment
2869c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
2870c609719bSwdenk
2871c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
2872c609719bSwdenk  environment, the SROM's address is used.
2873c609719bSwdenk
2874c609719bSwdenko If there is no valid address in the SROM, and a definition in the
2875c609719bSwdenk  environment exists, then the value from the environment variable is
2876c609719bSwdenk  used.
2877c609719bSwdenk
2878c609719bSwdenko If both the SROM and the environment contain a MAC address, and
2879c609719bSwdenk  both addresses are the same, this MAC address is used.
2880c609719bSwdenk
2881c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
2882c609719bSwdenk  addresses differ, the value from the environment is used and a
2883c609719bSwdenk  warning is printed.
2884c609719bSwdenk
2885c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
2886c609719bSwdenk  is raised.
2887c609719bSwdenk
2888c609719bSwdenk
2889c609719bSwdenkImage Formats:
2890c609719bSwdenk==============
2891c609719bSwdenk
2892c609719bSwdenkThe "boot" commands of this monitor operate on "image" files which
2893c609719bSwdenkcan be basicly anything, preceeded by a special header; see the
2894c609719bSwdenkdefinitions in include/image.h for details; basicly, the header
2895c609719bSwdenkdefines the following image properties:
2896c609719bSwdenk
2897c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
2898c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
28997f70e853Swdenk  LynxOS, pSOS, QNX, RTEMS, ARTOS;
29001f4bb37dSwdenk  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
29017b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
29023d1e8a9dSwdenk  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
29037b64fef3SWolfgang Denk  Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
2904c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
2905c609719bSwdenk* Load Address
2906c609719bSwdenk* Entry Point
2907c609719bSwdenk* Image Name
2908c609719bSwdenk* Image Timestamp
2909c609719bSwdenk
2910c609719bSwdenkThe header is marked by a special Magic Number, and both the header
2911c609719bSwdenkand the data portions of the image are secured against corruption by
2912c609719bSwdenkCRC32 checksums.
2913c609719bSwdenk
2914c609719bSwdenk
2915c609719bSwdenkLinux Support:
2916c609719bSwdenk==============
2917c609719bSwdenk
2918c609719bSwdenkAlthough U-Boot should support any OS or standalone application
29197152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
2920c609719bSwdenkU-Boot.
2921c609719bSwdenk
2922c609719bSwdenkU-Boot includes many features that so far have been part of some
2923c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
2924c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
2925c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
29267152b1d0Swdenkserves several purposes:
2927c609719bSwdenk
2928c609719bSwdenk- the same features can be used for other OS or standalone
2929c609719bSwdenk  applications (for instance: using compressed images to reduce the
2930c609719bSwdenk  Flash memory footprint)
2931c609719bSwdenk
2932c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
29337152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
2934c609719bSwdenk
2935c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
2936c609719bSwdenk  images; of course this also means that different kernel images can
2937c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
2938c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
2939c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
2940c609719bSwdenk  software is easier now.
2941c609719bSwdenk
2942c609719bSwdenk
2943c609719bSwdenkLinux HOWTO:
2944c609719bSwdenk============
2945c609719bSwdenk
2946c609719bSwdenkPorting Linux to U-Boot based systems:
2947c609719bSwdenk---------------------------------------
2948c609719bSwdenk
2949c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
2950c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
2951c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
2952c609719bSwdenkLinux :-).
2953c609719bSwdenk
2954c609719bSwdenkBut now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
2955c609719bSwdenk
2956c609719bSwdenkJust make sure your machine specific header file (for instance
2957c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
2958c609719bSwdenkInformation structure as we define in include/u-boot.h, and make
2959c609719bSwdenksure that your definition of IMAP_ADDR uses the same value as your
2960c609719bSwdenkU-Boot configuration in CFG_IMMR.
2961c609719bSwdenk
2962c609719bSwdenk
2963c609719bSwdenkConfiguring the Linux kernel:
2964c609719bSwdenk-----------------------------
2965c609719bSwdenk
2966c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
2967c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
2968c609719bSwdenk
2969c609719bSwdenk
2970c609719bSwdenkBuilding a Linux Image:
2971c609719bSwdenk-----------------------
2972c609719bSwdenk
297324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
297424ee89b9Swdenknot used. If you use recent kernel source, a new build target
297524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
297624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
297724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
297824ee89b9Swdenk100% compatible format.
2979c609719bSwdenk
2980c609719bSwdenkExample:
2981c609719bSwdenk
2982c609719bSwdenk	make TQM850L_config
2983c609719bSwdenk	make oldconfig
2984c609719bSwdenk	make dep
298524ee89b9Swdenk	make uImage
2986c609719bSwdenk
298724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
298824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
298924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
2990c609719bSwdenk
299124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
299224ee89b9Swdenk
299324ee89b9Swdenk* convert the kernel into a raw binary image:
299424ee89b9Swdenk
299524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
299624ee89b9Swdenk				 -R .note -R .comment \
299724ee89b9Swdenk				 -S vmlinux linux.bin
299824ee89b9Swdenk
299924ee89b9Swdenk* compress the binary image:
300024ee89b9Swdenk
300124ee89b9Swdenk	gzip -9 linux.bin
300224ee89b9Swdenk
300324ee89b9Swdenk* package compressed binary image for U-Boot:
300424ee89b9Swdenk
300524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
300624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
300724ee89b9Swdenk		-d linux.bin.gz uImage
300824ee89b9Swdenk
300924ee89b9Swdenk
301024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
301124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
301224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
301324ee89b9Swdenkbyte header containing information about target architecture,
301424ee89b9Swdenkoperating system, image type, compression method, entry points, time
301524ee89b9Swdenkstamp, CRC32 checksums, etc.
301624ee89b9Swdenk
301724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
301824ee89b9Swdenkprint the header information, or to build new images.
3019c609719bSwdenk
3020c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
3021c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
3022c609719bSwdenkchecksum verification:
3023c609719bSwdenk
3024c609719bSwdenk	tools/mkimage -l image
3025c609719bSwdenk	  -l ==> list image header information
3026c609719bSwdenk
3027c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
3028c609719bSwdenkfrom a "data file" which is used as image payload:
3029c609719bSwdenk
3030c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
3031c609719bSwdenk		      -n name -d data_file image
3032c609719bSwdenk	  -A ==> set architecture to 'arch'
3033c609719bSwdenk	  -O ==> set operating system to 'os'
3034c609719bSwdenk	  -T ==> set image type to 'type'
3035c609719bSwdenk	  -C ==> set compression type 'comp'
3036c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
3037c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
3038c609719bSwdenk	  -n ==> set image name to 'name'
3039c609719bSwdenk	  -d ==> use image data from 'datafile'
3040c609719bSwdenk
304169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
304269459791Swdenkaddress (0x00000000), but the entry point address depends on the
304369459791Swdenkkernel version:
3044c609719bSwdenk
3045c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
304624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
3047c609719bSwdenk
3048c609719bSwdenkSo a typical call to build a U-Boot image would read:
3049c609719bSwdenk
305024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
305124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
305224ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \
305324ee89b9Swdenk	> examples/uImage.TQM850L
305424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3055c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3056c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3057c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3058c609719bSwdenk	Load Address: 0x00000000
305924ee89b9Swdenk	Entry Point:  0x00000000
3060c609719bSwdenk
3061c609719bSwdenkTo verify the contents of the image (or check for corruption):
3062c609719bSwdenk
306324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
306424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3065c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3066c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
3067c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
3068c609719bSwdenk	Load Address: 0x00000000
306924ee89b9Swdenk	Entry Point:  0x00000000
3070c609719bSwdenk
3071c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
3072c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
3073c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
3074c609719bSwdenkneed to be uncompressed:
3075c609719bSwdenk
307624ee89b9Swdenk	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz
307724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
307824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
307924ee89b9Swdenk	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \
308024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
308124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
3082c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
3083c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
3084c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
3085c609719bSwdenk	Load Address: 0x00000000
308624ee89b9Swdenk	Entry Point:  0x00000000
3087c609719bSwdenk
3088c609719bSwdenk
3089c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
3090c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
3091c609719bSwdenk
3092c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
3093c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
3094c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
3095c609719bSwdenk	Image Name:   Simple Ramdisk Image
3096c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
3097c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
3098c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
3099c609719bSwdenk	Load Address: 0x00000000
3100c609719bSwdenk	Entry Point:  0x00000000
3101c609719bSwdenk
3102c609719bSwdenk
3103c609719bSwdenkInstalling a Linux Image:
3104c609719bSwdenk-------------------------
3105c609719bSwdenk
3106c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
3107c609719bSwdenkyou must convert the image to S-Record format:
3108c609719bSwdenk
3109c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
3110c609719bSwdenk
3111c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
3112c609719bSwdenkimage header, so the resulting S-Record file will be relative to
3113c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
3114c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
3115c609719bSwdenkcommand.
3116c609719bSwdenk
3117c609719bSwdenkExample: install the image to address 0x40100000 (which on the
3118c609719bSwdenkTQM8xxL is in the first Flash bank):
3119c609719bSwdenk
3120c609719bSwdenk	=> erase 40100000 401FFFFF
3121c609719bSwdenk
3122c609719bSwdenk	.......... done
3123c609719bSwdenk	Erased 8 sectors
3124c609719bSwdenk
3125c609719bSwdenk	=> loads 40100000
3126c609719bSwdenk	## Ready for S-Record download ...
3127c609719bSwdenk	~>examples/image.srec
3128c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
3129c609719bSwdenk	...
3130c609719bSwdenk	15989 15990 15991 15992
3131c609719bSwdenk	[file transfer complete]
3132c609719bSwdenk	[connected]
3133c609719bSwdenk	## Start Addr = 0x00000000
3134c609719bSwdenk
3135c609719bSwdenk
3136c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
3137c609719bSwdenkthis includes a checksum verification so you  can  be  sure  no	 data
3138c609719bSwdenkcorruption happened:
3139c609719bSwdenk
3140c609719bSwdenk	=> imi 40100000
3141c609719bSwdenk
3142c609719bSwdenk	## Checking Image at 40100000 ...
3143c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3144c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3145c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3146c609719bSwdenk	   Load Address: 00000000
3147c609719bSwdenk	   Entry Point:	 0000000c
3148c609719bSwdenk	   Verifying Checksum ... OK
3149c609719bSwdenk
3150c609719bSwdenk
3151c609719bSwdenkBoot Linux:
3152c609719bSwdenk-----------
3153c609719bSwdenk
3154c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
3155c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
3156c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
3157c609719bSwdenkparameters. You can check and modify this variable using the
3158c609719bSwdenk"printenv" and "setenv" commands:
3159c609719bSwdenk
3160c609719bSwdenk
3161c609719bSwdenk	=> printenv bootargs
3162c609719bSwdenk	bootargs=root=/dev/ram
3163c609719bSwdenk
3164c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3165c609719bSwdenk
3166c609719bSwdenk	=> printenv bootargs
3167c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3168c609719bSwdenk
3169c609719bSwdenk	=> bootm 40020000
3170c609719bSwdenk	## Booting Linux kernel at 40020000 ...
3171c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
3172c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3173c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
3174c609719bSwdenk	   Load Address: 00000000
3175c609719bSwdenk	   Entry Point:	 0000000c
3176c609719bSwdenk	   Verifying Checksum ... OK
3177c609719bSwdenk	   Uncompressing Kernel Image ... OK
3178c609719bSwdenk	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
3179c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
3180c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3181c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3182c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
3183c609719bSwdenk	...
3184c609719bSwdenk
3185c609719bSwdenkIf you want to boot a Linux kernel with initial ram disk, you pass
31867152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
3187c609719bSwdenkformat!) to the "bootm" command:
3188c609719bSwdenk
3189c609719bSwdenk	=> imi 40100000 40200000
3190c609719bSwdenk
3191c609719bSwdenk	## Checking Image at 40100000 ...
3192c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3193c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3194c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3195c609719bSwdenk	   Load Address: 00000000
3196c609719bSwdenk	   Entry Point:	 0000000c
3197c609719bSwdenk	   Verifying Checksum ... OK
3198c609719bSwdenk
3199c609719bSwdenk	## Checking Image at 40200000 ...
3200c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3201c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3202c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3203c609719bSwdenk	   Load Address: 00000000
3204c609719bSwdenk	   Entry Point:	 00000000
3205c609719bSwdenk	   Verifying Checksum ... OK
3206c609719bSwdenk
3207c609719bSwdenk	=> bootm 40100000 40200000
3208c609719bSwdenk	## Booting Linux kernel at 40100000 ...
3209c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
3210c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
3211c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
3212c609719bSwdenk	   Load Address: 00000000
3213c609719bSwdenk	   Entry Point:	 0000000c
3214c609719bSwdenk	   Verifying Checksum ... OK
3215c609719bSwdenk	   Uncompressing Kernel Image ... OK
3216c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
3217c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
3218c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
3219c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
3220c609719bSwdenk	   Load Address: 00000000
3221c609719bSwdenk	   Entry Point:	 00000000
3222c609719bSwdenk	   Verifying Checksum ... OK
3223c609719bSwdenk	   Loading Ramdisk ... OK
3224c609719bSwdenk	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
3225c609719bSwdenk	Boot arguments: root=/dev/ram
3226c609719bSwdenk	time_init: decrementer frequency = 187500000/60
3227c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
3228c609719bSwdenk	...
3229c609719bSwdenk	RAMDISK: Compressed image found at block 0
3230c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
3231c609719bSwdenk
3232c609719bSwdenk	bash#
3233c609719bSwdenk
32340267768eSMatthew McClintockBoot Linux and pass a flat device tree:
32350267768eSMatthew McClintock-----------
32360267768eSMatthew McClintock
32370267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
32380267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
32390267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
32400267768eSMatthew McClintockflat device tree:
32410267768eSMatthew McClintock
32420267768eSMatthew McClintock=> print oftaddr
32430267768eSMatthew McClintockoftaddr=0x300000
32440267768eSMatthew McClintock=> print oft
32450267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
32460267768eSMatthew McClintock=> tftp $oftaddr $oft
32470267768eSMatthew McClintockSpeed: 1000, full duplex
32480267768eSMatthew McClintockUsing TSEC0 device
32490267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
32500267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
32510267768eSMatthew McClintockLoad address: 0x300000
32520267768eSMatthew McClintockLoading: #
32530267768eSMatthew McClintockdone
32540267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
32550267768eSMatthew McClintock=> tftp $loadaddr $bootfile
32560267768eSMatthew McClintockSpeed: 1000, full duplex
32570267768eSMatthew McClintockUsing TSEC0 device
32580267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
32590267768eSMatthew McClintockFilename 'uImage'.
32600267768eSMatthew McClintockLoad address: 0x200000
32610267768eSMatthew McClintockLoading:############
32620267768eSMatthew McClintockdone
32630267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
32640267768eSMatthew McClintock=> print loadaddr
32650267768eSMatthew McClintockloadaddr=200000
32660267768eSMatthew McClintock=> print oftaddr
32670267768eSMatthew McClintockoftaddr=0x300000
32680267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
32690267768eSMatthew McClintock## Booting image at 00200000 ...
32700267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
32710267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
32720267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
32730267768eSMatthew McClintock   Load Address: 00000000
32740267768eSMatthew McClintock   Entry Point:	 00000000
32750267768eSMatthew McClintock   Verifying Checksum ... OK
32760267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
32770267768eSMatthew McClintockBooting using flat device tree at 0x300000
32780267768eSMatthew McClintockUsing MPC85xx ADS machine description
32790267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
32800267768eSMatthew McClintock[snip]
32810267768eSMatthew McClintock
32820267768eSMatthew McClintock
32836069ff26SwdenkMore About U-Boot Image Types:
32846069ff26Swdenk------------------------------
32856069ff26Swdenk
32866069ff26SwdenkU-Boot supports the following image types:
32876069ff26Swdenk
32886069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
32896069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
32906069ff26Swdenk	well) you can continue to work in U-Boot after return from
32916069ff26Swdenk	the Standalone Program.
32926069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
32936069ff26Swdenk	will take over control completely. Usually these programs
32946069ff26Swdenk	will install their own set of exception handlers, device
32956069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
32966069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
32976069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
32986069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
32996069ff26Swdenk	being started.
33006069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
33016069ff26Swdenk	(Linux) kernel image and one or more data images like
33026069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
33036069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
33046069ff26Swdenk	server provides just a single image file, but you want to get
33056069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
33066069ff26Swdenk
33076069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
33086069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
33096069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
33106069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
33116069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
33126069ff26Swdenk	a multiple of 4 bytes).
33136069ff26Swdenk
33146069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
33156069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
33166069ff26Swdenk	flash memory.
33176069ff26Swdenk
33186069ff26Swdenk   "Script files" are command sequences that will be executed by
33196069ff26Swdenk	U-Boot's command interpreter; this feature is especially
33206069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
33216069ff26Swdenk	as command interpreter.
33226069ff26Swdenk
3323c609719bSwdenk
3324c609719bSwdenkStandalone HOWTO:
3325c609719bSwdenk=================
3326c609719bSwdenk
3327c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
3328c609719bSwdenkrun "standalone" applications, which can use some resources of
3329c609719bSwdenkU-Boot like console I/O functions or interrupt services.
3330c609719bSwdenk
3331c609719bSwdenkTwo simple examples are included with the sources:
3332c609719bSwdenk
3333c609719bSwdenk"Hello World" Demo:
3334c609719bSwdenk-------------------
3335c609719bSwdenk
3336c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
3337c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
3338c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
3339c609719bSwdenklike that:
3340c609719bSwdenk
3341c609719bSwdenk	=> loads
3342c609719bSwdenk	## Ready for S-Record download ...
3343c609719bSwdenk	~>examples/hello_world.srec
3344c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3345c609719bSwdenk	[file transfer complete]
3346c609719bSwdenk	[connected]
3347c609719bSwdenk	## Start Addr = 0x00040004
3348c609719bSwdenk
3349c609719bSwdenk	=> go 40004 Hello World! This is a test.
3350c609719bSwdenk	## Starting application at 0x00040004 ...
3351c609719bSwdenk	Hello World
3352c609719bSwdenk	argc = 7
3353c609719bSwdenk	argv[0] = "40004"
3354c609719bSwdenk	argv[1] = "Hello"
3355c609719bSwdenk	argv[2] = "World!"
3356c609719bSwdenk	argv[3] = "This"
3357c609719bSwdenk	argv[4] = "is"
3358c609719bSwdenk	argv[5] = "a"
3359c609719bSwdenk	argv[6] = "test."
3360c609719bSwdenk	argv[7] = "<NULL>"
3361c609719bSwdenk	Hit any key to exit ...
3362c609719bSwdenk
3363c609719bSwdenk	## Application terminated, rc = 0x0
3364c609719bSwdenk
3365c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
3366c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
3367c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
3368c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
3369c609719bSwdenkcharacter, but this is just a demo program. The application can be
3370c609719bSwdenkcontrolled by the following keys:
3371c609719bSwdenk
3372c609719bSwdenk	? - print current values og the CPM Timer registers
3373c609719bSwdenk	b - enable interrupts and start timer
3374c609719bSwdenk	e - stop timer and disable interrupts
3375c609719bSwdenk	q - quit application
3376c609719bSwdenk
3377c609719bSwdenk	=> loads
3378c609719bSwdenk	## Ready for S-Record download ...
3379c609719bSwdenk	~>examples/timer.srec
3380c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
3381c609719bSwdenk	[file transfer complete]
3382c609719bSwdenk	[connected]
3383c609719bSwdenk	## Start Addr = 0x00040004
3384c609719bSwdenk
3385c609719bSwdenk	=> go 40004
3386c609719bSwdenk	## Starting application at 0x00040004 ...
3387c609719bSwdenk	TIMERS=0xfff00980
3388c609719bSwdenk	Using timer 1
3389c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
3390c609719bSwdenk
3391c609719bSwdenkHit 'b':
3392c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
3393c609719bSwdenk	Enabling timer
3394c609719bSwdenkHit '?':
3395c609719bSwdenk	[q, b, e, ?] ........
3396c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
3397c609719bSwdenkHit '?':
3398c609719bSwdenk	[q, b, e, ?] .
3399c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
3400c609719bSwdenkHit '?':
3401c609719bSwdenk	[q, b, e, ?] .
3402c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
3403c609719bSwdenkHit '?':
3404c609719bSwdenk	[q, b, e, ?] .
3405c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
3406c609719bSwdenkHit 'e':
3407c609719bSwdenk	[q, b, e, ?] ...Stopping timer
3408c609719bSwdenkHit 'q':
3409c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
3410c609719bSwdenk
3411c609719bSwdenk
341285ec0bccSwdenkMinicom warning:
341385ec0bccSwdenk================
341485ec0bccSwdenk
34157152b1d0SwdenkOver time, many people have reported problems when trying to use the
341685ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
341785ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
3418f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
341985ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
342085ec0bccSwdenkuse "cu" for S-Record download ("loads" command).
342185ec0bccSwdenk
342252f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
342352f52c14Swdenkconfiguration to your "File transfer protocols" section:
342452f52c14Swdenk
342552f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
342652f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
342752f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
342852f52c14Swdenk
342952f52c14Swdenk
3430c609719bSwdenkNetBSD Notes:
3431c609719bSwdenk=============
3432c609719bSwdenk
3433c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
3434c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
3435c609719bSwdenk
3436c609719bSwdenkBuilding requires a cross environment; it is known to work on
3437c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
3438c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
3439c609719bSwdenkNote that the cross-powerpc package does not install include files;
3440c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
3441c609719bSwdenkmissing.  This file has to be installed and patched manually:
3442c609719bSwdenk
3443c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
3444c609719bSwdenk	# mkdir powerpc
3445c609719bSwdenk	# ln -s powerpc machine
3446c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
3447c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
3448c609719bSwdenk
3449c609719bSwdenkNative builds *don't* work due to incompatibilities between native
3450c609719bSwdenkand U-Boot include files.
3451c609719bSwdenk
3452c609719bSwdenkBooting assumes that (the first part of) the image booted is a
3453c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
3454c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
3455c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
34562a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
3457c609719bSwdenk
3458c609719bSwdenk
3459c609719bSwdenkImplementation Internals:
3460c609719bSwdenk=========================
3461c609719bSwdenk
3462c609719bSwdenkThe following is not intended to be a complete description of every
3463c609719bSwdenkimplementation detail. However, it should help to understand the
3464c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
3465c609719bSwdenkhardware.
3466c609719bSwdenk
3467c609719bSwdenk
3468c609719bSwdenkInitial Stack, Global Data:
3469c609719bSwdenk---------------------------
3470c609719bSwdenk
3471c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
3472c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
3473c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
3474c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
3475c609719bSwdenkis not initialized as zero. To be able to get a C environment working
3476c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
3477c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
3478c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
3479c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
3480c609719bSwdenklocked as (mis-) used as memory, etc.
3481c609719bSwdenk
34827152b1d0Swdenk	Chris Hallinan posted a good summary of	 these	issues	to  the
348343d9616cSwdenk	u-boot-users mailing list:
348443d9616cSwdenk
348543d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
348643d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
348743d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
348843d9616cSwdenk	...
348943d9616cSwdenk
349043d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
349143d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
349243d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
349343d9616cSwdenk	is that the cache is being used as a temporary supply of
349443d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
349543d9616cSwdenk	beyond the scope of this list to expain the details, but you
349643d9616cSwdenk	can see how this works by studying the cache architecture and
349743d9616cSwdenk	operation in the architecture and processor-specific manuals.
349843d9616cSwdenk
349943d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
350043d9616cSwdenk	is another option for the system designer to use as an
350143d9616cSwdenk	initial stack/ram area prior to SDRAM being available. Either
350243d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
350343d9616cSwdenk	board designers haven't used it for something that would
350443d9616cSwdenk	cause you grief during the initial boot! It is frequently not
350543d9616cSwdenk	used.
350643d9616cSwdenk
350743d9616cSwdenk	CFG_INIT_RAM_ADDR should be somewhere that won't interfere
350843d9616cSwdenk	with your processor/board/system design. The default value
350943d9616cSwdenk	you will find in any recent u-boot distribution in
35108a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
351143d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
351243d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
351343d9616cSwdenk	that are supposed to respond to that address! That code in
351443d9616cSwdenk	start.S has been around a while and should work as is when
351543d9616cSwdenk	you get the config right.
351643d9616cSwdenk
351743d9616cSwdenk	-Chris Hallinan
351843d9616cSwdenk	DS4.COM, Inc.
351943d9616cSwdenk
3520c609719bSwdenkIt is essential to remember this, since it has some impact on the C
3521c609719bSwdenkcode for the initialization procedures:
3522c609719bSwdenk
3523c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
3524c609719bSwdenk  to write it.
3525c609719bSwdenk
3526c609719bSwdenk* Do not use any unitialized global data (or implicitely initialized
3527c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
35287152b1d0Swdenk  zation is performed later (when relocating to RAM).
3529c609719bSwdenk
3530c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
3531c609719bSwdenk  that.
3532c609719bSwdenk
3533c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
3534c609719bSwdenknormal global data to share information beween the code. But it
3535c609719bSwdenkturned out that the implementation of U-Boot can be greatly
3536c609719bSwdenksimplified by making a global data structure (gd_t) available to all
3537c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
3538c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
3539c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
3540c609719bSwdenkplace a pointer (gd) to the global data into a register which we
3541c609719bSwdenkreserve for this purpose.
3542c609719bSwdenk
35437152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
3544c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
3545c609719bSwdenkGCC's implementation.
3546c609719bSwdenk
3547c609719bSwdenkFor PowerPC, the following registers have specific use:
3548c609719bSwdenk	R1:	stack pointer
3549c609719bSwdenk	R2:	TOC pointer
3550c609719bSwdenk	R3-R4:	parameter passing and return values
3551c609719bSwdenk	R5-R10: parameter passing
3552c609719bSwdenk	R13:	small data area pointer
3553c609719bSwdenk	R30:	GOT pointer
3554c609719bSwdenk	R31:	frame pointer
3555c609719bSwdenk
3556c609719bSwdenk	(U-Boot also uses R14 as internal GOT pointer.)
3557c609719bSwdenk
3558c609719bSwdenk    ==> U-Boot will use R29 to hold a pointer to the global data
3559c609719bSwdenk
3560c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
3561c609719bSwdenk    address of the global data structure is known at compile time),
3562c609719bSwdenk    but it turned out that reserving a register results in somewhat
3563c609719bSwdenk    smaller code - although the code savings are not that big (on
3564c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
3565c609719bSwdenk    624 text + 127 data).
3566c609719bSwdenk
3567c609719bSwdenkOn ARM, the following registers are used:
3568c609719bSwdenk
3569c609719bSwdenk	R0:	function argument word/integer result
3570c609719bSwdenk	R1-R3:	function argument word
3571c609719bSwdenk	R9:	GOT pointer
3572c609719bSwdenk	R10:	stack limit (used only if stack checking if enabled)
3573c609719bSwdenk	R11:	argument (frame) pointer
3574c609719bSwdenk	R12:	temporary workspace
3575c609719bSwdenk	R13:	stack pointer
3576c609719bSwdenk	R14:	link register
3577c609719bSwdenk	R15:	program counter
3578c609719bSwdenk
3579c609719bSwdenk    ==> U-Boot will use R8 to hold a pointer to the global data
3580c609719bSwdenk
3581d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
3582d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
3583c609719bSwdenk
3584c609719bSwdenkMemory Management:
3585c609719bSwdenk------------------
3586c609719bSwdenk
3587c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
3588c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
3589c609719bSwdenk
3590c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
3591c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
3592c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
3593c609719bSwdenkphysical memory banks.
3594c609719bSwdenk
3595c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
3596c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
3597c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
3598c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
3599c609719bSwdenkmemory is reserved for use by malloc() [see CFG_MALLOC_LEN
3600c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
3601c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
3602c609719bSwdenk
3603c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
3604c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
3605c609719bSwdenk
3606c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
3607c609719bSwdenkthis:
3608c609719bSwdenk
3609c609719bSwdenk	0x0000 0000	Exception Vector code
3610c609719bSwdenk	      :
3611c609719bSwdenk	0x0000 1FFF
3612c609719bSwdenk	0x0000 2000	Free for Application Use
3613c609719bSwdenk	      :
3614c609719bSwdenk	      :
3615c609719bSwdenk
3616c609719bSwdenk	      :
3617c609719bSwdenk	      :
3618c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
3619c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
3620c609719bSwdenk	0x00FC 0000	Malloc Arena
3621c609719bSwdenk	      :
3622c609719bSwdenk	0x00FD FFFF
3623c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
3624c609719bSwdenk	...		eventually: LCD or video framebuffer
3625c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
3626c609719bSwdenk	0x00FF FFFF	[End of RAM]
3627c609719bSwdenk
3628c609719bSwdenk
3629c609719bSwdenkSystem Initialization:
3630c609719bSwdenk----------------------
3631c609719bSwdenk
3632c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
3633c609719bSwdenk(on most PowerPC systens at address 0x00000100). Because of the reset
3634c609719bSwdenkconfiguration for CS0# this is a mirror of the onboard Flash memory.
36357152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
3636c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
3637c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
3638c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
3639c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
3640c609719bSwdenkthe caches and the SIU.
3641c609719bSwdenk
3642c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
3643c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
3644c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
3645c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
3646c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
3647c609719bSwdenksimple memory test is run that determines the size of the SDRAM
3648c609719bSwdenkbanks.
3649c609719bSwdenk
3650c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
36517152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
3652c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
3653c609719bSwdenk0x00000000, with any additional banks following immediately to create
3654c609719bSwdenkcontiguous memory starting from 0.
3655c609719bSwdenk
3656c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
3657c609719bSwdenkand allocates memory for use by malloc() and for the global Board
3658c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
3659c609719bSwdenkpages, and the final stack is set up.
3660c609719bSwdenk
3661c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
3662c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
3663c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
3664c609719bSwdenknew address in RAM.
3665c609719bSwdenk
3666c609719bSwdenk
3667c609719bSwdenkU-Boot Porting Guide:
3668c609719bSwdenk----------------------
3669c609719bSwdenk
3670c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
36716aff3115Swdenklist, October 2002]
3672c609719bSwdenk
3673c609719bSwdenk
3674c609719bSwdenkint main (int argc, char *argv[])
3675c609719bSwdenk{
3676c609719bSwdenk	sighandler_t no_more_time;
3677c609719bSwdenk
3678c609719bSwdenk	signal (SIGALRM, no_more_time);
3679c609719bSwdenk	alarm (PROJECT_DEADLINE - toSec (3 * WEEK));
3680c609719bSwdenk
3681c609719bSwdenk	if (available_money > available_manpower) {
3682c609719bSwdenk		pay consultant to port U-Boot;
3683c609719bSwdenk		return 0;
3684c609719bSwdenk	}
3685c609719bSwdenk
3686c609719bSwdenk	Download latest U-Boot source;
3687c609719bSwdenk
36886aff3115Swdenk	Subscribe to u-boot-users mailing list;
36896aff3115Swdenk
3690c609719bSwdenk	if (clueless) {
3691c609719bSwdenk		email ("Hi, I am new to U-Boot, how do I get started?");
3692c609719bSwdenk	}
3693c609719bSwdenk
3694c609719bSwdenk	while (learning) {
3695c609719bSwdenk		Read the README file in the top level directory;
36967cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
3697c609719bSwdenk		Read the source, Luke;
3698c609719bSwdenk	}
3699c609719bSwdenk
3700c609719bSwdenk	if (available_money > toLocalCurrency ($2500)) {
3701c609719bSwdenk		Buy a BDI2000;
3702c609719bSwdenk	} else {
3703c609719bSwdenk		Add a lot of aggravation and time;
3704c609719bSwdenk	}
3705c609719bSwdenk
3706c609719bSwdenk	Create your own board support subdirectory;
3707c609719bSwdenk
37086aff3115Swdenk	Create your own board config file;
37096aff3115Swdenk
3710c609719bSwdenk	while (!running) {
3711c609719bSwdenk		do {
3712c609719bSwdenk			Add / modify source code;
3713c609719bSwdenk		} until (compiles);
3714c609719bSwdenk		Debug;
3715c609719bSwdenk		if (clueless)
3716c609719bSwdenk			email ("Hi, I am having problems...");
3717c609719bSwdenk	}
3718c609719bSwdenk	Send patch file to Wolfgang;
3719c609719bSwdenk
3720c609719bSwdenk	return 0;
3721c609719bSwdenk}
3722c609719bSwdenk
3723c609719bSwdenkvoid no_more_time (int sig)
3724c609719bSwdenk{
3725c609719bSwdenk      hire_a_guru();
3726c609719bSwdenk}
3727c609719bSwdenk
3728c609719bSwdenk
3729c609719bSwdenkCoding Standards:
3730c609719bSwdenk-----------------
3731c609719bSwdenk
3732c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
37332c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
37342c051651SDetlev Zundel"scripts/Lindent" in your Linux kernel source directory.  In sources
37352c051651SDetlev Zundeloriginating from U-Boot a style corresponding to "Lindent -pcs" (adding
37362c051651SDetlev Zundelspaces before parameters to function calls) is actually used.
3737c609719bSwdenk
37382c051651SDetlev ZundelSource files originating from a different project (for example the
37392c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
37402c051651SDetlev Zundelreformated to ease subsequent migration to newer versions of those
37412c051651SDetlev Zundelsources.
37422c051651SDetlev Zundel
37432c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
37442c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
37452c051651SDetlev Zundelin your code.
3746c609719bSwdenk
3747c178d3daSwdenkPlease also stick to the following formatting rules:
3748180d3f74Swdenk- remove any trailing white space
3749180d3f74Swdenk- use TAB characters for indentation, not spaces
3750180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
3751180d3f74Swdenk- do not add more than 2 empty lines to source files
3752180d3f74Swdenk- do not add trailing empty lines to source files
3753180d3f74Swdenk
3754c609719bSwdenkSubmissions which do not conform to the standards may be returned
3755c609719bSwdenkwith a request to reformat the changes.
3756c609719bSwdenk
3757c609719bSwdenk
3758c609719bSwdenkSubmitting Patches:
3759c609719bSwdenk-------------------
3760c609719bSwdenk
3761c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
3762c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
3763c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
3764c609719bSwdenk
376590dc6704SwdenkPatches shall be sent to the u-boot-users mailing list.
3766c609719bSwdenk
3767c609719bSwdenkWhen you send a patch, please include the following information with
3768c609719bSwdenkit:
3769c609719bSwdenk
3770c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
3771c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
3772c609719bSwdenk  patch actually fixes something.
3773c609719bSwdenk
3774c609719bSwdenk* For new features: a description of the feature and your
3775c609719bSwdenk  implementation.
3776c609719bSwdenk
3777c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
3778c609719bSwdenk
3779c609719bSwdenk* For major contributions, your entry to the CREDITS file
3780c609719bSwdenk
3781c609719bSwdenk* When you add support for a new board, don't forget to add this
3782c609719bSwdenk  board to the MAKEALL script, too.
3783c609719bSwdenk
3784c609719bSwdenk* If your patch adds new configuration options, don't forget to
3785c609719bSwdenk  document these in the README file.
3786c609719bSwdenk
3787c609719bSwdenk* The patch itself. If you are accessing the CVS repository use "cvs
3788c609719bSwdenk  update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your
3789c609719bSwdenk  version of diff does not support these options, then get the latest
3790c609719bSwdenk  version of GNU diff.
3791c609719bSwdenk
37926dff5529Swdenk  The current directory when running this command shall be the top
37936dff5529Swdenk  level directory of the U-Boot source tree, or it's parent directory
37946dff5529Swdenk  (i. e. please make sure that your patch includes sufficient
37956dff5529Swdenk  directory information for the affected files).
37966dff5529Swdenk
3797c609719bSwdenk  We accept patches as plain text, MIME attachments or as uuencoded
3798c609719bSwdenk  gzipped text.
3799c609719bSwdenk
380052f52c14Swdenk* If one logical set of modifications affects or creates several
380152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
380252f52c14Swdenk
380352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
380452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
380552f52c14Swdenk
380652f52c14Swdenk
3807c609719bSwdenkNotes:
3808c609719bSwdenk
3809c609719bSwdenk* Before sending the patch, run the MAKEALL script on your patched
3810c609719bSwdenk  source tree and make sure that no errors or warnings are reported
3811c609719bSwdenk  for any of the boards.
3812c609719bSwdenk
3813c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
3814c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
3815c609719bSwdenk  returned with a request to re-formatting / split it.
3816c609719bSwdenk
3817c609719bSwdenk* If you modify existing code, make sure that your new code does not
3818c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
3819c609719bSwdenk  When adding new features, these should compile conditionally only
3820c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
3821c609719bSwdenk  disabled must not need more memory than the old code without your
3822c609719bSwdenk  modification.
382390dc6704Swdenk
382490dc6704Swdenk* Remember that there is a size limit of 40 kB per message on the
382590dc6704Swdenk  u-boot-users mailing list. Compression may help.
3826